查询所有频道的基础信息

接口描述

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

接口URL

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

在线API调用

请求方式

GET

接口约束

1、接口同时支持HTTP 、HTTPS ，建议使用HTTPS 确保接口安全，接口调用有频率限制，详细请查看

请求参数描述

示例

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

响应参数描述

Data参数描述

Contents参数描述

VideoList参数描述

Java请求示例

快速接入基础代码请下载相关依赖源码， 点击下载源代码 ,下载后加入到自己的源码工程中即可。测试用例中的HttpUtil.java 和 LiveSignUtil.java 都包含在下载文件中。

强烈建议您使用直播Java SDK完成API的功能对接，直播Java SDK 对API调用逻辑、异常处理、数据签名、HTTP请求线程池进行了统一封装和优化。

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
    
}

响应示例

系统全局错误说明详见全局错误说明

成功示例

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

异常示例

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