Skip to main content
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.
All requests go through the Vobiz API gateway at https://api.vobiz.ai and are scoped to an account under /api/v1/account/{account_id}/. Examples use {account_id} and {auth_token} placeholders. Keep credentials on your server and never expose them in client-side code.

​
Workflow

1

Create an agent

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

Create a campaign

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

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.
4

Upload contacts

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

Launch and monitor

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

Export outcomes

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

​
Base URL

Always call the gateway. The campaign service itself sits behind an internal load balancer on private addresses and is not reachable from the internet, so a service-specific hostname will not resolve. Every example on these pages uses api.vobiz.ai.
Authenticate with X-Auth-ID and X-Auth-Token, or with an account-service JWT through the gateway. See Authentication.

​
Endpoint index

Every path below is prefixed with /api/v1/account/{account_id}. Each page has a live playground. Agents Campaigns Lifecycle controls Contacts, upload, and results Caller pool Capacity and lookup That is 24 account-scoped endpoints. A GET /status/ liveness check is also exposed, unauthenticated and unprefixed. Service-to-service routes under /internal/* are covered in Authentication and are not reachable through the gateway.

​
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

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

​
Common status codes