跳到主要内容

设置聊天室全体禁言

聊天室业务支持全体禁言功能。通过调用本接口，您可以将指定聊天室加入服务端的全体禁言列表，实现以下效果：

  • 全局限制：启用后，该聊天室所有成员无法通过客户端 SDK 往聊天时发送消息。
  • 例外处理：通过设置聊天时全体禁言白名单允许特定用户发言。
  • 自动清理：聊天室解散时自动解除全体禁言状态。
服务端特权

通过 Server API 发送的消息不受禁言限制，被禁言用户仍可通过此方式发言

版本兼容性

通知功能需要客户端 SDK 满足最低版本要求：

  • Android/iOS IMLib ≥ 5.4.5
  • Web IMLib ≥ 5.7.9

请求方法​

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

频率限制： 每秒钟限 100 次

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

正文参数​

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

参数类型必传说明
chatroomIdString是需要全体禁言的聊天室 ID。
extraString否通知携带的 JSON 格式的扩展信息，仅在 needNotify 为 true 时有效。
needNotifyboolean否是否通知成员。默认 false 不通知。如果为 true，客户端会触发相应回调方法（要求 Android/iOS IMLib ≧ 5.4.5；Web IMLib ≧ 5.7.9）。通知范围为指定聊天室中的所有成员。

请求示例​

HTTP
POST /chatroom/ban/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=123

返回结果​

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

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

返回结果示例​

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

{"code":200}
最后于 更新