Query Thumbnail Information for All Channels

API Description

1、查询账号下所有的频道缩略信息列表
2、列表信息仅包含频道缩略信息，如需频道具体信息，请使用【获取频道信息】接口
3、接口支持https协议

API URL

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

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

Example

http://api.polyv.net/live/v3/channel/management/list?watchStatus=playback&appId=frlr1zazn3&sign=E02F269E702E0AE2154D94B25FD5390D&pageSize=20&page=1&keyword=%E6%B5%8B%E8%AF%95&categoryId=345134&timestamp=1621841187446

Response Parameters

Data Parameter Description

Contents Parameter Description

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 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 testGetSimpleChannelList() 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/management/list";
    String categoryId="345134";
    String watchStatus="playback";
    String keyword="测试";
    String page=String.valueOf(1);
    String pageSize=String.valueOf(20);

    //http 调用逻辑
    Map<String, String> requestMap = new HashMap<>();
    requestMap.put("appId", appId);
    requestMap.put("timestamp", timestamp);
    requestMap.put("categoryId", categoryId);
    requestMap.put("watchStatus", watchStatus);
    requestMap.put("keyword", keyword);
    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":20,
        "pageNumber":1,
        "totalItems":1,
        "contents":[
            {
                "channelId":2191569,
                "name":"测试",
                "channelPasswd":"******",
                "categoryId":"345134",
                "scene":"ppt",
                "watchStatus":"playback",
                "watchStatusText":"回放中",
                "sceneText":"三分屏",
                "watchUrl":"https://live.polyv.cn/watch/2191569"
            }
        ],
        "startRow":1,
        "firstPage":true,
        "lastPage":true,
        "prePageNumber":1,
        "limit":1,
        "offset":0,
        "totalPages":1,
        "endRow":1,
        "nextPageNumber":1
    }
}

Error Example

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