添加用户到白名单

为指定用户设置白名单用户列表。设置后该用户只能接收到自己白名单列表中用户发送的消息。使用该接口前请确认已开启白名单服务。详见白名单服务概述。

• 单个用户的白名单总人数存在上限，具体与计费套餐有关。IM 旗舰版与 IM 尊享版上限为 3000 人，其他套餐详见功能对照表中的服务限制。
• 调用服务端 API 发送单聊消息默认不受白名单限制。如需启用限制，请在调用 API 时设置 verifyBlacklist 为 1。

请求方法

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

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

频率限制： 每秒钟限 100 次

正文参数

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

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

请求示例

POST /user/whitelist/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=7&whiteUserId=123&whiteUserId=1456

返回结果

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

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

返回结果示例

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

{"code":200}