Voice Campaign Manager API

The Voice Campaign Manager API lets you create outbound calling campaigns and operate their full lifecycle. You define a reusable agent, configure campaign capacity and caller ID behavior, upload contacts, then start or schedule the campaign.

The production campaign service is https://campaign.vobiz.ai. The examples use {account_id} and {auth_token} placeholders. Keep credentials on your server and never expose them in client-side code.

Workflow

Create an agent

Save the returned agent id. The agent defines the answer URL, optional hangup URL, request methods, and static SIP headers.

Create a campaign

Select the agent, concurrency, timezone, caller-ID strategy, retry policy, and optional schedule or daily calling window.

Configure caller IDs

For a pool campaign, add at least one number. Fixed campaigns use fixed_caller_id. Per-contact campaigns read the caller ID from each CSV row.

Upload contacts

Upload a CSV with a to column. A valid upload moves the campaign from draft to ready.

Launch and monitor

Call the start endpoint for an immediate launch, or set scheduled_at. Monitor campaign health, contacts, attempts, and account capacity.

Export outcomes

Download campaign results or query CDRs with campaign_id for billing and call-quality analysis.

Base URLs

Service	Production	Local development
Campaign Manager	`https://campaign.vobiz.ai`	`http://localhost:8095`
CDR API	`https://cdr.vobiz.ai`	`http://localhost:8096`

Resource map

Authentication

Configure customer and internal request headers.

Agents

Manage reusable answer and hangup webhook configurations.

Campaigns

Create, list, retrieve, and update outbound campaigns.

Campaign controls

Start, pause, resume, cancel, and archive campaigns.

Contacts and results

Upload CSV contacts, browse contacts and attempts, and export results.

Caller-ID pools

Add numbers and manage rotation limits.

Capacity and monitoring

Inspect account capacity and campaign health.

Webhook events

Verify signed campaign and contact events.

Lifecycle

draft ──upload──▶ ready ──start/schedule──▶ running ──▶ completed
                     │                       │  ▲
                     │                       ▼  │
                     │                     paused
                     │                       │
                     └───────────────────────┴──▶ cancelled

non-running campaign ──archive──▶ archived

queued can appear while launch work is being prepared. Some mutation endpoints reject both queued and active states.

Common status codes

Code	Meaning
`200`	Request succeeded.
`201`	Resource created.
`400`	Request data is invalid.
`401`	Authentication failed. Check both headers and account ownership.
`404`	The resource does not exist for the authenticated account.
`409`	The requested transition or edit is not allowed in the current state.
`502`	An upstream platform dependency is unavailable.

​Workflow

​Base URLs

​Resource map

Authentication

Agents

Campaigns

Campaign controls

Contacts and results

Caller-ID pools

Capacity and monitoring

Webhook events

​Lifecycle

​Common status codes

Workflow

Base URLs

Resource map

Lifecycle

Common status codes