频道改变回调通知
更新时间:2026-06-11 19:22:28
作用
在旧版后台创建频道、删除频道,或者在新版后台创建频道、删除频道、修改频道(仅编辑直播间信息)、修改观看条件时,保利威会对所设置的回调地址进行回调通知。
详情
请求方式
POST
请求类型
application/json
正常响应
如果您正常接收到请求,10秒内返回http状态码为200即可。
若超时或者返回http状态码非200,保利威将在间隔5秒、10秒发起重试。(只要有一次请求成功,下次将不再发起重试)
回调参数说明
注:请求参数在Query参数中获取
| 参数名 | 类型 | 说明 |
|---|---|---|
| timestamp | Long | 请求时间戳 |
| sign | String | 校验的加密字符串,生成的规则md5(AppSecret+timestamp),AppSecret是直播系统的用密匙 |
注:请求参数在body中获取
type为delete时回调的字段
| 参数名 | 类型 | 说明 |
|---|---|---|
| type | String | 操作的类型,delete为删除 |
| channelId | String | 频道号 |
| operationTime | Long | 操作的时间点,为13位的时间戳 |
type为create、update时回调的字段
| 参数名 | 类型 | 说明 |
|---|---|---|
| type | String | 操作的类型,create为新建,update为更新 |
| channelId | String | 频道号 |
| operationTime | Long | 操作的时间点,为13位的时间戳 |
| categoryName | String | 频道所属分类名称 |
| scene | String | 频道的直播场景,topclass-大班课,double-双师课,train-企业培训,seminar-研讨会,alone-活动营销,portrait-带货 |
| pureRtcEnabled | String | 是否开启无延迟,Y表示开启,N表示不开启 |
| linkMicLimit | Integer | 连麦人数上限 |
| transmitType | String | 转播频道类型,normal-没有开启转播,transmit-发起转播,receive-接收转播 |
| coverImg | String | 直播封面 |
| liveType | String | 开播模板,ppt-文档+视频,alone-纯视频,topclass-纯视频-极速(原大班课),seminar-研讨会 |
| startTime | String | 直播开始时间,如:2022-01-20 00:00:00 |
| watchType | String | 观看模板,normal-横屏,portrait-竖屏 |
| name | String | 频道名称 |
| bgImg | String | 暖场图片 |
| splashImg | String | 引导图 |
| publisher | String | 主持人 |
type为auth时回调的字段
| 参数名 | 类型 | 说明 |
|---|---|---|
| channelId | String | 频道号 |
| userId | String | 用户ID |
| rank | Integer | 用于实现一个频道设置两个观看条件,为1或2(1为主要条件,2为次要条件) |
| globalSettingEnabled | String | 是否开启全局设置(该值仅对旧版后台有效) Y:开启 N:不开启 |
| enabled | String | 是否开启观看条件 Y:开启 N:不开启 |
| authType | String | 观看条件类型 none:无限制 code:验证码观看 pay:付费观看 phone:白名单观看 info:登记观看 wxshare:分享观看 custom:自定义授权观看 external:外部授权观看 direct:独立授权) |
| subAuthType | String | authType为none时对应的值,public-公开观看,wx-微信授权 |
| wxAuthExpireValue | String | subAuthType为wx时,对应的微信授权有效期,例如: 3d表示3天,3h表示3小时 |
| codeAuthTips | String | 验证码观看条件提示信息 |
| authCode | String | 验证码观看的验证码 |
| qcodeTips | String | 验证码观看的二维码提示 |
| qcodeImg | String | 验证码观看的二维码图片 |
| payAuthTips | String | 付费观看提示信息 |
| price | Float | 付费观看的价格,单位:元 |
| watchEndTime | Long | 付费观看,截止时间,为null表示:一次付费,永久有效 |
| validTimePeriod | Integer | 付费观看的截止时长(天) |
| customKey | String | 自定义授权观看的key |
| customUri | String | 自定义授权观看的接口地址 |
| externalKey | String | 外部授权观看的key |
| externalUri | String | 外部授权观看的接口地址 |
| externalRedirectUri | String | 外部授权观看,用户直接访问观看页时的跳转地址 |
| externalButtonEnabled | String | 外部授权观看,登录按钮。Y为开启,N为关闭。开启后用户访问链接时,引导页面将显示登录按钮 |
| directKey | String | 独立授权key |
| trialWatchEnabled | String | 付费观看的试看开关,默认为N Y:开 N:关 |
| trialWatchTime | Integer | 试看时间,单位为分钟 |
| trialWatchEndTime | Long | 试看截止日期,为null 表示对该频道永久有效 |
| whiteListInputTips | String | 白名单输入提示 |
| whiteListEntryText | String | 白名单入口文案 |
| onceWhitelistEnabled | String | 白名单不允许重复使用,默认为N,Y:是、N:否 |
| authTips | String | 白名单观看提示信息 |
| infoDesc | String | 登记观看描述字段 |
| infoAuthTips | String | 登记观看条件提示信息 |
请求体示例
请求Query示例
sign=8cc3607a4eb5bb3b5ded247b36c11c03×tamp=1662081806366
请求json示例
{
"type": "create",
"operationTime": 1660286426422,
"channelId": 3289191,
"categoryName": "默认分类",
"scene": "topclass",
"pureRtcEnabled": "N",
"linkMicLimit": 0,
"transmitType": "normal",
"startTime": "",
"coverImg": "//liveimages.videocc.net/uploaded/images/2022/08/gcfk857g37.png",
"liveType": "ppt",
"watchType": "normal"
}
如何设置
前提条件:账号需要开通频道修改回调功能,如果未开通此功能,则回调设置处没有“直播间信息修改回调URL”
通过后台设置:
登录账户 - 进入【云直播】 - 点击【开发设置】- 点击【回调设置】- 找到“直播间信息修改回调URL”
注意:提交的接口地址必须要以 http:// 或者 https:// 开头
若无法找到对应设置,可能为账号权限不足,如需获取帮助,请联系右下角在线客服解决。
