Recordings

Get recording download paths

get

Generate download paths for call recording playback. Returns separate paths for inbound (caller) and outbound (agent) audio channels, plus the recording metadata file.

Authorizations

AuthorizationstringRequired

API key issued via POST /v1/{workspace_id}/api-keys. Pass the returned api_key value as a Bearer token.

Path parameters

workspace_idstring · uuidRequired

call_sidstringRequired

Responses

200

Successful Response

application/json

Download paths for call recording playback.

call_sidstringRequired

Twilio call SID

statusconst: availableOptional

Recording availability status

Default: available

inbound_urlstring · nullableOptional

Download URL for inbound (caller) audio

outbound_urlstring · nullableOptional

Download URL for outbound (agent) audio

metadata_urlstring · nullableOptional

Download URL for recording metadata JSON

404

Recording not found

422

Validation Error

application/json

503

Call recording not configured

get/v1/{workspace_id}/recordings/{call_sid}/urls

GET /v1/{workspace_id}/recordings/{call_sid}/urls HTTP/1.1
Host: api.platform.amigo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "call_sid": "text",
  "status": "available",
  "inbound_url": "text",
  "outbound_url": "text",
  "metadata_url": "text"
}

Get recording metadata

get

Fetch metadata for a call recording including duration, audio formats, sample rates, and file sizes.

Authorizations

AuthorizationstringRequired

API key issued via POST /v1/{workspace_id}/api-keys. Pass the returned api_key value as a Bearer token.

Path parameters

workspace_idstring · uuidRequired

call_sidstringRequired

Responses

200

Successful Response

application/json

Call recording metadata.

call_sidstringRequired

Twilio call SID

workspace_idstring · uuidRequired

Workspace that owns this recording

service_idstring · uuid · nullableOptional

Service (agent) that handled the call

directionstring · enumRequired

Call direction

Possible values:

duration_secondsnumberRequired

Total call duration in seconds

inbound_formatstringRequired

Audio format for the inbound (caller) channel

inbound_sample_rateintegerRequired

Sample rate in Hz for the inbound channel

outbound_formatstringRequired

Audio format for the outbound (agent) channel

outbound_sample_rateintegerRequired

Sample rate in Hz for the outbound channel

tts_providerstringRequired

Text-to-speech provider used for the call

call_start_isostringRequired

Call start time as ISO-8601 string

call_end_isostringRequired

Call end time as ISO-8601 string

inbound_size_bytesintegerRequired

Inbound audio file size in bytes

outbound_size_bytesintegerRequired

Outbound audio file size in bytes

media_start_epoch_msnumberRequired

Media stream start time as Unix epoch milliseconds

404

Recording not found

422

Validation Error

application/json

503

Call recording not configured

get/v1/{workspace_id}/recordings/{call_sid}/metadata

GET /v1/{workspace_id}/recordings/{call_sid}/metadata HTTP/1.1
Host: api.platform.amigo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "call_sid": "text",
  "workspace_id": "123e4567-e89b-12d3-a456-426614174000",
  "service_id": "123e4567-e89b-12d3-a456-426614174000",
  "direction": "inbound",
  "duration_seconds": 1,
  "inbound_format": "text",
  "inbound_sample_rate": 1,
  "outbound_format": "text",
  "outbound_sample_rate": 1,
  "tts_provider": "text",
  "call_start_iso": "text",
  "call_end_iso": "text",
  "inbound_size_bytes": 1,
  "outbound_size_bytes": 1,
  "media_start_epoch_ms": 1
}

Download recording file

get

Proxy download a recording file (inbound audio, outbound audio, or metadata) from UC Volume.

Authorizations

AuthorizationstringRequired

API key issued via POST /v1/{workspace_id}/api-keys. Pass the returned api_key value as a Bearer token.

Path parameters

workspace_idstring · uuidRequired

call_sidstringRequired

filenamestringRequired

Responses

200

Successful Response

application/json

anyOptional

400

Invalid filename

404

Recording file not found

422

Validation Error

application/json

503

Call recording not configured

get/v1/{workspace_id}/recordings/{call_sid}/download/{filename}

GET /v1/{workspace_id}/recordings/{call_sid}/download/{filename} HTTP/1.1
Host: api.platform.amigo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content