List voicemail messages

curl --request GET \
  --url https://{host}/api/v1/voicemail \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://{host}/api/v1/voicemail', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{}

{
  "error": {
    "code": "invalid_request",
    "message": "<string>"
  }
}

{
  "error": {
    "code": "invalid_request",
    "message": "<string>"
  }
}

{
  "error": {
    "code": "invalid_request",
    "message": "<string>"
  }
}

Voicemail

List voicemail messages

Messages left when nobody could take the call. Recorded by FireTone rather than mod_voicemail, so a message carries the call it came from and the customer who left it. Transcription happens after the call and may lag by seconds; status is new, transcribing, ready or failed, and a failed message still has playable audio because the audio is the product and the text is the convenience. Default sort is created_at descending. Filters: status, source, extension_id, queue_id, contact_id, call_uuid, since. Search covers the transcript, the summary and the caller’s number.

List voicemail messages

curl --request GET \
  --url https://{host}/api/v1/voicemail \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://{host}/api/v1/voicemail', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{}

{
  "error": {
    "code": "invalid_request",
    "message": "<string>"
  }
}

{
  "error": {
    "code": "invalid_request",
    "message": "<string>"
  }
}

{
  "error": {
    "code": "invalid_request",
    "message": "<string>"
  }
}

Authorizations

Authorization

string

header

required

Every request sends Authorization: Bearer <token>. The token is either a panel session (a JWT from /auth/login, 12 hours) or an API key ft_<id>_<secret>. An API key is accepted only from an address on its IP allowlist (403 ip_not_allowed otherwise; 403 ip_allowlist_required for an old key that has none), is limited to its rate per minute (429 rate_limited with Retry-After; X-RateLimit-Limit/Remaining/Reset on every response), and at most 60 call placements a minute.

Query Parameters

limit

integer

default:50

Required range: x <= 500

offset

integer

default:0

sort

string

Sort key. Each list accepts its own allow-list of keys, given in that endpoint's description; anything else is a 400. ORDER BY cannot be parameterised, so the key is looked up rather than interpolated. Every sort carries a tiebreak on the primary key, so paging stays disjoint when the sort column has duplicates.

Response

List voicemail messages

The response is of type object.