查詢所有頻道的基礎資訊
更新時間:2022-09-02 18:08:07
介面描述
1、查询账号下所有的频道基础信息列表,观看页状态与新版后台一致
2、接口支持https协议
介面URL
http://api.polyv.net/live/v4/channel/basic-info/list
請求方式
GET
介面限制
1、介面同時支援HTTP、HTTPS,建議使用HTTPS確保介面安全,介面呼叫有頻率限制,詳細請查看
請求參數描述
| 參數名 | 必選 | 類型 | 說明 |
|---|---|---|---|
| appId | true | String | 帳號appId【詳見取得金鑰】 |
| timestamp | true | Long | 目前13位毫秒級時間戳,3分鐘內有效 |
| sign | true | String | 簽名,為32位大寫的MD5值,產生簽名的appSecret金鑰作為通訊資料安全的關鍵資訊,嚴禁儲存在用戶端直接使用,所有API都必須透過客戶自己伺服器中轉呼叫POLYV伺服器取得回應資料【詳見簽名產生規則】 |
| channelIds | false | String | 頻道號,多個頻道用英文逗號分隔 |
| orderBy | false | String | 排序欄位,預設按頻道建立時間降序 startTimeDesc:開播時間降序 startTimeAsc:開播時間升序 |
| pageNumber | false | Integer | 查詢頁數,預設1 |
| pageSize | false | Integer | 每頁資料大小,預設10,最大值100 |
範例
http://api.polyv.net/live/v4/channel/basic-info/list?pageNumber=2&appId=frlr1zazn3&sign=1AEEA7FE8C0DF0BF6918B5212906ED97&pageSize=2×tamp=1651801721026
回應參數描述
| 參數名 | 類型 | 說明 |
|---|---|---|
| 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 | 頻道密碼 |
| publisher | String | 主持人名稱 |
| startTime | Long | 直播開始時間,關閉時為0,開啟時為13位毫秒級時間戳 |
| pageView | Integer | 頁面累計觀看數 |
| splashImg | String | 頻道引導圖url |
| desc | String | 直播介紹 |
| watchUrl | String | 觀看頁連結 |
| watchStatus | String | 頻道的觀看頁狀態,取值為 live:直播中 end:直播結束 playback:回放中 waiting:等待中 unStart:未開始 |
| watchStatusText | 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 testListChannelBasicInfo() 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/channel/basic-info/list";
String pageNumber = "2";
String pageSize = "2";
//http 调用逻辑
Map<String, String> requestMap = new HashMap<>();
requestMap.put("appId", appId);
requestMap.put("timestamp", timestamp);
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": "028071a1aa4c464a9c441cf79de24dfb.61.16518013990160097",
"data": {
"pageNumber": 6,
"pageSize": 1,
"totalPages": 96,
"totalItems": 96,
"contents": [
{
"channelId": 3042405,
"channelPasswd": "xxxxx",
"name": "测试中英文复制1",
"publisher": "sadman",
"startTime": 1635652800000,
"splashImg": "https://liveimages.videocc.net/uploaded/images/2021/09/g2bpwvlg83.jpeg",
"desc": "<p>JAVA大师无延迟直播课-纯视频</p>",
"watchStatus": "waiting",
"watchStatusText": "等待中",
"pageView": 10,
"watchUrl": "https://live.polyv.cn/watch/3042405"
}
]
},
"success": true
}
異常範例
{
"code": 400,
"status": "error",
"requestId": "d310b70bc329403f87f77f9203d50f89.128.16360831552223589",
"error": {
"code": 20001,
"desc": "application not found."
},
"success": false
}
