Start Free Account
API - Transactional SMS
How To Keep it Simple

To trigger a Transactional SMS, you need to send information via an HTTPS request to the URL address https://api.siremobile.com/ire/secure/triggerSMS. At a minimum of you need four pieces of information to send along with this request. To see how the information can be used to generate a REST API request click the BUILD URL button below. The default information is fake but you can enter your real account information to try it.

The URL you need to call the REST API

This REST URL will work with either GET (like from your Browser) or POST from any application that supports web REST calls. This REST URL is using basic user name / password over SSL security. Optionally, if you want to learn to use full Pub/Private key with your REST API calls click here SIRE REST API Pub/Private Key Option

Where do I send it?

The API is hosted athttps://api.siremobile.com/ire/secure/, and may be accessed via HTTPS only.

Each request MUST be authenticated, using a combination of Access Key ID (or simple username) and Secret Access Key (or simple password)

What do I send?

Target SMS Phone Number

This is an US based 10 digit phone number. Don't worry about the formatting of the phone number, as Sire will automatically scrub out non-numeric numbers for you.

  • (949)555-1212
  • 949.555.1212
  • 949-555-1212
Will all work.

Batch Id

Every campaign you create in Sire UI will have an assigned 6-8 digit Batch Id. This Batch Id is system unique and is used to identify which Sire flow you wish to trigger with the REST API request. You can only trigger requests to Batch Ids from your own account.

Access Key ID

This access key uniquely identifies your account as part of the request. This can be used as a straight User Name or as the Public key in a more secure Pub/Private key authentication scheme. You can get this access key from the Security Credentials sub menu item under the My Account Menu. You can add new keys or the existing keys can be disabled or deleted.

Secret Access Key

This access key uniquely identifies your account as part of the request. This can be used as a straight Password or as the Private key used to encrypt a salted timestamp string in a more secure Pub/Private key authentication scheme. You can get this access key from the Security Credentials sub menu item under the My Account Menu. You can add new keys or the existing keys can be disabled or deleted.

Three ways you can send data to the API

  • URL Parameters

    If you use URL parameters then the data you send must be URL encoded.

  • POST Form Data
  • POST JSON

Parameters MUST be submitted in the query string for GET requests. For POST requests, parameters MAY be submitted in the query string, but SHOULD be submitted in the POST body as a JSON hash (while setting Content-Type: application/json).

The JSON you would need to submit with POST requests

This REST URL will work with either GET (like from your Browser) or POST from any application that supports web REST calls. This REST URL is using basic user name / password over SSL security. Optionally, if you want to learn to use full Pub/Private key with your REST API calls click here SIRE REST API Pub/Private Key Option

How do I send it?

Using a Browser to Call API Methods

To learn more about the API and practice using the methods, you can either use either the tool of your choice or use this guide to make the calls using either a browser or a RESTful add-on to a browser.

Using the browser address bar

It is simple to make calls to the API using only your browser's address bar. For the most part, only GET methods will work for this approach.

1. Go to your browser's address bar and type in the following url

https://api.siremobile.com/ire/secure/

Followed by the method you would like to see.

An example of how to trigger an SMS campaign using the method GET: triggerSMS, type in the following:

https://api.siremobile.com/ire/secure/triggerSMS

For query parameters, simply add them onto the end of the url you just typed in with a ? after the method call but before typing in the query parameters. Each query parameter is separated by &

An example of how to to trigger an SMS campaign to a specific user using the method GET: triggerSMS with query parameters of:

  • inpContactString=(949)555-1212
  • inpBatchId=160706
  • inpUserName=7FBD5A70B591DF0EA63C
  • inpPassword=********
type in the following:

Using a RESTful add-on for your browser

You may also Install a RESTful add-on to your browser of your choice:

Suggestions

  • Google Chrome: Install the Postman RESTful Client, or another RESTful Client of your choice, add-on for Google Chrome

  • Mozilla Firefox: Install the RESTClient, or another RESTful Client of your choice, add-on for Mozilla Firefox

What do I get back?

1. First thing you will get back on all REST API requests is an acknowledgment. HTTP status codes are used to indicate the success or otherwise of REST API requests. The following status are common:

CodeDescription
200Successful request. Body will contain a JSON or XML hash of response data
400Error: details in response body
401Authentication error: response body will contain an explanation
403Forbidden: app disabled or over message quota

2. After a successful request (HTTP status code: 200) you will also get back request details. Two possible formats you can get the detail result data back from the API

Key values to look for in the return results
  • REQUESTUUID - Unique ID assigned to the request from the Sire System
  • INPBATCHID - The Campaign Id of the original request.
  • INPCONTACTSTRING - The Contact string used in the original Request
  • SMSDEST - Short code used by the Campaign Id. used by those customers that have more than one Short Code.
  • SMSINIT - System code - Value of 1 for Accepted by downstream carriers as a valid request. If this is 0 you may look for additional reasons why in Results Exception Messaging
  • STATUSCODE - System code - Value of 1 for successful request on the API - Value of 0 for unsuccessful API requests
  • BLOCKEDBYDNC - System code - Value of 1 if the user has asked not to be contacted on the target short code any more. Value of 0 if not blocked by any prior DNC request.
Schedule Limited Campaigns
  • INPTIMEZONE - Optional input specifying the time zone of the requested device. This is ignored for real time campaigns.
  • CURRTZ - If a time zone is not provided as part of the request, this is the time zone detected for the target device.
Results Exception Messaging.
  • MESSAGE - If there is any additional information of note related to this request. Usually blank under normal calls
  • TYPE - Type of Error if Any
  • ERRMESSAGE - Cause of Error if Any
  • DISTRIBUTIONID - Internal System ID to help track which system is processing the request. Use REQUESTUUID for system wide unique Id
Common Result Scenarios
  • OK, successful submission to the platform
  • Account Suspended
  • Credit Balance is 0
  • Message could not be forwarded to the core platform
  • Error in message data causing translation error
  • Message contains illegal characters causing encoding error
  • General sending error
  • Private connection configuration error
  • Message rejected by core platform
  • Invalid INPCONTACTSTRING
  • Invalid INPBATCHID
  • Destination busy
Unlimited Custom Data Fields (CDF)s

Beyond just First Name / Last Name. Tools to manage your custom data. Your account. Your data. No Limits!

Your company's unique strengths are its competitive advantage. Why should you compromise with vanilla application deployments or other vendor limits? With Sire's Custom Data Fields, you don't have to.

Any CDFs in the message flow will be replaced with the data you send as part of the triggerSMS API call. Send these additional CDF values as part of the URL query string in GET and POST requests or as part of the JSON data in the POST requests.

Personalization

Personalize different parts of each message for each individual recipient.


{%inpCustomerName%}, thanks for your recent social media contact with {%inpBrandName%}. We'll text you shortly for some feedback about your experience.

Customization

Customize parts of the message to relate to each individual recipient's transaction history. The knowledge that a company has about a customer needs to be put into practice and the information held has to be taken into account in order to be able to give the client exactly what he wants


Hello. This is a {%inpBrand%} Alert to help you manage your account ending in {%inpLastFourAcct%}. The ${%inpAmount%} ATM withdrawal you made on {%inpDateTime%} was more than the ${%inpThreshold%} limit in your Alerts settings.If you have questions, please log on to your account or call 1-877-555-1212. Thanks for choosing {%inpBrand%}.

An example of how to to trigger an SMS campaign to a specific user with Custom Data Fields (CDF)s using the method GET: triggerSMS with query parameters of:

  • inpContactString=(949)555-1212
  • inpBatchId=160706
  • inpUserName=7FBD5A70B591DF0EA63C
  • inpPassword=********
  • inpCustomerName=Joe
  • inpBrandName=BrandX
type in the following:

Who can I send to?

SMS marketing is messaging customers who you've subscribed to various lists. They give you permission to send them messages, and as long as you follow all guidelines and best practices, there should never be negative feedback on your brand. Targeting is also key, which is why you should use the profile data collection options when you subscribe your customers to better target your messages in the most relevant way possible.

Shared Short Code accounts are limited to sending triggered SMS to only those phone numbers already on their double opt in lists.

Enterprise clients may upload their existing lists for use on their own dedicated short codes for pre-approved campaigns.