禁言指定聊天室用户

聊天室业务支持禁言用户功能，可设置指定的一个或多个用户在指定聊天室中禁言。App 可使用该功能禁言 App 业务中的聊天室成员，被禁言用户可以接收查看聊天室中其他用户聊天信息，但不能发送消息。

用户退出聊天室不会使禁言状态失效。

提示

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

请求方法

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

频率限制： 每秒钟限 100 次

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

正文参数

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

参数	类型	必传	说明
userId	String	是	用户 ID，可同时禁言多个用户，最多不超过 20 个。
chatroomId	String	是	聊天室 ID。
minute	String	是	禁言时长，以分钟为单位，最大值为 43200 分钟。
extra	String	否	通知携带的 JSON 格式的扩展信息，仅在 needNotify 为 true 时有效。
needNotify	boolean	否	是否通知成员。默认 false 不通知。如果为 true，客户端会触发相应回调方法（要求 Android/iOS IMLib ≧ 5.4.5；Web IMLib ≧ 5.7.9）。通知范围：指定聊天室中所有成员。

请求示例

POST /chatroom/user/gag/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

userId=2583&userId=2582&chatroomId=16&minute=1

返回结果

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

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

返回结果示例

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

{"code":200}