DescribeUserList

API prototype parameter

https://rtc-api.zego.im?Action=DescribeUserList

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

💡Common parameter. A 16-character hexadecimal random string (hex-encoded 8-byte random number). For the generation algorithm, refer to the signature example.

💡Common parameter. Current Unix timestamp in seconds. For the generation algorithm, refer to the signature example. A maximum deviation of 10 minutes is allowed.

💡Common parameter. Signature used to verify the legitimacy of the request. Please refer to the signature mechanism to generate it.

💡Public parameter. Signature version number.

Room ID. An empty list is returned if the Room does not exist.

Time order of users logging into the Room, default value is 0. 0: ascending order by time; 1: descending order by time

The number of users returned in a single request, with a value range of 0-200, which means calling this interface returns a maximum of 200 users at a time. When the number of users in the Room exceeds 200, you need to use the Marker value (user starting position identifier) returned in the previous call's result to call this interface again to query the remaining users.

For example, if there are 450 users in the Room, when calling this interface to query the user list:

• (1) First call: pass an empty value for the Marker parameter to query users 1-200; assume the Marker value in the returned result is "marker1".
• (2) Second call: set the Marker parameter value to "marker1" to query users 201-400; assume the Marker value in the returned result is "marker2".
• (3) Third call: set the Marker parameter value to "marker2" to query users 401-450; the query is complete, and the Marker in the returned result is empty.

Query user starting position identifier, returned in the response of each request. When empty, user information is returned from the beginning.