Skip to main content

View a room session.

GET 
/room_sessions/:room_session_id

View a room session.

Request​

Path Parameters

    room_session_id uuidrequired

    The unique identifier of a room session.

Query Parameters

    include_participants boolean

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

Responses​

200: Get room session response.

Schema

    data

    object

    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

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

Request samples

curl -L 'https://api.telnyx.com/v2/room_sessions/:room_session_id' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'

Response samples

{
  "data": {
    "id": "7b61621f-62e0-4aad-ab11-9fd19e272e73",
    "room_id": "7b61621f-5fe4-4aad-ab11-9fd19e272e73",
    "active": false,
    "created_at": "2021-04-16T09:46:20.954863Z",
    "updated_at": "2021-04-16T10:24:55.962200Z",
    "ended_at": "2021-04-16T10:24:55.962200Z",
    "participants": [],
    "record_type": "room_session"
  }
}