查詢所有頻道的基礎資訊
更新時間:2022-09-02 18:08:07
介面描述
1、查询账号下所有的频道基础信息列表
2、接口支持https协议
介面URL
http://api.polyv.net/live/v3/channel/basic/list
請求方式
GET
介面限制
1、介面同時支援HTTP、HTTPS,建議使用HTTPS確保介面安全,介面呼叫有頻率限制,詳細請查看
請求參數描述
| 參數名 | 必選 | 類型 | 說明 |
|---|---|---|---|
| appId | true | String | 帳號appId【詳見取得金鑰】 |
| timestamp | true | Long | 目前13位毫秒級時間戳記,3分鐘內有效 |
| sign | true | String | 簽名,為32位大寫的MD5值,產生簽名的appSecret金鑰作為通訊資料安全的關鍵資訊,嚴禁儲存在用戶端直接使用,所有API都必須透過客戶自己的伺服器中轉呼叫POLYV伺服器取得回應資料【詳見簽名產生規則】 |
| categoryIds | false | String | 分類ID,多個id用英文逗號分隔 |
| page | false | Integer | 查詢頁數,預設1 |
| pageSize | false | Integer | 每頁資料大小,預設20,最大20 |
範例
https://api.polyv.net/live/v3/channel/basic/list?categoryIds=340019%2C345134&appId=frlr1zazn3&sign=4A994A9B856E5728F43629AE0F52BDB7&pageSize=2&page=2×tamp=1621841218218
回應參數描述
| 參數名 | 類型 | 說明 |
|---|---|---|
| code | Integer | 回應狀態碼,200為成功返回,非200為失敗【詳見全域錯誤說明】 |
| status | String | 回應狀態文字資訊 |
| message | String | 回應描述資訊,當code為400或500時,輔助描述錯誤原因 |
| data | Object | 成功回應時返回全帳號頻道基礎資訊【詳見data欄位說明】 |
Data參數描述
| 參數名 | 類型 | 說明 |
|---|---|---|
| pageSize | Integer | 每頁資料大小,預設20,最大20 |
| pageNumber | Integer | 目前頁數 |
| totalItems | Integer | 總筆數 |
| contents | Array | 查詢的結果列表【詳見Contents參數描述】 |
| startRow | Integer | 目前頁第一筆記錄在總結果集中的位置 |
| firstPage | Boolean | 是否為第一頁,值為:true/false,預設為false |
| lastPage | Boolean | 是否為最後一頁,值為:true/false,預設為false |
| prePageNumber | Integer | 上一頁編號 |
| limit | Integer | 每頁數量大小 |
| nextPageNumber | Integer | 下一頁編號 |
| endRow | Integer | 目前頁最後一筆記錄在總結果集中的位置 |
| totalPages | Integer | 總頁數 |
| offset | Integer | 分頁起始記錄 |
Contents參數描述
| 參數名 | 類型 | 說明 |
|---|---|---|
| channelId | String | 頻道號 |
| name | String | 頻道名稱 |
| publisher | String | 主持人名稱 |
| startTime | Long | 直播開始時間,關閉時為0,開啟時為13位毫秒級時間戳記 |
| pageView | Integer | 頁面累計觀看數 |
| likes | Integer | 觀看頁按讚數 |
| coverImg | String | 頻道圖示url |
| splashImg | String | 頻道引導圖url |
| splashEnabled | String | 引導頁開關,取值 Y:開啟 N:關閉 |
| desc | String | 直播介紹 |
| maxViewer | Integer | 最大線上觀看人數 |
| watchStatus | String | 頻道的觀看頁狀態,取值為 live:直播中 end:直播結束 playback:回放中 waiting:等待直播 |
| watchStatusText | String | 觀看頁狀態描述,直播中,回放中,已結束,未開始 |
| onlineNum | Integer | 線上人數 |
| bgImg | String | 暖場圖片URL |
| videoList | Array | 回放影片列表,當有多個時按新增時間倒序排列【詳見videoList參數描述】 |
| categoryId | Integer | 分類ID |
videoList參數描述
| 參數名 | 類型 | 說明 |
|---|---|---|
| videoId | String | 直播系統產生的id (影片庫中的回放影片) |
| videoPoolId | String | 點播影片vid (影片庫中的回放影片) |
Java請求範例
快速接入基礎程式碼請下載相關依賴原始碼, 點擊下載原始碼 ,下載後加入到自己的原始碼工程中即可。測試案例中的HttpUtil.java 和 LiveSignUtil.java 都包含在下載檔案中。
強烈建議您使用直播Java SDK完成API的功能對接,直播Java SDK 對API呼叫邏輯、例外處理、資料簽名、HTTP請求執行緒池進行了統一封裝和最佳化。
private static final Logger log = LoggerFactory.getLogger(AccountTest.class);
/**
* 查询所有频道的基础信息
* @throws IOException
* @throws NoSuchAlgorithmException
*/
@Test
public void testUserChannelBasicList() 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/basic/list";
String categoryIds="340019,345134";
String page = String.valueOf(2);
String pageSize=String.valueOf(2);
//http 调用逻辑
Map<String, String> requestMap = new HashMap<>();
requestMap.put("appId", appId);
requestMap.put("timestamp", timestamp);
requestMap.put("categoryIds", categoryIds);
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":2,
"pageNumber":2,
"totalItems":28,
"contents":[
{
"channelId":2191532,
"name":"Spring 知识精讲1111",
"publisher":"主持人",
"startTime":0,
"pageView":3,
"likes":0,
"coverImg":"https://liveimages.videocc.net/assets/wimages/pc_images/logo.png",
"splashImg":"https://liveimages.videocc.net/uploaded/images/2020/11/ftezpn7cup.jpg",
"splashEnabled":"N",
"desc":"",
"maxViewer":300,
"watchStatus":"playback",
"watchStatusText":"回放中",
"onlineNum":0,
"bgImg":null,
"videoList":[
{
"videoId":"1b96d90bf5",
"videoPoolId":"1b448be323e68e4404332113a57353b2_1"
}
],
"categoryId":340019
},
{
"channelId":2190410,
"name":"入职培训",
"publisher":"主持人",
"startTime":0,
"pageView":6,
"likes":23,
"coverImg":"https://liveimages.videocc.net/assets/wimages/pc_images/logo.png",
"splashImg":"https://liveimages.videocc.net/uploaded/images/2020/11/ftezpn7cup.jpg",
"splashEnabled":"N",
"desc":"",
"maxViewer":-1,
"watchStatus":"playback",
"watchStatusText":"回放中",
"onlineNum":0,
"bgImg":null,
"videoList":null,
"categoryId":340019
}
],
"startRow":3,
"firstPage":false,
"lastPage":false,
"prePageNumber":1,
"limit":2,
"nextPageNumber":3,
"endRow":4,
"totalPages":14,
"offset":2
}
}
異常範例
{
"code": 400,
"status": "error",
"message": "invalid signature.",
"data": ""
}
