修改全域回呼設定
更新時間:2026-06-08 17:28:22
介面描述
1、修改全局回调设置
2、(timestamp, appId)参与sign签名,并和sign一起通过url传递,请求体参数不参与签名,通过post请求体传递【请设置请求头contentType:application/json】
3、接口支持https协议
介面URL
http://api.polyv.net/live/v4/user/global-setting/callback/update
請求方式
POST
介面限制
1、介面同時支援HTTP、HTTPS,建議使用HTTPS以確保介面安全,介面呼叫有頻率限制,詳細請查看
2、提交的回呼地址必須以 http:// 或 https:// 開頭
請求參數描述
| 參數名 | 必選 | 類型 | 說明 |
|---|---|---|---|
| appId | true | String | 帳號appId【詳見取得金鑰】 |
| timestamp | true | Long | 當前13位毫秒級時間戳,3分鐘內有效 |
| sign | true | String | 簽名,為32位大寫的MD5值,生成簽名的appSecret金鑰作為通訊資料安全的關鍵資訊,嚴禁保存在用戶端直接使用,所有API都必須透過客戶自己伺服器中轉呼叫POLYV伺服器取得回應資料【詳見簽名生成規則】 |
請求體參數描述
| 參數名 | 必選 | 類型 | 說明 |
|---|---|---|---|
| recordCallbackUrl | false | String | 錄製生成回呼URL |
| recordFileCallBackType | false | String | 回呼錄製檔案內容 all:全部回放影片 last:最終回放影片 |
| recordCallbackVideoType | false | String | 回呼檔案類型 m3u8:m3u8檔案 mp4:mp4檔案 m3u8,mp4:m3u8和mp4檔案 |
| playbackCallbackUrl | false | String | 轉存成功回呼URL |
| rebirthVodCallbackEnabled | false | String | 重製課件轉存點播回呼開關 Y:開啟 N:關閉 |
| pptRecordCallbackUrl | false | String | 課件重製成功回呼URL |
| streamCallbackUrl | false | String | 直播狀態改變回呼URL |
| channelBasicUpdateCallbackUrl | false | String | 頻道直播間資訊修改回呼URL |
| liveScanCallbackUrl | false | String | 直播內容審核不通過回呼URL |
| playbackCacheCallbackUrl | false | String | 直播回放快取生成回呼通知URL |
| aiPptVideoCallbackUrl | false | String | 影片創作資訊回呼 |
| liveViolationCutoffCallbackUrl | false | String | 直播違規斷流回呼 |
| liveStatsCallbackUrl | false | String | 直播資料統計資訊回呼 |
範例
http://api.polyv.net/live/v4/user/global-setting/callback/update?appId=frlr1zazn3&sign=1C6F581887B59B388325338DA850330D×tamp=1657852824050
請求體參數:
{
"rebirthVodCallbackEnabled": "Y",
"recordCallbackUrl": "https://www.abc.com/callback1",
"streamCallbackUrl": "https://www.abc.com/callback3",
"recordFileCallBackType": "last",
"recordCallbackVideoType": "m3u8",
"playbackCallbackUrl": "https://www.abc.com/callback2",
"aiPptVideoCallbackUrl":"https://www.abc.com/callback4"
"liveViolationCutoffCallbackUrl":"https://www.abc.com/callback4"
}
回應參數描述
| 參數名 | 類型 | 說明 |
|---|---|---|
| code | Integer | 狀態碼,與http狀態碼相同,用於確定基本的回應狀態 |
| status | String | 回應結果,由業務決定,成功回傳success,失敗回傳error |
| success | Boolean | 是否成功回應 |
| requestId | String | 請求ID,每次請求生成的唯一UUID,僅可用於排查、除錯,不應與業務掛鉤 |
| error | Object | 狀態碼非200時的錯誤資訊【詳見Error欄位描述】 |
| data | Boolean | 成功回傳true |
Error參數描述
| 參數名 | 類型 | 說明 |
|---|---|---|
| code | Integer | 錯誤代碼,用於確定具體的錯誤原因 |
| desc | String | 錯誤描述,與error.code對應 |
Java請求範例
快速接入基礎程式碼請下載相關依賴原始碼, 點擊下載原始碼,下載後加入自己的原始碼工程中即可。測試案例中的HttpUtil.java 和 LiveSignUtil.java 都包含在下載檔案中。
強烈建議您使用直播Java SDK完成API的功能對接,直播Java SDK對API呼叫邏輯、異常處理、資料簽名、HTTP請求執行緒池進行了統一封裝和最佳化。
private static final Logger log = LoggerFactory.getLogger(UserTest.class);
/**
* 修改全局回调设置
* @throws IOException
* @throws NoSuchAlgorithmException
*/
@Test
public void updateCallbackTest() throws IOException, NoSuchAlgorithmException {
//公共参数,填写自己的实际参数
String appId = super.appId;
String appSecret = super.appSecret;
String timestamp = String.valueOf(System.currentTimeMillis());
//业务参数
String url = "http://api.polyv.net/live/v4/user/global-setting/callback/update";
String recordCallbackUrl = "https://www.abc.com/callback1";
String recordFileCallBackType = "last";
String recordCallbackVideoType = "m3u8";
String playbackCallbackUrl = "https://www.abc.com/callback2";
String rebirthVodCallbackEnabled = "Y";
String streamCallbackUrl = "https://www.abc.com/callback3";
String aiPptVideoCallbackUrl = "https://www.abc.com/callback4";
String liveViolationCutoffCallbackUrl = "https://www.abc.com/callback4";
//http 调用逻辑
Map<String, String> requestMap = new HashMap<>();
requestMap.put("appId", appId);
requestMap.put("timestamp", timestamp);
Map<String, Object> jsonMap = new HashMap<>();
jsonMap.put("recordCallbackUrl", recordCallbackUrl);
jsonMap.put("recordFileCallBackType", recordFileCallBackType);
jsonMap.put("recordCallbackVideoType", recordCallbackVideoType);
jsonMap.put("playbackCallbackUrl", playbackCallbackUrl);
jsonMap.put("rebirthVodCallbackEnabled", rebirthVodCallbackEnabled);
jsonMap.put("streamCallbackUrl", streamCallbackUrl);
jsonMap.put("aiPptVideoCallbackUrl", aiPptVideoCallbackUrl);
jsonMap.put("liveViolationCutoffCallbackUrl", liveViolationCutoffCallbackUrl);
requestMap.put("sign", LiveSignUtil.getSign(requestMap, appSecret));
url = HttpUtil.appendUrl(url, requestMap);
String response = HttpUtil.postJsonBody(url, JSON.toJSONString(jsonMap), null);
log.info("测试修改全局回调设置成功:{}", response);
//do somethings
}
回應範例
系統全域錯誤說明詳見全域錯誤說明
成功範例
{
"code": 200,
"status": "success",
"requestId": "8acd0194a7b6459a8ab168fcf2b63153.69.16578528273261669",
"data": true,
"success": true
}
異常範例
{
"code": 400,
"status": "error",
"requestId": "d310b70bc329403f87f77f9203d50f89.128.16360831552223589",
"error": {
"code": 20001,
"desc": "application not found."
},
"success": false
}
