跳到主要内容

全局禁言用户

聊天室业务支持将指定用户在应用下的所有聊天室中禁言,支持设置禁言时长。

在禁言时间段内,被禁言用户在应用下的所有聊天室中都无法通过客户端 SDK 发送消息。

开通服务

使用聊天室全局禁言功能前,请确认已为当前 App Key 开通相关服务。

如未开通服务,Server API 将返回 1009 错误。注意,在未开通服务时,如果连续请求导致 API 请求频率超过限制,Server API 会返回 HTTP 429 Too Many Requests 错误(错误码为 1008)。

请求方法

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

频率限制: 每秒钟限 100 次

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

正文参数

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

参数类型必传说明
userIdString用户 ID,可同时禁言多个用户,每次最多不超过 20 个。
minuteString禁言时长,以分钟为单位,最大值为 43200 分钟。
extraString通知携带的 JSON 格式的扩展信息,仅在 needNotifytrue 时有效。
needNotifyboolean是否通知成员。默认 false 不通知。如果为 true,客户端会触发相应回调方法(要求 Android/iOS IMLib ≧ 5.4.5;Web IMLib ≧ 5.7.9)。通知范围:被禁言用户。

请求示例

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

userId=2582&userId=2583&minute=1

返回结果

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

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

返回结果示例

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

{"code":200}