Business at the Speed of Text

Take a few minutes to watch how Solutions by Text can provide you with a compliant solution to enhance the customer experience and increase your bottom line through the power of texting.

Two-Way Texting Changes the Game

Put real-time text responses in your customers’ pockets and real-time access at your staff’s fingertips.

Two-Way Texting Changes the Game

Put real-time text responses in your customers’ pockets and real-time access at your staff’s fingertips.

Business at the Speed of Text

Take a few minutes to watch how Solutions by Text can provide you with a compliant solution to enhance the customer experience and increase your bottom line through the power of texting.

Two-Way Texting Changes the Game

Put real-time text responses in your customers’ pockets and real-time access at your staff’s fingertips.

Browse Articles

General Interface

This category of APIs include details for methods that are applicable at a tenant level such as carrier lookup, reading organization tree, Read Verification Type, MMS and Reverse Lookup.

SmartURL™ Interface

The SmartURL™ interface encapsulates the APIs to manage the creation and curation of short URL links.

Subscriber Interface

The Subscriber Interface relates to a specific recipient of messages from the platform.

Template Interface

The Template Interface provides the flexibility to pre-define standard format of messages that might be required to be sent under different application/business/organizational contexts.

Create Short URL using Custom Keyword

Using this service user can create Short URL using a custom keyword.

Group Interface

The Group concept in the SBT platform relates to a targeted audience for one or more message campaigns; typically, groups may be created based on demographic criteria such as: Geography (zip codes), Age groups, etc. and would typically be specific to the type of messages and / or frequency with which you might want to address them.

Keyword Interface

The Keyword service provides the flexibility to Search and Manage Keywords

Message Interface

The Messaging interface encapsulates the core messaging APIs which provide multiple, flexible options to send and receive messages.

Report Interface

The report feature provides one with the ability to get reports related to messages sent, messages received, keywords and subscribers.

Send Template Message

Using this method template messages can be sent to a single subscriber. Messages also can be sent to multiple subscribers but all should belong to the same group.

This method subscribes a phone number to a specified group, but if the phone number is already in the group, then it will return an error stating that Subscriber information already exists in the system. This method allows Division and Organization Org codes also.

Login API Interface

The Authentication interface encapsulates the APIs to manage the security aspects of an API session. An API session might typically comprise one or more API calls (across the disparate API groups). Before any API calls can be made, one needs to obtain a 'security token' through the Authentication interface.

Status Codes and Actions

Status Codes and Actions Sl.No.Status Code.Status Description - Response to API RequestStatus Description in UIAction

Create Template

Creates a new template in a specified Group.

Invalid security token Title, Organization Code and SecurityToken fields are mandatory

Returns the Short URL based on input Long URL and domain configured at SBT side.

Get Short URL Details

Returns the Long URL and other statistics based on input Short URL and Org Code.

Returns the Short URLs based on input Long URLs and domain configured at SBT side. Note: In one request maximum 100 Short URLs can be generated.

Planning Your Integration

Overview The API platform has been organized to help simplify the process of integrating your applications. Before any message

This method returns details of an existing group.

RequestVBTWithTransactionTicket

This method is used to receive the pin and reserved word while performing VBT and also transaction ticket is generated. The code must be setup to pass the pin and reserved word.

Determines if a keyword is available for use in a particular group

Authenticate API Key

This returns the security token which is used in all methods for authentication.

Using this method, messages can be sent to a single subscriber or multiple subscribers but all subscribers should belong to the same group...

Delete Template

Deletes an existing template from a Group.

Get Carrier Lookup Details

Returns the carrier lookups done based on the category of Lookup source.

Get Custom URL Report

Returns the Customized Short URLs generated based on input Date and Time Range.

Get Subscribers Status

Get the status of a subscriber based on an Orgcode. If you provide parent level OrgCode, then it will display all the groups under the parent and status of the subscribers.

GetShortURL Report

Returns the Short URLs generated based on input Date and Time Range.

This method enables to Create, Update and Delete the Keyword in a particular group.

RequireVBTWithTransactionTicket

This method is used to receive the pin and reserved word while performing VBT and also transaction ticket is generated. The code must be setup to pass the pin and reserved word.

API Usage Limits

For better reliability, optimum performance and to ensure the SBT API platform is available to all of our customers...

Get Deactivation Numbers

Returns the Deactivated and Ported subscriber numbers based on the Organization code and status (All/Deactivated/Ported) code provided.

Get a list of all active templates for a group.

ConfirmVBTWithTransactionTicket

ConfirmVBTWithTransactionTicket verifies the pin for a phone number and generates the transaction ticket to track the opt in confirmation message. This method is used when VBT type is set to PIN.

Update Subscriber

Subscriber details can be updated via this method.

Purges an MMS image sent by a mobile user

A "callback URL" is the web address an API needs to send information for use by a different web site. You will need to have a system that can accept http requests from our server in order to use the callback_url and status_url. This has been tested with JAVA and .Net applications.

Inbound Messages

Returns the messages received for a group, division, organization.

Get the information of an existing active template from group.

This method is used to receive the pin and reserved word while performing VBT. The code must be setup to pass the pin and reserved word.

Update Subscriber By Org

This method updates subscriber information like First Name, Last Name, Unique ID etc., based on the Organization. This method is useful in cases where the same subscriber can have different values (e.g. account number) in different Organizations of the same tenant.

Update Template

Updates an existing active template from Group.

Archive Inbound Messages

Returns the archived messages received. (Only top level org codes are to be used)

This method is used to receive the pin and reserved word while performing VBT. The code must be setup to pass the pin and reserved word.

The Status URL is used to receive real time updates of message deliveries. There are two ways to use this functionality. The preferred method is to provide it to your SBT Client Consultant and they will configure it for your account. Alternately, you can include the URL in your send message API's in the field "status url".

This method removes subscribers from a specified group by making them inactive. Group, Division or Organization code can be designated to remove the subscription(s).

ConfirmVBT verifies the pin for a phone number. This method is used when VBT type is set to PIN.

Get Carrier Lookup

Get the cellular carrier ID and Name for a specific phone number.

Inbound Messages By Type

Returns the messages received for a group, division, and organization based on the given content type (Help, Stop, Stopall, VBT, Keyword, Inbound).

Update Target For Custom URL

Using this service user can update the Target LongURL for custom Short URL.

Returns messages sent from various levels of the platform.

Get Message Status

This method returns the status of a message transaction by using the transaction ticket that is generated when a message is sent through all the send message APIs. When you send a message via sendMessage, sendMessageTemplate, the response contains a field called transaction ticket - this is the unique identifier for the particular transaction of sending a message. With this transaction ticket, you can use getMessageStatus to identify the current status of the message.

Get the Organization tree for a specified org code.

Messages Sent By Type

Returns messages sent from various levels of platform based on the category of messages.

Archive Messages Sent

Returns archived messages sent from various levels of the platform. (Only top level orgcodes are to be used)

ReadVerificationType

Returns the VBT type set for Group, Division, Organization or Company level.

Send Message to Org

This method is used to send messages to subscribers in a Group, Division, or Organization. The messages will be sent to all active subscribers in the specified Group, Division or Organization.

Report of subscribers existing in a group with details on their susbcription method across the company.

Get report on Number of hits(requests) for all premium keywords created in a group across the company.

Retrieves an MMS image sent by a mobile user

Send Template Message To Org

This method is used to send template messages to subscribers in a Group. Message will be sent to all active subscribers in the specified Group.

Get Message Status By Note

Get the status of a sent message using note. You can have multiple recipients, but only one note per message. To check the status of the messages, use the combination of note and mobile number.

Message History Details

Returns messages history details (Inbound and Outbound) based on the mobile number from various levels of the platform.

Special Characters

Supported Special Characters