Documentation
Server APIs v2
Room signaling
Get a room's user list

Get a room's user list

Last updated：2022-03-22 13:07

1 Description

Get the list of users in a room.

2 Request method and endpoint

Request method: GET
Request endpoint: https://rtc-api.zego.im/?Action=DescribeUserList
Transmission protocol: HTTPS
Rate limit:
- Same AppID: 10 times/second
- Same room: 6 times/20 seconds

3 Request parameters

Listed below are the parameters specific to this request and part of the public request parameters. For the complete list of public request parameters, see Server APIs public request parameters.

Parameter	Type	Required	Description
RoomId	String	Yes	Room ID.
Mode	Int	Yes	The chronological order by which the user logged into the room. 0: in positive chronological order 1: in reverse chronological order
Limit	Int	Yes	The number of users returned by a single request, the value range is 0-200, the default is 200.
Marker	String	No	Query the user start bit identifier, the response of each request is returned, if it is empty, the user information will be returned from the beginning.

4 Request Example

https://rtc-api.zego.im/?Action=DescribeUserList
&RoomId=room_demo
&Mode=0
&Limit=2
&Marker=
&<public Request Parameters>

5 Response parameters

Parameter	Type	Description
Code	Number	Return code.
Message	String	A Description of the operation result.
RequestId	String	Request ID.
Data	Object	Response data.
└ Marker	String	User start bit identifier.
└ UserList	Array of Object	User list.
└ UserId	String	Username.
└ UserName	String	User nickname.

6 Response example

{
    "Code": 0,
    "Message": "success",
    "RequestId": "TestRequestId1635940600561291000",
    "Data": {
        "Marker": "1635940599950-user2",
        "UserList": [
            {
                "UserId": "user1",
                "UserName": "user1"
            },
            {
                "UserId": "user2",
                "UserName": "user2"
            }
        ]
    }
}

7 Return codes

Listed below are the return codes related to this API. For the complete list of return codes, see Return codes.

Return code	Possible cause and solution
104	The room does not exist. (the detection logic is the same as the return codes 5024 and 50001.) Please check the RoomId.
206	The rate limit (requests per second) has exceeded the limit. Please adjust the frequency of your requests or contact ZEGOCLOUD technical support.
5018	Room status does not match. Please try again later.
5024	The room does not exist. (the detection logic is the same as the return codes 104 and 5001.) Please check the RoomId.
50001	The room does not exist. (the detection logic is the same as the return codes 104 and 5024.) When there are no users in a room, the room will be automatically destroyed by the server. When there is only one user in a room and the user exits or is kicked out of the room, the room will be automatically destroyed by the server. When a room's heartbeat request times out by 100 seconds, the room will be destroyed by the server.
50002	User does not exist. Please check the UserId.
50003	Failed to query the user's online info. Please check whether the user is online based on the UserId.
50004	Failed to read the user info. Please check whether the user is online based on the UserId.
50009	Moderation failed. Please try again later or contact ZEGOCLOUD technical support.
50011	The number of recipients of the custom message has exceeded the limit.
50012	The length of the custom message has exceeded the limit.
50013	Failed to send custom messages. Please contact ZEGOCLOUD technical support.