QueryAppGroupList
https://zim-api.zego.im/
Get the IDs of all groups in the App.
Request
Query Parameters
- 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.
Possible values: [QueryAppGroupList]
API prototype parameter
https://zim-api.zego.im/?Action=QueryAppGroupList
💡Public parameter. Application ID, assigned by ZEGOCLOUD. Get it from the ZEGOCLOUD Admin Console.
💡Public parameter. A 16-character hexadecimal random string (hex encoding of 8-byte random number). Refer to Signature example for how to generate.
💡Public parameter. Current Unix timestamp, in seconds. Refer to Signature example for how to generate, with a maximum error of 10 minutes.
Possible values: [2.0]
Default value: 2.0
💡Public parameter. Signature version number.
💡Public parameter. Signature, used to verify the legitimacy of the request. Refer to Signing the requests for how to generate an API request signature.
Possible values: <= 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.
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:
Responses
- 200
- application/json
