Skip to content
Vocapable Developers

List inbound voicemail inbox receipts

GET
/v1/calls/inbound-voicemails
curl --request GET \
  --url 'https://api.vocapable.com/v1/calls/inbound-voicemails?limit=50' \
  --header 'Authorization: Bearer <token>'

List admitted inbound messages, including explicit import failures and absences.

This is a receipt inbox, not a second recordings API. When an item says available, its call_id can be read through the ordinary call detail and recording endpoints; every other state is intentionally non-playable.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Query Parameters

Section titled “Query Parameters”
limit
Limit
integer
default: 50 >= 1 <= 200
cursor
Any of:
string

Responses

Section titled “Responses”

200

Section titled “200”

Successful Response

Media typeapplication/json
CursorPage[InboundVoicemailSummary]
object
data
required
Data
Array<object>
InboundVoicemailSummary

One inbound voicemail receipt in the customer inbox.

A receipt appears as soon as a lawful caller is invited to record, so a carrier or storage failure is visible rather than silently dropping the message. call_id and recording_id stay null until private audio has been imported into the ordinary Call and Recording records; clients must not construct an audio URL from this response.

object
id
required
Id
string
status
required
Status
string
Allowed values: recording ready importing available absent failed
call_id
Any of:
string
recording_id
Any of:
string
phone_number_id
required
Phone Number Id
string
agent_version_id
required
Agent Version Id
string
contact_id
Any of:
string
from_e164
required
From E164
string
to_e164
required
To E164
string
duration_seconds
Any of:
integer
received_at
required
Received At
string format: date-time
completed_at
Any of:
string format: date-time
failure_code
Any of:
string
updated_at
required
Updated At
string format: date-time
next_cursor
Any of:
string
has_more
Has More
boolean
Example
{
  "data": [
    {
      "status": "recording"
    }
  ],
  "has_more": false
}

422

Section titled “422”

Validation Error

Media typeapplication/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
input
Input
ctx
Context
object
Examplegenerated
{
  "detail": [
    {
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example",
      "input": "example",
      "ctx": {}
    }
  ]
}