分頁取得簡單頻道資訊列表介面

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

介面URL

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

介面說明

1、分页获取简单频道列表信息接口
2、每页数据最大100个
2、接口支持https

支援格式

JSON

請求方式

GET

請求數限制

TRUE

請求參數

參數名	必選	類型	說明
appId	是	string	從API設定中取得，在直播系統登記的appId
timestamp	是	long	目前13位毫秒級時間戳，3分鐘內有效
sign	是	String	簽名，為32位大寫的MD5值,`產生簽名的appSecret金鑰作為通訊資料安全的關鍵資訊，嚴禁儲存在客戶端直接使用，所有API都必須透過客戶自己伺服器中轉呼叫POLYV伺服器取得回應資料`【詳見簽名產生規則】
channelIds	否	string	頻道號，多個以英文逗號分隔，如：100001,100002
startDay	否	string	開始日期，格式yyyy-MM-dd
endDay	否	string	結束日期，格式yyyy-MM-dd
size	否	int	每頁大小
page	否	int	目前頁

回應成功JSON範例：

{
    "code": 200,
    "status": "success",
    "message": "",
    "data": {
        "pageSize": 1,
        "pageNumber": 1,
        "totalItems": 129,
        "contents": [
            {
                "channelId": 128457,
                "name": "普通暖场视频",
                "startTime": "2020-08-06 18:20:00.0"
            }
        ],
        "startRow": 1,
        "firstPage": true,
        "lastPage": false,
        "prePageNumber": 1,
        "limit": 1,
        "endRow": 1,
        "nextPageNumber": 2,
        "totalPages": 129,
        "offset": 0
    }
}

回應失敗JSON範例：

未輸入appId

{
    "code": 400,
    "status": "error",
    "message": "appId is required.",
    "data": ""
}

appId不正確

{
    "code": 400,
    "status": "error",
    "message": "application not found.",
    "data": ""
}

時間戳錯誤

{
    "code": 400,
    "status": "error",
    "message": "invalid timestamp.",
    "data": ""
}

簽名錯誤

{
    "code": 403,
    "status": "error",
    "message": "invalid signature.",
    "data": ""
}

欄位說明

參數名	類型	說明
code	int	回應代碼，成功為200，失敗為400，簽名錯誤為401，異常錯誤500
status	string	成功為success，失敗為error
message	string	錯誤時為錯誤提示訊息
data	object	回應結果集
pageNumber	int	目前的頁數
totalItems	int	總筆數
contents	array	查詢的結果列表
channelId	int	頻道號
name	string	頻道名稱
startTime	string	直播開始時間
firstPage	boolean	是否為第一頁，值為：true/false
lastPage	boolean	是否為最後一頁，值為：true/false
nextPageNumber	int	下一頁編號
prePageNumber	int	上一頁編號
totalPages	int	總頁數
startRow	int	目前頁第一個數量的位置
endRow	int	目前頁最後一個數量的位置
limit	int	每頁數量大小

Java請求範例

public static void main(String[] args) {
        String url = "http://api.polyv.net/live/v3/channel/management/query-list-sample";
        // 用户对应的appId和加密串
        String appId = "xxxxxxxxx";
        String appSecret = "xxxxxxxxxxxxxxxxxxxxxxxxxx";
        Map<String, String> params = new HashMap<>();
        params.put("channelIds", "0000000");
        PolyvTool.setLiveSign(params, appId, appSecret);
        // 调用Polyv的httpClient工具类发送请求
        String content = HttpClientUtil.getInstance()
                .sendHttpPost(url, params);
        System.out.println(content);
    }