Batch Calls
Create Batch Call
Create a new batch outbound call campaign
POST
Creates a new batch call campaign with a list of recipients. You can send immediately, schedule for later, or save as a draft.
Each dial costs $0.005 plus standard per-minute calling charges.
Body Parameters
string
required
Must be
createstring
required
Name for the batch campaign.Example:
"Appointment Reminders - January"string
required
Your Magpipe phone number to use as caller ID. Must be an active number in your account.Example:
"+16045551234"string
UUID of the agent to handle calls. If not provided, uses the agent assigned to the caller_id number.
array
required
Array of recipient objects. Each must have at least
phone_number.boolean
default:"true"
If
true, starts calling immediately. If false, requires scheduled_at.string
ISO 8601 timestamp for when to start calling. Required when
send_now is false.Example: "2024-02-15T09:00:00.000Z"string
default:"00:00"
Earliest time of day to make calls (HH:MM format).Example:
"09:00"string
default:"23:59"
Latest time of day to make calls (HH:MM format).Example:
"17:00"array
default:"[0,1,2,3,4,5,6]"
Days of the week when calls can be made. 0=Sunday, 6=Saturday.Example (Mon-Fri):
[1, 2, 3, 4, 5]integer
default:"5"
Number of concurrency slots reserved for non-batch calls (inbound, etc).
string
Call purpose passed to the agent.
string
Call goal passed to the agent.
Response
object
The created batch object.