查詢觀看記錄

更新時間：2025-09-17 09:49:01

介面描述

1、查询观看记录

2、接口支持https协议

3、直播观看详情数据支持查询最近3年内的历史数据，建议将历史数据导出到本地储存，以便后续查询。

4、日期不传查当月数据

介面URL

http://api.polyv.net/live/v4/user/viewlog/list

線上API呼叫

請求方式

GET

介面限制

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

請求參數說明

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

範例

http://api.polyv.net/live/v4/user/viewlog/list?pageNumber=1&viewerId=123456&endDate=2023-08-30&appId=frlr1zazn3&sign=D68D18B56C800A7BF56597855336BA75&pageSize=10&startDate=2023-08-01&timestamp=1691130500787

回應參數說明

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

Data參數說明

參數名	類型	說明
contents	Array	分頁資料集合【詳見Contents參數說明】
pageNumber	Integer	目前頁數，第幾頁
pageSize	Integer	分頁大小
totalItems	Integer	總記錄數
totalPages	Integer	總頁數

Contents參數說明

參數名	類型	說明
avgDuration	String	平均觀看時長
nick	String	暱稱
totalDuration	String	總觀看時長
viewCount	Integer	觀看次數
viewerId	String	用戶Id
param4	String	自訂參數param4
param5	String	自訂參數param5

Error參數說明

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

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 viewlogListTest() 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/user/viewlog/list";
    String viewerId = "123456";
    Integer channelId = 5004544;
    String startDate = "2023-08-01";
    String endDate = "2023-08-30";
    String pageNumber = "1";
    String pageSize = "10";
    
    //http 调用逻辑
    Map<String, String> requestMap = new HashMap<>();
    requestMap.put("appId", appId);
    requestMap.put("timestamp", timestamp);
    requestMap.put("endDate", endDate);
    requestMap.put("pageNumber", pageNumber);
    requestMap.put("pageSize", pageSize);
    requestMap.put("startDate", startDate);
    requestMap.put("viewerId", viewerId);
    requestMap.put("channelId", channelId);
    
    requestMap.put("sign", LiveSignUtil.getSign(requestMap, appSecret));
    
    String response = HttpUtil.get(url, requestMap);
    
    log.info("测试查询观看记录成功：{}", response);
    //do somethings
    
}

回應範例

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

成功範例

{
    "code": 200,
    "status": "success",
    "requestId": "0b908277c2b44d719d158edcd05e98a3.2379.16911305029825653",
    "data": {
        "pageNumber": 1,
        "pageSize": 10,
        "totalPages": 1,
        "totalItems": 1,
        "contents": [
            {
                "viewerId": "123456",
                "nick": "1122",
                "viewCount": 4,
                "totalDuration": "00:02:37",
                "avgDuration": "00:00:39"
            }
        ]
    },
    "success": true
}

異常範例

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