全部文档

更新时间: 2021-03-08

# 功能描述

限制用户之间发送消息，例如：用户 A 将 B 加入白名单后，用户 B 才能给 A 发送消息，针对强好友关系的应用场景可使用此功能。可提交工单 (opens new window)申请开通用户白名单功能

1、用户白名单服务与用户黑名单服务不能同时使用，融云默认开启的是用户黑名单服务。

2、建立用户白名单关系同时，需要在开发者应用服务器维护一份用户白名单关系，以方便对业务数据的处理。

3、如果客户之前使用了黑名单功能，开通白名单功能后，黑名单功能不再生效，但原黑名单中设置的信息不会丢失，开发者切换回黑名单功能时，原黑名单设置仍然生效。

# 实现方法

# 添加白名单
# 功能接口

请求地址： https://数据中心域名/user/whitelist/add.json

请求方法： POST

调用频率： 每秒钟限 100 次

签名规则： 所有请求融云服务端 API 接口的请求均需要进行规则校验，详细请参考 通用 API 接口签名规则

# 输入参数
参数 类型 必传 说明
userId String 是 用户 Id。
whiteUserId String 是 被添加的用户 Id，每次最多添加 20 个用户。
# 返回结果
返回值 返回类型 说明
code Int 返回码，200 为正常。
# 代码示例

Request：

POST /user/whitelist/add.json HTTP/1.1
Host: api-cn.ronghub.com
App-Key: uwd1c0sxdlx2
Nonce: 14314
Timestamp: 1408710653491
Signature: 45beb7cc7307889a8e711219a47b7cf6a5b000e8
Content-Type: application/x-www-form-urlencoded

userId=7&whiteUserId=123&whiteUserId=1456

已复制
1
2
3
4
5
6
7
8
9

Response：

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

{"code":200}

已复制
1
2
3
4
# 移除白名单
# 功能接口

请求地址： https://数据中心域名/user/whitelist/remove.json

请求方法： POST

调用频率： 每秒钟限 100 次

签名规则： 所有请求融云服务端 API 接口的请求均需要进行规则校验，详细请参考 通用 API 接口签名规则

# 输入参数
参数 类型 必传 说明
userId String 是 用户 Id。
whiteUserId String 是 被移除的用户 Id，每次最多移除 20 个用户。
# 返回结果
返回值 返回类型 说明
code Int 返回码，200 为正常。
# 代码示例

Request：

POST /user/whitelist/remove.json HTTP/1.1
Host: api-cn.ronghub.com
App-Key: uwd1c0sxdlx2
Nonce: 14314
Timestamp: 1408710653491
Signature: 45beb7cc7307889a8e711219a47b7cf6a5b000e8
Content-Type: application/x-www-form-urlencoded

userId=7&whiteUserId=123&whiteUserId=1456

已复制
1
2
3
4
5
6
7
8
9

Response：

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

{"code":200}

已复制
1
2
3
4
# 查询白名单
# 功能接口

请求地址： https://数据中心域名/user/whitelist/query.json

请求方法： POST

调用频率： 每秒钟限 100 次

签名规则： 所有请求融云服务端 API 接口的请求均需要进行规则校验，详细请参考 通用 API 接口签名规则

# 输入参数
参数 类型 必传 说明
userId String 用户 Id。
# 返回结果
返回值 返回类型 说明
code Int 返回码，200 为正常。
users String[] 白名单用户数组。
# 代码示例

Request：

POST /user/whitelist/query.json HTTP/1.1
Host: api-cn.ronghub.com
App-Key: uwd1c0sxdlx2
Nonce: 14314
Timestamp: 1408710653491
Signature: 45beb7cc7307889a8e711219a47b7cf6a5b000e8
Content-Type: application/x-www-form-urlencoded

userId=jlk456j5

已复制
1
2
3
4
5
6
7
8
9

Response：

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

{"code":200,"users":["jlk454","jlk457"]}

已复制
1
2
3
4

文档是否解决您的问题 ?

如果遇到产品相关问题，您可 提交工单 寻求帮助