全部文档

( 最近更新时间:2020-04-28 19:00:00 )

# 功能描述

1、用户违反 App 中的相关规定时,开发者可根据情况对用户进行封禁处理,封禁后即刻生效,如该用户此时已经与融云保持连接,会将该用户连接断开。

2、封禁期内用户无法连接融云,无法使用 IM 服务。封禁期满后,自动解除封禁,可正常连接融云使用 IM 服务。也可以调用解除用户封禁方法。

3、封禁时间范围由开发者自行设置,以分钟为最小单位,最长封禁 30 天(43200 分钟)。

# 实现方法

# 添加封禁用户
# 功能接口

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

请求方法: POST

调用频率: 每秒钟限 100 次

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

# 输入参数
参数 类型 必传 说明
userId String 用户 Id,支持一次封禁多个用户,最多不超过 20 个。
minute Int 封禁时长,单位为分钟,最大值为 43200 分钟。
# 返回结果
返回值 返回类型 说明
code Int 返回码,200 为正常。
# 代码示例

Request:

POST /user/block.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=BWSZNmXBD&userId=jlk456j5&minute=10
已复制
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/unblock.json

请求方法: POST

调用频率: 每秒钟限 100 次

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

# 输入参数
参数 类型 必传 说明
userId String 用户 Id,支持一次解除多个用户,最多不超过 20 个。
# 返回结果
返回值 返回类型 说明
code Int 返回码,200 为正常。
# 代码示例

Request:

POST /user/unblock.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&userId=jlk45211
已复制
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
# 查询封禁用户

查询被封禁用户信息。可查询封禁用户总数,被封禁用户的用户 ID,封禁结束时间。

# 功能接口

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

请求方法: POST

调用频率: 每秒钟限 100 次

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

# 输入参数
参数 类型 必传 说明
page Int 分页获取封禁用户列表时当前页数,不传或传入 0 时不做分页处理,默认获取前 1000 个被封禁的用户列表,按封禁结束时间倒序排序。
size Int 分页获取封禁用户列表时每页行数,不传时默认为 50 条。
# 返回结果
返回值 返回类型 说明
code Int 返回码,200 为正常。
users String 被封禁用户数组。
userId String 被封禁用户 ID。
blockEndTime String 封禁结束时间。
# 代码示例

Request:

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

page=1&size=50
已复制
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":[{"userId":"jlk456j5","blockEndTime":"2015-01-11 01:28:20"}]}
已复制
1
2
3
4

# 注意事项

文档是否解决您的问题 ?

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