Call Recording API

The call recordings API provides a way to access call recordings on the account.

API calls

Click on each call to view the endpoint, method, and request example.

Get recordings
Get recording media or document
Get recording document attachment
Remove a recording

Parameters

The table shows the possible parameters available for recording requests.

Key	Description	Type	Options/Min/Max/Default
`action`	Required. Indicates whether to start or stop the recording.	string	`start`, `stop`. The default is `start`.
`format`	Indicates the format to store the recording on disk.	string	`mp3`, `wav`
`label`	Label to include in the origin of call recording.	string
`media_name`	The name of media.	string
`method`	Method and endpoint to use when sending the recording to the supplied URL.	string	`put`, `post`. The default is `put`.
`origin`	Indicates how the recording was started - read-only	string
`record_min_sec`	The minimum length, in seconds, the recording must be to be considered successful. Otherwise it is deleted	integer
`record_on_answer`	Whether to delay the recording until the channel is answered. The default is `false`.	boolean
`record_on_bridge`	Whether to delay the recording until the channel is bridged. The default is `false`.	boolean
`record_sample_rate`	What sampling rate to use on the recording	integer
`should_follow_transfer`	If true, the recording will continue after a transfer on the active leg.	boolean	The default is `true`.
`skip_module`	When set to true this callflow action is skipped, advancing to the wildcard branch (if any).	boolean
`time_limit`	Time limit, in seconds, for the recording.	integer	The default is `3600`.
`url`	The URL to use when sending the recording for storage.	string

Get recordings

Returns a list of all call recordings with pagination and filtering.

Method and endpoint

GET /v2/accounts/{ACCOUNT_ID}/recordings GET /v2/accounts/{ACCOUNT_ID}/users/{USER_ID}/recordings

Request

curl -v -X GET \
    -H "X-Auth-Token: {AUTH_TOKEN}" \
    http://{SERVER}:8000/v2/accounts/{ACCOUNT_ID}/recordings

Get recording media or document

Returns a specific recording document.

Method and endpoint

GET /v2/accounts/{ACCOUNT_ID}/recordings/{RECORDING_ID}

Request

curl -v -X GET \
    -H "X-Auth-Token: {AUTH_TOKEN}" \
    http://{SERVER}:8000/v2/accounts/{ACCOUNT_ID}/recordings/{RECORDING_ID}

Get recording document attachment

Returns a specific recording document attachment if available.

NOTE: For clients that do not support setting the Accept header, a query string parameter can be included: ?accept=audio/mpeg. The optional parameter inline can be either true or false.

Method and endpoint

GET /v2/accounts/{ACCOUNT_ID}/recordings/{RECORDING_ID}

Request

curl -v -X GET \
    -H "X-Auth-Token: {AUTH_TOKEN}" \
    -H "Accept: audio/mpeg" \
    http://{SERVER}:8000/v2/accounts/{ACCOUNT_ID}/recordings/{RECORDING_ID}

Remove a recording

Deletes the metadata document. If the binary data is stored on the metadata document (instead of on a storage provider), it is also deleted. Recordings stored on storage providers are not deleted.

Method and endpoint

  DELETE /v2/accounts/{ACCOUNT_ID}/recordings/{RECORDING_ID}

Request

curl -v -X DELETE \
    -H "X-Auth-Token: {AUTH_TOKEN}" \
    http://{SERVER}:8000/v2/accounts/{ACCOUNT_ID}/recordings/{RECORDING_ID}