查询所有频道的基础信息

旧版接口地址查询所有频道的基础信息(旧版)

接口描述

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

接口URL

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

在线API调用

请求方式

GET

接口约束

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

请求参数描述

示例

http://api.polyv.net/live/v4/channel/basic/list?categoryIds=340019&pageNumber=2&appId=frlr1zazn3&sign=02E681A4BECB8D8B73056C08B1DF6443&pageSize=2&timestamp=1648776618809

响应参数描述

Error参数描述

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 testListChannelBasic() 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/list";
    String categoryIds = "340019";
    String pageNumber = "2";
    String pageSize = "2";

    //http 调用逻辑
    Map<String, String> requestMap = new HashMap<>();
    requestMap.put("appId", appId);
    requestMap.put("timestamp", timestamp);
    requestMap.put("categoryIds", categoryIds);
    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
    
}

响应示例

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

成功示例

{
    "code": 200,
    "status": "success",
    "requestId": "d961bc1daf4844a39de9a2c57beb3f51.66.16487766217727375",
    "data": {
        "pageNumber": 2,
        "pageSize": 2,
        "totalPages": 36,
        "totalItems": 71,
        "contents": [
            {
                "channelId": 1981629,
                "name": "创建并初始化频道-验证码观看",
                "publisher": "主讲人sadboy",
                "startTime": 1602306535000,
                "coverImg": "https://liveimages.videocc.net/assets/wimages/pc_images/logo.png",
                "splashImg": null,
                "splashEnabled": "N",
                "desc": "这是一个描述",
                "watchUrl": "https://1b448be323.live.polyv.cn/watch/1981629",
                "watchStatus": "end",
                "watchStatusText": "已结束",
                "bgImg": null,
                "categoryId": 340019,
                "pageView": 25,
                "likes": 0,
                "maxViewer": 0,
                "onlineNum": 0,
                "videoList": null,
                "scene": "alone",
                "newScene": "undefined",
                "template": "alone"
            },
            {
                "channelId": 2191569,
                "name": "测试",
                "publisher": "主持人名称",
                "startTime": 1557888134000,
                "coverImg": "https://liveimages.videocc.net/uploaded/images/2021/05/fyw76bd9ed.png",
                "splashImg": "https://liveimages.videocc.net/uploaded/images/2021/05/fyw76bi945.png",
                "splashEnabled": "Y",
                "desc": "这是直播介绍,可以是html代码",
                "watchUrl": "https://1b448be323.live.polyv.cn/watch/2191569",
                "watchStatus": "end",
                "watchStatusText": "已结束",
                "bgImg": "http://static.live.polyv.net/uploaded/images/2016/07/egqo3soa33.jpg",
                "categoryId": 340019,
                "pageView": 1003,
                "likes": 666,
                "maxViewer": 100,
                "onlineNum": 0,
                "videoList": [
                    {
                        "videoId": "929b7c13bd",
                        "videoPoolId": "1b448be3231d54331c41d70c6656d8b4_1",
                        "duration": "00:01:29"
                    },
                    {
                        "videoId": "929b7c13bd",
                        "videoPoolId": "1b448be3231d54331c41d70c6656d8b4_1",
                        "duration": "00:01:29"
                    }
                ],
                "scene": "ppt",
                "newScene": "undefined",
                "template": "undefined"
            }
        ]
    },
    "success": true
}

异常示例

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