Skip to content

Read no-cache carrier-confirmed handoff lifecycle

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

Poll a safe lifecycle projection; carrier callbacks and workers remain the only writers.

Admins and Managers may review any inbound receptionist handoff in their tenant. A Rep receives the same shape only when their server-linked human-rep id is a durable target of the request. The 404 remains identical for absent and unauthorized rep rows.

handoff_id
required
Handoff Id
string

Successful Response

Media typeapplication/json
MobileLiveHandoff

The current carrier-confirmed lifecycle of one authorized handoff.

This is intentionally status-only. It contains no carrier operation identifiers, telephone destination, handoff summary, transcript, recording URL, or media state. In particular, it is not an action surface: a rep joining the carrier consult remains the only way an accepted transition can occur.

object
id
required
Id
string
call_id
required
Call Id
string
call_state
required
Call State
string
Allowed values: active handoff_pending transferred ended expired
status
required
Status
string
Allowed values: requested dispatching offered accepted redirecting redirected snapshot_ready completed declined timed_out carrier_failed reconciliation_required cancelled
failure_code
Any of:
string
requested_at
required
Requested At
string format: date-time
expires_at
required
Expires At
string format: date-time
rep_joined_at
Any of:
string format: date-time
caller_redirected_at
Any of:
string format: date-time
completed_at
Any of:
string format: date-time
Example
{
"call_state": "active",
"status": "requested"
}

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