Skip to main content
POST
Starts a real-time outbound voice call using a campaign configured in the dashboard. Required scope: calls:create

Prerequisites

  • Outbound campaign with workflow (or static script + voice) and caller ID
  • Project API key with calls:create for the same organization and project
You do not need a dial list or to start the campaign for API-triggered calls.

Authentication

X-API-Key
string
required
Project API key with the calls:create scope. Format: bot_live_…
See Authentication.

Path parameters

organization_id
string
required
Organization ID. Must match the API key.
project_id
string
required
Project ID. Must match the API key.
campaign_id
string
required
Outbound campaign ID.

Body

Send a JSON object representing the customer. Extra fields are available in prompts as {{ customer.<key> }}.
phone_number
string
required
Destination number. Prefer E.164 (for example +14155552671).
name
string
Optional display name ({{ customer.name }}).
email
string
Optional email ({{ customer.email }}).
[custom fields]
string | number | boolean
Any additional keys (for example order_id) are available as {{ customer.order_id }}.

Response

success
boolean
required
true when the call was queued and dispatched.
campaign_call_id
string
required
Created campaign call ID.
message
string
required
Human-readable confirmation.

Errors

400
Bad Request
Missing/invalid body, invalid phone, or campaign not ready.
401
Unauthorized
Missing, invalid, or revoked API key.
403
Forbidden
Missing calls:create, or key does not match org/project.
404
Not Found
Campaign not found.
500
Internal Server Error
Unexpected dispatch failure.