回调接口开发指南

版本: 1.3.2
日期: 2020-11-09

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

1、http://domain

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

3、https://domain

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

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

直播开始回调参数说明:

字段名 说明
userId CC账号ID
roomId 直播间ID
liveId 直播ID
type 回调类型(参考回调类型说明)
startTime 直播开始时间, 格式为"yyyy-MM-dd HH:mm:ss"

直播结束回调参数说明:

字段名 说明
userId CC账号ID
roomId 直播间ID
liveId 直播ID
type 回调类型(参考回调类型说明)
startTime 直播开始时间, 格式为"yyyy-MM-dd HH:mm:ss"
endTime 直播结束时间, 格式为"yyyy-MM-dd HH:mm:ss"
stopStatus 直播结束状态,10:正常结束,20:非正常结束

直播录制回调参数说明:

字段名 说明
userId CC账号
roomId 直播间ID
liveId 直播ID
recordId 回放ID
type 回调类型(参考回调类型说明)
startTime 录制开始时间, 格式为"yyyy-MM-dd HH:mm:ss"
endTime 录制结束时间, 格式为"yyyy-MM-dd HH:mm:ss"(回调类型type为102或103时,会返回该参数)
recordStatus 回放状态,10:回放处理成功,20:回放处理失败,30:录制时间过长(回调类型type为103时,会返回该参数)
sourcetype 回放来源,0:录制; 1:合并; 2:迁移; 3:上传; 4:裁剪(回调类型type为103时,会返回该参数)
recordVideoId 回放视频ID(回放状态recordStatus为10时,会返回该参数)
recordVideoDuration 回放视频时长,单位:秒(回放状态recordStatus为10时,会返回该参数)
replayUrl 回放观看地址(回放状态recordStatus为10时,会返回该参数)

离线回放回调参数说明:

字段名 说明
userId CC账号
roomId 直播间ID
liveId 直播ID
recordId 回放ID
type 回调类型
offlineStatus 离线包可用状态(10:可用,20:不可用)
offlineMd5 离线包MD5
offlineUrl 离线包地址

回调类型说明:

回调类型 说明
1 直播开始
2 直播结束
101 录制开始
102 录制结束
103 录制完成
200 离线回放

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

{
    "result": "OK"
}

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

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

版本更新记录

更新日期 版本号 更新内容
2020-11-09 1.3.2 直播录制回调中的replayUrl 修改为 https协议

results matching ""

    No results matching ""