查詢批量頻道狀態（舊版）

更新時間：2022-09-02 18:08:07

新版介面位址批量查詢頻道直播狀態，強烈建議您使用新版介面

介面描述

1、批量查询频道直播状态
2、接口支持https协议

介面URL

http://api.polyv.net/live/v2/channels/live-status

請求方式

POST

介面約束

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

2、該介面查詢直播中的接收轉播頻道狀態時，介面會回傳end，建議您使用新版介面

請求參數描述

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

範例

http://api.polyv.net/live/v2/channels/live-status

表單參數：

appId=frlr1zazn3&sign=19DAF4C4375B0352B0B9A37148C6E830&channelIds=2149813%2C2149710&timestamp=1621840930470

回應參數描述

參數名	類型	說明
code	Integer	回應狀態碼，200為成功回傳，非200為失敗【詳見全域錯誤說明】
status	String	回應狀態文字資訊
message	String	回應描述資訊，當code為400或者500的時候，輔助描述錯誤原因
data	Array	請求失敗時為空，請求成功時為頻道直播流狀態資訊【詳見data欄位說明】

data欄位說明

參數名	類型	說明
channelId	String	頻道號
status	String	頻道的直播狀態 live：正在直播 end：未直播
seminarStatus	String	研討會頻道的研討狀態 seminar_live：正在研討 seminar_end：暫無研討

Java請求範例

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

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

private static final Logger log = LoggerFactory.getLogger(ChannelStateTest.class);
/**
 * 批量查询频道直播流状态
 * @throws IOException
 * @throws NoSuchAlgorithmException
 */
@Test
public void testGetLiveStatusList() 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/v2/channels/live-status";
    String channelIds = "2149813,2149710";
    
    Map<String, String> requestMap = new HashMap<>();
    requestMap.put("appId", appId);
    requestMap.put("timestamp", timestamp);
    requestMap.put("channelIds", channelIds);
    requestMap.put("sign", LiveSignUtil.getSign(requestMap, appSecret));
    String response = HttpUtil.postFormBody(url, requestMap);
    log.info("测试批量查询频道直播状态，返回值：{}", response);
    //do somethings
    
}

回應範例

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

成功範例

{
    "code":200,
    "status":"success",
    "message":"",
    "data":[
        {
            "channelId":2149710,
            "status":"end",
            "seminarStatus":"seminar_end"
        },
        {
            "channelId":2149813,
            "status":"live",
            "seminarStatus":"seminar_live"
        }
    ]
}

異常範例

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