更新时间: 2021-01-26

# 功能描述

1、设置某一聊天室全部成员禁言,设置后该聊天室中的所有成员都不能通过终端 SDK 发送消息。

2、如果在聊天室全部成员禁言状态下,需要某些用户可以发言时,可将此用户加入到聊天室禁言用户白名单中,聊天室销毁后白名单中用户同时删除。

3、Server API 发送的消息权限级别较高,不受禁言限制,特殊情况下可通过 Server API 发送消息。

4、聊天室禁言白名单服务对聊天室中其他逻辑说明:

  • 用户添加到白名单后,该用户在聊天室中同时设置了用户禁言,则白名单功能权限大于聊天室中成员禁言,可发送消息。

  • 设置为白名单中用户,如应用下该用户设置了聊天室全局禁言,则白名单功能不生效,用户无法在该聊天室中发送消息。

  • 白名单中用户可以被封禁踢出聊天室,再次加入聊天室时白名单状态仍然有效。

# 全体成员禁言

# 添加全体禁言

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

请求方法: POST

调用频率: 无限制

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

输入参数

参数 类型 必传 说明
chatroomId String 需要设置为禁言的聊天室 Id。

返回结果

返回值 返回类型 说明
code Int 返回码,200 为正常。

示例代码

Request:

POST /chatroom/ban/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

chatroomId=123
已复制
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://数据中心域名/chatroom/ban/rollback.json

请求方法: POST

调用频率: 无限制

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

输入参数

参数 类型 必传 说明
chatroomId String 被移除禁言的聊天室 Id

返回结果

返回值 返回类型 说明
code Int 返回码,200 为正常。

示例代码

Request:

POST /chatroom/ban/rollback.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

chatroomId=123
已复制
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://数据中心域名/chatroom/ban/query.json

请求方法: POST

调用频率: 无限制

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

输入参数

参数 类型 必传 说明
size Int 获取聊天室禁言列表的每页条数,不传时默认为 50 条,上限为 1000 条;
page Int 当前页面数,不传时默认获取第 1 页

返回结果

返回值 返回类型 说明
code Int 返回码,200 为正常。
chatroomIds String[] 被全体禁言的聊天室数组。

示例代码

Request:

POST /chatroom/ban/query.json HTTP/1.1
Host: api-cn.ronghub.com
App-Key: uwd1c0sxdlx2
Nonce: 14314
Timestamp:  1592295337000
Signature: ef03d19bb860b4e90ce7bd5f50652a744bc2ce92
Content-Type: application/x-www-form-urlencoded

size=50&page=1
已复制
1
2
3
4
5
6
7
8
9

Response:

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

{
  "code":200,
  "chatroomIds":[
    "123",
    "234"
  ]
}
已复制
1
2
3
4
5
6
7
8
9
10
# 聊天室禁言状态检查

请求地址: https://数据中心域名/chatroom/ban/check.json

请求方法: POST

调用频率: 无限制

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

输入参数

参数 类型 必传 说明
chatroomId String 要查询的聊天室 Id

返回结果

返回值 返回类型 说明
code Int 返回码,200 为正常。
status String 禁言状态,1 为全体禁言、0 为非全体禁言

示例代码

Request:

POST /chatroom/ban/check.json HTTP/1.1
Host: api-cn.ronghub.com
App-Key: uwd1c0sxdlx2
Nonce: 14314
Timestamp:  1592295337000
Signature: ef03d19bb860b4e90ce7bd5f50652a744bc2ce92
Content-Type: application/x-www-form-urlencoded

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

Response:

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

{
    "code": 200,
    "status": 0
}
已复制
1
2
3
4
5
6
7

# 全体成员禁言白名单

# 添加禁言白名单

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

请求方法: POST

调用频率: 无限制

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

输入参数

参数 类型 必传 说明
chatroomId String 聊天室 Id
userId String 需要添加到白名单中的用户 Id,白名单中用户上限为 20 个,支持批量添加,单次添加上限不超过 20 个。

返回结果

返回值 返回类型 说明
code Int 返回码,200 为正常。

示例代码

Request:

POST /chatroom/user/ban/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

chatroomId=LoDld8izA&userId=uu1&userId=uu2
已复制
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://数据中心域名/chatroom/user/ban/whitelist/rollback.json

请求方法: POST

调用频率: 无限制

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

输入参数

参数 类型 必传 说明
chatroomId String 聊天室 Id
userId String 需要移除白名单的用户 Id,支持批量添加,单次添加上限不超过 20 个。

返回结果

返回值 返回类型 说明
code Int 返回码,200 为正常。

示例代码

Request:

POST /chatroom/user/ban/whitelist/rollback.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

chatroomId=LoDld8izA&userId=uu1&userId=uu2
已复制
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://数据中心域名/chatroom/user/ban/whitelist/query.json

请求方法: POST

调用频率: 无限制

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

输入参数

参数 类型 必传 说明
chatroomId String 聊天室 Id

返回结果

返回值 返回类型 说明
code Int 返回码,200 为正常。
userIds String[] 聊天室中白名单用户数组。

示例代码

Request:

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

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

Response:

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

{
    "code": 200,
    "userIds": [
        "uu2",
        "uu1"
    ]
}
已复制
1
2
3
4
5
6
7
8
9
10

文档是否解决您的问题 ?

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