Skip to main content

Find a Room by its unique name.

GET 
/rooms/:name

Find a room by its unique name.

Permissions​

The API token must include the following scopes: Video.

Request​

Path Parameters

    name stringrequired

    Unique name of the room

Query Parameters

    include_active_session boolean

    Specifies whether or not to include information about the room's active session (if any)

Responses​

OK

Schema

    id uuid

    A unique identifier for the room

    name string

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

    Example: my_room
    display_name string

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

    Example: My Room's Name
    description string

    Description of the room. Maximum of 3000 characters.

    Example: This room will be used for full company all hands meetings
    max_members integer

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

    Example: 20
    quality string

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

    Example: 720p
    join_from date-time

    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

    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

    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

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

    Example: 120
    layout string

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

    Example: grid-responsive
    record_on_start boolean

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

    enable_room_previews boolean

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

    audio_video_sync boolean

    Enable/disable jitter buffer audio-video sync.

    Example: true
    fps integer

    Frames Per Second parameter of room video quality

    Example: 20

    active_session

    object

    id uuid

    Unique ID of the session

    room_id uuid

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

    name string

    The named identifier of room session.

    Example: my_example_room
    display_name string

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

    Example: My Room's Name
    join_from date-time

    Room Session does not accept new Members before this time.

    join_until date-time

    Room Session stops accepting new Members at this time.

    remove_at date-time

    Remove Members from the Room Session at this time.

    remove_after_seconds_elapsed int32

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

    Example: 120
    layout string

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

    Example: grid-responsive
    max_members integer

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

    Example: 20
    fps integer

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

    Example: 20
    quality string

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

    Example: 720p
    start_time date-time
    end_time date-time
    duration integer

    How long, in seconds, the Room Session lasted.

    Example: 120
    status string
    Example: completed
    record_on_start boolean

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

    enable_room_previews boolean

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

    preview_url string

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

    Example: https://...
    audio_video_sync boolean

    Enable/disable jitter buffer audio-video sync.

    Default value: false
    Example: true
    created_at date-time
    updated_at date-time