保利威文档中心

幫助中心

查詢所有頻道的縮略資訊

更新時間:2022-09-02 18:08:07

介面描述

1、查询账号下所有的频道缩略信息列表
2、列表信息仅包含频道缩略信息,如需频道具体信息,请使用【获取频道信息】接口
3、接口支持https协议

介面URL

http://api.polyv.net/live/v3/channel/management/list

請求方式

GET

介面限制

1、介面同時支援HTTP、HTTPS,建議使用HTTPS確保介面安全,介面呼叫有頻率限制,詳細請查看

請求參數描述

參數名 必選 類型 說明
appId true String 帳號appId【詳見取得金鑰
timestamp true Long 當前13位毫秒級時間戳,3分鐘內有效
sign true String 簽名,為32位大寫的MD5值,產生簽名的appSecret金鑰作為通訊資料安全的關鍵資訊,嚴禁儲存在用戶端直接使用,所有API都必須透過客戶自己伺服器中轉呼叫POLYV伺服器取得回應資料【詳見簽名產生規則
page false Integer 頁碼,預設為1
pageSize false Integer 每頁資料大小,預設每頁顯示20筆資料
categoryId false String 所屬分類id
watchStatus false String 觀看頁狀態篩選
live:直播中
playback:回放中
end:已結束
waiting:未開始
keyword false String 頻道名稱,模糊查詢

範例

http://api.polyv.net/live/v3/channel/management/list?watchStatus=playback&appId=frlr1zazn3&sign=E02F269E702E0AE2154D94B25FD5390D&pageSize=20&page=1&keyword=%E6%B5%8B%E8%AF%95&categoryId=345134&timestamp=1621841187446

回應參數描述

參數名 類型 說明
code Integer 回應狀態碼,200為成功返回,非200為失敗【詳見全域錯誤說明
status String 回應狀態文字資訊
message String 回應描述資訊,當code為400或500時,輔助描述錯誤原因
data Object 回應成功時返回頻道縮略資訊【詳見data欄位說明
Data參數描述
參數名 類型 說明
pageSize Integer 每頁顯示的資料筆數,預設每頁顯示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 頻道名稱
channelPasswd String 頻道密碼
categoryId String 直播分類id
scene String 場景
alone:活動直播
ppt:三分屏
topclass:大班課
seminar:研討會
watchStatus String 觀看頁狀態描述
直播中
回放中
已結束
未開始
watchStatusText String 觀看頁狀態
live:直播中
playback:回放中
end:已結束
waiting:未開始
sceneText String 場景描述
watchUrl String 觀看頁連結

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 testGetSimpleChannelList() 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/v3/channel/management/list";
    String categoryId="345134";
    String watchStatus="playback";
    String keyword="测试";
    String page=String.valueOf(1);
    String pageSize=String.valueOf(20);

    //http 调用逻辑
    Map<String, String> requestMap = new HashMap<>();
    requestMap.put("appId", appId);
    requestMap.put("timestamp", timestamp);
    requestMap.put("categoryId", categoryId);
    requestMap.put("watchStatus", watchStatus);
    requestMap.put("keyword", keyword);
    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":[
            {
                "channelId":2191569,
                "name":"测试",
                "channelPasswd":"******",
                "categoryId":"345134",
                "scene":"ppt",
                "watchStatus":"playback",
                "watchStatusText":"回放中",
                "sceneText":"三分屏",
                "watchUrl":"https://live.polyv.cn/watch/2191569"
            }
        ],
        "startRow":1,
        "firstPage":true,
        "lastPage":true,
        "prePageNumber":1,
        "limit":1,
        "offset":0,
        "totalPages":1,
        "endRow":1,
        "nextPageNumber":1
    }
}

異常範例

{
    "code": 400,
    "status": "error",
    "message": "invalid signature.",
    "data": ""
}
联系客服,在线咨询