全部文档

更新时间: 2021-03-08

# 功能描述

1、设置某一群组全部成员禁言，设置后该群组的所有成员都不能通过终端 SDK 发送消息。

2、如果在群组全部成员禁言状态下，需要某些用户可以发言时，可将此用户加入到群禁言用户白名单中。

3、Server API 发送的消息权限级别较高，不受禁言限制，可使用被禁言用户通过 Server API 发送消息。

# 全体成员禁言

# 添加全体成员禁言

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

请求方法： POST

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

输入参数

参数 类型 必传 说明
groupId String 是 群组 Id，支持一次设置多个，最多不超过 20 个。

返回结果

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

示例代码

Request：

POST /group/ban/add.json HTTP/1.1
Host: api-cn.ronghub.com
App-Key: c9kqb3rdkbb8j
NONCE: 97
TIMESTAMP:  1480479442
SIGNATURE:  9774e3d91656dc92df8aff294d46d6a506412538
Content-Type: application/x-www-form-urlencoded

groupId=XklWnVzXm&groupId=LklWnVzXq

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

请求方法： POST

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

输入参数

参数 类型 必传 说明
groupId String 群组 Id，支持一次设置多个，最多不超过 20 个。

返回结果

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

示例代码

Request：

POST /group/ban/rollback.json HTTP/1.1
Host: api-cn.ronghub.com
App-Key: c9kqb3rdkbb8j
NONCE: 97
TIMESTAMP:  1480479442
SIGNATURE:  9774e3d91656dc92df8aff294d46d6a506412538
Content-Type: application/x-www-form-urlencoded

groupId=L6c85orxt&groupId=X6c95orxt

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

请求方法： POST

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

输入参数

参数 类型 必传 说明
groupId String 否 群组 Id，每次查询最多不超过 20 个，不传时，表示查询所有设置禁言的群组列表。

返回结果

返回值 返回类型 说明
code Int 返回码，200 为正常。
groupinfo String[] 禁言群组信息数据。
groupId String 群组 Id。
stat String 禁言状态，0 表示为未禁言、1 表示为禁言。

示例代码

Request：

POST /group/ban/query.json HTTP/1.1
Host: api-cn.ronghub.com
App-Key: c9kqb3rdkbb8j
NONCE: 97
TIMESTAMP:  1480479442
SIGNATURE:  9774e3d91656dc92df8aff294d46d6a506412538
Content-Type: application/x-www-form-urlencoded

已复制
1
2
3
4
5
6
7

Response：

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

{
  "code":200,
  "groupinfo":[
  {
    "groupId": "groupId1",
    "stat":1
  },
  {
    "groupId": "groupId2",
    "stat":1
  }
  ]
}

已复制
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16

# 全体成员禁言白名单

# 添加禁言白名单

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

请求方法： POST

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

输入参数

参数 类型 必传 说明
userId String 是 用户 Id，支持一次添加多个用户，最多不超过 20 个。
groupId String 是 群组 Id。

返回结果

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

示例代码

Request：

POST /group/user/ban/whitelist/add.json HTTP/1.1
Host: api-cn.ronghub.com
App-Key: c9kqb3rdkbb8j
NONCE: 97
TIMESTAMP:  1480479442
SIGNATURE:  9774e3d91656dc92df8aff294d46d6a506412538
Content-Type: application/x-www-form-urlencoded

groupId=2MqOJa1Un&userId=3212&userId=2583

已复制
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://数据中心域名/group/user/ban/whitelist/rollback.json

请求方法： POST

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

输入参数

参数 类型 必传 说明
userId String 是 用户 Id，支持同时移除多个用户，每次最多不超过 20 个。
groupId String 是 群组 Id。

返回结果

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

示例代码

Request：

POST /group/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

userId=2582&userId=2583&groupId=16

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

请求方法： POST

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

输入参数

参数 类型 必传 说明
groupId String 是 群组 Id。

返回结果

返回值 返回类型 说明
code Int 返回码，200 为正常。
userIds String[] 用户 Id。

示例代码

Request：

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

groupId=16

已复制
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":["2111","2582"]}

已复制
1
2
3
4

文档是否解决您的问题 ?

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