修改频道回调设置
更新时间:2026-04-24 09:28:34
接口描述
1、修改频道回调设置接口
2、如频道需要跟随用户设置,可以调用设置频道默认项开关接口
3、接口支持https协议
接口URL
http://api.polyv.net/live/v3/channel/callback/update-setting
请求方式
POST
接口约束
1、接口同时支持HTTP 、HTTPS ,建议使用HTTPS 确保接口安全,接口调用有频率限制,详细请查看
请求参数描述
| 参数名 | 必选 | 类型 | 说明 |
|---|---|---|---|
| appId | true | String | 账号appId【详见获取密钥】 |
| timestamp | true | Long | 当前13位毫秒级时间戳,3分钟内有效 |
| sign | true | String | 签名,为32位大写的MD5值,生成签名的appSecret密钥作为通信数据安全的关键信息,严禁保存在客户端直接使用,所有API都必须通过客户自己服务器中转调用POLYV服务器获取响应数据【详见签名生成规则】 |
| channelId | true | String | 频道号 |
| recordCallbackVideoType | false | String | 录制回调文件类型,可选值m3u8或mp4或m3u8,mp4 |
| recordCallbackUrl | false | String | 录制回调http(s)地址,需要url编码,如果要清空设置传入空串 |
| playbackCallbackUrl | false | String | 转存成功回调http(s)地址,需要url编码,如果要清空设置传入空串 |
| streamCallbackUrl | false | String | 流状态回调http(s)地址,需要url编码,如果要清空设置传入空串 |
| pptRecordCallbackUrl | false | String | 课件重制成功回调http(s)地址,需要url编码,如果要清空设置传入空串 |
| liveScanCallbackUrl | false | String | 直播内容鉴别回调http(s)地址,需要url编码,如果要清空设置传入空串 |
| playbackCacheCallbackUrl | false | String | 回放转存回调http(s)地址,需要url编码,如果要清空设置传入空串 |
| subtitleCallbackUrl | false | String | (规划中,预计2025Q2支持)字幕生成回调http(s)地址,需要url编码,如果要清空设置传入空串 |
| liveViolationCutoffCallbackUrl | false | String | 直播违规断流回调http(s)地址,需要url编码,如果要清空设置传入空串 |
| customBookingCallbackUrl | false | String | 直播观众预约回调http(s)地址,需要url编码,如果要清空设置传入空串 |
示例
http://api.polyv.net/live/v3/channel/callback/update-setting
表单参数:
pptRecordCallbackUrl=&playbackCacheCallbackUrl=&recordCallbackUrl=http%3A%2F%2Fcallback.polyv.net%2Ftest%3Fcallback%3Dtrue&appId=frlr1zazn3&sign=EBA8303B5004D82010C62089727E34C0&streamCallbackUrl=&recordCallbackVideoType=m3u8&playbackCallbackUrl=&liveScanCallbackUrl=&channelId=2191569×tamp=1621840010962
响应参数描述
| 参数名 | 类型 | 说明 |
|---|---|---|
| code | Integer | 响应状态码,200为成功返回,非200为失败【详见全局错误说明】 |
| status | String | 响应状态文本信息 |
| message | String | 响应描述信息,当code为400或者500的时候,辅助描述错误原因 |
| data | String | 响应成功时返回空 |
Java请求示例
快速接入基础代码请下载相关依赖源码, 点击下载源代码 ,下载后加入到自己的源码工程中即可。测试用例中的HttpUtil.java 和 LiveSignUtil.java 都包含在下载文件中。
强烈建议您使用直播Java SDK完成API的功能对接,直播Java SDK 对API调用逻辑、异常处理、数据签名、HTTP请求线程池进行了统一封装和优化。
private static final Logger log = LoggerFactory.getLogger(ChannelOperateTest.class);
/**
* 修改回调设置
* @throws IOException
* @throws NoSuchAlgorithmException
*/
@Test
public void testUpdateSetting() throws IOException, NoSuchAlgorithmException {
//公共参数,填写自己的实际
String appId = super.appId;
String appSecret = super.appSecret;
String userId = super.userId;
String timestamp = String.valueOf(System.currentTimeMillis());
//业务参数
String url="https://api.polyv.net/live/v3/channel/callback/update-setting";
String channelId="2191569";
String recordCallbackVideoType="m3u8";
String recordCallbackUrl="http://callback.polyv.net/test?callback=true";
String playbackCallbackUrl="";
String streamCallbackUrl="";
String pptRecordCallbackUrl="";
String liveScanCallbackUrl="";
String playbackCacheCallbackUrl="";
String liveViolationCutoffCallbackUrl="";
//http 调用逻辑
Map<String, String> requestMap = new HashMap<>();
requestMap.put("appId", appId);
requestMap.put("timestamp", timestamp);
requestMap.put("channelId", channelId);
requestMap.put("recordCallbackVideoType", recordCallbackVideoType);
requestMap.put("recordCallbackUrl", recordCallbackUrl);
requestMap.put("playbackCallbackUrl", playbackCallbackUrl);
requestMap.put("streamCallbackUrl", streamCallbackUrl);
requestMap.put("pptRecordCallbackUrl", pptRecordCallbackUrl);
requestMap.put("liveScanCallbackUrl", liveScanCallbackUrl);
requestMap.put("playbackCacheCallbackUrl", playbackCacheCallbackUrl);
requestMap.put("liveViolationCutoffCallbackUrl", liveViolationCutoffCallbackUrl);
requestMap.put("customBookingCallbackUrl", customBookingCallbackUrl);
requestMap.put("sign", LiveSignUtil.getSign(requestMap, appSecret));
String response = HttpUtil.postFormBody(url, requestMap);
log.info("测试修改回调设置,返回值:{}", response);
//do somethings
}
响应示例
系统全局错误说明详见全局错误说明
成功示例
{
"code":200,
"status":"success",
"message":"",
"data":""
}
异常示例
{
"code": 400,
"status": "error",
"message": "invalid signature.",
"data": ""
}
