Skip to main content
GET
/
rooms
JavaScript
import Telnyx from 'telnyx';

const client = new Telnyx({
  apiKey: 'My API Key',
});

const rooms = await client.rooms.list();

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

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

include_sessions
boolean

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

Example:

true

filter
object

Consolidated filter parameter (deepObject style). Originally: filter[date_created_at][eq], filter[date_created_at][gte], filter[date_created_at][lte], filter[date_updated_at][eq], filter[date_updated_at][gte], filter[date_updated_at][lte], filter[unique_name]

page
object

Consolidated page parameter (deepObject style). Originally: page[size], page[number]

Response

200 - application/json

List rooms response.

data
object[]
meta
object