Telnyx

{ "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 } }

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

filter[date_ended_at]

object

Show child attributes

filter[date_ended_at][eq]

string<date>

ISO 8601 date for filtering room recordings ended on that date.

Example:

"2021-04-25"

filter[date_ended_at][gte]

string<date>

ISO 8601 date for filtering room recordings ended on or after that date.

Example:

"2021-04-25"

filter[date_ended_at][lte]

string<date>

ISO 8601 date for filtering room recordings ended on or before that date.

Example:

"2021-04-25"

filter[date_started_at]

object

Show child attributes

filter[date_started_at][eq]

string<date>

ISO 8601 date for filtering room recordings started on that date.

Example:

"2021-04-25"

filter[date_started_at][gte]

string<date>

ISO 8601 date for filtering room recordings started on or after that date.

Example:

"2021-04-25"

filter[date_started_at][lte]

string<date>

ISO 8601 date for filtering room recordings started on or before that date.

Example:

"2021-04-25"

filter[room_id]

string<uuid>

room_id for filtering room recordings.

Example:

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

filter[participant_id]

string<uuid>

participant_id for filtering room recordings.

Example:

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

filter[session_id]

string<uuid>

session_id for filtering room recordings.

Example:

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

filter[status]

string

status for filtering room recordings.

Example:

"completed"

filter[type]

string

type for filtering room recordings.

Example:

"audio"

filter[duration_secs]

integer

duration_secs greater or equal for filtering room recordings.

Example:

20

page

object

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

Show child attributes

page[size]

integer

default:20

The size of the page.

Required range: 1 <= x <= 250

page[number]

integer

default:1

The page number to load.

Required range: x >= 1

Response

200 - application/json

List room recordings response.

data

object[]

Show child attributes

data.id

string<uuid>

A unique identifier for the room recording.

Example:

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

data.room_id

string<uuid>

Identify the room associated with the room recording.

Example:

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

data.session_id

string<uuid>

Identify the room session associated with the room recording.

Example:

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

data.participant_id

string<uuid>

Identify the room participant associated with the room recording.

Example:

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

data.status

enum<string>

Shows the room recording status.

Available options:

completed,

processing

Example:

"completed"

data.type

enum<string>

Shows the room recording type.

Available options:

audio,

video

Example:

"audio"

data.size_mb

number<float>

Shows the room recording size in MB.

Example:

10.5

data.download_url

string

Url to download the recording.

Example:

"https://www.example.com"

data.codec

string

Shows the codec used for the room recording.

Example:

"opus"

data.duration_secs

integer

Shows the room recording duration in seconds.

Example:

67

data.created_at

string<date-time>

ISO 8601 timestamp when the room recording was created.

Example: