保利威文档中心

帮助中心

直播服务端 API

查询频道踢人列表

更新时间：2022-09-02 18:08:07

接口描述

1、通过频道号，查询踢人列表
2、接口支持https协议

接口URL

http://api.polyv.net/live/v3/channel/chat/list-kicked

在线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 频道号

示例

http://api.polyv.net/live/v3/channel/chat/list-kicked

表单参数：

appId=frlr1zazn3&sign=815A35BC0A4666E4BC14FB04A8C55D82&channelId=2191569&timestamp=1616640471944

响应参数描述

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

data字段说明

参数名 类型 说明
banned Boolean 是否禁言
channelId String 频道号
clientIp String 用户ip
nick String 昵称
param4 String 自定义参数param4
pic String 头像图片地址
roomId String 房间号
uid String 聊天室socketid
userId String 用户userId
userType String 用户身份
manager：管理员
teacher：讲师
assistant：助教
guest：嘉宾
viewer：参与者
slice/student：观看者

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 testGetChannelKickedUserList() throws IOException, NoSuchAlgorithmException {
        //公共参数,填写自己的实际参数
        String appId = super.appId;
        String appSecret = super.appSecret;
        String timestamp = String.valueOf(System.currentTimeMillis());

        //业务参数
        String url = "http://api.polyv.net/live/v3/channel/chat/list-kicked";
        String channelId = "2191569";

        //http 调用逻辑
        Map<String,String> requestMap = new HashMap<>();
        requestMap.put("appId", appId);
        requestMap.put("timestamp",timestamp);
        requestMap.put("channelId",channelId);
        requestMap.put("sign",LiveSignUtil.getSign(requestMap, appSecret));
        String response = HttpUtil.postFormBody(url, requestMap);
        log.info("测试查询频道踢人列表接口返回值：{}",response);

}

响应示例

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

成功示例
{
  "code": 200,
  "status": "success",
  "message": "",
  "data": [
    {
      "banned": true,
      "channelId": "2191569",
      "clientIp": "59.41.20.74",
      "nick": "卉",
      "param4": "oi_ubswUnFt8QQFAAEJbKmd8W9BE",
      "pic": "https://thirdwx.qlogo.cn/mmopen/vi_32/3lMXVJoLMLJibnkFuA23lyqj5MOQufhW5ATvHuB8byssutficHKU0u7OMx5OQgg9WNVuHf44AXfbAMMAZejuYFTg/132",
      "roomId": "2191569",
      "uid": "xw5hNBg77lGOcx5fADoX",
      "userId": "ovtl9t_RxnrTdqkXqkT5Q5lnxp2A",
      "userType": "slice"
    }
  ]
}
异常示例
{
  "code": 400,
  "status": "error",
  "message": "invalid signature.",
  "data": ""
}
联系客服，在线咨询