QueryRoomUserList
https://zim-api.zego.im/
Obtain information about room members based on the room ID, including the number of room users, user IDs, and names.
Request
Query Parameters
- 0: In chronological order (default).
- 1: In reverse chronological order.
- First call: Set Limit to 100, leave NextFlag empty, query users 1 to 100; the NextFlag value in the returned result is 1.
- Second call: Set Limit to 100, set NextFlag to 1, query users 101 to 200; the NextFlag value in the returned result is 2.
- Third call: Set Limit to 100, set NextFlag to 2, query users 201 to 250; query complete, the NextFlag in the returned result is 0.
Possible values: [QueryRoomUserList]
API prototype parameter
https://zim-api.zego.im/?Action=QueryRoomUserList
💡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: <= 32 characters
Room ID, with a maximum length of 32 bytes. Only supports numbers, English characters, and '!', '#', '$', '%', '&', '(', ')', '+', '-', ':', ';', '<', '=', '.', '>', '?', '@', '[', ']', '^', '_', '{', '}', '|', '~'.
Possible values: [0, 1]
Default value: 0
Sort by user login time to the room:
Pagination flag. Leave it empty for the first call, and then fill in the NextFlag value returned from the previous call. When the returned NextFlag is 0, it means the room member list has been fully retrieved.
For example, if there are 250 members in the room, when calling this API to query the room member list:
Possible values: <= 500
Number of users to query in a single call, with a value range of [0, 500]. This means calling this API once can return a maximum of 500 members.
When the number of members in the room exceeds Limit, you need to call this API multiple times and keep Limit consistent.
If left empty or greater than 500, the default value is 500.
If you need to increase the query result limit, please contact ZEGOCLOUD Technical Support for configuration.
Responses
- 200
- application/json