Query Basic Information of All Channels

API Description

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

API URL

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

Online API Call

Request Method

GET

API Constraints

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

Request Parameters Description

Example

http://api.polyv.net/live/v3/channel/basic/channel-list?categoryIds=340019%2C391352&appId=frlr1zazn3&sign=6E5E01CBF9D9B7F5216C0A7C93A897A7&pageSize=2&page=2&timestamp=1642734203497

Response Parameters Description

Data Parameters Description

Contents Parameters Description

VideoList Parameters Description

Java Request Example

For quick integration of basic code, please download the relevant dependency source code. Click here to download the source code. After downloading, add it to your own source code 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 packaging 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 testChannelBasicList() throws IOException, NoSuchAlgorithmException {
    //公共参数,填写自己的实际参数
    String appId = super.appId;
    String appSecret = super.appSecret;
    String userId = super.userId;
    String timestamp = String.valueOf(System.currentTimeMillis());
    //业务参数
    String url = "http://api.polyv.net/live/v3/channel/basic/channel-list";
    String categoryIds = "340019,391352";
    String page = "2";
    String pageSize = "2";
    
    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 error descriptions, see Global Error Description

Success Example

{
    "code": 200,
    "status": "success",
    "message": "",
    "data": {
        "pageSize": 2,
        "pageNumber": 2,
        "totalItems": 59,
        "contents": [
            {
                "channelId": 2791952,
                "name": "⌛Emoji⌛⌚⌨",
                "publisher": "主持人",
                "startTime": 0,
                "pageView": 0,
                "likes": 0,
                "coverImg": "https://liveimages.videocc.net/assets/wimages/pc_images/logo.png",
                "splashImg": "https://liveimages.videocc.net/uploaded/images/2021/09/g2bta2pjbw.jpg",
                "splashEnabled": "Y",
                "desc": "",
                "maxViewer": 0,
                "watchStatus": "unStart",
                "watchStatusText": "未开始",
                "onlineNum": 0,
                "bgImg": null,
                "videoList": null,
                "categoryId": 340019
            },
            {
                "channelId": 2779196,
                "name": "测试",
                "publisher": "主持人",
                "startTime": 1642453440000,
                "pageView": 0,
                "likes": 0,
                "coverImg": "https://liveimages.videocc.net/assets/wimages/pc_images/logo.png",
                "splashImg": "https://liveimages.videocc.net/uploaded/images/2021/09/g2bta2pjbw.jpg",
                "splashEnabled": "Y",
                "desc": "",
                "maxViewer": -1,
                "watchStatus": "unStart",
                "watchStatusText": "未开始",
                "onlineNum": 0,
                "bgImg": null,
                "videoList": null,
                "categoryId": 340019
            }
        ],
        "limit": 2,
        "offset": 2,
        "endRow": 4,
        "totalPages": 30,
        "nextPageNumber": 3,
        "startRow": 3,
        "firstPage": false,
        "lastPage": false,
        "prePageNumber": 1
    }
}

Error Example

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