Skip to content
vocapable.Docs

Who can take this caller now

GET
/v1/workspace/calls/{call_id}/transfer-candidates
curl --request GET \
  --url https://api.vocapable.com/v1/workspace/calls/example/transfer-candidates \
  --header 'Authorization: Bearer <token>'

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
call_id
required
Call Id
string

Responses

Section titled “Responses”

200

Section titled “200”

Successful Response

Media typeapplication/json
WorkspaceTransferCandidates
object
data
required
Data
Array<object>
WorkspaceTransferCandidate
object
user_id
required
User Id
string
name
required
Name
string
role
required
Role
string
Allowed values: owner manager rep
device_label
required
Device Label
string
device_kind
Device Kind
string
default: browser
Allowed values: browser mobile
unavailable
Unavailable
Array<object>
WorkspaceTransferUnavailable

A teammate who cannot take the caller right now, and why (E5-R1).

object
user_id
required
User Id
string
name
required
Name
string
role
required
Role
string
Allowed values: owner manager rep
reason
required
Reason
string
Allowed values: on_a_call away offline device_not_ready after_call_work
destinations
Destinations
Array<object>
WorkspaceTransferDestination

A number the owner allow-listed for external transfers and three-way calls (E5-R3).

object
id
required
Id
string
name
required
Name
string
phone_e164
required
Phone E164
string
revision
required
Revision
integer
payment_line
Payment Line
boolean
receptionist
Any of:
WorkspaceReceptionistTransfer

Whether the caller can be handed back to the AI receptionist from this call.

object
available
required
Available
boolean
reason
required
Reason
string
Example
{
  "data": [
    {
      "role": "owner",
      "device_kind": "browser"
    }
  ],
  "unavailable": [
    {
      "role": "owner",
      "reason": "on_a_call"
    }
  ],
  "destinations": [
    {
      "payment_line": 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": {}
    }
  ]
}