Documentation
RoomKit
Server APIs
Education Cloud Service APIs
List rooms joined by a user

List rooms joined by a user

Last updated：2022-03-03 20:27

1 Description

Lists all the rooms joined by a given user.

2 Request method and endpoint

Request method: POST
Request endpoint:

Service environment Rate limit Endpoint

Productiont

10 requests/second

https://roomkit-edu-api.zego.im/room/query
Transmission protocol: HTTPS

Service environment	Rate limit	Endpoint
Productiont	10 requests/second	https://roomkit-edu-api.zego.im/room/query

3 Request parameters

Parameter	Type	Required	Example	Description
uid	Int64	Yes	99900000	User ID
secret_id	Int64	Yes	12580	The Secret ID assigned to your project by ZEGO.
access_token	String	Yes	"CIE7hNPK6Y55DeUJBSDrInP"	The server access token obtained via the get_access_token request.
begin_timestamp	Int64	Yes	1623954399000	The earliest room start time of the query, a timestamp in milliseconds. All rooms with a start time later than this value will be returned as the query result.
status	Int	Yes	3	A fixed value of 3.
page	Int	No	1	The page number indicating which page of the query result is to be returned. Page number starts from 1.
count	Int	No	20	Number of entries per page. The default value is 20.

4 Sample request

{
    "begin_timestamp": 1623954399000,
    "status": 3,
    "access_token": "jZPr93v1-Nzpm6KUIAvov_G7rbpZrqqr5bj0_huosae-EC6v2lgzdGFxQvX6h-ofFTuPlZL574Q=",
    "secret_id": 1000001,
    "uid": 100062223
}

5 Response parameters

Parameter	Type	Example	Description
ret	Object	-	The returned status of the request.
ret.code	Int	0	The returned code.
ret.message	String	"succeed"	The returned message.
ret.version	String	"1.0.0"	Version number.
data	Object	-	The returned data of the request.
data.count	Int	1	Number of rooms.
data.room_list	Array of Object	-	The list of rooms returned by the query.
data.room_list[0].room_id	String	"123456789"	Room ID.
data.room_list[0].pid	Int64	1200	Product ID.
data.room_list[0].subject	String	"The Future of Remote Learning"	The subject of the room.
data.room_list[0].room_type	Int	1	Room type: 1: General Room 3: One-on-One Room 5: Large Room 6: Live Audio Room
data.room_list[0].begin_timestamp	Int64	1590666065838	The start time of the room, a timestamp in milliseconds.
data.room_list[0].end_timestamp	Int64	1624434174000	The end time of the room, a timestamp in milliseconds.
data.room_list[0].create_timestamp	Int64	1590666065838	The creation time of the room, a timestamp in milliseconds.
data.room_list[0].host	Object	-	The Host of the room.
data.room_list[0].host.uid	Int64	99975923	User ID of the Host.
data.room_list[0].locked	Int	0	Room's lock status: 0: Unlocked 1: Locked
data.room_list[0].status	Int	1	Room status: 1: Not yet started 2: In progress 4: Ended 8: Cancelled
data.room_list[0].max_attendee_count	Int	10	The maximum number of users allowed in the room.
data.room_list[0].user_role	Int	1	The user's role in this room: 1: Host 2: Attendee 4: Assistant
data.room_list[0].settings	Object	-	Room settings.
data.room_list[0].settings.enable_host_cam	Bool	true	Whether the Host's camera is on by default.
data.room_list[0].settings.enable_host_mic	Bool	true	Whether the Host's microphone is on by default.
data.room_list[0].settings.enable_attendee_cam	Bool	true	Whether the Attendees' camera is on by default.
data.room_list[0].settings.enable_attendee_mic	Bool	true	Whether the Attendees' microphone is on by default.
data.room_list[0].settings.enable_chat	Bool	true	Whether the text chat feature is enabled.
data.room_list[0].settings.enable_raise_hand	Bool	true	Whether the Raise Hand feature is enabled.
data.room_list[0].settings.enable_attendee_share	Bool	true	Whether the content sharing feature is enabled for Attendees.
data.room_list[0].settings.enable_attendee_draw	Bool	true	Whether Attendees can use the paintbrush tool.
data.room_list[0].settings.enable_wait	Bool	true	Whether the Waiting Room feature is enabled by default.
data.room_list[0].settings.enable_wait_setting	Bool	true	Whether the Waiting Room feature can be enabled on demand.
data.room_list[0].settings.is_auto_start	Bool	true	Whether the room starts automatically.
data.room_list[0].settings.max_onstage_count	Int	2	The maximum number of users allowed on the speaker stage.
data.room_list[0].settings.is_private_room	Bool	false	Whether it is a private room. A private room only accepts invited people and the organization's administrators.

6 Sample response

{
    "ret": {
        "code": 0,
        "message": "succeed",
        "version": "1.0.0"
    },
    "data": {
        "count": 1,
        "room_list": [
            {
                "room_id": "124768350",
                "pid": 1241,
                "subject": "The Future of Remote Learning",
                "room_type": 6,
                "settings": {
                    "enable_host_cam": true,
                    "enable_host_mic": true,
                    "enable_attendee_cam": true,
                    "enable_attendee_mic": true,
                    "automatic_recording": false,
                    "enable_wait": false,
                    "enable_wait_setting": false,
                    "enable_chat": true,
                    "enable_raise_hand": true,
                    "default_locked": false,
                    "enable_attendee_share": true,
                    "enable_attendee_draw": true,
                    "is_auto_start": false,
                    "max_onstage_count": 2,
                    "is_private_room": false
                },
                "begin_timestamp": 1624433994000,
                "end_timestamp": 1624434174000,
                "create_timestamp": 1624434001531,
                "duration": 3,
                "status": 2,
                "locked": 0,
                "host": {
                    "uid": 100062223
                },
                "attendee_count": 2,
                "max_user_count": 2,
                "max_attendee_count": 2,
                "user_role": 1
            }
        ]
    }
}

ZEGO UIKits

Cloud Communications Products

Low-Code Products

AIGC

Supporting Services

List rooms joined by a user

1 Description

2 Request method and endpoint

3 Request parameters

4 Sample request

5 Response parameters

6 Sample response