保利威文档中心

帮助中心

频道回调功能(弃用)

更新时间:2023-06-16 11:33:33

该功能非SaaS后台功能 直播间信息修改回调 对应文档。该回调没有后台配置页面,建议不使用该功能完成业务。

SaaS后台功能【直播间信息修改回调】对应文档:频道改变回调通知

作用

账号下直播频道新增、删除、修改(包括基本信息设置、讲师设置、嘉宾设置、直播状态的修改),会对所设置的接口地址进行回调通知。

详情

设置回调接口地址后,当存在频道新增、修改、删除操作,会以post的方式请求回调接口

超时重试

回调服务器在发送消息通知后,5秒内没有收到您的服务器的响应,即认为通知失败。后续失败会以5秒、10秒、20秒的间隔继续重试3次。

回调消息格式

事件回调消息以 HTTP/HTTPS POST 请求发送给您的服务器,其中:

  • 字符编码格式:UTF-8。
  • 请求:body 格式为 JSON。url会带上timestamp和sign,验签名方式为md5(body + timestamp + appSecret)
  • 应答要求:响应头需指定Content-Type: application/json;
  • 正确应答:http status code: 200为正确业务接收处理,其他状态一律视为失败重试处理 。

回调数据示例

一、下述为“频道创建”的示例 ur参数:timestamp=1620878344475&sign=eb7d6b79d3816214131015973294b179 响应体:

{
    "channelId": 2290918,
    "channelName": "演示频道",
    "eventType": "ADD",
    "eventTime": "2021-05-13 11:58:29"
}

二、下述为“频道修改”的示例 ur参数:timestamp=1620878679926&sign=176230a93b89023a974976eafda7c12a 响应体:

{
    "channelId": 2290918,
    "channelName": "演示频道",
    "liveStatus": "waiting",
    "eventType": "MODIFY",
    "eventTime": "2021-05-13 12:04:04",
    "startTime": "2021-05-13 22:04:04",
    "splashImg":"https://liveimages.videocc.net/uploaded/images/2021/05/fyjxijew0x1.jpg"
    "publisher": "主持人",
    "teacher": {
        "nickname": "讲师",
        "actor": "讲师"
    },
    "guests": [
        {
            "nickname": "陈老师",
            "actor": "嘉宾"
        }
    ]
}

三、下述为“频道删除”的示例 ur参数:timestamp=1620878775840&sign=2e4867bc2a6df0f648ed7ba43a63421c 响应体:

{
    "channelId": 2290918,
    "channelName": "演示频道",
    "eventType": "DELETE",
    "eventTime": "2021-05-13 12:05:40"
}

回调参数说明

参数名 类型及范围 说明
channelId int 频道id
channelName string 频道名称
liveStatus string 直播状态(live-直播,end-结束 waiting-等待直播,playback-回放)
eventType string 事件类型(ADD-新增,MODIFY-修改,DELETE-删除)
eventTime string 事件触发时间
publisher string 主持人
splashImg string 引导页图片
startTime string 开播时间
teacher object 主持
teacher.nickname string 主持昵称
teacher.actor string 主持头衔
guests array 嘉宾
guests[].nickname string 嘉宾昵称
guests[].actor string 嘉宾头衔
联系客服,在线咨询