View a list of room recordings.

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

View a list of room recordings.

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

Parameters

In Query
filter[date_ended_at][eq]
string
(date)
optional
ISO 8601 date for filtering room recordings ended on that date.
Example: "2021-04-25"
filter[date_ended_at][gte]
string
(date)
optional
ISO 8601 date for filtering room recordings ended after that date.
Example: "2021-04-25"
filter[date_ended_at][lte]
string
(date)
optional
ISO 8601 date for filtering room recordings ended before that date.
Example: "2021-04-25"
filter[date_started_at][eq]
string
(date)
optional
ISO 8601 date for filtering room recordings started on that date.
Example: "2021-04-25"
filter[date_started_at][gte]
string
(date)
optional
ISO 8601 date for filtering room recordings started after that date.
Example: "2021-04-25"
filter[date_started_at][lte]
string
(date)
optional
ISO 8601 date for filtering room recordings started before that date.
Example: "2021-04-25"
filter[room_id]
string
(uuid)
optional
room_id for filtering room recordings.
Example: "0ccc7b54-4df3-4bca-a65a-3da1ecc777f0"
filter[participant_id]
string
(uuid)
optional
participant_id for filtering room recordings.
Example: "0ccc7b54-4df3-4bca-a65a-3da1ecc777f0"
filter[session_id]
string
(uuid)
optional
session_id for filtering room recordings.
Example: "0ccc7b54-4df3-4bca-a65a-3da1ecc777f0"
filter[status]
string
optional
status for filtering room recordings.
Example: "completed"
filter[type]
string
optional
type for filtering room recordings.
Example: "audio"
filter[duration_secs][eq]
integer
optional
duration_secs equal for filtering room recordings.
Example: 20
filter[duration_secs][lte]
integer
optional
duration_secs less or equal for filtering room recordings.
Example: 20
filter[duration_secs][gte]
integer
optional
duration_secs greater or equal for filtering room recordings.
Example: 20
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 room recordings response.

Success Response

{
  "data": {
    "codec": "opus",
    "completed_at": "2021-04-16T10:25:55.962200Z",
    "created_at": "2021-04-16T09:46:20.954863Z",
    "download_url": "https://www.example.com",
    "duration_secs": 3660,
    "ended_at": "2021-04-16T10:24:55.962200Z",
    "id": "6b61621f-62e0-4aad-ab11-9fd19e272e73",
    "participant_id": "9b61621f-5fe4-4aad-ab11-9fd19e272e73",
    "record_type": "room_session",
    "room_id": "7b61621f-5fe4-4aad-ab11-9fd19e272e73",
    "session_id": "8b61621f-5fe4-4aad-ab11-9fd19e272e73",
    "size_mb": 5.6,
    "started_at": "2021-04-16T09:24:55.962200Z",
    "status": "completed",
    "type": "audio",
    "updated_at": "2021-04-16T10:24:55.962200Z"
  },
  "meta": {
    "page_number": 2,
    "page_size": 25,
    "total_pages": 3,
    "total_results": 55
  }
}

...

deletehttps://api.telnyx.com/v2/room_recordings

...

...

Parameters

Responses

Success Response

...

gethttps://api.telnyx.com/v2/room_recordings/{room_recording_id}

...

...

Parameters

Responses

Success Response

...

deletehttps://api.telnyx.com/v2/room_recordings/{room_recording_id}

...

...

Parameters

Responses

Success Response

Was this page helpful?