Query Basic Information of All Channels

API Description

1、查询账号下所有的频道基础信息列表
2、接口支持https协议

API URL

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

Request Method

GET

API Constraints

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

Request Parameter Description

Example

https://api.polyv.net/live/v3/channel/basic/list?categoryIds=340019%2C345134&appId=frlr1zazn3&sign=4A994A9B856E5728F43629AE0F52BDB7&pageSize=2&page=2&timestamp=1621841218218

Response Parameter Description

Data Parameter Description

Contents Parameter Description

videoList Parameter Description

Java Request Example

For quick integration, please download the relevant dependency source code. Click here to download the source code. After downloading, add it to your own source project. The test cases include HttpUtil.java and LiveSignUtil.java 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(AccountTest.class);
/**
 * 查询所有频道的基础信息
 * @throws IOException
 * @throws NoSuchAlgorithmException
 */
@Test
public void testUserChannelBasicList() throws IOException, NoSuchAlgorithmException {
    //公共参数,填写自己的实际
    String appId = super.appId;
    String appSecret = super.appSecret;
    String userId = super.userId;
    String timestamp = String.valueOf(System.currentTimeMillis());
    //业务参数
    String url = "https://api.polyv.net/live/v3/channel/basic/list";
    String categoryIds="340019,345134";
    String page = String.valueOf(2);
    String pageSize=String.valueOf(2);
   
    //http 调用逻辑
    Map<String, String> requestMap = new HashMap<>();
    requestMap.put("appId", appId);
    requestMap.put("timestamp", timestamp);
    requestMap.put("categoryIds", categoryIds);
    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

}

Response Example

For global system error descriptions, see Global Error Description

Success Example

{
    "code":200,
    "status":"success",
    "message":"",
    "data":{
        "pageSize":2,
        "pageNumber":2,
        "totalItems":28,
        "contents":[
            {
                "channelId":2191532,
                "name":"Spring 知识精讲1111",
                "publisher":"主持人",
                "startTime":0,
                "pageView":3,
                "likes":0,
                "coverImg":"https://liveimages.videocc.net/assets/wimages/pc_images/logo.png",
                "splashImg":"https://liveimages.videocc.net/uploaded/images/2020/11/ftezpn7cup.jpg",
                "splashEnabled":"N",
                "desc":"",
                "maxViewer":300,
                "watchStatus":"playback",
                "watchStatusText":"回放中",
                "onlineNum":0,
                "bgImg":null,
                "videoList":[
                    {
                        "videoId":"1b96d90bf5",
                        "videoPoolId":"1b448be323e68e4404332113a57353b2_1"
                    }
                ],
                "categoryId":340019
            },
            {
                "channelId":2190410,
                "name":"入职培训",
                "publisher":"主持人",
                "startTime":0,
                "pageView":6,
                "likes":23,
                "coverImg":"https://liveimages.videocc.net/assets/wimages/pc_images/logo.png",
                "splashImg":"https://liveimages.videocc.net/uploaded/images/2020/11/ftezpn7cup.jpg",
                "splashEnabled":"N",
                "desc":"",
                "maxViewer":-1,
                "watchStatus":"playback",
                "watchStatusText":"回放中",
                "onlineNum":0,
                "bgImg":null,
                "videoList":null,
                "categoryId":340019
            }
        ],
        "startRow":3,
        "firstPage":false,
        "lastPage":false,
        "prePageNumber":1,
        "limit":2,
        "nextPageNumber":3,
        "endRow":4,
        "totalPages":14,
        "offset":2
    }
}

Error Example

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