Skip to main content
Place a call
The 202 is an acknowledgement — the call dials asynchronously. Track its outcome via webhooks or GET /v1/calls/{id}.

Authorizations

Authorization
string
header
required

Your API key as a Bearer token, e.g. Authorization: Bearer vk_….

Headers

Idempotency-Key
string | null
authorization
string | null
X-Vocily-Workspace
string | null
X-Vocily-Org
string | null

Body

application/json

Outbound call request.

agent_id
string
required

Agent to use for the call

to_number
string
required

Destination number (E.164)

from_number
string | null

Our number (must be in workspace); optional if only one number

variables
Variables · object | null

Prompt variables e.g. {customer_name: 'Rahul'}

metadata
Metadata · object | null

Opaque customer JSON, stored + echoed on reads/webhooks

Response

Successful Response

Outbound call response.

execution_id
string
required
call_sid
string | null
status
string
default:started
message
string
default:Outbound call initiated; it will begin dialing shortly
metadata
Metadata · object | null