Documentation menu

API reference

Recordings

List, download, and delete call recordings captured by <Record> or <RecordSession>.

GET/recordings/

List recordings. Query: call_uuid (string, optional), limit (integer, default 50, max 200), offset (integer, default 0). Returns array<Recording>.

POST/recordings/download

Get a time-limited download URL.

FieldTypeRequiredDefaultDescription
uuidstringRequiredThe recording.
ttl_secondsintegerOptional300How long the URL stays valid.

Returns { url: string, expires_in: integer }. Errors 404 not found, 410 deleted.

POST/recordings/delete

Soft-delete a recording. Body { uuid: string }. Returns { message: string }.

The Recording object

FieldTypeDescription
uuidstringStable identifier.
call_uuid / call_sidstringThe call this recording belongs to.
duration_secondsinteger, nullableLength of the audio.
size_bytesinteger, nullableFile size.
media_formatstringAudio format, e.g. wav.
storage_backendstringWhere the file lives.
expires_atstring, nullableWhen it will be purged.
created_atstringISO-8601 timestamp.