Call Recordings API

Call Recordings operations API

Retrieve call recording

Retrieves the details of an existing call recording

SecuritybearerAuth
Request
path Parameters
recording_id
required
string <uuid>

Uniquely identifies the recording by id.

Example: 6a09cdc3-8948-47f0-aa62-74ac943d6c58
Responses
200

Successful response with details about a recording.

Response Schema: application/json
object (RecordingResponseData)
call_control_id
string

Unique identifier and token for controlling the call.

call_leg_id
string

ID that is unique to the call and can be used to correlate webhook events.

call_session_id
string

ID that is unique to the call session and can be used to correlate webhook events. Call session is a group of related call legs that logically belong to the same phone call, e.g. an inbound and outbound leg of a transferred call.

channels
string

When dual, final audio file has the first leg on channel A, and the rest on channel B.

Enum: "single" "dual"
conference_id
string

Uniquely identifies the conference.

created_at
string

ISO 8601 formatted date indicating when the resource was created.

object

The links to download the recording files.

duration_millis
integer <int32>

The duration of the recording in milliseconds.

id
string

Uniquely identifies the recording.

record_type
string
Value: "recording"
recording_started_at
string

ISO 8601 formatted date of when the recording started.

recording_ended_at
string

ISO 8601 formatted date of when the recording ended.

source
string

The kind of event that led to this recording being created.

Enum: "conference" "call"
status
string

The status of the recording. Only resources for completed recordings are currently supported.

Value: "completed"
updated_at
string

ISO 8601 formatted date indicating when the resource was updated.

default

Unexpected error

Response Schema: application/json
Array of objects (Error)
Array
code
required
string <int>
detail
string
meta
object
object
title
required
string
get/recordings/{recording_id}
Request samples 
Response samples 
application/json
{
  • "data": {
    • "call_control_id": "v3:e-31OnvjEM7Y4wvxr3TKNk8M3QyLcGZPiUIzCGtwQtOtEjY-B0urkw",
    • "call_leg_id": "84a97d76-e40f-11ed-9074-02420a0daa69",
    • "call_session_id": "84a97d76-e40f-11ed-9074-02420a0daa69",
    • "channels": "dual",
    • "conference_id": "84a97d76-e40f-11ed-9074-02420a0daa69",
    • "created_at": "2018-02-02T22:25:27.521Z",
    • "download_urls": {
      • "mp3": "string",
      • "wav": "string"
      },
    • "duration_millis": 60000,
    • "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    • "record_type": "recording",
    • "recording_started_at": "2019-01-23T18:10:02.574Z",
    • "recording_ended_at": "2019-01-23T18:10:02.574Z",
    • "source": "conference",
    • "status": "completed",
    • "updated_at": "2018-02-02T22:25:27.521Z"
    }
}
Delete a call recording
Permanently deletes a call recording.


SecuritybearerAuth 
Request 
path Parameters
recording_id
required
string <uuid> 
Uniquely identifies the recording by id.


 
 Example:  6a09cdc3-8948-47f0-aa62-74ac943d6c58
Responses 
200
Successful response with details about a recording.


Response Schema: application/json
object (RecordingResponseData) 
 
call_control_id
string
Unique identifier and token for controlling the call.


 
call_leg_id
string
ID that is unique to the call and can be used to correlate webhook events.


 
call_session_id
string
ID that is unique to the call session and can be used to correlate webhook events. Call session is a group of related call legs that logically belong to the same phone call, e.g. an inbound and outbound leg of a transferred call.


 
channels
string
When dual, final audio file has the first leg on channel A, and the rest on channel B.


 Enum: "single" "dual"  
conference_id
string
Uniquely identifies the conference.


 
created_at
string
ISO 8601 formatted date indicating when the resource was created.


 
object
The links to download the recording files.


 
duration_millis
integer <int32> 
The duration of the recording in milliseconds.


 
id
string
Uniquely identifies the recording.


 
record_type
string
 Value: "recording"  
recording_started_at
string
ISO 8601 formatted date of when the recording started.


 
recording_ended_at
string
ISO 8601 formatted date of when the recording ended.


 
source
string
The kind of event that led to this recording being created.


 Enum: "conference" "call"  
status
string
The status of the recording. Only resources for completed recordings are currently supported.


 Value: "completed"  
updated_at
string
ISO 8601 formatted date indicating when the resource was updated.


 
default
Unexpected error


Response Schema: application/json
Array of objects (Error) 
 
 Array 
code
required
string <int> 
 
detail
string
 
meta
object
 
object
 
title
required
string
 
delete/recordings/{recording_id}
Request samples 
Response samples 
application/json
{
  • "data": {
    • "call_control_id": "v3:e-31OnvjEM7Y4wvxr3TKNk8M3QyLcGZPiUIzCGtwQtOtEjY-B0urkw",
    • "call_leg_id": "84a97d76-e40f-11ed-9074-02420a0daa69",
    • "call_session_id": "84a97d76-e40f-11ed-9074-02420a0daa69",
    • "channels": "dual",
    • "conference_id": "84a97d76-e40f-11ed-9074-02420a0daa69",
    • "created_at": "2018-02-02T22:25:27.521Z",
    • "download_urls": {
      • "mp3": "string",
      • "wav": "string"
      },
    • "duration_millis": 60000,
    • "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    • "record_type": "recording",
    • "recording_started_at": "2019-01-23T18:10:02.574Z",
    • "recording_ended_at": "2019-01-23T18:10:02.574Z",
    • "source": "conference",
    • "status": "completed",
    • "updated_at": "2018-02-02T22:25:27.521Z"
    }
}
Deletes a list of call recordings
Permanently deletes a list of call recordings.


SecuritybearerAuth 
Request 
Request Body schema: application/json
required
List of Call Recordings IDs to delete.


 Array 
string
 
Responses 
204
The recordings have been successfully deleted.


default
Unexpected error


Response Schema: application/json
Array of objects (Error) 
 
 Array 
code
required
string <int> 
 
detail
string
 
meta
object
 
object
 
title
required
string
 
post/recordings/actions/delete
Request samples 
application/json
[
  • "string"
]
Response samples 
application/json
{
  • "errors": [
    • {
      • "code": "string",
      • "detail": "string",
      • "meta": { },
      • "source": {
        • "parameter": "string",
        • "pointer": "/json/pointer"
        },
      • "title": "string"
      }
    ]
}
List all call recordings
Returns a list of your call recordings.


SecuritybearerAuth 
Responses 
200
Successful response with details about recordings.


Response Schema: application/json
Array of objects (RecordingResponseData) 
 
 Array 
call_control_id
string
Unique identifier and token for controlling the call.


 
call_leg_id
string
ID that is unique to the call and can be used to correlate webhook events.


 
call_session_id
string
ID that is unique to the call session and can be used to correlate webhook events. Call session is a group of related call legs that logically belong to the same phone call, e.g. an inbound and outbound leg of a transferred call.


 
channels
string
When dual, final audio file has the first leg on channel A, and the rest on channel B.


 Enum: "single" "dual"  
conference_id
string
Uniquely identifies the conference.


 
created_at
string
ISO 8601 formatted date indicating when the resource was created.


 
object
The links to download the recording files.


 
duration_millis
integer <int32> 
The duration of the recording in milliseconds.


 
id
string
Uniquely identifies the recording.


 
record_type
string
 Value: "recording"  
recording_started_at
string
ISO 8601 formatted date of when the recording started.


 
recording_ended_at
string
ISO 8601 formatted date of when the recording ended.


 
source
string
The kind of event that led to this recording being created.


 Enum: "conference" "call"  
status
string
The status of the recording. Only resources for completed recordings are currently supported.


 Value: "completed"  
updated_at
string
ISO 8601 formatted date indicating when the resource was updated.


 
default
Unexpected error


Response Schema: application/json
Array of objects (Error) 
 
 Array 
code
required
string <int> 
 
detail
string
 
meta
object
 
object
 
title
required
string
 
get/recordings
Request samples 
Response samples 
application/json
{
  • "data": [
    • {
      • "call_control_id": "v3:e-31OnvjEM7Y4wvxr3TKNk8M3QyLcGZPiUIzCGtwQtOtEjY-B0urkw",
      • "call_leg_id": "84a97d76-e40f-11ed-9074-02420a0daa69",
      • "call_session_id": "84a97d76-e40f-11ed-9074-02420a0daa69",
      • "channels": "dual",
      • "conference_id": "84a97d76-e40f-11ed-9074-02420a0daa69",
      • "created_at": "2018-02-02T22:25:27.521Z",
      • "download_urls": {
        • "mp3": "string",
        • "wav": "string"
        },
      • "duration_millis": 60000,
      • "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      • "record_type": "recording",
      • "recording_started_at": "2019-01-23T18:10:02.574Z",
      • "recording_ended_at": "2019-01-23T18:10:02.574Z",
      • "source": "conference",
      • "status": "completed",
      • "updated_at": "2018-02-02T22:25:27.521Z"
      }
    ]
}
Delete stored credentials
Deletes a stored custom credentials configuration.


SecuritybearerAuth 
Request 
path Parameters
connection_id
required
string
Uniquely identifies a Telnyx application (Call Control)


 
Responses 
204
The credentials configuration for connection_id was deleted successfully.


default
Unexpected error


Response Schema: application/json
Array of objects (Error) 
 
 Array 
code
required
string <int> 
 
detail
string
 
meta
object
 
object
 
title
required
string
 
delete/custom_storage_credentials/{connection_id}
Request samples 
Response samples 
application/json
{
  • "errors": [
    • {
      • "code": "string",
      • "detail": "string",
      • "meta": { },
      • "source": {
        • "parameter": "string",
        • "pointer": "/json/pointer"
        },
      • "title": "string"
      }
    ]
}
Retrieve stored credentials
Returns the information about custom storage credentials.


SecuritybearerAuth 
Request 
path Parameters
connection_id
required
string
Uniquely identifies a Telnyx application (Call Control)


 
Responses 
200
A response with credentials resource.


Response Schema: application/json
required
object (CustomStorageConfiguration) 
 
record_type
required
string (RecordType) custom_storage_credentials
Identifies record type.


 
default
Unexpected error


Response Schema: application/json
Array of objects (Error) 
 
 Array 
code
required
string <int> 
 
detail
string
 
meta
object
 
object
 
title
required
string
 
get/custom_storage_credentials/{connection_id}
Request samples 
Response samples 
application/json
{
  • "data": {
    • "backend": "gcs",
    • "configuration": {
      • "bucket": "example-bucket",
      • "credentials": "OPAQUE_CREDENTIALS_TOKEN"
      }
    },
  • "record_type": "string"
}
Create custom storage credentials
Creates custom storage credentials configuration.


SecuritybearerAuth 
Request 
path Parameters
connection_id
required
string
Uniquely identifies a Telnyx application (Call Control)


 
Request Body schema: application/json
required
Creates new credentials resource for given connection_id.


backend
required
string
 Enum: "gcs" "s3"  
required
Google Cloud Storage Configuration Data (object) or AWS S3 Storage Configuration Data (object)
 
Responses 
200
A response with credentials resource.


Response Schema: application/json
required
object (CustomStorageConfiguration) 
 
record_type
required
string (RecordType) custom_storage_credentials
Identifies record type.


 
default
Unexpected error


Response Schema: application/json
Array of objects (Error) 
 
 Array 
code
required
string <int> 
 
detail
string
 
meta
object
 
object
 
title
required
string
 
post/custom_storage_credentials/{connection_id}
Request samples 
application/json
{
  • "backend": "gcs",
  • "configuration": {
    • "bucket": "example-bucket",
    • "credentials": "OPAQUE_CREDENTIALS_TOKEN"
    }
}
Response samples 
application/json
{
  • "data": {
    • "backend": "gcs",
    • "configuration": {
      • "bucket": "example-bucket",
      • "credentials": "OPAQUE_CREDENTIALS_TOKEN"
      }
    },
  • "record_type": "string"
}
Update stored credentials
Updates a stored custom credentials configuration.


SecuritybearerAuth 
Request 
path Parameters
connection_id
required
string
Uniquely identifies a Telnyx application (Call Control)


 
Request Body schema: application/json
required
Creates new credentials resource for given connection_id.


backend
required
string
 Enum: "gcs" "s3"  
required
Google Cloud Storage Configuration Data (object) or AWS S3 Storage Configuration Data (object)
 
Responses 
200
A response with credentials resource.


Response Schema: application/json
required
object (CustomStorageConfiguration) 
 
record_type
required
string (RecordType) custom_storage_credentials
Identifies record type.


 
default
Unexpected error


Response Schema: application/json
Array of objects (Error) 
 
 Array 
code
required
string <int> 
 
detail
string
 
meta
object
 
object
 
title
required
string
 
put/custom_storage_credentials/{connection_id}
Request samples 
application/json
{
  • "backend": "gcs",
  • "configuration": {
    • "bucket": "example-bucket",
    • "credentials": "OPAQUE_CREDENTIALS_TOKEN"
    }
}
Response samples 
application/json
{
  • "data": {
    • "backend": "gcs",
    • "configuration": {
      • "bucket": "example-bucket",
      • "credentials": "OPAQUE_CREDENTIALS_TOKEN"
      }
    },
  • "record_type": "string"
}