QueryAppCommunityList

GET

https://zim-api.zego.im/

获取 App 中所有社群的 ID。

注意

获取的数据可能会存在最多 1 分钟 的延迟。

说明

调用频率限制：1 次/秒。

Request

Query Parameters

Action string必填

可选值: [QueryAppCommunityList]

接口原型参数

https://zim-api.zego.im/?Action=QueryAppCommunityList

AppId uint32必填

💡公共参数。应用 Id，由 ZEGO 分配的用户唯一凭证。可从 ZEGO 控制台获取。

SignatureNonce string必填

💡公共参数。16 位 16 进制随机字符串（8 字节随机数的 hex 编码）。生成算法可参考签名示例。

Timestamp int64必填

💡公共参数。当前 Unix 时间戳，单位为秒。生成算法可参考签名示例，最多允许 10 分钟的误差。

SignatureVersion string必填

可选值: [2.0]

默认值: 2.0

💡公共参数。签名版本号。

Signature string必填

💡公共参数。签名，用于验证请求的合法性。请参考签名机制生成。

application/json

Body

Limit number

可选值: >= 0 and <= 10000

本次获取的社群 ID 数量的上限，不得超过 10000，即调用本接口一次最多返回 10000 个社群 ID。

当 App 内的社群数量存在超过 Limit 时，需调用多次本接口且 Limit 需保持一致。

如果传空或大于 10000，则默认取值为 10000。

Next number

分页拉取标志，第一次填 0，以后填上一次返回的值，返回的 Next 为 0 代表社群列表获取完毕。

例如，App 内有 25000 个社群，调用本接口查询社群列表时：

第一次调用本接口，Limit 填 10000，Next 填 0，查询第 1 ～ 10000 个社群；返回结果中的 Next 值为 1
第二次调用本接口，Limit 填 10000，Next 填 1，查询第 10001 ～ 20000 个社群；返回结果中 Next 值为 2。
第三次调用本接口，Limit 填 10000，Next 填 2，查询第 20001 ～ 25000 个社群；查询完毕，返回结果中的 Next 为 0。

Responses

application/json

数据结构
按数据结构生成的示例
示例

Schema

Code number

返回码。

以下仅列出了接口业务逻辑相关的返回码，完整返回码请参考全局返回码。

返回码	说明	处理建议
660000002	参数错误。	请参考请求参数输入正确参数。

Message string

请求结果的说明信息。

RequestId string

请求 ID。

TotalCount number

App 当前的社群总数。

Next number

分页拉取的标志。非 0 时表示列表查询未完。

说明

除上述说明之外，此字段与列表信息无任何关联，请勿基于此做任何其他逻辑。

CommunityIdList object[]

获取到的社群 ID 的集合。

Array[

CommunityId string

社群 ID。

CommunityName string

社群名称。

]

{
  "Code": 0,
  "Message": "success",
  "RequestId": "343649807833778782",
  "TotalCount": 1680,
  "Next": 2,
  "CommunityIdList": [
    {
      "CommunityId": "CommunityA",
      "CommunityName": "CommunityNameA"
    }
  ]
}

{
  "Code": 0,
  "Message": "success",
  "RequestId": "343649807833778782",
  "TotalCount": 1680,
  "Next": 2,
  "CommunityIdList": [
    {
      "CommunityId": "CommunityA",
      "CommunityName": "CommunityNameA"
    }
  ]
}

{
  "Code": 0,
  "Message": "success",
  "RequestId": "343649807833778782",
  "TotalCount": 1680,
  "Next": 2,
  "CommunityIdList": [
    {
      "CommunityId": "CommunityA",
      "CommunityName": "CommunityNameA"
    },
    {
      "CommunityId": "CommunityB",
      "CommunityName": "CommunityNameB"
    }
  ]
}

{
  "Code": 0,
  "Message": "success",
  "RequestId": "343649807833778782",
  "TotalCount": 1680,
  "Next": 2,
  "CommunityIdList": [
    {
      "CommunityId": "CommunityA",
      "CommunityName": "CommunityNameA"
    },
    {
      "CommunityId": "CommunityB",
      "CommunityName": "CommunityNameB"
    }
  ]
}