修改頻道回呼設定
更新時間: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": ""
}
