Overview
The SBT platform provides you with an effortless means to extend your application’s ability to communicate through SMS. Our API platform has been organized to help simplify the process of integrating your applications.
What our API can do for you
|
Authentication |
Message Delivery
|
Groups/Campaigns |
|
Subscribers |
Templates |
Reporting |
What’s New
12.20.2017 - Added a new page for 'ReversePhoneLookup', a new API that returns phone number owner information
12.06.2017 - Added a new endpoint and articles for Smart Click, the new URL shortening service
07.18.2017 - Added new pages for 'GetDeactivationNumbers' new API report in Reports section.
04.04.2017 - Added new parameter 'TransactionTicket' to Inbound Messages and Inbound Messages by Type reports
02.13.2017 - Added new parameter 'inbound transaction ticket' to callback parameters.
09.14.2016 - Added new REST API methods.
07.25.2016 - Added new pages for Keyword services, 'SearchKeyword' and 'ManageKeyword'.
06.16.2016 - Added new page for MMS Retrieve.
05.31.2016 - Added new response parameter 'UserName' to MessagesSent Report.
04.18.2016 - Added new response parameter 'UniqueID' to InboundMessageByType API Report.
03.14.2016 - Added new parameters 'MessageCategory' and 'MessageSubcategory' in Status URL section.
02.29.2016 - Added new pages for 'MessagesSentByType' new API report in Reports section.
02.04.2016 - Added two new pages for 'GetReverseLookupDetails' and 'GetCustomerIDDetails' in Reports section.
12.22.2015 - Added new response parameter 'UniqueID' to Reports - Send message, Send message Archive, Inbound Message, Inbound Message Archive.
12.01.2015 - Added new page for 'UpdateSubscriberByOrg' method.
08.25.2015 - Updated all endpoint URL with single wsdl.
08.25.2015 - Added new parameter 'DeliveryStatusID' to response of 'SentMessages' and 'ArchiveMessageSent' report API.
08.03.2015 - Added new page for new API 'ArchiveInboundMessages', 'ArchiveMessageSent' and updated 'IReport' section with new API information.
06.24.2015 - Added new page for new API 'GetCustomerID' and updated 'IGeneral' section with new API information.
05.28.2015 - Added new page for new API 'InboundMessagesbyType' and updated 'IReport' section with new API information.
04.02.2015 - Added new error codes related to API status in 'Error Codes' of 'IReport' section.
03.23.2015 - Added new page for 'Message History Details' API in 'IReport' section.
12.10.2014 - MessagesSent, InboundMessages and Subscribers page udated - Unique ID to be displayed in 'Mode Of Communication' field in MessagesSent and InboundMessages reports. Unique ID to be displayed in 'PrivateCode' field in Subscriber Report.
12.01.2014 - Callback Url & Status Url page udated - Status URL returns the Org Code along with other information.
11.14.2014 - New pages is added under IGeneral Section - Get Carrier Lookup and Reverse Lookup.
01.02.2014 - New page is added under ISubscriber Section - Get Subscribers Status.
Prerequisites
Using the API first requires that some elements of the system be configured. You must first have an active, valid account. With this account you will have a user name (email) and password. These credentials will allow you to access the user interface of the hosted platform. Once there, you can manage all aspects of your account. To begin using the APIs, you will need to get an API key that will serve as a means of authenticating the API client calls to the platform.
You will also need to know the Organization Code for your company. You can get this from the Manage screen on the dashboard. This Organization Code will allow you to start adding divisions, groups, keywords, and subscribers. Once you have created at least one group, you can then send messages to subscribers in that group by using the Organization Code assigned to that group.
Staging and Production Environment
There are two environments for API users to connect. The Staging environment is for the ongoing development and testing of APIs. Once the code is ready, the Production environment must be used.
Note: The Staging and Production environments are identical in API functionality. However, the API URL, credentials, Organization Code and message template IDs will be different between Staging and Production environments. Please make sure to configure these values while integrating the APIs.
Endpoints for staging and production:
Production:
https://ui.solutionsbytext.com/Sbt.App.SetUp/WSServices/{service}?singleWsdl
Staging:
https://test.solutionsbytext.com/Sbt.App.SetUp/WSServices/{service}?singeWsdl
* - Use the valid service name mentioned in each API service section.