查詢頻道歷史並發數據

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

介面描述

1、获取频道在某个日期区间并发人数
2、接口支持https协议

介面URL

http://api.polyv.net/live/v3/channel/statistics/concurrence

線上API呼叫

請求方式

GET

介面限制

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

2、開始日期和結束日期的時間跨度：最多查兩個月內的資料

3、按照時間升序排序

請求參數描述

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

範例

http://api.polyv.net/live/v3/channel/statistics/concurrence?endDate=2021-3-10&appId=frlr1zazn3&sign=8AAC3157EBB79FF42FA07A72335864A0&userId=1b448be323&channelId=1965681&startDate=2021-3-9&timestamp=1621842387331

回應參數描述

參數名	類型	說明
code	Integer	回應狀態碼，200為成功返回，非200為失敗【詳見全域錯誤說明】
status	String	回應狀態文字資訊
message	String	回應描述資訊，當code為400或500時，輔助描述錯誤原因
data	Arrray	請求成功時為日期區間內的並發資訊【詳見Data參數描述】，請求失敗時為空

Data參數描述

參數名	類型	說明
day	String	並發日期，格式：yyyy-MM-dd
minute	String	並發時間點，格式：HH:mm
viewers	Integer	並發人數

Java請求範例

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

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

private static final Logger log = LoggerFactory.getLogger(ChannelViewDataTest.class);
/**
 * 查询频道历史并发数据
 * @throws IOException
 */
@Test
public void testConcurrence() 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/channel/statistics/concurrence";
    String channelId = "1965681";
    String startDate = "2021-3-9";
    String endDate = "2021-3-10";

    //http 调用逻辑
    Map<String,String> requestMap = new HashMap<>();
    requestMap.put("appId", appId);
    requestMap.put("timestamp",timestamp);
    requestMap.put("userId",userId);
    requestMap.put("channelId",channelId);
    requestMap.put("startDate",startDate);
    requestMap.put("endDate",endDate);
    requestMap.put("sign",LiveSignUtil.getSign(requestMap, appSecret));
    String response = HttpUtil.get(url, requestMap);
    log.info("测试查询频道历史并发数据，返回值：{}",response);
    //do somethings

}

回應範例

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

成功範例

{
    "code":200,
    "status":"success",
    "message":"",
    "data":[
        {
            "day":"2021-03-09",
            "minute":"00:00",
            "viewers":0
        },
        {
            "day":"2021-03-10",
            "minute":"00:00",
            "viewers":0
        }
    ]
}

異常範例

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