跳到主要内容

查询直播列表

1.接口说明​

请求该接口查询直播列表，支持分页查询。

2.请求地址​

https://digitbot.bokecc.com/api/interact/channel/list

3.请求方式​

GET

4.请求参数​

(1).公共参数，参考服务说明。​

(2).接口参数​

①.Query参数：通过URL参数传递。​

参数名类型必需说明
versionString是接口版本号，当前支持版本：1.0.0。
sessionIdString否直播会话id
endedBoolean否是否已结束，为true时查询status状态为-10，40，41时的记录，为false时将查询其它状态的状态，此参数与status参数不应该同时使用。
statusInteger否直播状态，10：未初始化完成，20：初始化完成，30：直播中， 40：直播主动关闭，41：其它关闭（如长时间无心跳，网络链接中断等），-10: 初始化失败
createTimeStartString否直播创建时间查询起始日期，格式: yyyy-MM-dd
createTimeEndString否直播创建时间查询结束日期，格式: yyyy-MM-dd
sortTypeInteger否排序类型，1：直播创建时间倒序，2：直播创建时间正序，默认为1
pageNumInteger否查询页码，正整数。默认值：1。
pageSizeInteger否分页大小，正整数，取值范围为[1, 100]区间，默认值：25。

5.请求示例​

GET https://digitbot.bokecc.com/api/interact/channel/list?ended=false&pageNum=1&pageSize=50&accountId=xxx&version=1.0.0&hash=xxx&time=xxx HTTP/1.1

6.响应示例​

{
    "count": 100,
	"items": [{
            "sessionId": "6D8CEA3EFD84AAA4",
            "status": 41,
            "createTime": "2024-07-10 11:33:15",
            "startTime": "2024-07-10 11:33:30",
            "endTime": "2024-07-10 11:50:10",
            "ended": true
    }, ...]
}

7.响应说明​

字段名类型说明
countLong符合查询条件的AI声音总数量。
itemsArray查询页返回的直播(live)列表。

live字段说明​

字段名类型说明
sessionIdString直播会话id
statusInteger直播状态，10：未初始化完成，20：初始化完成，30：直播中， 40：直播主动关闭，41：其它关闭（如长时间无心跳，网络链接中断等），-10: 初始化失败
createTimeString直播创建时间, 格式：yyyy-MM-dd HH:mm:ss
startTimeString直播开启时间, 格式：yyyy-MM-dd HH:mm:ss
endTimeString直播关闭时间, 格式：yyyy-MM-dd HH:mm:ss
endedBoolean直播是否已结束