Query Basic Information of All Channels

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

API Description

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

API URL

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

Request Method

GET

API Constraints

The API supports both HTTP and HTTPS. HTTPS is recommended to ensure API security. API calls have frequency limits. Click for details

Request Parameter Description

Parameter	Required	Type	Description
appId	true	String	Account appId See Get Secret Key
timestamp	true	Long	Current 13-digit millisecond timestamp, valid within 3 minutes
sign	true	String	Signature, a 32-character uppercase MD5 value. `The appSecret key used to generate the signature is critical for communication data security. It must never be stored on the client side. All APIs must be called through the customer's own server to relay requests to the POLYV server for response data.` See Signature Generation Rules
channelIds	false	String	Channel IDs, multiple channels separated by commas
orderBy	false	String	Sort field, default sorted by channel creation time descending startTimeDesc: Sort by start time descending startTimeAsc: Sort by start time ascending
pageNumber	false	Integer	Page number to query, default 1
pageSize	false	Integer	Data size per page, default 10, maximum 100

Example

http://api.polyv.net/live/v4/channel/basic-info/list?pageNumber=2&appId=frlr1zazn3&sign=1AEEA7FE8C0DF0BF6918B5212906ED97&pageSize=2&timestamp=1651801721026

Response Parameter Description

Parameter	Type	Description
code	Integer	Status code, same as HTTP status code, used to determine basic response status
status	String	Response result, determined by business logic. Returns success on success, error on failure
success	Boolean	Whether the request was successful
requestId	String	Request ID, a unique UUID generated for each request. Only for troubleshooting and debugging, not for business logic
error	Object	Error information when status code is not 200 See Error Field Description
data	Object	See data Field Description

Error Parameter Description

Parameter	Type	Description
code	Integer	Error code, used to identify the specific error reason
desc	String	Error description, corresponding to error.code

data Parameter Description

Parameter	Type	Description
pageNumber	Integer	Current page number
pageSize	Integer	Data size per page
totalPages	Long	Total number of pages
totalItems	Long	Total number of items
contents	Array	Content of the current page See contents Field Description

contents Parameter Description

Parameter	Type	Description
channelId	String	Channel ID
name	String	Channel name
channelPasswd	String	Channel password
publisher	String	Host name
startTime	Long	Live broadcast start time, 0 when closed, 13-digit millisecond timestamp when active
pageView	Integer	Cumulative page views
splashImg	String	Channel splash image URL
desc	String	Live broadcast description
watchUrl	String	Watch page link
watchStatus	String	Watch page status, values: live: Live end: Ended playback: Playback waiting: Waiting unStart: Not started
watchStatusText	String	Watch page status description: Live, Playback, Ended, Waiting, Not started

Java Request Example

For quick integration of basic code, please download the relevant dependency source code. Click to download source code. After downloading, add it to your own source code project. The HttpUtil.java and LiveSignUtil.java in the test cases are included in the downloaded file.

It is strongly recommended to use the Live Java SDK for API integration. The Live Java SDK provides unified encapsulation and optimization for API call logic, exception handling, data signing, and HTTP request thread pools.

private static final Logger log = LoggerFactory.getLogger(ChannelOperateTest.class);
/**
 * 查询所有频道的基础信息
 * @throws IOException
 * @throws NoSuchAlgorithmException
 */
@Test
public void testListChannelBasicInfo() 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-info/list";
    String pageNumber = "2";
    String pageSize = "2";
    
    //http 调用逻辑
    Map<String, String> requestMap = new HashMap<>();
    requestMap.put("appId", appId);
    requestMap.put("timestamp", timestamp);
    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
    
}

Response Example

For global system error descriptions, see Global Error Description

Success Example

{
    "code": 200,
    "status": "success",
    "requestId": "028071a1aa4c464a9c441cf79de24dfb.61.16518013990160097",
    "data": {
        "pageNumber": 6,
        "pageSize": 1,
        "totalPages": 96,
        "totalItems": 96,
        "contents": [
            {
                "channelId": 3042405,
                "channelPasswd": "xxxxx",
                "name": "测试中英文复制1",
                "publisher": "sadman",
                "startTime": 1635652800000,
                "splashImg": "https://liveimages.videocc.net/uploaded/images/2021/09/g2bpwvlg83.jpeg",
                "desc": "<p>JAVA大师无延迟直播课-纯视频</p>",
                "watchStatus": "waiting",
                "watchStatusText": "等待中",
                "pageView": 10,
                "watchUrl": "https://live.polyv.cn/watch/3042405"
            }
        ]
    },
    "success": true
}

Error Example

{
    "code": 400,
    "status": "error",
    "requestId": "d310b70bc329403f87f77f9203d50f89.128.16360831552223589",
    "error": {
        "code": 20001,
        "desc": "application not found."
    },
    "success": false
}

Live Streaming Server API