Create bulk call
Create a new bulk-call campaign. Supports immediate, scheduled, and auto-retry modes.
Name of the bulk call campaign.
Your phone number id to use for making calls.
Array of contact objects. Each row needs `phone_number`. Any other key you add on the row (e.g. `customer_name`, `account_id`, `priority`) is passed to the agent as a context variable for that specific call, so the agent can reference it during the conversation.
Whether the campaign should be scheduled for future execution.
Scheduled execution time in format `YYYY-MM-DD HH:MM:SS` (required if `is_scheduled` is true).
curl -X POST 'https://backend.omnidim.io/api/v1/calls/bulk_call/create' \ -H 'Authorization: Bearer YOUR_API_KEY' \ -H 'Content-Type: application/json' \ -d '{ "name": "Customer Follow-up Campaign", "contact_list": [ { "phone_number": "+15551234567", "customer_name": "John Doe", "account_id": "ACC-12345" }, { "phone_number": "+15559876543", "customer_name": "Jane Smith", "account_id": "ACC-67890", "priority": "high" } ], "is_scheduled": false, "scheduled_datetime": "2026-12-25 10:00:00", "timezone": "America/New_York", "concurrent_call_limit": 1, "enabled_reschedule_call": false, "retry_config": { "auto_retry": false, "retry_schedule_days": 0, "retry_schedule_hours": 0, "retry_limit": 0 } }'
{ "status": "success", "message": "Bulk call created successfully", "id": 314, "is_scheduled": false, "current_status": "pending" }
Authorization
BearerAuth Bearer token authentication. Obtain your API key from the OmniDimension dashboard.
In: header
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json