保利威文档中心

幫助中心

查詢所有頻道的基礎資訊

更新時間:2025-09-17 09:34:52

舊版介面位址查詢所有頻道的基礎資訊(舊版)

介面描述

1、查询账号下所有的频道基础信息列表,观看页状态与新版后台一致
2、接口支持https协议

介面URL

http://api.polyv.net/live/v4/channel/basic/list

線上API呼叫

請求方式

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用英文逗號分隔,不超過200個
channelIds false String 頻道號,多個頻道用英文逗號分隔
watchStatus false String 觀看頁狀態篩選
live:直播中
playback:回放中
end:已結束
waiting:等待中
unStart:未開始
startTime false Long 直播開始時間,查詢開始時間13位時間戳
endTime false Long 直播結束時間,查詢結束時間13位時間戳
pageNumber false Integer 查詢頁數,預設1
pageSize false Integer 每頁資料大小,預設10,最大值不能超過1000
orderBy false String 排序欄位,預設按頻道建立時間升序
startTimeDesc:開播時間降序
startTimeAsc:開播時間升序
channelCreatedTimeDesc:頻道建立時間降序

範例

http://api.polyv.net/live/v4/channel/basic/list?categoryIds=340019&pageNumber=2&appId=frlr1zazn3&sign=02E681A4BECB8D8B73056C08B1DF6443&pageSize=2&timestamp=1648776618809

回應參數描述

參數名 類型 說明
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 頻道名稱
publisher String 主持人名稱
startTime Long 直播開始時間,開啟時為13位毫秒級時間戳
pageView Integer 頁面累計觀看數
likes Integer 觀看頁按讚數
coverImg String 頻道圖示url
splashImg String 頻道引導圖url
splashEnabled String 引導頁開關,取值
Y:開啟
N:關閉
desc String 直播介紹
maxViewer Integer 最大線上觀看人數
watchUrl String 直播觀看地址,例如 https://xxx.live.polyv.cn/watch/xxxx
watchStatus String 頻道的觀看頁狀態,取值為
live:直播中
end:直播結束
playback:回放中
waiting:等待中
unStart:未開始
banpush:已禁播
watchStatusText String 觀看頁狀態描述,直播中,回放中,已結束,等待中,未開始,已禁播
onlineNum Integer 線上人數
bgImg String 暖場圖片URL
videoList Array 回放影片列表(回放列表+點播列表),當有多個時按新增時間倒序排列【詳見videoList參數描述
categoryId Integer 分類ID
scene String 直播場景,新版直播不使用該欄位
alone:活動直播
topclass:大班課
ppt:三分屏
seminar:研討會
newScene String 新版後台直播場景,若未定義則取scene
undefined:未定義
topclass:大班課
double:雙師課(需開通權限)
train:企業培訓
seminar:研討會
alone:活動行銷
template String 新版後台直播模板,若老版頻道,該欄位為未定義
undefined:未定義
ppt:三分屏(橫屏)
alone:純影片(橫屏)
topclass:純影片-極速(橫屏)
seminar:研討會
portrait_ppt:三分屏(豎屏)
portrait_alone:純影片(豎屏)
streamType String 直播方式. client: 使用開播端或第三方推流(常規); disk: 偽直播;

VideoList參數描述

參數名 類型 說明
videoId String 直播系統產生的id (影片庫中的回放影片)
videoPoolId String 點播影片vid (影片庫中的回放影片)
duration String 影片時長(格式:00:01:29)

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 testListChannelBasic() 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/list";
    String categoryIds = "340019";
    String pageNumber = "2";
    String pageSize = "2";

    //http 调用逻辑
    Map<String, String> requestMap = new HashMap<>();
    requestMap.put("appId", appId);
    requestMap.put("timestamp", timestamp);
    requestMap.put("categoryIds", categoryIds);
    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": "d961bc1daf4844a39de9a2c57beb3f51.66.16487766217727375",
    "data": {
        "pageNumber": 2,
        "pageSize": 2,
        "totalPages": 36,
        "totalItems": 71,
        "contents": [
            {
                "channelId": 1981629,
                "name": "创建并初始化频道-验证码观看",
                "publisher": "主讲人sadboy",
                "startTime": 1602306535000,
                "coverImg": "https://liveimages.videocc.net/assets/wimages/pc_images/logo.png",
                "splashImg": null,
                "splashEnabled": "N",
                "desc": "这是一个描述",
                "watchUrl": "https://1b448be323.live.polyv.cn/watch/1981629",
                "watchStatus": "end",
                "watchStatusText": "已结束",
                "bgImg": null,
                "categoryId": 340019,
                "pageView": 25,
                "likes": 0,
                "maxViewer": 0,
                "onlineNum": 0,
                "videoList": null,
                "scene": "alone",
                "newScene": "undefined",
                "template": "alone"
            },
            {
                "channelId": 2191569,
                "name": "测试",
                "publisher": "主持人名称",
                "startTime": 1557888134000,
                "coverImg": "https://liveimages.videocc.net/uploaded/images/2021/05/fyw76bd9ed.png",
                "splashImg": "https://liveimages.videocc.net/uploaded/images/2021/05/fyw76bi945.png",
                "splashEnabled": "Y",
                "desc": "这是直播介绍,可以是html代码",
                "watchUrl": "https://1b448be323.live.polyv.cn/watch/2191569",
                "watchStatus": "end",
                "watchStatusText": "已结束",
                "bgImg": "http://static.live.polyv.net/uploaded/images/2016/07/egqo3soa33.jpg",
                "categoryId": 340019,
                "pageView": 1003,
                "likes": 666,
                "maxViewer": 100,
                "onlineNum": 0,
                "videoList": [
                    {
                        "videoId": "929b7c13bd",
                        "videoPoolId": "1b448be3231d54331c41d70c6656d8b4_1",
                        "duration": "00:01:29"
                    },
                    {
                        "videoId": "929b7c13bd",
                        "videoPoolId": "1b448be3231d54331c41d70c6656d8b4_1",
                        "duration": "00:01:29"
                    }
                ],
                "scene": "ppt",
                "newScene": "undefined",
                "template": "undefined"
            }
        ]
    },
    "success": true
}

異常範例

{
    "code": 400,
    "status": "error",
    "requestId": "d310b70bc329403f87f77f9203d50f89.128.16360831552223589",
    "error": {
        "code": 20001,
        "desc": "application not found."
    },
    "success": false
}
联系客服,在线咨询