查詢使用者下的歷史並發資料

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

介面URL

https://api.polyv.net/live/v3/user/statistics/concurrence

介面說明

1、接口用于获取用户在某个日期区间并发人数(按照时间升序排序)
2、接口支持https

支援格式

JSON

請求方式

GET

請求數限制

TRUE

請求參數

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

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

回應成功JSON範例：

{
    "code": 200,
    "status": "success",
    "message": "",
    "data": [{
        "day": "2019-04-10",
        "minute": "10:30",
        "viewers": 2
    }, {
        "day": "2019-04-16",
        "minute": "19:06",
        "viewers": 2
    }]
}

回應失敗JSON範例：

未輸入appId

{
    "code": 400,
    "status": "error",
    "message": "appId is required.",
    "data": ""
}

appId不正確

{
    "code": 400,
    "status": "error",
    "message": "application not found.",
    "data": ""
}

時間戳錯誤

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

簽名錯誤

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

頻道號格式錯誤

{
  "code": 400, 
  "status": "error", 
  "message": "param is not digit: dsadasd", 
  "data": ""
}

日期範圍錯誤

{
  "code": 400, 
  "status": "error", 
  "message": "startDate can not great endDater", 
  "data": ""
}

欄位說明

參數名	說明
code	回應代碼，成功為200，失敗為400，簽名錯誤為401，異常錯誤500
status	成功為success，失敗為error
message	錯誤時為錯誤提示訊息
data	日期區間內的歷史並發人數

php請求範例

<?php
//引用config.php
include 'config.php';

$params = array(
  'appId' => $appId,
  'timestamp' => $timestamp,  
  'startDate' => 2019-04-01,
  'endDate' => 2019-05-01
);

//生成sign
$sign = getSign($params); //详细查看config.php文件的getSign方法
$params['sign'] = $sign;

$url = "http://api.polyv.net/live/v3/user/statistics/concurrence?".http_build_query($params);

$curl = curl_init();
curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
curl_setopt($curl, CURLOPT_TIMEOUT, 500);
curl_setopt($curl, CURLOPT_URL, $url);
curl_setopt($curl, CURLOPT_POST, 0);
$res = curl_exec($curl);
curl_close($curl);

echo $res;
?>