We are proud to announce the launch of our API 2.0! Learn more about our streamlined, transactional and broadcast APIs. This version of the API documentation will remain available for reference only. There will be no new development, only bug fixes. We highly recommend upgrading to our newer and more sophisticated documentation.
Creates a call broadcast, adds numbers to it, and sends it immediately
Start sending calls using VoiceBroadcastConfig or by setting up an IVR using IvrBroadcastConfig.
Sending a call requires at least a ToNumber and sound id or an IVR. The returned broadcastId can be passed to
QueryCalls to get state of call actions in campaign and get list of individual
callIds for use in GetCall request. The broadcastId can also be passed to
GetBroadcastStats to get information about the call campaign, such as BilledAmount,
Duration, State, etc...
Unique ID, used to de-dup requests and make sure request is not processed twice
Type of Broadcast[VOICE, IVR, TEXT, CCC]
Title of Broadcast (default: API Send)
List of E.164 11 digit numbers space or comma separated
Scrub duplicates (default: false)
Label for Broadcast
Max simultaneous calls
Configuration needed for a Voice Broadcast
Unique ID of BroadcastConfig
DateTime Broadcast was created 'CCYY-MM-DDThh:mm:ss[Z|(+|-)hh:mm]'
E.164 11 digit number or short code
Restrict the times your compaign can run
Earliest time a client can be contacted in the timezone associated with the number's NPA/NXX
Latest time a client can be contacted in the timezone associated with the number's NPA/NXX