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.
This operation creates a Broadcast campaign and returns a broadcastId. To see the status
of this campaign call GetBroadcast with the returned broadcastId.
There are 3 types of Broadcast: TEXT, IVR, or VOICE. Select the appropriate config
to match the broadcast type, TextBroadcastConfig, IvrBroadcastConfig, or VoiceBroadcastConfig.
Prefer the Text Service operations (ex: SendText) and Call Service operations
(ex: SendCall) over this operation when managing simple text and call campaigns
since those operations are simpler and more concise.
Create Broadcast using attached info
Unique ID of web request to de-dup on
A TEXT, IVR, or VOICE Broadcast
Unique ID of Broadcast
Name of Broadcast
Status of Broadcast (response only)[START_PENDING, RUNNING, STOPPED, FINISHED, ARCHIVED, TEST, SETUP, SCHEDULED, SUSPENDED, VALIDATING_EMAIL, VALIDATING_START, BLOCKED_SUSPICIOUS, APPROVED, DECLINED, PAUSED]
Last Modified 'CCYY-MM-DDThh:mm:ss[Z|(+|-)hh:mm]'
Type of Broadcast[VOICE, IVR, TEXT, CCC]
Labels on Broadcast
If 'true' resumes the unfinished campaign to the next day
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