加入群组全体禁言白名单
将一个或多个群成员添加到指定群组的全体成员禁言白名单。
- 加入群组禁言白名单后,在群组已被设置为全体禁言时,该成员仍可通过客户端 SDK 向该群组发送消息。
- 白名单内的用户如果退出群组后再次加入,其白名单状态仍然有效。
- 群组解散后再次创建,其白名单状态仍然有效。
提示
群组单人禁言功能具有更高优先级。如果某用户已被单人禁言,即使用户已被添加到全体禁言白名单,仍无法向群组发送消息。
请求方法
POST: https://数据中心域名/group/user/ban/whitelist/add.json
频率限制: 每秒 100 次
签名规则: 所有服务端 API 请求均需要进行规则校验,详情请参阅 API 请求签名。
正文参数
HTTP 请求正文支持以下 application/x-www-form-urlencoded
表单参数:
参数 | 类型 | 必传 | 说明 |
---|---|---|---|
userId | String | 是 | 用户 ID。支持一次添加多个用户,最多不超过 20 个。 |
groupId | String | 是 | 群组 ID。 |
请求示例
HTTP
POST /group/user/ban/whitelist/add.json HTTP/1.1
Host: api.rong-api.com
App-Key: c9kqb3rdkbb8j
Nonce: 97
Timestamp: 1480479442
Signature: 9774e3d91656dc92df8aff294d46d6a506412538
Content-Type: application/x-www-form-urlencoded
groupId=2MqOJa1Un&userId=3212&userId=2583
返回结果
HTTP 响应正文包含具有以下结构的 JSON 对象:
返回值 | 返回类型 | 说明 |
---|---|---|
code | Number | 返回码,200 表示请求成功。 |
返回结果示例
HTTP
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
{"code":200}