Skip to main content

View a list of room recordings.

GET 
/room_recordings

Request ​

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]

    page object

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

Responses ​

200: List room recordings response.

Schema

    data

    object[]

  • Array [

    • id uuid

    A unique identifier for the room recording.

    room_id uuid

    Identify the room associated with the room recording.

    session_id uuid

    Identify the room session associated with the room recording.

    participant_id uuid

    Identify the room participant associated with the room recording.

    status string

    Possible values: [completed, processing]

    Shows the room recording status.

    type string

    Possible values: [audio, video]

    Shows the room recording type.

    size_mb float

    Shows the room recording size in MB.

    download_url string

    Url to download the recording.

    codec string

    Shows the codec used for the room recording.

    duration_secs integer

    Shows the room recording duration in seconds.

    created_at date-time

    ISO 8601 timestamp when the room recording was created.

    updated_at date-time

    ISO 8601 timestamp when the room recording was updated.

    ended_at date-time

    ISO 8601 timestamp when the room recording has ended.

    started_at date-time

    ISO 8601 timestamp when the room recording has stated.

    completed_at date-time

    ISO 8601 timestamp when the room recording has completed.

    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/room_recordings' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'

Response samples

{
  "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": {
    "page_number": 2,
    "page_size": 25,
    "total_pages": 3,
    "total_results": 55
  }
}