回调接口开发指南

日期: 2024-01-31

当直播开始、结束和录制开始、结束、完成后，直播系统会通过用户在admin配置的回调信息以GET⽅式发起回调。若⽤户网站地址使⽤HTTPS协议进⾏数据安全传输时，⽤户需保证其拥有的CA证书是合法的。 ⽤户可以在admin后台指定的回调符合以下四种格式之⼀即为合法：

1、http://domain

2、http://domain?data=****（data为⽤户⾃定义的参数）

3、https://domain

4、https://domain?data=****

若参数回调地址中携带有⽤户⾃定义的参数，则在进⾏回调通知时会将⽤户⾃定义的参数和下表中的参数⼀起以THQS⽅式进⾏加密。

直播开始回调参数说明：

直播结束回调参数说明：

直播录制回调参数说明：

离线回放回调参数说明：

回放重制回调参数说明：

互动结束回调参数说明：

伪直播资源准备结果回调参数说明：

敏感词设置回调参数说明：

敏感词设置回调action说明：

敏感词设置回调的其他说明：

1. 批量导入敏感词时，如果敏感词数量过多，回调请求会分多次执行，每次执行时携带一部分导入的敏感词
2. 设置免过滤角色的action中，“set_needless_filter_role”为前缀。只有前缀则表示当前动作为“免过滤角色清空”。“_lecturer_assistant_host”为实际设置的三种角色。

回调类型说明：

用户接受回调成功返回信息：

{
    "result": "OK"
}

返回内容长度限制在1024字符以内，如果返回其他内容，则回调系统会重试，重试的间隔会随着重试次数的增大而增大。若重试7次后，依然没有成功，则不再进行通知。因此，回调系统最多通知8次。这8次的通知时间距第一次的通知时间的差分别为:

[0，15s， 1m， 4m， 16m， 1h4m， 4h16m， 17h4m]

互动结束回调、敏感词设置回调的重试策略区分于其他回调。互动结束回调若失败，则系统会重试2次，每次间隔固定为15s。