logo
ConsoleSign Up
Document
Client API
Server API
In-app Chat
Overview
Release Notes
Accessing Server APIs
Call API Online
Connect to ZEGOCLOUD Document MCP Serverlink
User
Room
Group
Message
Call invitation
Conversation
Bot
ZIMAudio
Callbacks
Return codes
Debugging guide of server API operations
Privacy policylink
On this page

QueryAppGroupList

GET

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

Get the IDs of all groups in the App.

Note
The retrieved data may have a delay of up to 1 minute.
QPS Limit
1 time/s

Request

Query Parameters

    Action stringrequired

    Possible values: [QueryAppGroupList]

    API prototype parameter

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

    AppId uint32required

    💡Public parameter. Application ID, assigned by ZEGOCLOUD. Get it from the ZEGOCLOUD Admin Console.

    SignatureNonce stringrequired

    💡Public parameter. A 16-character hexadecimal random string (hex encoding of 8-byte random number). Refer to Signature example for how to generate.

    Timestamp int64required

    💡Public parameter. Current Unix timestamp, in seconds. Refer to Signature example for how to generate, with a maximum error of 10 minutes.

    SignatureVersion stringrequired

    Possible values: [2.0]

    Default value: 2.0

    💡Public parameter. Signature version number.

    Signature stringrequired

    💡Public parameter. Signature, used to verify the legitimacy of the request. Refer to Signing the requests for how to generate an API request signature.

Body

    Limit number

    Possible values: >= 0 and <= 10000

    Number of group IDs to retrieve at once, with a value range of [0, 10000], meaning this API can return a maximum of 10,000 group IDs per call.

    When the number of groups in the App exceeds the Limit, you need to call this API multiple times and the Limit must remain consistent.

    If empty or greater than 10,000, the default value is 10,000.

    Next number

    Pagination flag. Fill in 0 for the first time, and then fill in the value returned last time. When the returned Next is 0, it means the group list has been fully retrieved.

    For example, if there are 25,000 groups in the App, when calling this API to query the group list:

    • First call: Set Limit to 10,000 and Next to 0 to query groups 1 to 10,000; the Next value in the returned result is 1.
    • Second call: Set Limit to 10,000 and Next to 1 to query groups 10,001 to 20,000; the Next value in the returned result is 2.
    • Third call: Set Limit to 10,000 and Next to 2 to query groups 20,001 to 25,000; the query is complete, and the Next value in the returned result is 0.

Responses​

OK
Schema
    Code number

    Return code.

    The following only lists the return codes related to the API business logic. For the complete return codes, please refer to Return codes.

    Return codeDescriptionSuggested Solution
    660000002Parameter error.Please refer to Request Parameters and enter the correct parameters.
    660600006Error querying group list data.Please contact ZEGOCLOUD Technical Support.
    660600007The call frequency of the QueryAppGroupList API exceeds the limit.The call frequency is 1 time/s, please do not exceed the limit.
    Message string

    Description of the request result.

    RequestId string

    Request ID.

    TotalCount number

    Current total number of groups in the App.

    Next number

    Pagination flag. When non-zero, it indicates that the list query is not complete.

    Note

    Apart from the above description, this field has no association with the list information. Please do not base any other logic on this field.

    GroupIdList object[]
    Collection of retrieved group IDs.
  • Array[
    • GroupId string

    Group ID.

    GroupName string

    Group name.

  • ]

Previous

Modify group specification limits

Next

Query group member list

On this page

Back to top