跳到主要内容

加入聊天室全体禁言白名单

添加一个或多个聊天室成员到指定聊天室的全体成员禁言白名单。

  • 加入聊天室的禁言白名单后，在聊天室已被设置为全体禁言时，该成员仍可通过客户端 SDK 往该聊天室发送消息。
  • 在白名单的用户如果主动退出聊天室或因封禁退出聊天室，再次加入时，白名单状态仍然有效。
  • 聊天室销毁后再创建，原白名单状态自动失效。

禁言白名单服务与其他禁言功能关系说明：

  • 聊天室单人禁言不影响白名单生效。即使用户已在聊天室中被设置了单人禁言，在用户添加到禁言白名单后，即可通过客户端 SDK 往聊天室中发送消息。
  • 聊天室全局禁言影响白名单功能生效。如果出现将该用户添加到禁言白名单，该用户仍无法通过客户端 SDK 往聊天室中发送消息的情况，可检查该用户是否已被设置为 App Key 下所有聊天室中禁言。
提示

服务端（Server API）发送聊天室消息的接口不受聊天室全体成员禁言状态的限制，被禁言用户可通过 Server API 往该聊天室中发送消息。

请求方法​

POST： https://数据中心域名/chatroom/user/ban/whitelist/add.json

频率限制： 每秒钟限 100 次

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

正文参数​

HTTP 请求正文数据格式为 application/x-www-form-urlencoded，支持以下 HTTP 表单参数：

参数类型必传说明
chatroomIdString是聊天室 ID
userIdString是需要添加到白名单中的用户 ID，白名单中用户上限为 20 个，支持批量添加，单次添加上限不超过 20 个。
extraString否通知携带的 JSON 格式的扩展信息，仅在 needNotify 为 true 时有效。
needNotifyBoolean否是否通知成员。默认 false 不通知。如果为 true，客户端会触发相应回调方法（要求 Android/iOS IMLib ≧ 5.4.5；Web IMLib ≧ 5.7.9）。通知范围：指定聊天室中所有成员。

请求示例​

HTTP
POST /chatroom/user/ban/whitelist/add.json HTTP/1.1
Host: api.rong-api.com
App-Key: uwd1c0sxdlx2
Nonce: 14314
Timestamp: 1408710653491
Signature: 45beb7cc7307889a8e711219a47b7cf6a5b000e8
Content-Type: application/x-www-form-urlencoded

chatroomId=LoDld8izA&userId=uu1&userId=uu2

返回结果​

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

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

返回结果示例​

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

{"code":200}