接口URL
http://api.polyv.net/live/v3/channel/detail/get-channel-roomIds
接口说明
(接口调用有频率限制,详细请查看)
1、获取频道分房间列表信息
2、接口支持https
返回结果支持格式
JSON
请求方式
GET
请求数限制
TRUE
请求参数
参数名 | 必选 | 类型 | 说明 |
---|---|---|---|
appId | 是 | string | 从API设置中获取,在直播系统登记的appId |
timestamp | 是 | long | 当前13位毫秒级时间戳,3分钟内有效 |
sign | 是 | string | 签名,为32位大写的MD5值 |
channelId | 是 | int | 频道号 |
响应成功JSON示例:
{
"code": 200,
"status": "success",
"message": "",
"data": {
"roomIds": [
"157468201",
"157468202"
]
}
}
响应失败JSON示例:
未输入appId
{
"code": 400,
"status": "error",
"message": "appId is required.",
"data": ""
}
appId不正确
{
"code": 400,
"status": "error",
"message": "application not found.",
"data": ""
}
时间戳错误
{
"code": 400,
"status": "error",
"message": "invalid timestamp.",
"data": ""
}
签名错误
{
"code": 403,
"status": "error",
"message": "invalid signature.",
"data": ""
}
非法频道
{
"code": 403,
"status": "error",
"message": "illegal channel id: 1779742",
"data": ""
}
字段说明
参数名 | 类型 | 说明 |
---|---|---|
code | int | 响应代码,成功为200,失败为400,签名错误为401,异常错误500 |
status | string | 成功为success,失败为error |
message | string | 错误时为错误提示消息 |
data | object | 响应结果集 |
roomIds | array | 频道分房间的房间号列表 |
Java请求示例
public static void main(String[] args) {
String url = "http://api.polyv.net/live/v3/channel/detail/get-channel-roomIds";
// 用户对应的appId和加密串
String appId = "xxxxxxxxx";
String appSecret = "xxxxxxxxxxxxxxxxxxxxxxxxxx";
Map<String, String> params = new HashMap<>();
params.put("channelId", "0000000");
PolyvTool.setLiveSign(params, appId, appSecret);
// 调用Polyv的httpClient工具类发送请求
String content = HttpClientUtil.getInstance()
.sendHttpGet(url + "?" + PolyvTool.mapJoinNotEncode(params));
System.out.println(content);
}
签名规则(PolyvTool.java文件代码查看)
https://dev.polyv.net/2020/liveproduct/l-api/rule/live-api-java-detail/