跳到主要内容

查询群组全体禁言

查询群组是否设置为全部成员禁言，具体功能如下：

  • 传入有效的群组 ID 时，查询指定的单个群组或多个群组是否已设置全部成员禁言
  • 不传群组 ID 时，查询 App Key 下所有已被设置为全体成员禁言的群组列表

请求方法​

POST： https://数据中心域名/group/ban/query.json

频率限制： 每秒钟限 100 次

签名规则： 所有服务端 API 请求均需要进行规则校验，详见 API 请求签名。

正文参数​

HTTP 请求正文中可包含如下 HTTP 表单参数：

参数类型必传说明
groupIdString否群组 ID。单次可查询指定单个或多个群组，单次查询最多不超过 20 个群组。
pageint否页数。此参数传递后，groupId 参数无效。 groupId 参数不传递时，默认为 1。
sizeint否每页数量。此参数传递后，groupId 参数无效。 groupId 参数不传递时，默认为 50，最大为 200。

请求示例​

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 对象：

返回值返回类型说明
codeNumber返回码，200 为正常。
groupinfoString[]禁言群组信息数据。
groupIdString群组 ID。
statInt禁言状态，0 表示为未禁言、1 表示为禁言。

返回结果示例​

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

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