View a list of rooms.

gethttps://api.telnyx.com/v2/rooms

View a list of rooms.

curl -X GET \ --header "Content-Type: application/json" \ --header "Accept: application/json" \ --header "Authorization: Bearer YOUR_API_KEY" \ --globoff "https://api.telnyx.com/v2/rooms?filter[date_created_at][eq]=2021-04-25&filter[date_created_at][gte]=2021-04-25"

Parameters

In Query
filter[date_created_at][eq]
string
(date)
optional
ISO 8601 date for filtering rooms created on that date.
Example: "2021-04-25"
filter[date_created_at][gte]
string
(date)
optional
ISO 8601 date for filtering rooms created after that date.
Example: "2021-04-25"
filter[date_created_at][lte]
string
(date)
optional
ISO 8601 date for filtering rooms created before that date.
Example: "2021-04-25"
filter[date_updated_at][eq]
string
(date)
optional
ISO 8601 date for filtering rooms updated on that date.
Example: "2021-04-25"
filter[date_updated_at][gte]
string
(date)
optional
ISO 8601 date for filtering rooms updated after that date.
Example: "2021-04-25"
filter[date_updated_at][lte]
string
(date)
optional
ISO 8601 date for filtering rooms updated before that date.
Example: "2021-04-25"
filter[unique_name]
string
optional
Unique_name for filtering rooms.
Example: "my_video_room"
include_sessions
boolean
optional
To decide if room sessions should be included in the response.
Example: true
page[size]
integer
(1 - 250)
optional
The size of the page
Default:
20
page[number]
integer
(1)
optional
The page number to load
Default:
1

Responses

200
List rooms response.

Success Response

{
  "data": {
    "active_session_id": "7b61621f-62e0-4aad-ab11-9fd19e272e74",
    "created_at": "2021-04-16T09:46:20.954863Z",
    "enable_recording": true,
    "id": "7b61621f-62e0-4aad-ab11-9fd19e272e73",
    "max_participants": 50,
    "record_type": "room",
    "sessions": [
      {
        "active": true,
        "created_at": "2021-04-16T09:46:20.954863Z",
        "id": "7b61621f-62e0-4aad-ab11-9fd19e272e74",
        "participants": [],
        "record_type": "room_session",
        "room_id": "7b61621f-62e0-4aad-ab11-9fd19e272e73",
        "updated_at": "2021-04-16T10:24:55.962200Z"
      }
    ],
    "unique_name": "My Room",
    "updated_at": "2021-04-16T10:24:55.962200Z",
    "webhook_event_failover_url": "https://failover.example.com",
    "webhook_event_url": "https://www.example.com",
    "webhook_timeout_secs": 25
  },
  "meta": {
    "page_number": 2,
    "page_size": 25,
    "total_pages": 3,
    "total_results": 55
  }
}

...

posthttps://api.telnyx.com/v2/rooms

...

...

Parameters

Responses

Success Response

...

gethttps://api.telnyx.com/v2/rooms/{room_id}

...

...

Parameters

Responses

Success Response

...

patchhttps://api.telnyx.com/v2/rooms/{room_id}

...

...

Parameters

Responses

Success Response

...

deletehttps://api.telnyx.com/v2/rooms/{room_id}

...

...

Parameters

Responses

Success Response

...

gethttps://api.telnyx.com/v2/rooms/{room_id}/sessions

...

...

Parameters

Responses

Success Response

Was this page helpful?