设置聊天室全体禁言
聊天室业务支持将聊天室成员全体禁言。App 可以调用该 API,将指定的聊天室加入服务端的全体禁言聊天室列表。
- 将聊天室加入全体禁言列表后,聊天室全体禁言立即生效。该聊天室的所有成员均不能通过客户端 SDK 往该聊天室内发送消息。如需允许部分例外用户,可将用户加入聊天室禁言用户白名单。详见加入聊天室全体禁言白名单。
- 如果聊天室解散,全体禁言数据会被清除。
提示
服务端(Server API)发送聊天室聊消息接口不受聊天室全体成员禁言状态的限制,被禁言用户可通过 Server API 往该聊天室中发送消息。
请求方法
POST: https://数据中心域名/chatroom/ban/add.json
频率限制: 每秒钟限 100 次
签名规则: 所有服务端 API 请求均需要进行规则校验,详见 API 请求签名。
正文参数
HTTP 请求正文数据格式为 application/x-www-form-urlencoded
,支持以下 HTTP 表单参数:
参数 | 类型 | 必传 | 说明 |
---|---|---|---|
chatroomId | String | 是 | 需要设置为禁言的聊天室 ID。 |
extra | String | 否 | 通知携带的 JSON 格式的扩展信息,仅在 needNotify 为 true 时有效。 |
needNotify | boolean | 否 | 是否通知成员。默认 false 不通知。如果为 true ,客户端会触发相应回调方法(要求 Android/iOS IMLib ≧ 5.4.5;Web IMLib ≧ 5.7.9)。通知范围:指定聊天室中所有成员。 |
请求示例
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 对象:
返回值 | 返回类型 | 说明 |
---|---|---|
code | Number | 返回码,200 为正常。 |
返回结果示例
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
{"code":200}