跳到主要内容

直播接管排队

1.接口说明

添加排队的直播接管任务,接管排队任务未指定排队序号时按顺序加入队列,指定排序序号时按序号插入队列,如果指定序号比排队任务数大,则加入到队列尾。

2.请求地址

https://digitbot.bokecc.com/api/interact/channel/task/queue

3.请求方式

POST application/json

4.请求参数

①.Query参数:通过URL参数传递。

公共参数及以下参数:

参数名类型必需说明
versionString接口版本号,当前支持版本:1.0.0。

②.Body参数:通过请求Body传递,JSON格式。

参数名类型必需说明
sessionIdString直播会话id
priorityInteger插入排队期望位置序号, 取值大于等于0,如无或者超过当前队列最大长度则插入队尾
contentString接管文本内容,content和audio必需有一个有值,长度限制<500字符
audioString接管音频mp3地址,仅支持m3格式,content有内容时audio会被忽略
cancelPreBoolean是否取消之前排队接管任务,默认为false

5.请求示例

POST https://digitbot.bokecc.com/api/interact/channel/task/queue?accountId=xxx&version=1.0.0&hash=xxx&time=xxx HTTP/1.1
{
"sessionId": "xxxxxx",
"priority": 1,
"content" : "测试一段文本"
"cancelPre": true
}

6.响应示例

{
"taskId": "xxxxxx",
"queueSize": 5
}

7.响应说明

字段名类型说明
taskIdString接管任务id
queueSizeInteger当前排队任务数,不包含本次接管任务