Skip to content
vocapable.Docs

A receptionist transfer ringing in your app: ringing, answered, or declined

GET
/v1/mobile/workspace/handoffs/{handoff_id}/live
curl --request GET \
  --url https://api.vocapable.com/v1/mobile/workspace/handoffs/example/live \
  --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
LiveHandoffOffer

A receptionist transfer ringing for you, as the server sees it (PRD E3-R11/E4-R7).

state: ringing_app (your app is ringing), ringing_phone (the app was not answered; your verified phone is being rung), connecting (you answered; the caller is being moved to you), connected (the carrier confirmed the caller joined you), declined (you declined; the receptionist offers the caller to take a message), missed (nobody answered), ended, reassigned (E4-R7: the caller was sent to a teammate before you answered; your ring is cancelled).

object
handoff_id
required
Handoff Id
string
state
required
State
string
Allowed values: ringing_app ringing_phone connecting connected declined missed ended reassigned
yours
required
Yours
boolean
summary
required
Any of:
string
observed_at
required
Observed At
string format: date-time
can_redirect
required
Can Redirect
boolean
redirected_to
required
Any of:
string
workspace_call_id
Any of:
string
Example
{
  "state": "ringing_app"
}

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