查詢頻道回呼設定

更新時間：2026-04-24 09:26:22

介面描述

1、查询频道回调设置接口
2、接口支持https协议

介面URL

http://api.polyv.net/live/v3/channel/callback/get-setting

線上API呼叫

請求方式

GET

介面限制

1、介面同時支援HTTP、HTTPS，建議使用HTTPS確保介面安全，介面呼叫有頻率限制，詳細請查看

請求參數描述

參數名	必選	類型	說明
appId	true	String	帳號appId【詳見取得金鑰】
timestamp	true	Long	目前13位毫秒級時間戳記，3分鐘內有效
sign	true	String	簽名，為32位大寫的MD5值，`產生簽名的appSecret金鑰作為通訊資料安全的關鍵資訊，嚴禁儲存在用戶端直接使用，所有API都必須透過客戶自己伺服器中轉呼叫POLYV伺服器取得回應資料`【詳見簽名產生規則】
channelId	true	String	頻道號

範例

http://api.polyv.net/live/v3/channel/callback/get-setting?appId=frlr1zazn3&sign=7CC8C8BEBB917B1640FE7CA9B1DB4DD6&channelId=2191569&timestamp=1621840149303

回應參數描述

參數名	類型	說明
code	Integer	回應狀態碼，200為成功返回，非200為失敗【詳見全域錯誤說明】
status	String	回應狀態文字資訊
message	String	回應描述資訊，當code為400或500時，輔助描述錯誤原因
data	Object	回應成功時返回回呼設定資訊【詳見data欄位說明】

Data參數描述

參數名	類型	說明
recordCallbackUrl	String	錄製產生回呼URL
playbackCallbackUrl	String	錄製影片轉存成功回呼URL
streamCallbackUrl	String	串流狀態回呼URL
liveScanCallbackUrl	String	直播內容審核回呼URL
recordCallbackVideoType	String	錄製回呼的影片類型，多個影片類型用“,”分隔
pptRecordCallbackUrl	String	課件重製成功回呼URL
playbackSettingCallbackUrl	String	回放離線快取回呼URL
playbackCacheCallbackUrl	String	回放快取產生成功的回呼URL
subtitleCallbackUrl	String	（規劃中，預計2025Q2支援）字幕產生成功的回呼URL
globalSettingEnabled	String	是否套用全域設定開關 Y：走使用者回呼設定 N：走頻道設定
liveViolationCutoffCallbackUrl	String	直播違規斷流回呼
customBookingCallbackUrl	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 testGetCallbackSetting() 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/get-setting";
    String channelId="2191569";

    //http 调用逻辑
    Map<String, String> requestMap = new HashMap<>();
    requestMap.put("appId", appId);
    requestMap.put("timestamp", timestamp);
    requestMap.put("channelId", channelId);
    requestMap.put("sign", LiveSignUtil.getSign(requestMap, appSecret));
    String response = HttpUtil.get(url, requestMap);
    log.info("测试查询回调设置，返回值：{}", response);
    //do somethings

}

回應範例

系統全域錯誤說明詳見全域錯誤說明

成功範例

{
    "code":200,
    "status":"success",
    "message":"",
    "data":{
        "recordCallbackUrl":"http://www.abc.com/callback",
        "playbackCallbackUrl":"http://www.abc.com/callback",
        "streamCallbackUrl":"http://www.abc.com/callback",
        "liveScanCallbackUrl":null,
        "recordCallbackVideoType":"m3u8",
        "playbackCacheCallbackUrl":null,
        "pptRecordCallbackUrl":null,
        "playbackSettingCallbackUrl":null,
        "globalSettingEnabled":"Y",
        "liveViolationCutoffCallbackUrl": "http://www.abc.com/callback",
        "customBookingCallbackUrl": "http://www.booking.com/callback"
    }
}

異常範例

{
    "code": 400,
    "status": "error",
    "message": "invalid signature.",
    "data": ""
}