查询频道列表

接口描述

1、根据分类id和频道名称查询频道号列表
2、接口支持https协议

接口URL

http://api.polyv.net/live/v3/user/channels

在线API调用

请求方式

GET

接口约束

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

请求参数描述

参数名	必选	类型	说明
appId	true	String	账号appId【详见获取密钥】
timestamp	true	Long	当前13位毫秒级时间戳，3分钟内有效
sign	true	String	签名，为32位大写的MD5值,生成签名的appSecret密钥作为通信数据安全的关键信息，严禁保存在客户端直接使用，所有API都必须通过客户自己服务器中转调用POLYV服务器获取响应数据【详见签名生成规则】
categoryId	false	String	返回指定分类ID下的频道号列表；不传，返回账号下所有的频道列表
keyword	false	String	频道名称，模糊查询
labelId	false	String	标签id

示例

http://api.polyv.net/live/v3/user/channels?appId=frlr1zazn3&sign=D673B99508C8B99202D52A10FA77D091&keyword=%E8%AE%A8%E8%AE%BA&categoryId=340019&labelId=zpmz3640wkxpj267&timestamp=1621841285162

响应参数描述

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

Data参数描述

参数名	类型	说明
channels	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 testChannels() 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/user/channels";
    String categoryId="340019";
    String keyword="讨论";
    String labelId = "zpmz3640wkxpj267";

    //http 调用逻辑
    Map<String, String> requestMap = new HashMap<>();
    requestMap.put("appId", appId);
    requestMap.put("timestamp", timestamp);
    requestMap.put("categoryId", categoryId);
    requestMap.put("labelId", labelId);
    requestMap.put("keyword", keyword);
    requestMap.put("sign", LiveSignUtil.getSign(requestMap, appSecret));
    String response = HttpUtil.get(url, requestMap);
    log.info("测试查询频道列表，返回值：{}", response);
    //do somethings

}

响应示例

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

成功示例

{
    "code":200,
    "status":"success",
    "message":"",
    "data":{
        "channels":[
            2139283,
            2139268
        ]
    }
}

异常示例

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