跳到主要内容

加入超级群全体禁言白名单

App 可以添加一个或多个超级群成员到指定超级群（或频道）的禁言白名单。

在对 App 下的超级群或指定频道设置全体禁言后，可能需要允许部分用户通过客户端往群组或频道中发送消息。较简单的实现方式是设置对应级别的白名单，如下：

  • 设置超级群全体禁言后，如希望允许用户往群组中发送消息，可将该用户加入超级群的白名单。
  • 设置超级群频道全体禁言后，如希望允许用户往该频道发送消息，可将该用户加入该频道的白名单。
提示
  • 在白名单的用户如果退出超级群，再次加入，白名单状态仍然有效。
  • 超级群解散再创建，白名单状态仍然有效。

请求方法​

POST： https://数据中心域名/ultragroup/banned/whitelist/add.json

频率限制： 每秒钟限 100 次

签名规则： 所有服务端 API 请求均需要进行规则校验，详见 API 请求签名。

正文参数​

HTTP 请求正文中可包含如下 HTTP 表单参数：

参数类型必传说明
groupIdString是超级群 ID。
busChannelString否频道 ID 字段。
userIdsString是用户 ID 列表（以逗号分隔的字符串）。单次请求中最多不超过 20 个用户 ID。

请求示例​

HTTP
POST /ultragroup/banned/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=abcdefg&userIds=userId_001,userId_002

返回结果​

HTTP 响应正文包含具有以下结构的 JSON 对象：

返回值返回类型说明
codeNumber返回码，200 为正常。

返回结果示例​

HTTP
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

{"code":200}

同时使用超级群单人禁言服务​

如果您的 App 业务同时使用了超级群的单人禁言功能（在群范围或频道范围禁言指定成员），注意在单人禁言范围与白名单生效的范围一致（同为群或频道）时，白名单优先生效。参见以下场景描述：

  • 情况 1：设置用户在超级群中单人禁言，如用户在全体禁言白名单中，可正常发送消息。
  • 情况 2：设置用户在超级群频道中单人禁言，如用户在频道的全体禁言白名单中，可正常发送消息。

单人禁言的范围与白名单生效的范围不一致时，超级群级别的禁言或白名单设置具有更高优先级：

  • 情况 3：设置用户在超级群中禁言，如用户仅在频道的白名单中，则不可发送消息。
  • 情况 4：设置用户在超级群频道中禁言，如用户已在超级群的全体禁言白名单中，则仍可正常发送消息。
最后于 更新