查詢時間內直播場次資料

更新時間：2023-03-08 11:13:29

介面說明

1、查询时间内直播场次数据
2、（timestamp, appId）参与sign签名，并和sign一起通过url传递
3、接口支持https协议

介面URL

http://api.polyv.net/live/v4/statistics/session-stats/list

線上API呼叫

請求方式

POST

介面限制

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

2、不填寫查詢時間區間時，預設查詢目前時間到前一個小時之間產生的場次報表資料；查詢時間區間最大間隔24小時；

3、查詢的資料範圍：startTime=<直播場次開始時間直播場次結束時間<=endTime

4、直播中的場次資訊不會在資料中回傳

請求參數說明

參數名	必填	類型	說明
appId	true	String	帳號appId【詳見取得金鑰】
timestamp	true	Long	目前13位毫秒級時間戳記，3分鐘內有效
sign	true	String	簽名，為32位大寫的MD5值，`產生簽名的appSecret金鑰作為通訊資料安全的關鍵資訊，嚴禁儲存在用戶端直接使用，所有API都必須透過客戶自己伺服器中轉呼叫POLYV伺服器取得回應資料`【詳見簽名產生規則】
startTime	false	Long	開始時間，13位時間戳記
endTime	false	Long	結束時間，13位時間戳記
pageNumber	false	Integer	目前頁數
pageSize	false	Integer	每頁資料大小，預設10筆資料，最大值不能超過1000

範例

http://api.polyv.net/live/v4/statistics/session-stats/list?pageNumber=1&appId=frlr1zazn3&sign=EE807FB4A859A23E5B2EFA6CFC1FE7FC&pageSize=10&startTime=1634517072111&endTime=1634599872222&timestamp=1634788009047

回應參數說明

參數名	類型	說明
code	Integer	狀態碼，與http狀態碼相同，用於確定基本的回應狀態
status	String	回應結果，由業務決定，成功回傳success，失敗回傳error
success	Boolean	是否成功回應
requestId	String	請求ID，每次請求產生的唯一的UUID，僅可用於排查、除錯，不應該和業務掛鉤
error	Object	狀態碼非200時的錯誤資訊【詳見Error欄位說明】
data	Object	【詳見data欄位說明】

Error參數說明

參數名	類型	說明
code	Integer	錯誤代碼，用於確定具體的錯誤原因
desc	String	錯誤描述，與error.code對應

data參數說明

參數名	類型	說明
pageNumber	Integer	目前頁碼
pageSize	Integer	每頁資料量
totalPages	Long	頁面總數
totalItems	Long	總資料量
contents	Array	目前頁內容【詳見contents欄位說明】

contents參數說明

參數名	類型	說明
channelId	Integer	頻道ID
sessionId	String	直播場次ID
name	String	場次名稱
startTime	Long	直播開始時間，13位時間戳記
endTime	Long	直播結束時間，13位時間戳記
userId	String	直播帳號ID

Java請求範例

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

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

private static final Logger log = LoggerFactory.getLogger(getClass());
/**
 * 获取时间内直播场次数据
 * @throws IOException
 * @throws NoSuchAlgorithmException
 */
@Test
public void testGetLiveSession() throws IOException, NoSuchAlgorithmException {
    //公共参数,填写自己的实际参数
    String appId = super.appId;
    String appSecret = super.appSecret;
    String timestamp = String.valueOf(System.currentTimeMillis());
    
    //业务参数
    String url = "http://api.polyv.net/live/v4/statistics/session-stats/list";
    String startTime = "1634517072111";
    String endTime = "1634599872222";
    String pageNumber = "1";
    String pageSize = "10";
    
    //http 调用逻辑
    Map<String, String> requestMap = new HashMap<>();
    requestMap.put("appId", appId);
    requestMap.put("timestamp", timestamp);
    requestMap.put("startTime", startTime);
    requestMap.put("endTime", endTime);
    requestMap.put("pageNumber", pageNumber);
    requestMap.put("pageSize", pageSize);
    requestMap.put("sign", LiveSignUtil.getSign(requestMap, appSecret));
    
    url = HttpUtil.appendUrl(url, requestMap);
    String response = HttpUtil.postFormBody(url, null);
    log.info("测试获取时间内直播场次数据成功：{}", response);
    //do somethings
    
}

回應範例

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

成功範例

{
    "code": 200,
    "status": "success",
    "requestId": "b38bdd97dc404213a2436e7a086b9db9.80.16347880125725671",
    "data": {
        "pageNumber": 1,
        "pageSize": 10,
        "totalPages": 1,
        "totalItems": 2,
        "contents": [
            {
                "channelId": 2272655,
                "sessionId": "g3e0fasiw0",
                "name": "JAVA大师无延迟直播课-纯视频",
                "startTime": 1634520672000,
                "endTime": 1634520742000,
                "userId": "1b448be323"
            },
            {
                "channelId": 2477096,
                "sessionId": "g3eb7xbpn4",
                "name": "JAVA 知识精讲(误删)",
                "startTime": 1634544160000,
                "endTime": 1634544232000,
                "userId": "1b448be323"
            }
        ]
    },
    "success": true
}

異常範例

{
    "code": 400,
    "status": "error",
    "requestId": "d310b70bc329403f87f77f9203d50f89.128.16360831552223589",
    "error": {
        "code": 20001,
        "desc": "application not found."
    },
    "success": false
}