# 查询账号禁言列表

### 接口描述

```
1、通过账号下的禁言列表
2、接口支持https协议

```

### 接口URL

```
http://api.polyv.net/live/v3/user/chat/banned-user/list
```

[在线API调用](https://git.polyv.net/help-center/document-center/-/blob/master/req.html?api=http:/api.polyv.net/live/v3/user/chat/banned-user/list/README.md)

### 请求方式

```
GET
```

### 接口约束

1、接口同时支持HTTP 、HTTPS ，建议使用HTTPS 确保接口安全，接口调用有频率限制，[详细请查看](https://git.polyv.net/help-center/document-center/-/blob/master/live/api/limit/README.md)

### 请求参数描述

| 参数名       | 必选    | 类型      | 说明                                                                                                                                                                                                        |
| --------- | ----- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| appId     | true  | String  | 账号appId【详见[获取密钥](https://git.polyv.net/help-center/document-center/-/blob/master/live/api/getSecretKey/README.md)】                                                                                        |
| timestamp | true  | Long    | 当前13位毫秒级时间戳，3分钟内有效                                                                                                                                                                                        |
| sign      | true  | String  | 签名，为32位大写的MD5值,`生成签名的appSecret密钥作为通信数据安全的关键信息，严禁保存在客户端直接使用，所有API都必须通过客户自己服务器中转调用POLYV服务器获取响应数据`【详见[签名生成规则](https://git.polyv.net/help-center/document-center/-/blob/master/live/api/buildSign/README.md)】 |
| page      | false | Integer | 分页页码，默认1                                                                                                                                                                                                  |
| size      | false | Integer | 分页大小，默认10，最大1000                                                                                                                                                                                          |

### 示例

```requestUrl
http://api.polyv.net/live/v3/user/chat/banned-user/list?appId=fso8gzbxlr&timestamp=1621675923000&page=1&size=10&sign=88929522E99A082046519B7CF264D76C
```

### 响应参数描述

| 参数名     | 类型      | 说明                                                                                                                                                                            |
| ------- | ------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| code    | Integer | 响应状态码，200为成功返回，非200为失败【详见[全局错误说明](https://git.polyv.net/help-center/document-center/-/blob/master/live/api/errorInfo/README.md)】                                              |
| status  | String  | 响应状态文本信息                                                                                                                                                                      |
| message | String  | 响应描述信息，当code为400或者500的时候，辅助描述错误原因                                                                                                                                             |
| data    | Array   | 禁言数据 【详见[data字段说明](https://git.polyv.net/help-center/document-center/-/blob/master/live/api/chat/banned/get_user_banned_list.md?id=data%E5%AD%97%E6%AE%B5%E8%AF%B4%E6%98%8E)】 |

#### data字段说明

| 参数名        | 类型      | 说明       |
| ---------- | ------- | -------- |
| pageNumber | Integer | 当前页码     |
| pageSize   | Integer | 分页记录数    |
| totalItems | Integer | 总页数      |
| contents   | Array   | 禁言用户ID列表 |

### Java请求示例

快速接入基础代码请下载相关依赖源码， [点击下载源代码](https://git.polyv.net/help-center/document-center/-/blob/master/third_res/util.zip) ,下载后加入到自己的源码工程中即可。测试用例中的**HttpUtil.java 和 LiveSignUtil.java** 都包含在下载文件中。

> 强烈建议您使用[直播Java SDK](https://git.polyv.net/help-center/document-center/-/blob/master/live/java/README.md)完成API的功能对接，直播Java SDK 对API调用逻辑、异常处理、数据签名、HTTP请求线程池进行了统一封装和优化。

```java
private static final Logger log = LoggerFactory.getLogger(ChatBannedTest.class);

/**
 * 查询账号禁言列表
 * @throws IOException
 */
@Test
public void testUserBannedList() 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/user/chat/banned-user/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("page",page);
        requestMap.put("size",size);
        requestMap.put("sign",LiveSignUtil.getSign(requestMap, appSecret));
        String response = HttpUtil.get(url, requestMap);
        log.info("查询账号禁言列表接口返回值：{}",response);

}

```

### 响应示例

系统全局错误说明详见[全局错误说明](https://git.polyv.net/help-center/document-center/-/blob/master/live/api/errorInfo/README.md)

**成功示例**

```json
{
    "code": 200,
    "status": "success",
    "message": "",
    "data": {
        "pageSize": 10,
        "pageNumber": 2,
        "totalItems": 13,
        "contents": [
            "bannedVierId9",
            "bannedVierId12",
            "bannedViwerId11,bannedViwerId12"
        ]
    }
}
```

**异常示例**

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