Campaign Quickstart

Launch your first AI-powered outbound campaign using the Vozzo Campaign API.

This guide covers the complete flow:

1. Authenticate
2. Create a campaign
3. Start dialing
4. Monitor analytics

Before You Start

1. Verify Authentication

Test your API key and confirm access permissions.

Code
 
curl --request GET \
  --url https://backend.vozzo.ai/v1alpha/auth/me \
  --header 'Authorization: Token YOUR_SECRET_API_KEY'

Example Response

Code
 
{
  "user_id": "880e8400-e29b-41d4-a716-446655440000",
  "organization_name": "Acme Corp",
  "permissions": ["campaign:read", "campaign:write"]
}

2. Create a Campaign

Create a campaign with scheduling rules, retry settings, and recipient records.

Code
 
curl --request POST \
  --url https://backend.vozzo.ai/v1alpha/campaign \
  --header 'Authorization: Token YOUR_SECRET_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "agent_uuid": "YOUR_AGENT_UUID",
    "campaign_start_date": "2026-06-01",

    "campaign_config": {
      "campaign_name": "Welcome Outreach",

      "retry_options": {
        "max_calls_total": 3,
        "retry_delay": 60
      },

      "timeslot_settings": {
        "timezone": "IST",
        "start_time": "09",
        "end_time": "18",
        "allow_on_weekends": false
      }
    },

    "campaign_data": [
      {
        "to_phone_number": "+919876543210",
        "agent_language": "EN",
        "metadata": "{\\"customer_name\\":\\"John Doe\\"}"
      }
    ]
  }'

Campaign Structure

3. Start the Campaign

Update the campaign state to begin outbound calling.

Code
 
curl --request POST \
  --url https://backend.vozzo.ai/v1alpha/campaign/update-campaign/YOUR_CAMPAIGN_ID/ \
  --header 'Authorization: Token YOUR_SECRET_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "campaign_state": "RUNNING"
  }'

4. Monitor Progress

Track campaign health, call activity, and analytics in real time.

Code
 
GET /v1alpha/campaign/{campaign_id}

Code
 
GET /v1alpha/campaign/{campaign_id}/items

Typical Flow

Code
 
Authenticate
    ↓
Create Campaign
    ↓
Campaign State = TO_START
    ↓
Update State → RUNNING
    ↓
Monitor Calls & Analytics

Next Steps