查詢頻道場次資訊

介面描述

1、查询频道直播场次信息
2、接口支持https协议

介面URL

http://api.polyv.net/live/v3/channel/session/data/list

線上API呼叫

請求方式

GET

介面限制

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

2、開始日期與結束日期的時間跨度不得超過60天，不傳預設查詢最近60天

3、直播中的場次也會回傳，此時回傳endTime為null

請求參數描述

範例

https://api.polyv.net/live/v3/channel/session/data/list?appId=frlr1zazn3&sign=70DF5378E04B103CCCEA048260C75EDD&pageSize=10&page=1&channelId=2272655&timestamp=1652411923329

回應參數描述

data欄位描述

Contents參數描述

Java請求範例

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

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

private static final Logger log = LoggerFactory.getLogger(ChannelPlayBackTest.class);
/**
 * 查询频道直播场次信息
 * @throws IOException
 * @throws NoSuchAlgorithmException
 */
@Test
public void testGetChannelSessions() throws IOException, NoSuchAlgorithmException {
    //公共参数,填写自己的实际参数
    String appId = super.appId;
    String appSecret = super.appSecret;
    String userId = super.userId;
    String timestamp = String.valueOf(System.currentTimeMillis());
    //业务参数
    String url = "https://api.polyv.net/live/v3/channel/session/data/list";
    String channelId = "2272655";
    String page = "1";
    String pageSize = "10";
    
    Map<String, String> requestMap = new HashMap<>();
    requestMap.put("appId", appId);
    requestMap.put("timestamp", timestamp);
    requestMap.put("channelId", channelId);
    requestMap.put("startDate", startDate);
    requestMap.put("endDate", endDate);
    requestMap.put("page", page);
    requestMap.put("pageSize", pageSize);
    requestMap.put("sign", LiveSignUtil.getSign(requestMap, appSecret));
    String response = HttpUtil.get(url, requestMap);
    log.info("测试查询频道直播场次信息，返回值：{}", response);
    //do somethings
    
}

回應範例

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

成功範例

{
    "code": 200,
    "status": "success",
    "message": "",
    "data": {
        "pageSize": 10,
        "pageNumber": 1,
        "totalItems": 4,
        "contents": [
            {
                "sessionId": "g9lv2ghv2x",
                "channelId": 2272655,
                "userId": "1b448be323",
                "startTime": 1652062574000,
                "endTime": 1652062643000,
                "customId": null
            },
            {
                "sessionId": "g9b3pwv2b7",
                "channelId": 2272655,
                "userId": "1b448be323",
                "startTime": 1651219401000,
                "endTime": 1651219592000,
                "customId": null
            },
            {
                "sessionId": "g8ms75epoj",
                "channelId": 2272655,
                "userId": "1b448be323",
                "startTime": 1649313582000,
                "endTime": 1649313757000,
                "customId": null
            },
            {
                "sessionId": "g87lv4kjh2",
                "channelId": 2272655,
                "userId": "1b448be323",
                "startTime": 1648124333000,
                "endTime": 1648124412000,
                "customId": null
            }
        ],
        "limit": 4,
        "nextPageNumber": 1,
        "startRow": 1,
        "firstPage": true,
        "lastPage": true,
        "prePageNumber": 1,
        "endRow": 4,
        "totalPages": 1,
        "offset": 0
    }
}

異常範例

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