接口URL
https://api.polyv.net/live/v3/channel/chat/banned-user
接口说明
(接口调用有频率限制，详细请查看)
1、根据登录聊天室的userId禁言、解禁用户
2、接口支持https协议
返回结果支持格式
JSON
请求方式
POST
请求数限制
TRUE
请求参数
| 参数名 | 必选 | 类型 | 说明 |
|---|---|---|---|
| appId | 是 | string | 从API设置中获取，在直播系统登记的appId |
| timestamp | 是 | string | 当前13位毫秒级时间戳，3分钟内有效 |
| sign | 是 | string | 签名，32位大写MD5值 |
| channelId | 是 | int | 频道号 |
| userIds | 是 | string | 聊天室用户ID（非直播账号ID），多个用户用半角逗号,隔开 |
| toBanned | 否 | string | Y表示禁言，N表示解除禁言 |
响应成功JSON示例：
{
"code": 200,
"status": "success",
"message": "",
"data": "SUCCESS"
}
响应失败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: %s",
"data": ""
}
频道号不能为空
{
"code": 400,
"status": "error",
"message": "param should not be empty: %s",
"data": ""
}
用户ID不能为空
{
"code": 400,
"status": "error",
"message": "param should not be empty: %s",
"data": ""
}
字段说明
| 参数名 | 说明 |
|---|---|
| code | 请求状态响应码 |
| status | 请求状态 |
| message | 错误信息 |
| data | 响应数据 |
Java请求示例
@Test
public void testBannedChatUser() {
String url = "https://api.polyv.net/live/v3/channel/chat/banned-user";
// appId和加密串
String appId = "xxxxxxxxxx";
String appSecret = "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx";
int channelId = 1234567;
Map<String, String> params = new HashMap<>();
params.put("channelId", String.valueOf(channelId));
params.put("userIds", "xxxxxxxx,yyyyyyy");
params.put("toBanned", "Y");
// 调用Polyv的工具类方法设置sign
PolyvTool.setLiveSign(params, appId, appSecret);
String content = HttpClientUtil.getInstance().sendHttpPost(url, params);
System.out.println(content);
}
签名规则(PolyvTool.java文件代码查看)
https://dev.polyv.net/2020/liveproduct/l-api/rule/live-api-java-detail/
Loading...
