Read one inbound voicemail receipt

GET

/v1/calls/inbound-voicemails/{voicemail_id}

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

Return receipt state and timing, never audio bytes or a carrier callback URL.

Authorizations

• HTTPBearer

Parameters

Path Parameters

voicemail_id

required

Voicemail Id

string

Responses

200

Successful Response

Media typeapplication/json

InboundVoicemail

The full non-audio receipt for GET /calls/inbound-voicemails/{id}.

object

id

required

Id

string

status

required

Status

string

Allowed values: recording ready importing available absent failed

call_id

Any of:

string

string

null

null

recording_id

Any of:

string

string

null

null

phone_number_id

required

Phone Number Id

string

agent_version_id

required

Agent Version Id

string

contact_id

Any of:

string

string

null

null

from_e164

required

From E164

string

to_e164

required

To E164

string

duration_seconds

Any of:

integer

integer

null

null

received_at

required

Received At

string format: date-time

completed_at

Any of:

string

string format: date-time

null

null

failure_code

Any of:

string

string

null

null

updated_at

required

Updated At

string format: date-time

recording_action_at

Any of:

string

string format: date-time

null

null

max_recording_seconds

required

Max Recording Seconds

integer

Example

{
  "status": "recording"
}

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

Example^generated

{
  "detail": [
    {
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example",
      "input": "example",
      "ctx": {}
    }
  ]
}