channelSession
更新時間:2025-09-11 15:18:09
1、查詢頻道場次資訊
描述
查询频道直播场次信息
接口地址(仅做说明使用):https://api.polyv.net/live/v3/channel/session/data/list
呼叫限制
1、API 呼叫有頻率限制,詳細請查看,呼叫常見異常,詳細請查看
單元測試
@Test
public void testGetSessionList() throws IOException, NoSuchAlgorithmException {
LiveSessionListRequest liveSessionListRequest = new LiveSessionListRequest();
LiveSessionListResponse liveSessionListResponse;
try {
String channelId = super.createChannel();
liveSessionListRequest.setChannelId(channelId);
liveSessionListRequest.setStartDate(super.getDate(2022, 07, 01));
liveSessionListRequest.setEndDate(super.getDate(2022, 07, 22));
liveSessionListResponse = new LiveChannelSessionServiceImpl().getSessionList(liveSessionListRequest);
Assert.assertNotNull(liveSessionListResponse);
if (liveSessionListResponse != null) {
//to do something ......
log.debug("测试查询频道场次信息成功 {}", JSON.toJSONString(liveSessionListResponse));
}
} catch (PloyvSdkException e) {
//参数校验不合格 或者 请求服务器端500错误,错误信息见PloyvSdkException.getMessage()
log.error(e.getMessage(), e);
// 异常返回做B端异常的业务逻辑,记录log 或者 上报到ETL 或者回滚事务
throw e;
} catch (Exception e) {
log.error("SDK调用异常", e);
throw e;
}
}
單元測試說明
1、請求正確,回傳 LiveSessionListResponse 物件,B 端依據此物件處理業務邏輯;
2、請求參數驗證不合格,拋出 PloyvSdkException,錯誤訊息見 PloyvSdkException.getMessage(),如 [ 輸入參數 [xxx.chat.LivexxxRequest] 物件驗證失敗,失敗欄位 [pic不能為空 / msg不能為空] ]
3、伺服器處理異常,拋出 PloyvSdkException,錯誤訊息見 PloyvSdkException.getMessage(),如 [ 保利威請求回傳資料錯誤,請求流水號:66e7ad29fd04425a84c2b2b562d2025b,錯誤原因: invalid signature. ]
請求入參描述
| 參數名 | 必選 | 類型 | 說明 |
|---|---|---|---|
| channelId | true | String | 頻道號 |
| startDate | false | Date | 直播場次的開始日期,格式:yyyy-MM-dd HH:mm:ss,如果時間為00:00:00也支援格式:yyyy-MM-dd |
| endDate | false | Date | 直播場次的結束日期,格式:yyyy-MM-dd HH:mm:ss,如果時間為00:00:00也支援格式:yyyy-MM-dd |
| page | false | String | 頁數,預設為1 |
| pageSize | false | String | 每頁顯示的資料筆數,預設20 |
| appId | false | String | POLYV 使用者 APP_ID,多帳號呼叫時該參數必填(即呼叫了 initMultiAccount() 設定多帳號呼叫),透過註冊保利威官網取得,路徑:官網->登入->直播(開發設定) |
| appSecret | false | String | POLYV 使用者 APP_SECRET,多帳號呼叫時該參數必填(即呼叫了 initMultiAccount() 設定多帳號呼叫),透過註冊保利威官網取得,路徑:官網->登入->直播(開發設定) |
回傳物件描述
| 參數名 | 類型 | 說明 |
|---|---|---|
| contents | Array | 查詢的結果列表【詳見SessionInfo參數描述】 |
| pageSize | Integer | 每頁顯示的資料筆數,預設每頁顯示20筆資料 |
| currentPage | Integer | 當前頁【對應 API 文件的 pageNumber 欄位】 |
| totalItems | Integer | 記錄總筆數 |
| totalPage | Integer | 總頁數【對應 API 文件的 totalPages 欄位】 |
SessionInfo參數描述
| 參數名 | 類型 | 說明 |
|---|---|---|
| channelId | String | 頻道號 |
| sessionId | String | 直播場次 ID |
| userId | String | POLYV 使用者 ID,和保利威官網一致,取得路徑:官網->登入->直播(開發設定) |
| startTime | Date | 直播開始時間 |
| endTime | Date | 直播結束時間 |
