查詢全域回呼設定
更新時間:2025-09-04 09:52:52
介面描述
1、查询全局回调设置
2、接口支持https协议
介面URL
http://api.polyv.net/live/v4/user/global-setting/callback/get
請求方式
GET
介面限制
1、介面同時支援HTTP、HTTPS,建議使用HTTPS確保介面安全,介面呼叫有頻率限制,詳細請查看
請求參數描述
| 參數名 | 必選 | 類型 | 說明 |
|---|---|---|---|
| appId | true | String | 帳號appId【詳見取得金鑰】 |
| timestamp | true | Long | 當前13位毫秒級時間戳,3分鐘內有效 |
| sign | true | String | 簽名,為32位大寫的MD5值,產生簽名的appSecret金鑰作為通訊資料安全的關鍵資訊,嚴禁儲存在用戶端直接使用,所有API都必須透過客戶自己伺服器中轉呼叫POLYV伺服器取得回應資料【詳見簽名產生規則】 |
範例
http://api.polyv.net/live/v4/user/global-setting/callback/get?appId=frlr1zazn3&sign=4A5B12ECA5142FB85E12A8DE9BF7DE71×tamp=1657851977367
回應參數描述
| 參數名 | 類型 | 說明 |
|---|---|---|
| code | Integer | 狀態碼,與 http 狀態碼相同,用於確定基本的回應狀態 |
| status | String | 回應結果,由業務決定,成功回傳success,失敗回傳error |
| success | Boolean | 是否成功回應 |
| requestId | String | 請求ID,每次請求產生的唯一的 UUID,僅可用於排查、除錯,不應該和業務掛鉤 |
| error | Object | 狀態碼非200時的錯誤資訊【詳見Error欄位描述】 |
| data | Object | 【詳見data欄位說明】 |
Error參數描述
| 參數名 | 類型 | 說明 |
|---|---|---|
| code | Integer | 錯誤代碼,用於確定具體的錯誤原因 |
| desc | String | 錯誤描述,與 error.code 對應 |
data參數描述
| 參數名 | 類型 | 說明 |
|---|---|---|
| recordCallbackUrl | String | 錄製產生回呼URL |
| recordFileCallBackType | String | 回呼錄製檔案類型 all:全部回放影片 last:最終回放影片 |
| recordCallbackVideoType | String | 回呼檔案類型 m3u8:m3u8檔案 mp4:mp4檔案 m3u8,mp4:m3u8和mp4檔案 |
| playbackCallbackUrl | String | 轉存成功回呼URL |
| rebirthVodCallbackEnabled | String | 重製課件轉存點播回呼開關 Y:開啟 N:關閉 |
| pptRecordCallbackUrl | String | 課件重製成功回呼URL |
| streamCallbackUrl | String | 直播狀態改變回呼URL |
| channelBasicUpdateCallbackUrl | String | 頻道直播間資訊修改回呼URL |
| liveScanCallbackUrl | String | 直播內容審核不通過回呼URL |
| chatUserStatusCallbackUrl | String | 直播間人員狀態回呼URL |
| interactionCallbackUrl | String | 互動功能回呼URL |
| playbackCacheCallbackUrl | String | 直播回放快取產生回呼通知URL |
| playbackSettingCallbackUrl | String | 回放設定回呼URL |
| aiPptVideoCallbackUrl | String | 影片創作資訊回呼 |
| liveViolationCutoffCallbackUrl | String | 直播違規斷流回呼 |
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 getCallbackTest() 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/get";
//http 调用逻辑
Map<String, String> requestMap = new HashMap<>();
requestMap.put("appId", appId);
requestMap.put("timestamp", timestamp);
requestMap.put("sign", LiveSignUtil.getSign(requestMap, appSecret));
String response = HttpUtil.get(url, requestMap);
log.info("测试查询全局回调设置成功:{}", response);
//do somethings
}
回應範例
系統全域錯誤說明詳見全域錯誤說明
成功範例
{
"code": 200,
"status": "success",
"requestId": "8acd0194a7b6459a8ab168fcf2b63153.64.16578519813679255",
"data": {
"recordCallbackUrl": "http://www.abc.com/callback",
"recordFileCallBackType": "all",
"recordCallbackVideoType": "m3u8,mp4",
"playbackCallbackUrl": "http://www.abc.com/callback",
"rebirthVodCallbackEnabled": "Y",
"pptRecordCallbackUrl": "",
"streamCallbackUrl": "http://www.abc.com/callback",
"channelBasicUpdateCallbackUrl": "",
"liveScanCallbackUrl": "",
"chatUserStatusCallbackUrl": "",
"interactionCallbackUrl": "",
"playbackCacheEnabled": "N",
"chatUserStatusCallbackEnabled": "Y",
"playbackCacheCallbackUrl": "",
"playbackSettingCallbackUrl": null,
"aiPptVideoCallbackUrl":null,
"liveViolationCutoffCallbackUrl": "http://www.abc.com/callback"
},
"success": true
}
異常範例
{
"code": 400,
"status": "error",
"requestId": "d310b70bc329403f87f77f9203d50f89.128.16360831552223589",
"error": {
"code": 20001,
"desc": "application not found."
},
"success": false
}
