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.
To integrate to the slybroadcast API, users must be able to construct an HTML form that can generate and post information to:
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. If you would like your results returned to your own URL, then c_dispo_url should be used.
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"
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.
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.
The following data will be returned if a campaign is successfully received.
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'.
Your campaign information will be returned in the following format:
Below is example PHP code to handle the post back. *Users must acknowledge receipt of each call status by returning 'OK'.
You can request the status of your campaign by using the parameters below. Future scheduled campaigns include 90 days out.
Your status will be returned in the following format:
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.
Possible return responses may include:
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.
To request the number of remaining message credits in your account, the following parameters below must be used.
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:
To retrieve a full list of the audio files in your account, please post to the URL:
Use get_audio_list_with_duration to include each audio file's duration, in seconds.
We will return our system file name along with your self-created file name and the date/time created.
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:
If referencing our system file name, use c_sys_audio_name.
Corrections? Email us at email@example.com.