View a list of room sessions.

GET /rooms/{room_id}/sessions

JavaScript

JavaScript

import Telnyx from 'telnyx';

const client = new Telnyx({
  apiKey: process.env['TELNYX_API_KEY'], // This is the default and can be omitted
});

// Automatically fetches more pages as needed.
for await (const roomSession of client.rooms.sessions.list1(
  '0ccc7b54-4df3-4bca-a65a-3da1ecc777f0',
)) {
  console.log(roomSession.id);
}

200

{
  "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": {
    "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.

Path Parameters

room_id · string<uuid> · required

The unique identifier of a room.

Example:

"0ccc7b54-4df3-4bca-a65a-3da1ecc777f0"

Query Parameters

include_participants · boolean

To decide if room participants 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[date_ended_at][eq], filter[date_ended_at][gte], filter[date_ended_at][lte], filter[active]

Show child attributes

page · object

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

Show child attributes

Response

200

application/json

List room sessions response.

data · object[]

Show child attributes

meta · object

Show child attributes