查詢頻道場次資訊
更新時間:2022-09-02 18:08:07
介面描述
1、查询频道直播场次信息
2、接口支持https协议
介面URL
http://api.polyv.net/live/v3/channel/session/list
請求方式
GET
介面限制
1、介面同時支援HTTP、HTTPS,建議使用HTTPS以確保介面安全,介面呼叫有頻率限制,詳細請查看
請求參數描述
| 參數名 | 必選 | 類型 | 說明 |
|---|---|---|---|
| appId | true | String | 帳號appId【詳見取得金鑰】 |
| timestamp | true | Long | 當前13位毫秒級時間戳,3分鐘內有效 |
| sign | true | String | 簽名,為32位大寫的MD5值,產生簽名的appSecret金鑰作為通訊資料安全的關鍵資訊,嚴禁儲存在用戶端直接使用,所有API都必須透過客戶自己伺服器中轉呼叫POLYV伺服器取得回應資料【詳見簽名產生規則】 |
| channelId | true | String | 頻道號 |
| startDate | false | String | 開始日期,格式:yyyy-MM-dd HH:mm:ss,若時間為00:00:00也支援格式:yyyy-MM-dd |
| endDate | false | String | 結束日期,格式:yyyy-MM-dd HH:mm:ss,若時間為00:00:00也支援格式:yyyy-MM-dd |
| page | false | String | 頁數,預設為1 |
| pageSize | false | String | 每頁顯示的資料筆數,預設20 |
範例
https://api.polyv.net/live/v3/channel/session/list?endDate=2021-01-01&appId=frlr1zazn3&sign=A7743F8014514A865F73D11A006606C1&pageSize=10&page=1&channelId=2191532&startDate=2020-01-01×tamp=1621841156849
回應參數描述
| 參數名 | 類型 | 說明 |
|---|---|---|
| code | Integer | 回應狀態碼,200為成功返回,非200為失敗【詳見全域錯誤說明】 |
| status | String | 回應狀態文字資訊 |
| message | String | 回應描述資訊,當code為400或500時,輔助描述錯誤原因 |
| data | Object | 請求失敗時為空,請求成功時為頻道直播場次資訊【詳見data欄位描述】 |
data欄位描述
| 參數名 | 類型 | 說明 |
|---|---|---|
| pageSize | Integer | 每頁資料筆數 |
| pageNumber | Integer | 目前頁數 |
| totalItems | Integer | 總筆數 |
| contents | Array | 查詢的結果列表【詳見Contents參數描述】 |
| startRow | Integer | 目前頁第一筆記錄在總結果集中的位置 |
| firstPage | Boolean | 是否為第一頁,值為:true/false |
| lastPage | Boolean | 是否為最後一頁,值為:true/false |
| prePageNumber | Integer | 上一頁編號 |
| nextPageNumber | Integer | 下一頁編號 |
| limit | Integer | 每頁數量大小 |
| totalPages | Integer | 總頁數 |
| endRow | Integer | 目前頁最後一筆記錄在總結果集中的位置 |
| offset | Integer | 分頁起始記錄 |
Contents參數描述
| 參數名 | 類型 | 說明 |
|---|---|---|
| channelId | String | 頻道號 |
| sessionId | String | 直播場次ID |
| userId | String | POLYV使用者ID,與保利威官網一致,取得路徑:官網->登入->直播(開發設定) |
| startTime | Long | 直播開始時間,13位毫秒級時間戳 |
| endTime | Long | 直播結束時間,13位毫秒級時間戳 |
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/list";
String channelId = "2191532";
String startDate = "2020-01-01";
String endDate = "2021-01-01";
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":20,
"pageNumber":1,
"totalItems":1,
"contents":[
{
"sessionId":"fwmnnydr06",
"channelId":2191532,
"userId":"1b448be323",
"startTime":1615450395000,
"endTime":1615450509000
}
],
"startRow":1,
"firstPage":true,
"lastPage":true,
"prePageNumber":1,
"limit":1,
"endRow":1,
"nextPageNumber":1,
"totalPages":1,
"offset":0
}
}
異常範例
{
"code": 400,
"status": "error",
"message": "invalid signature.",
"data": ""
}
