集團帳號使用頻道號取得外部授權密鑰

更新時間：2026-08-13 17:32:38

介面描述

1、集团账号通过频道号查询频道外部授权观看的secretKey
2、仅支持查询当前集团账号及其分账号下的频道
3、频道需要已开启外部授权观看
4、接口支持https协议

介面URL

http://api.polyv.net/live/v4/group/channel/external-auth-key/get

線上API呼叫

請求方式

GET

介面約束

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

2、集團帳號介面計算簽名請使用集團主帳號的appId、appSecret

3、appSecret僅用於產生簽名，不需要作為請求參數傳輸

4、介面結果存在約60秒伺服端快取，修改頻道外部授權觀看設定後，建議等待快取刷新後再次查詢

請求參數描述

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

範例

http://api.polyv.net/live/v4/group/channel/external-auth-key/get?appId=g8dtv537aq&timestamp=1710000000000&channelId=123456&sign=YOUR_UPPERCASE_MD5_SIGN

回應參數描述

參數名	類型	說明
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參數描述

參數名	類型	說明
channelId	Integer	頻道號
secretKey	String	頻道外部授權觀看的secretKey

Java請求範例

快速接入基礎代碼請下載相關依賴原始碼，點擊下載原始碼，下載後加入到自己的原始碼工程中即可。測試案例中的HttpUtil.java 和 LiveSignUtil.java 都包含在下載檔案中。

強烈建議您使用直播Java SDK完成API的功能對接，直播Java SDK 對API呼叫邏輯、異常處理、資料簽名、HTTP請求執行緒池進行了統一封裝和最佳化。

private static final Logger log = LoggerFactory.getLogger(ChannelOperateTest.class);

/**
 * 通过频道号获取外部授权频道secretKey
 * @throws IOException
 * @throws NoSuchAlgorithmException
 */
@Test
public void groupChannelExternalAuthKeyTest() throws IOException, NoSuchAlgorithmException {
    //公共参数，填写自己的实际参数
    String appId = super.groupAppId;
    String appSecret = super.groupAppSecret;
    String timestamp = String.valueOf(System.currentTimeMillis());

    //业务参数
    String url = "http://api.polyv.net/live/v4/group/channel/external-auth-key/get";
    String channelId = "123456";

    //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("测试通过频道号获取外部授权频道secretKey成功：{}", response);
    //do somethings
}

回應範例

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

成功範例

{
    "code": 200,
    "status": "success",
    "requestId": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
    "data": {
        "channelId": 123456,
        "secretKey": "**********"
    },
    "success": true
}

異常範例

{
    "code": 400,
    "status": "error",
    "requestId": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
    "data": null,
    "error": {
        "code": 1097,
        "desc": "非法的频道ID"
    },
    "success": false
}

錯誤碼說明

錯誤碼	錯誤描述	說明
10001	channelId不能為空	未傳channelId
10001	channelId必須大於0	channelId小於或等於0
10002	簽名錯誤	sign驗證失敗
30004	找不到頻道	頻道不存在，或頻道不屬於目前集團帳號及其子帳號
1169	頻道未開啟外部授權觀看	頻道未開啟外部授權觀看，或未設定可用的外部授權secretKey
20000	appId is required.	未傳appId

注意事項

1、該介面只回傳外部授權觀看設定中的secretKey；頻道未開啟外部授權觀看時，不回傳其他觀看限制設定

2、非目前集團帳號及其子帳號下的頻道統一回傳「非法的頻道ID」，不會回傳頻道歸屬資訊

3、secretKey屬於敏感資訊，建議僅在伺服端使用和儲存，不要輸出到前端頁面、用戶端程式碼或公開日誌