Campaigns
Trigger outbound call
Place an immediate outbound campaign call via project API key
POST
Starts a real-time outbound voice call using a campaign configured in the dashboard.
Required scope:
See Authentication.
calls:create
Prerequisites
- Outbound campaign with workflow (or static script + voice) and caller ID
- Project API key with
calls:createfor the same organization and project
Authentication
Project API key with the
calls:create scope. Format: bot_live_…Path parameters
Organization ID. Must match the API key.
Project ID. Must match the API key.
Outbound campaign ID.
Body
Send a JSON object representing the customer. Extra fields are available in prompts as{{ customer.<key> }}.
Destination number. Prefer E.164 (for example
+14155552671).Optional display name (
{{ customer.name }}).Optional email (
{{ customer.email }}).Any additional keys (for example
order_id) are available as {{ customer.order_id }}.Response
true when the call was queued and dispatched.Created campaign call ID.
Human-readable confirmation.
Errors
Missing/invalid body, invalid phone, or campaign not ready.
Missing, invalid, or revoked API key.
Missing
calls:create, or key does not match org/project.Campaign not found.
Unexpected dispatch failure.

