Send a Batch of Calls

Your API key for authentication.

This is the prompt or task used for all the phone calls in the request. Information can be inserted into it surrounding variable names with {{curly braces}}.

Example:

"You are calling {{business}} to renew their subscription to {{service}} before it expires on {{date}}."

Define a list of calls to make and their properties. Each call in call_data MUST have a “phone_number” property. Properties are case-sensitive.

Example:

[
  {   
    "phone_number": "1234567890",
    "business": "ABC Corp",
    "service": "Netflix",
    "date": "September 4th"
  },
  {
    "phone_number": "32176540987",
    "business": "XYZ inc.",
    "service": "Window Cleaning",
    "date": "December 20th"
  }
]

Use a purchased number to send batch calls from. We do not recommend this for large batches as there is risk of your number getting flagged for spam.

Adds a user-friendly label to your batch to keep track of it’s original intention. This can help differentiate multiple call batches that are part of the same Campaign. Shown when a batch is retreived.

Use campaign_id to organize related batches together. This can be set manually or auto-generated through Campaigns.

When this is set to true, only the first call of call_data will be dispatched. A common use case is to set the first phone_number value to your own to confirm everything’s set up properly.

Includes additional information in the response when true so that it’s easier to find any issues.

All other parameters supported by the Send Call endpoint are supported here as well. They will be applied to each call in the batch.

A URL that will receive a POST request when the batch is completed. The request will include the batch_id and the status of the batch.

If anything other than “success” is returned, there was an error.

The unique identifier for the batch.