View a list of room recordings.

GET /room_recordings

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 roomRecordingListResponse of client.roomRecordings.list()) {
  console.log(roomRecordingListResponse.id);
}

200

{
  "data": [
    {
      "id": "6b61621f-62e0-4aad-ab11-9fd19e272e73",
      "room_id": "7b61621f-5fe4-4aad-ab11-9fd19e272e73",
      "session_id": "8b61621f-5fe4-4aad-ab11-9fd19e272e73",
      "participant_id": "9b61621f-5fe4-4aad-ab11-9fd19e272e73",
      "status": "completed",
      "download_url": "https://www.example.com",
      "type": "audio",
      "duration_secs": 3660,
      "size_mb": 5.6,
      "codec": "opus",
      "created_at": "2021-04-16T09:46:20.954863Z",
      "updated_at": "2021-04-16T10:24:55.962200Z",
      "started_at": "2021-04-16T09:24:55.962200Z",
      "ended_at": "2021-04-16T10:24:55.962200Z",
      "completed_at": "2021-04-16T10:25:55.962200Z",
      "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.

Query Parameters

filter · object

Consolidated filter parameter (deepObject style). Originally: filter[date_ended_at][eq], filter[date_ended_at][gte], filter[date_ended_at][lte], filter[date_started_at][eq], filter[date_started_at][gte], filter[date_started_at][lte], filter[room_id], filter[participant_id], filter[session_id], filter[status], filter[type], filter[duration_secs]

Show child attributes

page · object

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

Show child attributes

Response

200

application/json

List room recordings response.

data · object[]

Show child attributes

meta · object

Show child attributes