Skip to content
vocapable.Docs

Ring your verified phone to take this waiting caller

POST
/v1/workspace/shared-phone/tickets/{ticket_id}/pickup
curl --request POST \
  --url https://api.vocapable.com/v1/workspace/shared-phone/tickets/example/pickup \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "expected_revision": 1, "device": "browser" }'

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
ticket_id
required
Ticket Id
string

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
SharedPhonePickup
object
expected_revision
required
Expected Revision
integer
>= 1
device
required
Device
string
Allowed values: browser mobile verified_phone

Responses

Section titled “Responses”

200

Section titled “200”

Successful Response

Media typeapplication/json
SharedPhonePickupResult
object
ticket_id
required
Ticket Id
string
offer_id
required
Offer Id
string
generation
required
Generation
integer
outcome
required
Outcome
string
Allowed values: leg_bound cleanup_required already_started unconfirmed
Example
{
  "outcome": "leg_bound"
}

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