公告：融云新文档中心已上线，欢迎到新文档中心阅读 IM 服务端文档。
查询群成员禁言列表
更新时间:2024-02-19
PDF
获取在指定群组中被禁言的用户，返回用户 ID 列表。
不指定群组时（groupId 为空）则获取所有群组禁言用户列表。
请求方法
POST： https://数据中心域名/group/user/gag/list.json
签名规则： 所有服务端 API 请求均需要进行规则校验，详见 API 请求签名。
频率限制： 每秒钟限 100 次
正文参数
HTTP 请求正文中可包含如下 HTTP 表单参数：
| 参数 | 类型 | 必传 | 说明 |
|---|---|---|---|
| groupId | String | 否 | 群组 ID，为空时则获取所有群组禁言用户列表。 |
请求示例
POST /group/user/gag/list.json HTTP/1.1
Host: api.rong-api.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
返回结果
HTTP 响应正文包含具有以下结构的 JSON 对象：
| 返回值 | 返回类型 | 说明 |
|---|---|---|
| code | Number | 返回码，200 为正常。 |
| users | Array of objects | 禁言成员列表。 |
| users[i].startTime | String | 禁言开始时间。精确到秒，格式为 YYYY-MM-DD HH:MM:SS，例如 2022-09-25 16:12:38。注意：time 的值与应用所属数据中心有关。如您的 App 业务使用国内数据中心，则 time 为北京时间。如您的 App 业务使用海外数据中心，则 time 为 UTC 时间。 |
| users[i].time | String | 解禁时间。精确到秒，格式为 YYYY-MM-DD HH:MM:SS，例如 2022-09-25 16:12:38。注意：time 的值与应用所属数据中心有关。如您的 App 业务使用国内数据中心，则 time 为北京时间。如您的 App 业务使用海外数据中心，则 time 为 UTC 时间。 |
| users[i].userId | String | 群成员的用户 ID。 |
返回结果示例
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
{
"code": 200,
"users": [
{
"startTime": "2024-02-07 18:25:12",
"time": "2024-02-07 18:55:12",
"userId": "u02"
},
{
"startTime": "2024-02-07 18:25:12",
"time": "2024-02-07 18:55:12",
"userId": "u01"
}
]
}
已复制
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
131 6185 6839