Voicemail

List voicemails

get

List voicemail records with optional filters. Requires Channel.view permission.

Authorizations

BearerAuth

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

Query parameters

use_case_idany ofOptional

string · uuidOptional

or

nullOptional

setup_idany ofOptional

string · uuidOptional

or

nullOptional

statusany ofOptional

or

nullOptional

recipient_phone_numberany ofOptional

string · max: 16OptionalPattern: ^\+1\d{10}$

or

nullOptional

Responses

200

Successful Response

application/json

403

Insufficient permissions.

422

Validation Error

application/json

get

/v1/{workspace_id}/voicemail

HTTPcURLJavaScriptPython

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

{
  "items": [
    {
      "voicemail_id": "123e4567-e89b-12d3-a456-426614174000",
      "setup_id": "text",
      "use_case_id": "text",
      "recipient_phone_number": "text",
      "status": "text",
      "created_at": "2026-05-12T12:44:59.436Z",
      "updated_at": "2026-05-12T12:44:59.436Z"
    }
  ]
}

Send a voicemail

post

Send a ringless voicemail. Accepts multipart form with use_case_id, recipient_phone_number (US E.164), and audio MP3 file (10-60s, max 8 MB). Requires Channel.send permission.

Authorizations

BearerAuth

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

Body

multipart/form-data

use_case_idstring · uuidRequired

recipient_phone_numberstring · max: 16RequiredPattern: ^\+1\d{10}$

audiostringRequired

Responses

201

Successful Response

application/json

403

Insufficient permissions.

404

Use case not found or no phone assigned.

413

Audio exceeds 8 MB.

422

Invalid audio or configuration.

502

Channel manager unavailable.

504

Channel manager timed out.

post

/v1/{workspace_id}/voicemail

HTTPcURLJavaScriptPython

POST /v1/{workspace_id}/voicemail HTTP/1.1
Host: api.platform.amigo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: multipart/form-data
Accept: */*
Content-Length: 101

{
  "use_case_id": "123e4567-e89b-12d3-a456-426614174000",
  "recipient_phone_number": "text",
  "audio": "text"
}

{
  "voicemail_id": "123e4567-e89b-12d3-a456-426614174000",
  "sender_phone_number": "text"
}