Bulk calls
Add contacts in bulk
Add up to 1000 contacts to a campaign in one request.
POST/calls/bulk_call//add_contacts
Bearersession
Path parameters
campaign_idrequiredBody
Each row needs to_number. Note this differs from the contact_list on Create bulk call, which uses phone_number and takes loose keys: here the variables go in an explicit custom_variables object.
To number*
Number to call, in international format.
Custom variables
Passed to the agent as context for this call, so it
can use them in the conversation.
Metadata
Stored with the contact and returned on its row in
Bulk call results. Not shown to the agent.
curl -X POST 'https://backend.omnidim.io/api/v1/calls/bulk_call/{campaign_id}/add_contacts' \ -H 'Authorization: Bearer YOUR_API_KEY' \ -H 'Content-Type: application/json' \ -d '{ "contacts": [ { "to_number": "+15551234567", "custom_variables": { "contact_name": "Ravi" } } ] }'
Example response
{ "status": "success", "message": "1 of 2 contacts added", "campaign_id": 314, "campaign_status": "in_progress", "added": [ { "line_id": 8801, "to_number": "+15551234567" } ], "added_count": 1, "rejected": [ { "index": 1, "reason": "to_number is not a valid phone number" } ], "rejected_count": 1 }
Authorization
BearerAuth AuthorizationBearer <token>
Bearer token authentication. Obtain your API key from the OmniDimension dashboard.
In: header
Path Parameters
campaign_id*integer
Id of the bulk call campaign.
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response body
application/jsonResponse Body
application/json