Call Recordings

About Recordings

Recordings endpoint provides a way to access call recordings.

Fetch recordings

Fetches recordings for the whole account

GET /v2/accounts/{ACCOUNT_ID}/recordings

Fetches recordings for the {USER_ID}

GET /v2/accounts/{ACCOUNT_ID}/users/{USER_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}

Change writable properties on a recording

You can change user metadata on a recording to store extra information with the recording for your own purposes. This metadata can also be used by some storage back-ends.

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

curl -v -X PATCH \
    -H "X-Auth-Token: {AUTH_TOKEN}" \
    -H "Content-Type: application/json" \
    -d '{"data": {
          "user_metadata": { "tags": { "important": 1 } }
         }
        }' \
    http://{SERVER}:8000/v2/accounts/{ACCOUNT_ID}/recordings/{RECORDING_ID}

{
    "data": {
        "user_metadata": {
            "tags": {
                "important": 1
            }
        },
        ...
    }
}

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}