Skip to main content

View a list of room sessions.

GET 
/rooms/:room_id/sessions

Request ​

Path Parameters

    room_id uuidrequired

    The unique identifier of a room.

Query Parameters

    filter[date_created_at][eq] date

    ISO 8601 date for filtering room sessions created on that date.

    filter[date_created_at][gte] date

    ISO 8601 date for filtering room sessions created after that date.

    filter[date_created_at][lte] date

    ISO 8601 date for filtering room sessions created before that date.

    filter[date_updated_at][eq] date

    ISO 8601 date for filtering room sessions updated on that date.

    filter[date_updated_at][gte] date

    ISO 8601 date for filtering room sessions updated after that date.

    filter[date_updated_at][lte] date

    ISO 8601 date for filtering room sessions updated before that date.

    filter[date_ended_at][eq] date

    ISO 8601 date for filtering room sessions ended on that date.

    filter[date_ended_at][gte] date

    ISO 8601 date for filtering room sessions ended after that date.

    filter[date_ended_at][lte] date

    ISO 8601 date for filtering room sessions ended before that date.

    filter[active] boolean

    Filter active or inactive room sessions.

    include_participants boolean

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

    page[size] integer

    Possible values: >= 1 and <= 250

    Default value: 20

    The size of the page.

    page[number] integer

    Possible values: >= 1

    Default value: 1

    The page number to load.

Responses ​

200: List room sessions response.

Schema

    data

    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

  • ]

    • meta

    object

    page_number integer
    page_size integer
    total_pages integer
    total_results integer

Request samples

curl -L 'https://api.telnyx.com/v2/rooms/:room_id/sessions' \
-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"
    }
  ],
  "meta": {
    "page_number": 2,
    "page_size": 25,
    "total_pages": 3,
    "total_results": 55
  }
}