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.
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/slyi.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 Greenwich Mean Time and use the 24-hour clock. (YYYY-MM-DD THH:MM:SSZ)
Example: December 31, 2022 at 5:00pm = "2022-12-31 T17:00:00Z"
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 | 12345678 | 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 or Mp3 files only) with c_audio. |
| c_audio | Text | wav | Audio file type (WAV or Mp3). Required only if c_url is used. |
| c_phone | Text | 442077810000, 442073004300 | Destination phone numbers. Max: 10,000 per submission. |
| c_callerID | Text | 441932864471 | Caller ID of campaign. This will appear within the recipient's voicemail-box. |
| c_date | Text | now | Date/Time of delivery in Greenwich Mean Time.
YYYY-MM-DD THH:MM:SSZ
*Must use 24-hour time format. Example: 5:00pm = 17:00:00 |
| c_title | Text | My First slybroadcast Campaign | Campaign name or title. (Optional). |
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 Greenwich Mean Time (GMT) and should be designated with T and Z and use the 24-hour clock. (YYYY-MM-DD THH:MM:SSZ)
Example: December 31, 2022 at 5:00pm = "2022-12-31 T17:00:00Z"
To send a campaign using your own audio file, use c_url. You must designate the file type you are using (.WAV or .MP3 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. You must provide your own URL.
*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'.
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.
Results 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. Pending message credits are messages scheduled to be delivered and are in your que.
The following data will be returned:
To retrieve a full list of the audio files in your account, please post to the URL:
https://www.mobile-sphere.com/gateway/slyi.aflist.php
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:
https://www.mobile-sphere.com/gateway/slyi.dla.php
If referencing our system file name, use c_sys_audio_name.
Corrections? Email us at support@slybroadcast.com.