更新时间: 2021-04-16

# 功能描述

限制用户之间发送消息,例如:用户 A 将 B 加入黑名单后,用户 B 无法向用户 A 发送消息,加入后即刻生效,应用中的每个用户都可以设置自己的黑名单列表。

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

# 实现方法

# 添加黑名单
# 功能接口

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

请求方法: POST

调用频率: 每秒钟限 100 次

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

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

Request:

POST /user/blacklist/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=jlk456j5&blackUserId=jlk454&blackUserId=jlk457
已复制
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/blacklist/remove.json

请求方法: POST

调用频率: 每秒钟限 100 次

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

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

Request:

POST /user/blacklist/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=jlk456j5&blackUserId=jlk454
已复制
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/blacklist/query.json

请求方法: POST

调用频率: 每秒钟限 100 次

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

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

Request:

POST /user/blacklist/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

文档是否解决您的问题 ?

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