Skip to main content

Campaigns are stateful orchestration objects, not static configs.

Use bulk_call_campaigns to manage dial strategy, schedule windows, and downstream reporting flows.

Endpoint families

  • Core CRUD: list/create/get/update
  • Lifecycle controls: launch, pause, resume, cancel
  • Cloning: clone, clone_prefill, save_as_template
  • Runtime insight: tasks, analytics, dispatch_health
  • Output paths: results_export, collection export
  • Planning helpers: capacity_preview, audience_timezone_analysis
1

Create in draft state

Validate agent assignment, number pool, schedule timezone, and concurrency.
2

Run preflight checks

Use capacity and timezone analysis before first launch.
3

Launch and monitor dispatch health

Validate task creation, first outcomes, and number health.
4

Pause/resume for controlled tuning

Tune script, schedule, or concurrency using pause-resume loops.
5

Export and reconcile

Pull results export and analytics for CRM and BI handoff.

Create and launch

curl -X POST "https://api.callaro.ai/api/v1/bulk_call_campaigns" \
  -H "X-Api-Key: $CALLARO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"Q2 Pipeline Reactivation","agent_id":42,"timezone":"Asia/Kolkata","campaign_phone_number_ids":[101,102],"concurrency_limit":3}'

curl -X POST "https://api.callaro.ai/api/v1/bulk_call_campaigns/123/launch" \
  -H "X-Api-Key: $CALLARO_API_KEY"

Monitor and control

curl "https://api.callaro.ai/api/v1/bulk_call_campaigns?page=1&per_page=20" -H "X-Api-Key: $CALLARO_API_KEY"
curl "https://api.callaro.ai/api/v1/bulk_call_campaigns/123/dispatch_health" -H "X-Api-Key: $CALLARO_API_KEY"
curl "https://api.callaro.ai/api/v1/bulk_call_campaigns/123/analytics?from=2026-04-01&to=2026-04-30" -H "X-Api-Key: $CALLARO_API_KEY"
curl -X POST "https://api.callaro.ai/api/v1/bulk_call_campaigns/123/pause" -H "X-Api-Key: $CALLARO_API_KEY"
curl -X POST "https://api.callaro.ai/api/v1/bulk_call_campaigns/123/resume" -H "X-Api-Key: $CALLARO_API_KEY"

State transition guidance

Current stateAllowed actionOperator intent
DraftLaunchBegin first execution window
RunningPauseTemporary stop for tuning/investigation
PausedResume or CancelContinue or terminate safely
Running/PausedCancelEnd campaign and prevent further dispatch

Failure and rollback patterns

  • If launch fails with validation errors, fix campaign configuration before retrying.
  • If dispatch health degrades, pause campaign and investigate number health, schedule windows, or contact quality.
  • If analytics mismatch appears, compare webhook dedupe logs with tasks and results export output.