Polyv Help Center

Help Center

POLYV Help Center

Paginated Simple Channel Info List API

Updated: 2022-09-02 18:08:07

API URL

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

API Description

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

Supported Format

JSON

Request Method

GET

Request Limit

TRUE

Request Parameters

Parameter Required Type Description
appId Yes string Obtained from API settings, the appId registered in the live streaming system
timestamp Yes long Current 13-digit millisecond timestamp, valid within 3 minutes
sign Yes String Signature, a 32-character uppercase MD5 value. The appSecret used to generate the signature is critical for communication data security. It must not be stored or used directly on the client side. All APIs must be called through the customer's own server to relay requests to the POLYV server to obtain response data. See Signature Generation Rules
channelIds No string Channel IDs, separated by commas if multiple, e.g., 100001,100002
startDay No string Start date, format yyyy-MM-dd
endDay No string End date, format yyyy-MM-dd
size No int Page size
page No int Current page number

Successful Response JSON Example:

{
    "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
    }
}

Failed Response JSON Examples:

No appId provided

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

Incorrect appId

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

Timestamp error

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

Signature error

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

Field Description

Parameter Type Description
code int Response code: 200 for success, 400 for failure, 401 for signature error, 500 for server error
status string "success" for success, "error" for failure
message string Error message when status is "error"
data object Response result set
pageNumber int Current page number
totalItems int Total number of items
contents array List of query results
channelId int Channel ID
name string Channel name
startTime string Live stream start time
firstPage boolean Whether it is the first page, values: true/false
lastPage boolean Whether it is the last page, values: true/false
nextPageNumber int Next page number
prePageNumber int Previous page number
totalPages int Total number of pages
startRow int Position of the first item on the current page
endRow int Position of the last item on the current page
limit int Number of items per page

Java Request Example

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);
    }
联系客服，在线咨询