Skip to content
vocapable.Docs

Voicemails across every business line, newest first

GET
/v1/workspace/voicemails
curl --request GET \
  --url 'https://api.vocapable.com/v1/workspace/voicemails?state=open&mine=false&limit=25' \
  --header 'Authorization: Bearer <token>'

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Query Parameters

Section titled “Query Parameters”
state
State
string
default: open
Allowed values: open handled all
line
Any of:
string
<= 64 characters
mine
Mine
boolean
cursor
Any of:
string
<= 128 characters
limit
Limit
integer
default: 25 >= 1 <= 50

Responses

Section titled “Responses”

200

Section titled “200”

Successful Response

Media typeapplication/json
WorkspaceVoicemails
object
data
required
Data
Array<object>
WorkspaceVoicemail
object
id
required
Id
string
status
required
Status
string
Allowed values: ready importing available failed
phone_number_id
required
Phone Number Id
string
line_e164
required
Line E164
string
caller
required
WorkspaceVoicemailCaller
object
phone_e164
required
Phone E164
string
contact_id
required
Any of:
string
name
required
Any of:
string
organization_id
required
Any of:
string
organization_name
required
Any of:
string
received_at
required
Received At
string format: date-time
duration_seconds
required
Any of:
integer
call_id
required
Any of:
string
transcript
required
Any of:
string
summary
required
Any of:
string
source
required
Source
string
Allowed values: waiting_line answering_policy voicemail_route
unread
required
Unread
boolean
handled
required
Handled
boolean
handled_at
required
Any of:
string format: date-time
handled_by
required
Any of:
WorkspacePersonRef

A teammate named on a record: the id the server holds and the name to show.

object
user_id
required
User Id
string
name
required
Name
string
assignee
required
Any of:
WorkspacePersonRef

A teammate named on a record: the id the server holds and the name to show.

object
user_id
required
User Id
string
name
required
Name
string
revision
required
Revision
integer
return_call
required
WorkspaceVoicemailReturnCall

What the Return call button dials: the caller, from the line they called.

object
contact_id
required
Any of:
string
phone_e164
required
Phone E164
string
from_line_id
required
From Line Id
string
unread
required
Unread
integer
viewer_user_id
required
Viewer User Id
string
has_more
required
Has More
boolean
next_cursor
required
Any of:
string
Example
{
  "data": [
    {
      "status": "ready",
      "source": "waiting_line"
    }
  ]
}

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": {}
    }
  ]
}