查詢所有頻道的縮略資訊
更新時間:2022-11-11 23:57:21
舊版介面位址查詢所有頻道的縮略資訊(舊版)
介面描述
1、查询账号下所有的频道缩略信息列表,观看页状态与新版后台一致
2、列表信息仅包含频道缩略信息,如需频道具体信息,请使用【获取频道信息】接口
3、接口支持https协议
介面URL
http://api.polyv.net/live/v4/channel/simple/list
請求方式
GET
介面約束
1、介面同時支援HTTP、HTTPS,建議使用HTTPS確保介面安全,介面呼叫有頻率限制,詳細請查看
請求參數描述
| 參數名 | 必選 | 類型 | 說明 |
|---|---|---|---|
| appId | true | String | 帳號appId【詳見取得金鑰】 |
| timestamp | true | Long | 當前13位毫秒級時間戳,3分鐘內有效 |
| sign | true | String | 簽名,為32位大寫的MD5值,產生簽名的appSecret金鑰作為通訊資料安全的關鍵資訊,嚴禁儲存在用戶端直接使用,所有API都必須透過客戶自己伺服器中轉呼叫POLYV伺服器取得回應資料【詳見簽名產生規則】 |
| pageNumber | false | Integer | 頁碼,預設為1 |
| pageSize | false | Integer | 每頁資料大小,預設每頁顯示10筆資料,最大值不能超過1000 |
| categoryId | false | String | 所屬分類ID |
| watchStatus | false | String | 觀看頁狀態篩選 live:直播中 playback:回放中 end:已結束 waiting:等待中 unStart:未開始 |
| keyword | false | String | 頻道名稱,模糊查詢 |
| orderBy | false | String | 排序欄位,預設按頻道建立時間升序 startTimeDesc:開播時間降序 startTimeAsc:開播時間升序 channelCreatedTimeDesc:頻道建立時間降序 |
範例
http://api.polyv.net/live/v4/channel/simple/list?pageNumber=2&watchStatus=unStart&appId=frlr1zazn3&sign=A69559D6EBF130B9C0F60807459FC311&pageSize=3&categoryId=391352×tamp=1642733791590
回應參數描述
| 參數名 | 類型 | 說明 |
|---|---|---|
| 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 | String | 頻道號 |
| name | String | 頻道名稱 |
| channelPasswd | String | 頻道密碼 |
| categoryId | String | 直播分類ID |
| scene | String | 場景 alone:活動直播 ppt:三分屏 topclass:大班課 seminar:研討會 |
| watchStatus | String | 觀看頁狀態描述 直播中 回放中 已結束 等待中 未開始 已禁播 |
| watchStatusText | String | 觀看頁狀態 live:直播中 playback:回放中 end:已結束 waiting:等待中 unStart:未開始 banpush:已禁播 |
| sceneText | String | 場景描述 |
| watchUrl | String | 觀看頁連結 |
Java請求範例
快速接入基礎程式碼請下載相關依賴原始碼, 點擊下載原始碼 ,下載後加入到自己的原始碼工程中即可。測試案例中的HttpUtil.java 和 LiveSignUtil.java 都包含在下載檔案中。
強烈建議您使用直播Java SDK完成API的功能對接,直播Java SDK 對API呼叫邏輯、異常處理、資料簽名、HTTP請求執行緒池進行了統一封裝和最佳化。
private static final Logger log = LoggerFactory.getLogger(ChannelOperateTest.class);
/**
* 查询所有频道的缩略信息
* @throws IOException
* @throws NoSuchAlgorithmException
*/
@Test
public void testChannelSimpleList() throws IOException, NoSuchAlgorithmException {
//公共参数,填写自己的实际参数
String appId = super.appId;
String appSecret = super.appSecret;
String userId = super.userId;
String timestamp = String.valueOf(System.currentTimeMillis());
//业务参数
String url = "http://api.polyv.net/live/v4/channel/simple/list";
String keyword = "测试";
String categoryId = "391352";
String watchStatus = "unStart";
String pageNumber = "2";
String pageSize = "3";
Map<String, String> requestMap = new HashMap<>();
requestMap.put("appId", appId);
requestMap.put("timestamp", timestamp);
requestMap.put("categoryId", categoryId);
requestMap.put("watchStatus", watchStatus);
requestMap.put("pageNumber", pageNumber);
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",
"requestId": "92a918d76e7246599d1aad24a253a470.1842.16427336349010109",
"data": {
"pageNumber": 2,
"pageSize": 3,
"totalPages": 2,
"totalItems": 4,
"contents": [
{
"channelId": 2775591,
"name": "gateway 从入门到精通",
"channelPasswd": "ZM0h81",
"categoryId": 391352,
"scene": "seminar",
"newScene": "seminar",
"template": "seminar",
"watchStatus": "unStart",
"watchStatusText": "未开始",
"sceneText": "研讨会",
"watchUrl": "https://live.polyv.cn/watch/2775591"
}
]
},
"success": true
}
異常範例
{
"code": 400,
"status": "error",
"error": {
"code": 10003,
"desc": "时间戳过期"
},
"success": false
}
