更新时间: 2021-04-01
# 功能描述
提供聊天室全局禁言功能，被禁言用户在应用下的所有聊天室中都无法发送消息。如需要使用此功能，开发者可在开发者后台IM 商用版-增值服务 (opens new window)中开通。
# 添加禁言成员
# 功能接口
请求地址： https://数据中心域名/chatroom/user/ban/add.json
请求方法： POST
调用频率： 无限制
签名规则： 所有请求融云服务端 API 接口的请求均需要进行规则校验，详细请参考 通用 API 接口签名规则
# 输入参数
| 参数 | 类型 | 必传 | 说明 |
|---|---|---|---|
| userId | String | 是 | 用户 Id，可同时禁言多个用户，每次最多不超过 20 个。 |
| minute | String | 是 | 禁言时长，以分钟为单位，最大值为 43200 分钟。 |
# 返回结果
| 返回值 | 返回类型 | 说明 |
|---|---|---|
| code | Int | 返回码，200 为正常。 |
# 示例代码
Request：
POST /chatroom/user/ban/add.json HTTP/1.1 Host: api-cn.ronghub.com App-Key: uwd1c0sxdlx2 Nonce: 14314 Timestamp: 1408710653491 Signature: 45beb7cc7307889a8e711219a47b7cf6a5b000e8 Content-Type: application/x-www-form-urlencoded userId=2582&userId=2583&minute=1已复制
1
2
3
4
5
6
7
8
9
2
3
4
5
6
7
8
9
Response：
HTTP/1.1 200 OK Content-Type: application/json; charset=utf-8 {"code":200}已复制
1
2
3
4
2
3
4
# 移除禁言成员
# 功能接口
请求地址： https://数据中心域名/chatroom/user/ban/remove.json
请求方法： POST
调用频率： 无限制
签名规则： 所有请求融云服务端 API 接口的请求均需要进行规则校验，详细请参考 通用 API 接口签名规则
# 输入参数
| 参数 | 类型 | 必传 | 说明 |
|---|---|---|---|
| userId | String | 是 | 用户 Id，可同时移除多个用户，每次最多不超过 20 个。 |
# 返回结果
| 返回值 | 返回类型 | 说明 |
|---|---|---|
| code | Int | 返回码，200 为正常。 |
# 示例代码
Request：
POST /chatroom/user/ban/remove.json HTTP/1.1 Host: api-cn.ronghub.com App-Key: uwd1c0sxdlx2 Nonce: 14314 Timestamp: 1408710653491 Signature: 45beb7cc7307889a8e711219a47b7cf6a5b000e8 Content-Type: application/x-www-form-urlencoded userId=2582已复制
1
2
3
4
5
6
7
8
9
2
3
4
5
6
7
8
9
Response：
HTTP/1.1 200 OK Content-Type: application/json; charset=utf-8 {"code":200}已复制
1
2
3
4
2
3
4
# 获取禁言成员
# 输入参数
无
# 返回结果
| 返回值 | 返回类型 | 说明 |
|---|---|---|
| code | Int | 返回码，200 为正常。 |
| users | String | 被禁言用户数组。 |
| time | String | 解禁时间。 |
| userId | String | 被禁言用户 Id。 |
# 示例代码
请求地址： https://数据中心域名/chatroom/user/ban/query.json
请求方法： POST
调用频率： 无限制
签名规则： 所有请求融云服务端 API 接口的请求均需要进行规则校验，详细请参考 通用 API 接口签名规则
Request：
POST /chatroom/user/ban/query.json HTTP/1.1 Host: api-cn.ronghub.com App-Key: uwd1c0sxdlx2 Nonce: 14314 Timestamp: 1408710653491 Signature: 45beb7cc7307889a8e711219a47b7cf6a5b000e8 Content-Type: application/x-www-form-urlencoded已复制
1
2
3
4
5
6
7
2
3
4
5
6
7
Response：
HTTP/1.1 200 OK Content-Type: application/json; charset=utf-8 { "code":200, "users":[{ "time":"2015-09-25 16:12:38", "userId":"2582" }] }已复制
1
2
3
4
5
6
7
8
9
10
2
3
4
5
6
7
8
9
10