频道内踢人

接口描述

1、通过登录聊天室的userId，频道内踢出用户
2、接口支持https协议

接口URL

http://api.polyv.net/live/v4/chat/channel/forbid/kick-users

在线API调用

请求方式

POST

接口约束

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

请求参数描述

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

请求体参数描述

参数名	必选	类型	说明
viewerIds	true	Array	需要踢人的用户ID列表
nickNames	true	Array	需要踢人的用户ID列表对应的用户昵称列表，跟viewerIds一一对应

示例

http://api.polyv.net/live/v4/chat/channel/forbid/kick-users

表单参数：

appId=frlr1zazn3&sign=19E2B706E637BDDD0AC6865DA8E1FF8E&timestamp=1621843261592&channelId=1003

请求体json参数：

{
  "viewerIds":["20230907_2","20230907_1"],
  "nickNames":["22","11"]
}

响应参数描述

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

Java请求示例

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

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

private static final Logger log = LoggerFactory.getLogger(ChatBannedTest.class);
/**
 * 聊天室针对频道踢人
 * @throws IOException
 */
@Test
public void testForbidChannelKickUsers() 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/chat/channel/forbid/kick-users";

        //http 调用逻辑
        Map<String, String> requestMap = new HashMap<>();
        requestMap.put("appId", appId);
        requestMap.put("timestamp", timestamp);

        requestMap.put("sign", LiveSignUtil.getSign(requestMap, appSecret));
        requestMap.put("channelId", "1003");

        String body = "{ \"viewerIds\":[\"20230907_2\",\"20230907_1\"],\"nickNames\":[\"22\",\"11\"]}";
        url = HttpUtil.appendUrl(url, requestMap);
        String response = HttpUtil.postJsonBody(url,body,null);

        log.info("测试聊天室频道踢人接口，返回值：{}", response);
        //do somethings

}

响应示例

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

成功示例

{
  "code": 200,
  "status": "success",
  "message": "",
  "data": "SUCCESS"
}

异常示例

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