API Reference Docs

• HTML

  |

  JSON

  
  Updated March 29, 2021
  
  Getting Started
  

  MobileSphere has developed and deployed an API solution for the Slybroadcast platform in order to facilitate the integration of its solution for third party providers. All transactions require specific information that indicate to the gateway that the transaction is authentic and that it has been submitted for processing with the client’s knowledge. The API can handle all the necessary steps in the secure transaction process — data collection, data submission and audio file delivery to voicemail — while keeping the process virtually transparent to its end user. View our API on Postman here.

  All requests must be submitted as a form using the POST method. Post to the URL below, unless otherwise specified:
  https://www.mobile-sphere.com/gateway/vmb.php

  Hosting providers must have a server scripting or CGI capability such as ASP, PHP, Perl, or JSP. To receive a status of each call, MobileSphere uses a webhook. The POST HTTP form method is used for examples below. Users can provide a URL to which each call status can be posted, automatically. However, this is optional.
  c_dispo_url="https://www.yoursite.com/results"
  *Users must acknowledge receipt of each call status by returning 'OK' if using c_dispo_url.
  
  Other Items
  IMPORTANT 1: All values containing URL information must be encoded.
  IMPORTANT 2: Audio file names are case sensitive. "Meeting1" and "meeting1" would be two different files.
  IMPORTANT 3: 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"
  IMPORTANT 4: TLSv1.1 or TLSv1.2 must be used. We do not accept TLSv1.
  
  
  

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_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.
c_callerID	Text	6173999982	Caller ID of campaign. This will appear within the recipient's voicemail-box. Must be a valid phone number.
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.mobile-sphere.com/gateway/vmb.aflist.php
c_method	Text	get_audio_list_with_duration	Use to view your full list of audio files with duration, in seconds. Posts must be made to the url: https://www.mobile-sphere.com/gateway/vmb.aflist.php

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 scheduled to be delivered and are in your que.

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

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.mobile-sphere.com/gateway/vmb.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_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.mobile-sphere.com/gateway/vmb.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_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.mobile-sphere.com/gateway/vmb.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_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>

The following data will be returned if a campaign is successfully received.

OK session_id=9377466671 number of phone=1

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.mobile-sphere.com/gateway/vmb.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_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 following format:

"Session ID" | "Call To" | "Status" | "Reason for Failure" | "Delivery Time" | "Carrier" 9145797854 | 6173999981 | OK | | 2017-12-31 17:00:00 | verizon wireless 9145797854 | 6173999982 | OK | | 2017-12-31 17:00:04 | verizon wireless 9145797854 | 6173999983 | Failure | Do Not Dial List Removed | | | 9145797854 | 6173999984 | Failure | Unable to Detect VM | 2017-12-31 17:00:32 | paetec 9145797854 | 6173999985 | Failure | VM may be full or not setup | 2017-12-31 17:00:34 | TMobile

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"; ?>

You can request the status of your current campaign by using the parameters below. Future scheduled campaigns include 90 days out.

<form action="https://www.mobile-sphere.com/gateway/vmb.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_reports"> <!-- To retrieve the statuses of all running campaigns include:--> <input type="text" name="c_ctype" value="running"> <!-- To retrieve the statuses of all paused campaigns include:--> <input type="text" name="c_ctype" value="paused"> </form>

Your status will be returned in the following format:

"Session ID" | "Total Numbers" | "Delivery Time" | "Status" | 9145797854 | 2500 | 2017-03-31 10:00:00 | paused 9145797854 | 2 | 2017-03-31 10:02:04 | running

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.mobile-sphere.com/gateway/vmb.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>

Your status will be returned in the following format:

"Session ID" | "Call To" | "Status" | "Reason for Failure" | "Delivery Time" | "Carrier" 9145797854 | 6173999981 | OK | | 2017-12-31 17:00:00 | verizon wireless 9145797854 | 6173999982 | OK | | 2017-12-31 17:00:04 | verizon wireless 9145797854 | 6173999983 | Failure | Do Not Dial List Removed | | | 9145797854 | 6173999984 | Failure | Unable to Detect VM | 2017-12-31 17:00:32 | paetec

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.mobile-sphere.com/gateway/vmb.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 may include:

OK 9145797854 <session_id> was paused OK 9145797854 <session_id> resumed ERROR 9145797854 <session_id> invalid or not found

To cancel a running campaign or a scheduled campaign, 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.
*Once a campaign is cancelled, it cannot be restarted.

<form action="https://www.mobile-sphere.com/gateway/vmb.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 cancel a running or scheduled campaign include:--> <input type="text" name="c_option" value="stop"> <input type="submit" value="submit"> </form>

To request the number of remaining message credits in your account, the following fields must be used. The response will include the remaining message credits in your account. Pending message credits are messages scheduled to be delivered and are in your que.

<form action="https://www.mobile-sphere.com/gateway/vmb.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>

The following data will be returned:

remaining messages=200 pending messages=0

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.mobile-sphere.com/gateway/vmb.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>

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

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

<form action="https://www.mobile-sphere.com/gateway/vmb.aflist.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.

"System File Name" | "Self Created Audio File Name" | "Time Created" r18032b404759888.wav | My First Slybroadcast Recording | 2018-01-01 15:03:00

To download an audio file referencing the 5-digit name assigned when recording via the Slybroadcast Recording Center or our system name, please post to the URL:
https://www.mobile-sphere.com/gateway/vmb.dla.php

<form action="https://www.mobile-sphere.com/gateway/vmb.dla.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_audio_code" value="55555"> </form>

If referencing our system file name, use c_sys_audio_name.

<form action="https://www.mobile-sphere.com/gateway/vmb.dla.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_sys_audio_name" value="r18094b4047197888.wav"> </form>

• Integration Details
  Zapier automates your tedious workflows by connecting slybroadcast to 750+ business tools, including Slack, MailChimp, Gmail, and Trello. Tasks can be set up with automations called Zaps to take care of repetitive tasks for you. No coding is required. Sign up for a free Zapier account to use these popular automated Zaps:
  
  
  
  How do I connect slybroadcast to Zapier?
  
  1. Log in to your Zapier account.
  2. Navigate to "Connected Accounts" from the top menu bar.
  3. Now click on "Connect new account" and search for "slybroadcast"
  4. Use your credentials to connect your slybroadcast account to Zapier.
  5. Once that's done you can start creating an automation! Use a pre-made Zap or create your own with the Zap Editor. Creating a Zap requires no coding knowledge and you'll be walked step-by-step through the setup.
  6. Need inspiration? See everything that's possible with slybroadcast and Zapier.
  
  

Corrections? Email us at support@slybroadcast.com.