Skip to content
vocapable.Docs

Pick up a parked caller

POST
/v1/workspace/parked-calls/{transfer_id}/pickup
curl --request POST \
  --url https://api.vocapable.com/v1/workspace/parked-calls/example/pickup \
  --header 'Authorization: Bearer <token>'

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
transfer_id
required
Transfer Id
string

Responses

Section titled “Responses”

200

Section titled “200”

Successful Response

Media typeapplication/json
WorkspaceParkedCalls
object
data
required
Data
Array<object>
WorkspaceParkedCall

A caller parked on a line, waiting for any teammate to pick up (E5-R6).

object
transfer_id
required
Transfer Id
string
call_id
required
Call Id
string
contact_name
required
Any of:
string
organization_name
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
parked_by
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
parked_at
required
Parked At
string format: date-time
picking_up
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
revision
required
Revision
integer
Examplegenerated
{
  "data": [
    {
      "transfer_id": "example",
      "call_id": "example",
      "contact_name": "example",
      "organization_name": "example",
      "line": {
        "id": "example",
        "name": "example",
        "phone_e164": "example"
      },
      "parked_by": {
        "user_id": "example",
        "name": "example"
      },
      "parked_at": "2026-04-15T12:00:00Z",
      "picking_up": {
        "user_id": "example",
        "name": "example"
      },
      "revision": 1
    }
  ]
}

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