Field Name Type Example Value Definition
c_uid Text test@slybroadcast.com Login email address. Required for each request.
c_password Password xxxxxxxx Password. Required for each request.
c_method Text new_campaign Required when sending a slybroadcast campaign.
c_record_audio Text My First Message Audio file name as seen within your account. *Case Sensitive. Not required if c_url provided.
c_url Text http://www.yourwebsite.com/MeetingReminder.wav To send a campaign using your own audio file, use c_url. You must designate the file type you are using (WAV, Mp3 or M4a files only) with c_audio. Audio files must be greater than five seconds.
c_audio Text wav Audio file type (WAV, Mp3 or M4a). Required only if c_url is used.
c_phone Text 6173999980,6173999981 Destination phone numbers. Max: 10,000 per submission.*Not required if c_listid is provided.
c_listid Text 94454 List ID attached to each list uploaded to website. Use c_method=get_phone_list to obtain list of IDs. *Not required if c_phone is provided.
c_callerID Text 6173999982 Caller ID of campaign. This will appear within the recipient's voicemail-box.
c_date Text now Date/Time of delivery in Eastern Time. YYYY-MM-DD HH:MM:SS *Must use 24-hour time format.
Example: 5:00pm = 17:00:00
c_title Text My First Broadcast Campaign name or title. (Optional). Session ID must be used in requesting results or statuses.
mobile_only Hidden 1 By sending 1, campaign will be sent to mobile numbers only. (Optional).

Field Name Type Example Value Definition
c_option Hidden callstatus Use when requesting the call status of one phone number in a slybroadcast campaign. Session ID & c_phone must be included.
c_option Hidden campaign_result Use when requesting the call results for each phone number in a single campaign. Session ID must be included.
c_option Hidden pause Campaign will be paused. Session ID must be included.
c_option Hidden run Use to resume a campaign that is currently paused. Session ID must be included.
c_option Hidden cancel Use this parameter when cancelling a scheduled campaign. Session ID must be included.
c_option Hidden stop By using this parameter, campaigns that are currently running will be stopped.
Stopped campaigns cannot be restarted. Session ID must be included.
c_option Hidden do_not_dial Use this when adding telephone numbers to your account's Do Not Dial List.
All numbers included on this list will never receive voicemails sent from your account.
c_option Hidden remove_do_not_dial To remove phone numbers from your account's Do Not Dial List, use this parameter.
c_option Hidden campaign_by_date To view all Session IDs from a specific date. YYYY-MM-DD.

Field Name Type Example Value Definition
c_method Text get_audio_list Use to view your full list of audio files. Posts must be made to the url:
https://www.slybroadcast.com/gateway/vmb.json.php
c_method Text get_audio_list_with_duration Use to view your full list of audio files with duration. Duration in seconds. Posts must be made to the url:
https://www.slybroadcast.com/gateway/vmb.json.php
c_method Text get_phone_list Use to retrieve a full list of your phone number lists uploaded to the website, along with their specific ID's.

Field Name Type Example Value Definition
session_id Text 2103524120 Created automatically by system when creating a campaign.
c_dispo_url Text https://www.yoursite.com/results URL that will receive call status postbacks. (Optional)
You must acknowledge receipt of each call status by returning 'OK'.
c_sys_audio_name Text r18904b140407197964.wav Use ONLY if sending the system file name of your audio file. Not required if c_url or c_record_audio provided.
c_endtime Text 2019-12-31 15:30:00 Campaign will stop at time provided, regardless of its' completion. YYYY-MM-DD HH:MM:SS
remain_message Text 1 Response will include the remaining message credits in your account. Pending message credits are messages cheduled to be delivered and are in your que.

SENDING A SLYBROADCAST CAMPAIGN

Below is a sample of a successful campaign submission, using the POST method. We will return an acknowledgement 'OK' if successful. Otherwise, we will send back an error message indicating the missing variables.

The base URL for all API calls, unless otherwise noted, is https://www.slybroadcast.com/gateway/vmb.json.php

IMPORTANT: All campaigns are sent out in Eastern Time and use the 24-hour clock. (YYYY-MM-DD HH:MM:SS)
Example: December 31, 2019 at 5:00pm = "2019-12-31 17:00:00"

<form action="https://www.slybroadcast.com/gateway/vmb.json.php" method="post"> <input type="text" name="c_uid" value="admin@slybroadcast.com"> <input type="password" name="c_password" value=""> <input type="hidden" name="c_method" value="new_campaign"> <input type="hidden" name="c_callerID" value="6173999980"> <input type="text" name="c_phone" value="6173999981,6173999982,6173999983"> <input type="hidden" name="c_date" value="2019-12-31 17:00:00"> <!-- To use an audio file visible within your account, include: --> <!-- Audio file names are case sensitive --> <input type="text" name="c_record_audio" value="My First Voice Message"> <!--To send to mobile phone numbers ONLY, input value = 1--> <input type="hidden" name="mobile_only" value="1"> <input type="submit" value="submit"> </form>

To send a campaign using your own audio file, use c_url. You must designate the file type you are using (.WAV, .Mp3 or .M4a files only) with c_audio. Audio files must be greater than five seconds.

<form action="https://www.slybroadcast.com/gateway/vmb.json.php" method="post"> <input type="text" name="c_uid" value="admin@slybroadcast.com"> <input type="password" name="c_password" value=""> <input type="hidden" name="c_method" value="new_campaign"> <input type="hidden" name="c_callerID" value="6173999980"> <input type="text" name="c_phone" value="6173999981,6173999982,6173999983"> <input type="hidden" name="c_date" value="2019-12-31 17:00:00"> <!--If using an audio file accessed from a URL, use c_url and include file type extension--> <input type="text" name="c_url" value="http://www.yourwebsite.com/MeetingReminder.wav"> <input type="text" name="c_audio" value="wav"> <input type="submit" value="submit"> </form>

To set an End Time to your campaign, use c_endtime. By inserting an End Time, your campaign will not run past the time chosen, regardless of its percentage of completion.

<form action="https://www.slybroadcast.com/gateway/vmb.json.php" method="post"> <input type="text" name="c_uid" value="admin@slybroadcast.com"> <input type="password" name="c_password" value=""> <input type="hidden" name="c_method" value="new_campaign"> <input type="hidden" name="c_callerID" value="6173999980"> <input type="text" name="c_phone" value="6173999981,6173999982,6173999983"> <input type="hidden" name="c_date" value="now"> <!--If setting an end time, include c_endtime--> <input type="text" name="c_endtime" value="2018-02-01 20:00:00"> <input type="submit" value="submit"> </form>

JSON Response

{ "new_campaign": "OK", "session_id": "2103524120", "number_of_phone": 2, }, OR { "ERROR":"c_uid: required; c_password: required; c_option or c_method required; " }

CALL RESULTS RETURNED TO URL

Users can provide a URL to which each call status will be posted, automatically using c_dispo_url . However, this is optional.
*Users must acknowledge receipt of each call status by returning 'OK'.

<form action="https://www.slybroadcast.com/gateway/vmb.json.php" method="post"> <input type="text" name="c_uid" value="admin@slybroadcast.com"> <input type="password" name="c_password" value=""> <input type="password" name="c_method" value="new_campaign"> <input type="hidden" name="c_callerID" value="6173999980"> <input type="text" name="c_phone" value="6173999981,6173999982,6173999983"> <input type="hidden" name="c_date" value="now"> <!-- To receive call statuses automatically to your own URL, include: --> <input type="text" name="c_dispo_url" value="http://www.yoursite.com/mystatus.php"> <input type="submit" value="submit"> </form>

Your campaign information will be returned in the JSON format below:

[{ "campaign id": "2103524120", "destination": "6173999980", "dial status": "OK", "fail reason": "", "delivery time": "2018-05-01 15:12:38", "carrier": "AT&T"}, {"campaign id": "2103524120", "destination": "6173999981", "dial status": "Failure", "fail reason": "Landline Removed", "delivery time": "2018-05-01 15:12:51", "carrier": "Comcast"}]

Below is example PHP code to handle the post back. *Users must acknowledge receipt of each call status by returning 'OK'.

//$postback = '"campaign_id"|"destination"|"dispoCode"|"dispoText"|"delivery_time"|"carrier"'; $postback = '"2324444455"|"6173999980"|"OK"|""|"2018-01-10 10:00:00"|"landline"'; // Parse the data into variables as seen below: list($campaign_id, $destination, $dispo_Code, $dispo_Text, $delivery_time, $carrier) = explode("|", $postback, 6); // Variables will appear with ' " ' around them: echo $campaign_id.",".$destination; // Will print: "2324444455","6173999980" //To remove ' " ' use: $campaign_id = str_replace('"', '', $campaign_id); $destination = str_replace('"', '', $destination); echo $campaign_id.",".$destination."\n"; //Will print: 2324444455,6173999980 // Save your data, then return an 'OK': echo "OK"; ?>

RESULTS OF COMPLETED CAMPAIGN

To request the call results for each phone number in a single campaign, the following parameters must be included. Be sure the session_id is the one received in response to your initial campaign submission.

<form action="https://www.slybroadcast.com/gateway/vmb.json.php" method="post"> <input type="text" name="c_uid" value="admin@slybroadcast.com"> <input type="password" name="c_password" value=""> <input type="text" name="c_option" value="campaign_result"> <input type="text" name="session_id" value="9145797854"> <input type="submit" value="submit"> </form>

JSON Response

[{ "campaign id": "9145797854", "destination": "6173999944", "dial status": "OK", "fail reason": "", "delivery time": "2018-05-01 15:12:38", "carrier": "AT&T"}, {"campaign id": "9145797854", "destination": "6173999945", "dial status": "Failure", "fail reason": "Landline Removed", "delivery time": "2018-05-01 15:12:51", "carrier": "Comcast"}]

PAUSE OR RESUME YOUR CAMPAIGN

To temporarily pause a running campaign or resume a campaign that was previously paused, you must include the session_id of the campaign received in the response to your initial campaign. We will return an 'OK' or an error if the session_id was not found.

<form action="https://www.slybroadcast.com/gateway/vmb.json.php" method="post"> <input type="text" name="c_uid" value="admin@slybroadcast.com"> <input type="password" name="c_password" value=""> <input type="text" name="session_id" value="9145797854"> <!-- To pause a running campaign include:--> <input type="text" name="c_option" value="pause"> <!-- To resume a campaign that was previously paused include:--> <input type="text" name="c_option" value="run"> <input type="submit" value="submit"> </form>

Possible return responses in JSON may include:

{"OK": "Campaign was paused."} OR {"ERROR": "Campaign was not paused."} OR {"OK": "Campaign was resumed."} OR {"ERROR": "Campaign was not resumed."}

REQUEST REMAINING CREDITS

To request the number of remaining message credits in your account, the following parameters below must be used.

<form action="https://www.slybroadcast.com/gateway/vmb.json.php" method="post"> <input type="text" name="c_uid" value="admin@slybroadcast.com"> <input type="password" name="c_password" value=""> <input type="text" name="remain_message" value="1"> <input type="submit" value="submit"> </form>

JSON Responses

[{"remaining_messages": 18246, "pending_messages": 0, }]

RETRIEVING PHONE LIST IDS

To retrieve a full list of your phone number lists uploaded to the website along with their specific ID's, the following parameters below must be used:

<form action="https://www.slybroadcast.com/gateway/vmb.json.php" method="post"> <input type="text" name="c_uid" value="admin@slybroadcast.com"> <input type="password" name="c_password" value=""> <input type="text" name="c_method" value="get_phone_list"> </form>

JSON Responses

[{"c_listid":"442178","list_name":"Office Numbers","number_of_phone":"54"}, {"c_listid":"107386","list_name":"Test","number_of_phone":"199"}] OR {"ERROR":"No phone list found."}

DO NOT DIAL LIST UPDATES

With the Do Not Dial List feature, you can add or remove phone numbers that you do not want to include in your slybroadcast campaigns. Adding a phone number to this list ensures that the recipient will not receive voice messages sent from your slybroadcast account.

To add or remove phone numbers from your personal Do Not Dial List, the following parameters below must be used:

<form action="https://www.slybroadcast.com/gateway/vmb.json.php" method="post"> <input type="text" name="c_uid" value="admin@slybroadcast.com"> <input type="password" name="c_password" value=""> <!-- Add numbers to Do Not Dial List --> <input type="text" name="c_option" value="do_not_dial"> <input type="text" name="c_phone" value="6173999980,6173999981"> <!-- Remove numbers from Do Not Dial List --> <input type="text" name="c_option" value="remove_do_not_dial"> <input type="text" name="c_phone" value="6173999980"> </form>

JSON Responses

[{"OK": "2 phone numbers saved." }] OR [{"OK": "1 phone number(s) removed." }]

RETRIEVE A LIST OF AUDIO FILES

To retrieve a full list of the audio files in your account, please post to the URL: https://www.slybroadcast.com/gateway/vmb.json.php

Use get_audio_list_with_duration to include each audio file's duration, in seconds.

<form action="https://www.slybroadcast.com/gateway/vmb.json.php" method="post"> <input type="text" name="c_uid" value="admin@slybroadcast.com"> <input type="password" name="c_password" value=""> <input type="text" name="c_method" value="get_audio_list"> <input type="submit" value="submit"> </form>

We will return our system file name along with your self-created file name and the date/time created.

[{"c_sys_audio_name":"b9055b179205.wav","Audio file Title":"Test Message to Co-Workers","Create Date":"2018-01-09 11:44:39"}, {"c_sys_audio_name":"b9055b179709.wav","Audio file Title":"Customer Reminder 1","Create Date":"2017-09-28 13:11:10"}, {"c_sys_audio_name":"b9055b185998.wav","Audio file Title":"Holiday Special Event","Create Date":"2017-08-01 16:42:54"}]

DELETING AN AUDIO FILE

To delete an audio file in your account, post to the URL: https://www.slybroadcast.com/gateway/vmb.json.php

The system file name must be included.

*If an audio file is currently scheduled to be used in a future campaign, the camapign will still complete. You must delete the campaign to stop it from going out.

<form action="https://www.slybroadcast.com/gateway/vmb.json.php" method="post"> <input type="text" name="c_uid" value="admin@slybroadcast.com"> <input type="password" name="c_password" value=""> <input type="text" name="c_method" value="delete_audio"> <input type="text" name="c_sys_audio_name" value="b9055b179205.wav"> <input type="submit" value="submit"> </form>

We will return one of the following responses.

[{"OK":"Audio File Delete"}] OR [{"ERROR":"Audio file not found."}]

Corrections? Email us at support@slybroadcast.com.

Log In



Thank you! If an account is found, a password reset email will be sent.

Email Address
Password
Forgot Password?

Forgot Your Password?

No problem! Enter your email address and we'll send you a reset link.


Thank you! If an account is found, a password reset email will be sent.
Email Address