跳到主要内容

添加用户到黑名单

为指定用户的黑名单中添加一个或多个用户。被加入黑名单中的用户无法向当前用户发送单聊消息。

  • 黑名单服务可限制用户之间发送消息，但加入黑名单为单向操作，例如：用户 A 拉黑用户 B，代表 B 无法给 A 发消息。但 A 向 B 发消息，B 仍然能正常接收。
  • 单个用户的黑名单总人数存在上限，具体与计费套餐有关。IM 旗舰版与 IM 尊享版上限为 3000 人，其他套餐详见功能对照表中的服务限制。
  • 调用服务端 API 发送单聊消息默认不受黑名单限制。如需启用限制，请在调用相关 API 时设置 verifyBlacklist 为 1。
提示

在即时通讯服务端建立用户黑名单关系的同时，需要在自己的应用服务器维护一份用户黑名单关系，以方便自己对业务数据的处理。

请求方法​

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

频率限制： 每秒钟限 100 次

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

正文参数​

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

参数类型必传说明
userIdString是用户 ID。
blackUserIdString是被加入黑名单的用户 ID。单次可添加最多 20 个 blackUserId。单个用户的黑名单总人数存在上限，具体与计费套餐有关。IM 旗舰版与 IM 尊享版上限为 3000 人，其他套餐详见功能对照表中的服务限制。

请求示例​

POST /user/blacklist/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=jlk456j5&blackUserId=jlk454&blackUserId=jlk457

返回结果​

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

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

返回结果示例​

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

{"code":200}
最后于 更新