跳到主要内容

封禁聊天室用户

聊天室业务支持封禁用户功能,支持在指定聊天室中封禁一个或多个用户。

  • 被封禁时,如果用户如在聊天室中,将立即被踢出该聊天室。
  • 被封禁用户在封禁时间内不能加入此聊天室。

请求方法

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

频率限制: 每秒钟限 100 次

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

正文参数

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

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

请求示例

POST /chatroom/user/block/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 对象:

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

返回结果示例

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

{"code":200}