全平台封禁用户列表

接口描述

1、全平台（账号下）封禁的聊天室用户列表（包括禁言、踢人等）
2、接口支持https协议

接口URL

http://api.polyv.net/live/v4/chat/forbid/list

在线API调用

请求方式

GET

接口约束

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

请求参数描述

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

示例

http://api.polyv.net/live/v4/chat/forbid/list?appId=fso8gzbxlr&timestamp=1621675923000&pageNumber=1&pageSize=10&sign=88929522E99A082046519B7CF264D76C

响应参数描述

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

data字段说明

参数名	类型	说明
pageNumber	Integer	当前页码
pageSize	Integer	分页记录数
totalItems	Integer	总页数
contents	Array	封禁（包括禁言、踢人）用户列表

contents字段说明

参数名	类型	说明
nickName	String	用户昵称
viewerId	String	用户ID
banned	String	是否被禁言，Y是，N不是
kicked	String	是否被踢人，Y是，N不是
operationTime	Long	操作的时间戳（13位）

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 testForbidUserList() 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/forbid/list";
		String page = String.valueOf(1);
		String size = String.valueOf(10);
    
        //http 调用逻辑
        Map<String,String> requestMap = new HashMap<>();
        requestMap.put("appId", appId);
        requestMap.put("timestamp",timestamp);
        requestMap.put("pageNumber",page);
        requestMap.put("pageSize",size);
        requestMap.put("sign",LiveSignUtil.getSign(requestMap, appSecret));
        String response = HttpUtil.get(url, requestMap);
        log.info("查询全平台封禁用户列表接口返回值：{}",response);

}

响应示例

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

成功示例

{
    "code": 200,
    "status": "success",
    "message": "",
    "data": {
        "pageSize": 10,
        "pageNumber": 1,
        "totalItems": 2,
        "contents": [
          {
            "nickName": "造数据用户3328",
            "viewerId": "618948782650200",
            "operationTime": 1693980442776,
            "banned": "Y",
            "kicked": "Y"
          },
          {
            "nickName": "数字房间号-造数据用户3364",
            "viewerId": "618964027359200",
            "operationTime": 1693980442771,
            "banned": "Y",
            "kicked": "Y"
          }
        ]
    }
}

异常示例

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