跳到主要内容

设置白名单服务开关

为指定单个或多个用户开启用户白名单服务。开启用户白名单服务后，黑名单功能不再生效。

开启服务后，可通过「添加白名单」接口功能为启用服务的用户设置白名单用户列表。

提示
  • 当前接口仅为指定用户启用白名单服务。如果您需要 App Key 下所有用户均启用白名单服务，您可以在融云控制台，通过应用配置>IM 服务>免费基础功能>单群聊>单聊用户白名单，为 App Key 下所有用户均启用单聊用户白名单。注意：如果为 App Key 全部用户开启白名单服务，所有用户的黑名单服务失效。
  • 如果 App Key 启用了单聊用户白名单服务，无法通过当前接口将指定单个或多个用户切换为用户黑名单服务。
  • 用户白名单人数存在上限。详见 IM 尊享版、IM 旗舰版功能对照表。

请求方法​

POST： https://数据中心域名/user/whitesetting/set.json

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

频率限制： 每秒钟限 100 次

正文参数​

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

参数类型必传说明
userIdString[]是用户 ID，最多设置 20 个。
whiteSettingInt是状态，1 为开启白名单、0 为开启黑名单，默认为黑名单。

请求示例​

POST /user/whitesetting/set.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=98&userId=99&whiteSetting=0

返回结果​

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

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

返回结果示例​

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

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