Skip to main content

View a room.

GET 

/rooms/:room_id

View a room.

Request

Path Parameters

    room_id uuidrequired

    The unique identifier of a room.

Query Parameters

    include_sessions boolean

    To decide if room sessions should be included in the response.

Responses

200: Get room response.

Schema

    data

    object

    id uuid

    A unique identifier for the room.

    max_participants integer

    Maximum participants allowed in the room.

    unique_name string

    The unique (within the Telnyx account scope) name of the room.

    created_at datetime

    ISO 8601 timestamp when the room was created.

    updated_at datetime

    ISO 8601 timestamp when the room was updated.

    active_session_id uuid

    The identifier of the active room session if any.

    sessions

    object[]

  • Array [

  • id uuid

    A unique identifier for the room session.

    room_id uuid

    Identify the room hosting that room session.

    active boolean

    Shows if the room session is active or not.

    created_at datetime

    ISO 8601 timestamp when the room session was created.

    updated_at datetime

    ISO 8601 timestamp when the room session was updated.

    ended_at datetime

    ISO 8601 timestamp when the room session has ended.

    participants

    object[]

  • Array [

  • id uuid

    A unique identifier for the room participant.

    session_id uuid

    Identify the room session that participant is part of.

    context string

    Context provided to the given participant through the client SDK

    joined_at datetime

    ISO 8601 timestamp when the participant joined the session.

    updated_at datetime

    ISO 8601 timestamp when the participant was updated.

    left_at datetime

    ISO 8601 timestamp when the participant left the session.

    record_type string
  • ]

  • record_type string
  • ]

  • enable_recording boolean

    Default value: false

    Enable or disable recording for that room.

    webhook_event_url url

    The URL where webhooks related to this room will be sent. Must include a scheme, such as 'https'.

    webhook_event_failover_url urlnullable

    The failover URL where webhooks related to this room will be sent if sending to the primary URL fails. Must include a scheme, such as 'https'.

    webhook_timeout_secs integernullable

    Possible values: <= 30

    Specifies how many seconds to wait before timing out a webhook.

    record_type string

404: Resource not found

Schema

    code intrequired
    title stringrequired
    detail string

    source

    object

    pointer json-pointer

    JSON pointer (RFC6901) to the offending entity.

    parameter string

    Indicates which query parameter caused the error.

    meta object
Loading...