Skip to main content

Find a Room by ID

Find a room by ID.

Permissions

The API token must include the following scopes: Video.

Path Parameters
id uuid REQUIRED

Unique ID of the room

Responses
200

OK

Schema OPTIONAL
id uuid OPTIONAL

A unique identifier for the room

name string OPTIONAL

A named unique identifier for the room. Allowed characters: A-Za-z0-9_-. Maximum of 100 characters.

display_name string OPTIONAL

Display name of the room. Maximum of 200 characters. Defaults to the value of name.

max_members integer OPTIONAL

The maximum number of members in the room at a time. Must be at least one to a maximum of 300. Defaults to 20.

quality string OPTIONAL

The room's resolution. Allowed values are 720p or 1080p. Defaults to 720p.

join_from date-time OPTIONAL

Room does not accept new participants before this time. Overridable by token. Expects RFC 3339 datetime: 2022-01-01T23:59:60Z. Date only: 2022-01-01 will be converted to 2022-01-01T00:00:00Z

join_until date-time OPTIONAL

Room stops accepting new participants at this time, but keeps running until all participants leave. Overridable by token. Expects RFC 3339 datetime: 2022-01-01T23:59:60Z. Date only: 2022-01-01 will be converted to 2022-01-01T00:00:00Z

remove_at date-time OPTIONAL

Remove users from the room at this time. Overridable by token. Expects RFC 3339 datetime: 2022-01-01T23:59:60Z. Date only: 2022-01-01 will be converted to 2022-01-01T00:00:00Z

remove_after_seconds_elapsed int32 OPTIONAL

Remove users after they are in the room for N seconds. Overridable by token.

layout string OPTIONAL

The room's initial layout. Defaults to grid-responsive. See documentation for a full list of supported layouts.

record_on_start boolean OPTIONAL

Specifies whether to start recording a Room Session when one is started for this Room

enable_room_previews boolean OPTIONAL

Whether a video with a preview of the content of the room is to be generated.

fps integer OPTIONAL

Frames Per Second parameter of room video quality

active_session object OPTIONAL
id uuid OPTIONAL

Unique ID of the session

room_id uuid OPTIONAL

Unique ID of the Room if the Session was created from a Room and was not an auto-created Session.

name string OPTIONAL

The named identifier of room session.

display_name string OPTIONAL

Display name of room, no character limitations. Maxium of 200 characters. Defaults to the value of name.

join_from date-time OPTIONAL

Room Session does not accept new Members before this time.

join_until date-time OPTIONAL

Room Session stops accepting new Members at this time.

remove_at date-time OPTIONAL

Remove Members from the Room Session at this time.

remove_after_seconds_elapsed int32 OPTIONAL

Remove Members after they are in the Room Session for N seconds.

layout string OPTIONAL

The Room Session's initial layout. Defaults to grid-responsive. See documentation for a full list of supported layouts.

max_members integer OPTIONAL

The maximum number of members allowed in the room at a time.

fps integer OPTIONAL

The Room Session's frames per second. Possible values are 20 or 30.

quality string OPTIONAL

The Room Session's resolution. Possible values are 720p or 1080p.

start_time date-time OPTIONAL
end_time date-time OPTIONAL
duration integer OPTIONAL

How long, in seconds, the Room Session lasted.

status string OPTIONAL
record_on_start boolean OPTIONAL

Whether a recording was automatically started when this Room Session began.

enable_room_previews boolean OPTIONAL

Whether a video with a preview of the content of the room is to be generated.

preview_url string OPTIONAL

If room previews are enabled and the room session is in progress, this is the URL of the preview video.

created_at date-time OPTIONAL
updated_at date-time OPTIONAL