Skip to content
vocapable.Docs

Who is calling and why, while the AI receptionist's transfer rings your app (the context card, PRD E3-R5)

GET
/v1/mobile/workspace/handoffs/{handoff_id}/context
curl --request GET \
  --url https://api.vocapable.com/v1/mobile/workspace/handoffs/example/context \
  --header 'Authorization: Bearer <token>'

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
handoff_id
required
Handoff Id
string

Responses

Section titled “Responses”

200

Section titled “200”

Successful Response

Media typeapplication/json
WorkspaceCallContext

What a person needs to know about the caller before and during the call.

Loaded from the server once the ring is reported (push payloads stay ID-only), by the handler, the teammate a transfer or three-way invitation is ringing, or anyone picking up a parked caller. Every field is null when it is not known.

object
call_id
required
Any of:
string
contact_id
required
Any of:
string
caller_name
required
Any of:
string
company
required
Any of:
string
line
required
Any of:
WorkspaceCallLine

The business line a call came from (E12-R1): the company’s own number, named.

object
id
required
Id
string
name
required
Name
string
phone_e164
required
Phone E164
string
need
required
Any of:
WorkspaceContextNeed
object
text
required
Text
string
source
required
Source
string
Allowed values: ai_handoff caller_request transfer_notes deal
last_interaction
required
Any of:
WorkspaceContextInteraction
object
kind
required
Kind
string
title
required
Title
string
body
required
Any of:
string
occurred_at
required
Occurred At
string format: date-time
open_deal
required
Any of:
WorkspaceCallLinkRef

One piece of work a call is linked to, as the handler may see it.

object
id
required
Id
string
title
required
Title
string
state
required
State
string
revision
required
Revision
integer
open_case
required
Any of:
WorkspaceCallLinkRef

One piece of work a call is linked to, as the handler may see it.

object
id
required
Id
string
title
required
Title
string
state
required
State
string
revision
required
Revision
integer
promised_callback
required
Any of:
WorkspaceContextCallback
object
task_id
required
Task Id
string
title
required
Title
string
due_at
required
Any of:
string format: date-time
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
flags
required
Any of:
WorkspaceContextFlags

The DNC / consent badge. do_not_contact wins over everything else.

object
do_not_contact
required
Do Not Contact
boolean
consent
required
Consent
string
Allowed values: recorded none
badge
required
Badge
string
transfer_notes
required
Any of:
string
whisper
required
Any of:
string
ai_handled
required
Ai Handled
boolean
ai_actions
Any of:
string
promised_next_step
Any of:
string
ai_written
Ai Written
Array<string>
ring_kind
Any of:
string
Allowed values: queue ai_handoff
ring_id
Any of:
string
Example
{
  "need": {
    "source": "ai_handoff"
  },
  "flags": {
    "consent": "recorded"
  },
  "ring_kind": "queue"
}

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