Skip to content
vocapable.Docs

Your call queue, the team's, incoming requests, or history

GET
/v1/workspace/queue
curl --request GET \
  --url 'https://api.vocapable.com/v1/workspace/queue?view=mine&filter=all&limit=50' \
  --header 'Authorization: Bearer <token>'

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Query Parameters

Section titled “Query Parameters”
view
View
string
default: mine
Allowed values: mine team incoming history
q
Any of:
string
<= 120 characters
filter
Filter

History only: how the conversation ended.

string
default: all
Allowed values: all missed ai_answered voicemail

History only: how the conversation ended.

limit
Limit
integer
default: 50 >= 1 <= 200
cursor
Any of:
string

Responses

Section titled “Responses”

200

Section titled “200”

Successful Response

Media typeapplication/json
WorkspaceQueue

One call-desk view. Exactly the list its view names is filled.

object
view
required
View
string
Allowed values: mine team incoming history
rows
Rows
Array<object>
WorkspaceQueueRow
object
contact_id
required
Contact Id
string
organization_id
required
Any of:
string
organization_name
required
Any of:
string
name
required
Name
string
title
required
Any of:
string
owner
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
assignment
required
Assignment
string
Allowed values: assigned_to_you assigned_to_teammate unassigned
status
required
Status
string
Allowed values: ready held do_not_contact contact_review_needed
hold
required
Any of:
WorkspacePolicyHold
object
code
required
Code
string
Allowed values: do_not_contact owned_by_teammate owner_unassigned device_not_ready not_available no_address contact_review_needed ai_consent_missing callback_scheduled timezone_unknown outside_local_window frequency_cap_reached service_not_entitled spend_cap_reached
message
required
Message
string
recovery
required
Recovery
string
stage
required
Any of:
string
need
required
Any of:
string
next_step
required
Any of:
string
incoming
Incoming
Array<object>
WorkspaceIncomingItem

A request a caller left with the AI receptionist, routed to people.

object
id
required
Id
string
kind
required
Kind
string
Allowed values: message support_ticket
state
required
State
string
Allowed values: open acknowledged resolved
severity
required
Any of:
string
contact_id
required
Any of:
string
organization_id
required
Any of:
string
organization_name
required
Any of:
string
contact_name
required
Any of:
string
caller_name
required
Any of:
string
subject
required
Any of:
string
reason
required
Reason
string
called_company
required
Called Company
string
ai_call_id
required
Any of:
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
created_at
required
Created At
string format: date-time
version
required
Version
integer
history
History
Array<object>
WorkspaceHistoryItem

One conversation. A transferred call is one conversation with several handlers.

object
call_id
required
Call Id
string
contact_id
required
Any of:
string
organization_id
required
Any of:
string
organization_name
required
Any of:
string
contact_name
required
Any of:
string
direction
required
Direction
string
Allowed values: outbound inbound handoff
phase
required
Phase
string
Allowed values: requested ringing talking transfer_pending wrap_up completed failed abandoned
handlers
required
Handlers
Array<object>
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
transferred
required
Transferred
boolean
outcome
required
Any of:
string
Allowed values: conversation callback no_answer do_not_contact not_interested voicemail failed wrong_number
notes
required
Any of:
string
next_step
required
Any of:
string
ai_call_id
required
Any of:
string
requested_at
required
Requested At
string format: date-time
ended_at
required
Any of:
string format: date-time
transcription
WorkspaceCallTranscription

What a person is told about a call’s transcript (PRD E7-R6, E6-R8).

label is the exact sentence the clients show (“Transcribing”, “Not recorded - made from a personal phone”, …) so the web console and the app use the same words.

object
status
Status
string
default: off
Allowed values: off live ended failed
untranscribed_reason
Any of:
string
Allowed values: personal_phone consent_off disclosure_not_played feature_off carrier_unavailable not_connected
label
Label
string
default: Not transcribed
next_cursor
Any of:
string
has_more
Has More
boolean
Example
{
  "view": "mine",
  "rows": [
    {
      "assignment": "assigned_to_you",
      "status": "ready",
      "hold": {
        "code": "do_not_contact"
      }
    }
  ],
  "incoming": [
    {
      "kind": "message",
      "state": "open"
    }
  ],
  "history": [
    {
      "direction": "outbound",
      "phase": "requested",
      "outcome": "conversation",
      "transcription": {
        "status": "off",
        "untranscribed_reason": "personal_phone",
        "label": "Not transcribed"
      }
    }
  ],
  "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": {}
    }
  ]
}