查詢頻道列表

更新時間：2023-11-09 11:01:14

介面描述

1、根据分类id和频道名称查询频道号列表
2、接口支持https协议

介面URL

http://api.polyv.net/live/v3/user/channels

線上API呼叫

請求方式

GET

介面限制

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

請求參數描述

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

範例

http://api.polyv.net/live/v3/user/channels?appId=frlr1zazn3&sign=D673B99508C8B99202D52A10FA77D091&keyword=%E8%AE%A8%E8%AE%BA&categoryId=340019&labelId=zpmz3640wkxpj267&timestamp=1621841285162

回應參數描述

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

Data參數描述

參數名	類型	說明
channels	String[]	返回頻道號結果集

Java請求範例

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

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

private static final Logger log = LoggerFactory.getLogger(AccountTest.class);
/**
 * 查询频道列表
 * @throws IOException
 * @throws NoSuchAlgorithmException
 */
@Test
public void testChannels() throws IOException, NoSuchAlgorithmException {
    //公共参数,填写自己的实际
    String appId = super.appId;
    String appSecret = super.appSecret;
    String userId = super.userId;
    String timestamp = String.valueOf(System.currentTimeMillis());
    //业务参数
    String url="http://api.polyv.net/live/v3/user/channels";
    String categoryId="340019";
    String keyword="讨论";
    String labelId = "zpmz3640wkxpj267";

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

}

回應範例

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

成功範例

{
    "code":200,
    "status":"success",
    "message":"",
    "data":{
        "channels":[
            2139283,
            2139268
        ]
    }
}

異常範例

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