Skip to main content
A broadcast sends one approved template to many contacts. The assistant does not schedule it until you have seen the recipient count and asked to schedule.

​
Order of calls

1

Use an approved template

create_broadcast takes templateName and language. The template must already be APPROVED. Optional contactPhones is a list of up to 1,000 numbers with country codes. Pass phoneNumberRef when the account has more than one number.
2

Preview

preview_broadcast counts recipients. The assistant shows you that count. schedule_broadcast stays blocked until you accept it.
3

Schedule

schedule_broadcast takes scheduledDateTime. The time is at least 5 minutes from now and within 30 days. A past time, a time inside the next 5 minutes, or a time past 30 days is rejected. The assistant calls this only after you ask.
list_broadcasts and get_broadcast read drafts and scheduled sends. list_broadcast_deliveries returns one row per recipient. Filter with status, page (starting at 1), and limit up to 200. delete_broadcast deletes a broadcast that is still PENDING or QUEUED. A broadcast that has started, finished, or is inside the last minute before it starts cannot be deleted.