Call Recordings V1

Call Recording operations

List all call recordings

Returns a list of your call recordings.

Request
query Parameters
page[page]
integer
Default: 1

Page number of results to load

page[page_size]
integer <= 1000
Default: 20

Number of results per page

call_id
string

If present, recordings will be filtered to those with a matching call_id. Matching is case-sensitive

from
string

If present, recordings will be filtered to those with a matching from attribute. Matching is case-sensitive

to
string

If present, recordings will be filtered to those with a matching to attribute. Matching is case-sensitive

telnyx_session_uuid
string

If present, recordings will be filtered to those with a matching telnyx_session_uuid attribute. Matching is case-sensitive

connection_id
string

If present, recordings will be filtered to those with a matching connection_id attribute. Matching is case-sensitive

Responses
200

Call Recording response

Response Schema: application/json
Array of objects (CallRecordingResponse)
Array
id
required
string

Unique identifier of the recording

record_type
required
string

The type of record being returned. This will always be recording

required
object (Call)
required
object (DownloadURLs)
created_at
required
string

ISO 8601 formatted date of when the call recording was created

updated_at
required
string

ISO 8601 formatted date of when the call recording was last updated

401

Unauthorized

422

Unprocessable entity. Can be caused by improper use of filters or nodes.

get/recordings
Request samples
Response samples
application/json
{
  • "data": [
    • {
      • "id": "string",
      • "record_type": "string",
      • "call": {
        • "start_time": "string",
        • "end_time": "string",
        • "duration": 0,
        • "to": "string",
        • "from": "string",
        • "telnyx_session_uuid": "string",
        • "connection_id": "string"
        },
      • "download_urls": {
        • "wav": "string"
        },
      • "created_at": "string",
      • "updated_at": "string"
      }
    ]
}

Retrieve a call recording

Retrieves the details of an existing call recording.

Request
path Parameters
id
required
string

ID of the recording to retrieve

Responses
200

Call recording response

Response Schema: application/json
object (CallRecordingResponse)
id
required
string

Unique identifier of the recording

record_type
required
string

The type of record being returned. This will always be recording

required
object (Call)
required
object (DownloadURLs)
created_at
required
string

ISO 8601 formatted date of when the call recording was created

updated_at
required
string

ISO 8601 formatted date of when the call recording was last updated

401

Unauthorized

404

Resource not found

422

Unprocessable entity. Can be caused by invalid UUID format

get/recordings/{id}
Request samples
Response samples
application/json
{
  • "data": {
    • "id": "string",
    • "record_type": "string",
    • "call": {
      • "start_time": "string",
      • "end_time": "string",
      • "duration": 0,
      • "to": "string",
      • "from": "string",
      • "telnyx_session_uuid": "string",
      • "connection_id": "string"
      },
    • "download_urls": {
      • "wav": "string"
      },
    • "created_at": "string",
    • "updated_at": "string"
    }
}

Delete a call recording

Permanently deletes a call recording.

Request
path Parameters
id
required
string

ID of Call Recording to delete

Responses
200

Call recording response

Response Schema: application/json
object (CallRecordingResponse)
id
required
string

Unique identifier of the recording

record_type
required
string

The type of record being returned. This will always be recording

required
object (Call)
required
object (DownloadURLs)
created_at
required
string

ISO 8601 formatted date of when the call recording was created

updated_at
required
string

ISO 8601 formatted date of when the call recording was last updated

401

Unauthorized

404

Resource not found

422

Unprocessable entity. Can be caused by invalid UUID format

delete/recordings/{id}
Request samples
Response samples
application/json
{
  • "data": {
    • "id": "string",
    • "record_type": "string",
    • "call": {
      • "start_time": "string",
      • "end_time": "string",
      • "duration": 0,
      • "to": "string",
      • "from": "string",
      • "telnyx_session_uuid": "string",
      • "connection_id": "string"
      },
    • "download_urls": {
      • "wav": "string"
      },
    • "created_at": "string",
    • "updated_at": "string"
    }
}

Deletes a list of call recordings

Permanently deletes a list of call recordings.

Request
Request Body schema: application/json

List of Call Recordings IDs to delete

Array
string
Responses
204

Success

401

Unauthorized

422

Unprocessable entity. Can be caused by invalid UUID format

post/recordings/actions/delete
Request samples
application/json
[
  • "string"
]