Gigabark Application Programming Interface (API)

start_broadcast

Description:   Start a new broadcast.
URL:   https://www.gigabark.com/api/start_broadcast.php
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.

Parameters

Parameter Name	Required	Description	Permitted Valued	Default
email	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.		(none)
caller_id	No	If your account has multiple caller-id's authorized, this field specifies the caller-id to use on this broadcast.		(none)

** Either recipient_list_id or recipients must be specified.

Interactive API Test Tool

This tool simulates an API call to our system at the URL above. The data in the form fields are the parameters sent in that API call. The response from our system is shown below.

email *
password *
format
method *
broadcast_name
recipient_list_id
recipients
message *
voicemail_message
caller_id

Since you are not logged in, we return an empty object and avoid login verification.

Parameter string on API call:

Response to API call:

Sample PHP Code to call API:

$curl_url = "https://gigabark.com/api/start_broadcast.php";
$POST = "email=your.email@email.com&password=pwd"; // Add params from this page

$curl_handle=curl_init($curl_url);
if (!$curl_handle) die("curl connection failed");

curl_setopt($curl_handle, CURLOPT_SSL_VERIFYPEER, false);
curl_setopt($curl_handle, CURLOPT_POST,1);
curl_setopt($curl_handle, CURLOPT_RETURNTRANSFER,1);
curl_setopt($curl_handle, CURLOPT_TIMEOUT, 5);
curl_setopt($curl_handle, CURLOPT_POSTFIELDS,$POST);

$output = curl_exec($curl_handle);
curl_close($curl_handle);