查询群组全体禁言状态
查询群组是否被设置为全部成员禁言。功能说明如下:
- 传入一个或多个有效的群组 ID 时,查询指定群组是否已设置为全部成员禁言。
- 不传入群组 ID 时,分页查询 App Key 下所有已被设置为全体成员禁言的群组列表。
请求方法
POST: https://数据中心域名/group/ban/query.json
频率限制: 每秒 100 次
签名规则: 所有服务端 API 请求均需要进行规则校验,详情请参阅 API 请求签名。
正文参数
HTTP 请求正文支持以下 application/x-www-form-urlencoded
表单参数:
参数 | 类型 | 必传 | 说明 |
---|---|---|---|
groupId | String | 否 | 群组 ID。支持一次查询多个,最多不超过 20 个。 |
page | Int | 否 | 页码。使用此参数进行分页查询时,groupId 参数无效。不传 groupId 时,默认为 1 。 |
size | Int | 否 | 每页数量。使用此参数进行分页查询时,groupId 参数无效。不传 groupId 时,默认为 50 ,最大为 200 。 |
请求示例
HTTP
POST /group/ban/query.json HTTP/1.1
Host: api.rong-api.com
App-Key: c9kqb3rdkbb8j
Nonce: 97
Timestamp: 1480479442
Signature: 9774e3d91656dc92df8aff294d46d6a506412538
Content-Type: application/x-www-form-urlencoded
返回结果
HTTP 响应正文包含具有以下结构的 JSON 对象:
返回值 | 返回类型 | 说明 |
---|---|---|
code | Number | 返回码,200 表示请求成功。 |
groupinfo | String[] | 禁言群组信息。 |
groupsinfo[i].groupId | String | 群组 ID。 |
groupsinfo[i].stat | Int | 禁言状态:0 表示未禁言,1 表示已禁言。 |
返回结果示例
HTTP
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
{
"code":200,
"groupinfo":[
{
"groupId": "groupId1",
"stat":1
},
{
"groupId": "groupId2",
"stat":1
}
]
}