封禁用户
对 App 用户进行封禁处理,一般用于 App 用户违规情形。
- 封禁时必须设置封禁时间范围,以分钟为最小单位,最长封禁 30 天(43200 分钟)。
- 不支持永久封禁。
- 封禁期满后,自动解除封禁。也可以主动调用解除封禁方法进行解封。
封禁指定的单个或多个用户。封禁操作即刻生效,影响如下:
- 如果被封禁用户此时已经与即时通讯服务保持连接,封禁后会即时断开该用户的 IM 连接。
- 被封禁用户无法与即时通讯服务建立 IM 连接,无法主动使用 IM 服务。
- 被 封禁期间,其他用户可向被封禁用户发送消息,但被封禁用户无法接收消息,无法收到推送通知。解封后用户可正常连接并使用即时通讯服务,再次上线可以收到被封禁期间的离线消息?。请注意,离线消息最长存储 7 天,如果 7 天内客户端都没有上线,服务端将抛弃掉过期的消息。
请求方法
POST: https://数据中心域名/user/block.json
频率限制: 每秒钟限 100 次
签名规则: 所有服务端 API 请求均需要进行规则校验,详见 API 请求签名。
正文参数
HTTP 请求正文数据格式为 application/x-www-form-urlencoded
,支持以下 HTTP 表单参数:
参数 | 类型 | 必传 | 说明 |
---|---|---|---|
userId | String | 是 | 用户 ID,支持一次封禁多个用户,最多不超过 20 个。 |
minute | Number | 是 | 封禁时长,单位为分钟,最大值为 43200 分钟。 |
请求示例
POST /user/block.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=BWSZNmXBD&userId=jlk456j5&minute=10
返回结果
HTTP 响应正文包含具有以下结构的 JSON 对象:
返回值 | 返回类型 | 说明 |
---|---|---|
code | Number | 返回码,200 为正常。 |
返回结果示例
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
{"code":200}