查询所有频道的缩略信息

接口描述

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

接口URL

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

请求方式

GET

接口约束

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

请求参数描述

参数名	必选	类型	说明
appId	true	String	账号appId【详见获取密钥】
timestamp	true	Long	当前13位毫秒级时间戳，3分钟内有效
sign	true	String	签名，为32位大写的MD5值,生成签名的appSecret密钥作为通信数据安全的关键信息，严禁保存在客户端直接使用，所有API都必须通过客户自己服务器中转调用POLYV服务器获取响应数据【详见签名生成规则】
page	false	Integer	页码，默认为1
pageSize	false	Integer	每页数据大小，默认每页显示20条数据
categoryId	false	String	所属分类id
watchStatus	false	String	观看页状态筛选 live：直播中 playback：回放中 end：已结束 waiting：未开始
keyword	false	String	频道名称，模糊查询

示例

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

响应参数描述

参数名	类型	说明
code	Integer	响应状态码，200为成功返回，非200为失败【详见全局错误说明】
status	String	响应状态文本信息
message	String	响应描述信息，当code为400或者500的时候，辅助描述错误原因
data	Object	响应成功时返回频道缩略信息【详见data字段说明】

Data参数描述

参数名	类型	说明
pageSize	Integer	每页显示的数据条数，默认每页显示20条数据
pageNumber	Integer	当前页
totalItems	Integer	记录的总数
contents	Array	查询的结果列表，频道基础信息【详见Contents参数描述】
startRow	Integer	当前页第一条记录在总结果集中的位置
firstPage	Boolean	是否为第一页，值为：true/false，默认为false
lastPage	Boolean	是否为最后一页，值为：true/false，默认为false
prePageNumber	Integer	上一页编号
limit	Integer	每页数量大小
nextPageNumber	Integer	下一页编号
endRow	Integer	当前页最后一条记录在总结果集中的位置
totalPages	Integer	总页数
offset	Integer	分页起始记录

Contents参数描述

参数名	类型	说明
channelId	String	频道号
name	String	频道名称
channelPasswd	String	频道密码
categoryId	String	直播分类id
scene	String	场景 alone：活动直播 ppt：三分屏 topclass：大班课 seminar：研讨会
watchStatus	String	观看页状态描述 直播中 回放中 已结束 未开始
watchStatusText	String	观看页状态 live：直播中 playback：回放中 end：已结束 waiting：未开始
sceneText	String	场景描述
watchUrl	String	观看页链接

Java请求示例

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

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

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

}

响应示例

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

成功示例

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

异常示例

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