Description: Start a new broadcast.
Returns: [broadcast object] or [error object] Note: The object returned will reflect the success or failure of starting the broadcast, but broadcasts take a few moments to set up and start. For current, real-time status of the broadcast, use the 'broadcast_status' API.
|Parameter Name||Required||Description||Permitted Valued||Default|
|Yes||The email address associated with the Gigabark account making API requests||(none)|
|password||Yes||The password used to log into the Gigabark account making API requests||(none)|
|format||No||The format of responses from the Gigabark servers to your API requests.||xml, json||xml|
|method||Yes||Whether the broadcast is a voice, sms, or survey.||voice, sms, survey||voice|
|broadcast_name||No||The name to give your broadcast||(none)|
|recipient_list_id||No**||The ID of an existing recipient list in your account to which to send the broadcast.||(none)|
|recipients||No**||A comma-separated list of recipients to which to send the broadcast.||(none)|
|message||Yes||The message to send to the recipients. This is either the ID of an existing message in your account, or a text string. For voice calls, a text string will be converted to voice using our text-to-speech engine. Surveys must use the ID of an existing survey.||(none)|
|voicemail_message||No||(Not applicable for SMS)
The message to play if the call goes voicemail. If omitted, the voice_message parameter will be played when calls go to voicemail.
|caller_id||No||If your account has multiple caller-id's authorized, this field specifies the caller-id to use on this broadcast.||(none)|