查询所有频道的基础信息

接口描述

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

接口URL

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

请求方式

GET

接口约束

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

请求参数描述

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

示例

http://api.polyv.net/live/v4/channel/basic-info/list?pageNumber=2&appId=frlr1zazn3&sign=1AEEA7FE8C0DF0BF6918B5212906ED97&pageSize=2&timestamp=1651801721026

响应参数描述

参数名	类型	说明
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	频道名称
channelPasswd	String	频道密码
publisher	String	主持人名称
startTime	Long	直播开始时间，关闭时为0，开启时为13位毫秒级时间戳
pageView	Integer	页面累计观看数
splashImg	String	频道引导图url
desc	String	直播介绍
watchUrl	String	观看页链接
watchStatus	String	频道的观看页状态，取值为 live：直播中 end：直播结束 playback：回放中 waiting：等待中 unStart：未开始
watchStatusText	String	观看页状态描述，直播中，回放中，已结束，等待中，未开始

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 testListChannelBasicInfo() 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-info/list";
    String pageNumber = "2";
    String pageSize = "2";
    
    //http 调用逻辑
    Map<String, String> requestMap = new HashMap<>();
    requestMap.put("appId", appId);
    requestMap.put("timestamp", timestamp);
    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": "028071a1aa4c464a9c441cf79de24dfb.61.16518013990160097",
    "data": {
        "pageNumber": 6,
        "pageSize": 1,
        "totalPages": 96,
        "totalItems": 96,
        "contents": [
            {
                "channelId": 3042405,
                "channelPasswd": "xxxxx",
                "name": "测试中英文复制1",
                "publisher": "sadman",
                "startTime": 1635652800000,
                "splashImg": "https://liveimages.videocc.net/uploaded/images/2021/09/g2bpwvlg83.jpeg",
                "desc": "<p>JAVA大师无延迟直播课-纯视频</p>",
                "watchStatus": "waiting",
                "watchStatusText": "等待中",
                "pageView": 10,
                "watchUrl": "https://live.polyv.cn/watch/3042405"
            }
        ]
    },
    "success": true
}

异常示例

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