保利威文档中心

幫助中心

批量關聯或取消關聯接收轉播頻道設定

更新時間:2025-02-25 14:52:08

介面描述

1、批量关联或者取消关联接收转播频道设置
2、接口支持https协议

介面URL

https://api.polyv.net/live/v3/channel/transmit/associations

線上API呼叫

請求方式

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 轉播頻道號
receiveChannelIds true String 需要關聯或取消關聯的接收頻道ID,多個以英文逗號分隔
type false String 操作類型,取值:add 關聯,cancel 取消關聯,預設為 add 關聯

範例

https://api.polyv.net/live/v3/channel/transmit/associations

表單參數:

receiveChannelIds=12933,2938322&appId=frlr1zazn3&sign=2A861BD280299A4D7E6FF556C77C88D2&channelId=2149710&timestamp=1621843071824&type=add

回應參數描述

參數名 類型 說明
code Integer 回應狀態碼,200為成功返回,非200為失敗【詳見全域錯誤說明
status String 回應狀態文字資訊
message String 回應描述資訊,當code為400或500時,輔助描述錯誤原因
data String 成功返回操作成功的接收頻道 ID 陣列

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 testAddOrCancelReceiveChannels() 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/transmit/associations";
    String channelId = "2149710";
    String receiveChannelIds = "1238222,32232,323234,4444445";
    String type = "add";
    
    Map<String, String> requestMap = new HashMap<>();
    requestMap.put("appId", appId);
    requestMap.put("timestamp", timestamp);
    requestMap.put("receiveChannelIds", receiveChannelIds);
    requestMap.put("type", type);
    requestMap.put("channelId", channelId);
    requestMap.put("sign", LiveSignUtil.getSign(requestMap, appSecret));
    String response = HttpUtil.postFormBody(url, requestMap);
    log.info("测试批量关联或者取消关联接收频道设置,返回值:{}", response);
    //do somethings
    
}

回應範例

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

成功範例

{
    "code":200,
    "status":"success",
    "message":"",
    "data":[1222,323232,4444444]
}

異常範例

{
    "code": 400,
    "status": "error",
    "message": "invalid signature.",
    "data": ""
}
联系客服,在线咨询