查询所有频道的基础信息

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

接口描述

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

接口URL

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

在线API调用

请求方式

GET

接口约束

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

请求参数描述

参数名	必选	类型	说明
appId	true	String	账号appId【详见获取密钥】
timestamp	true	Long	当前13位毫秒级时间戳，3分钟内有效
sign	true	String	签名，为32位大写的MD5值,生成签名的appSecret密钥作为通信数据安全的关键信息，严禁保存在客户端直接使用，所有API都必须通过客户自己服务器中转调用POLYV服务器获取响应数据【详见签名生成规则】
categoryIds	false	String	分类ID，多个id用英文逗号分隔，不超过200个
channelIds	false	String	频道号，多个频道用英文逗号分隔
watchStatus	false	String	观看页状态筛选 live：直播中 playback：回放中 end：已结束 waiting：等待中 unStart：未开始
startTime	false	Long	直播开始时间，查询开始时间13位时间戳
endTime	false	Long	直播结束时间，查询结束时间13位时间戳
pageNumber	false	Integer	查询页数，默认1
pageSize	false	Integer	每页数据大小，默认10，最大值不能超过1000
orderBy	false	String	排序字段，默认按频道创建时间升序 startTimeDesc：开播时间降序 startTimeAsc：开播时间升序 channelCreatedTimeDesc：频道创建时间降序

示例

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

响应参数描述

参数名	类型	说明
code	Integer	状态码，与 http 状态码相同，用于确定基本的响应状态
status	String	响应结果，由业务决定，成功返回success，失败返回error
success	Boolean	是否成功响应
requestId	String	请求ID，每次请求生成的唯一的 UUID，仅可用于排查、调试，不应该和业务挂上钩
error	Object	状态码非200时的错误信息【详见Error字段描述】
data	Object	【详见data字段说明】

Error参数描述

参数名	类型	说明
code	Integer	错误代码，用于确定具体的错误原因
desc	String	错误描述，与 error.code 对应

data参数描述

参数名	类型	说明
pageNumber	Integer	当前页码
pageSize	Integer	每页数据量
totalPages	Long	页面总数
totalItems	Long	总数据量
contents	Array	当前页内容【详见contents字段说明】

contents参数描述

参数名	类型	说明
channelId	String	频道号
name	String	频道名称
publisher	String	主持人名称
startTime	Long	直播开始时间，开启时为13位毫秒级时间戳
pageView	Integer	页面累计观看数
likes	Integer	观看页点赞数
coverImg	String	频道图标url
splashImg	String	频道引导图url
splashEnabled	String	引导页开关，取值 Y：开启 N：关闭
desc	String	直播介绍
maxViewer	Integer	最大在线观看人数
watchStatus	String	频道的观看页状态，取值为 live：直播中 end：直播结束 playback：回放中 waiting：等待中 unStart：未开始 banpush：已禁播
watchStatusText	String	观看页状态描述，直播中，回放中，已结束，等待中，未开始，已禁播
onlineNum	Integer	在线人数
bgImg	String	暖场图片URL
videoList	Array	回放视频列表（回放列表+点播列表），当有多个时按添加时间倒叙排列【详见videoList参数描述】
categoryId	Integer	分类ID
scene	String	直播场景，新版直播不使用该字段 alone：活动直播 topclass：大班课 ppt：三分屏 seminar：研讨会
newScene	String	新版后台直播场景，若未定义则取scene undefined：未定义 topclass：大班课 double：双师课（需开通权限） train：企业培训 seminar：研讨会 alone：活动营销
template	String	新版后台直播模板，若老版频道，该字段为未定义 undefined：未定义 ppt：三分屏(横屏) alone：纯视频(横屏) topclass：纯视频-极速(横屏) seminar：研讨会 portrait_ppt：三分屏(竖屏) portrait_alone：纯视频(竖屏)

VideoList参数描述

参数名	类型	说明
videoId	String	直播系统生成的id （视频库中的回放视频）
videoPoolId	String	点播视频vid （视频库中的回放视频）
duration	String	视频时长（格式：00:01:29）

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": "这是一个描述",
                "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代码",
                "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
}