Call Recordings in the API

The Recordings API reads call recordings stored for the account and fetches the media or document for one recording. A request can also remove a recording. Automated use of this API can cause the account's API access to be restricted, so talk with the team before a job lists or downloads recordings on a schedule. Fetch a single recording when a person or a ticket needs that file.

About Recordings

Recordings endpoint provides a way to access call recordings.

Fetch recordings#

GET /v2/accounts/{ACCOUNT_ID}/recordings

Lists the call recording with pagination and filtering.

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

Fetch recording media or document#

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

Gets a specific recording document.

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

Gets a specific recording document attachment if available. Mind the Accept header in example below. For clients that do not support setting the Accept header, a query string parameter can be included: ?accept=audio/mpeg.

Optional parameter inline can be either true or false.

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#

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

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

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