EnableX SMS API enables developers to send / receive SMS for any marketing campaign or to do deep integration of SMS in business applications.

Table of Contents

Send First SMS from EnableX

To get started with SMS Service, you need to do the following:

  1. Login to EnableX Portal
  2. Subscribe to SMS Service
  3. Create a Project with SMS Service or add SMS Service to existing Project
  4. Go to SMS Section of the Project
  5. Create SMS Campaign
  6. Setup the Campaign to send / receive SMS
  7. Develop Web Hook URL to receive SMS
  8. Use API to send SMS

All the Steps are explained in detail below:

Project with SMS Service

You need to have a Project with SMS Service. You may either create a new Project with SMS Service or add SMS Service to any existing Project that needs this service.

  • To create Project with SMS Service
    • Navigate: {Main Menu) Projects / Create New Project
    • Check “SMS Service” too include in your Project
  • To add SMS Service to existing Project
    • Navigate: (Main Menu) Projects / My Projects
    • Click Project name to which you wish to add SMS Service. You reach Project Dashboard
    • Navigate: (Side Bar) Add New Service
    • In the “Add New Service” form,check “SMS Service” too include in your Project

Create Campaign

You need to create one or more Campaigns against SMS Service of your Project either to send or receive SMS. Follow the steps to create your Campaign:

  • Navigate: (Main Menu) Projects / My Projects / Project-Name (From List) – You reach project Dashboard
    • Click: (Project Dashboard Side Bar) SMS – You reach SMS Service page
    • Click: (SMS Service Page Side Bar) Campaign Listing – You reach a page with a list of all existing campaigns.
    • Click: (Campaign Listing Page) New Campaign” button – You reach a form to create your campaign.

Setup Campaign

Setting for Incoming SMS

A campaign can be setup to receive incoming sms and/or to send sms. To reach the Campaign Setting page, follow these steps:

  • Navigate to Campaign Listing Page as explained in above section.
  • Click: On a Campaign Title to reach “Dashboard” for the Campaign.
  • Click: (Campaign Dashboard) Settings Button – To reach Campaign Setting Form.

Explanation of the Form Elements:

  1. Long Code / Short Code: You may choose either of these. Click the button against the field to choose any Phone Number you have purchased. In case you don’t have any, you might like to place an order to buy a Long Code or Short Code.
  2. Keyword: In case you opt to receive SMS on a Shared Phone Number, you are required to add a Keyword to route incoming SMS.

Even In case of multiple campaigns against the same dedicated number you can configure separate keyword against each of the campaigns to route the message to their respective webhook.

  • Web Hook URL: Incoming message received on a number or Keyword, will be forwarded to the Web Hook URL using HTTP Post.
  • Web Hook URL Auth Information: We support only HTTP Basic Authentication to be used in your Web Hook URL. Provide related access credentials here.

Setting for Outgoing SMS

Refer the snapshot for Outgoing SMS Setting form:

Explanation of the Form Elements:

  1. Originating Country: It’s the originating country for SMS for which a Phone Number (Long Code or Short Code will be configured)
  2. Phone Number: The Phone Number is used as sender-phone number. In some Countries, using a Phone Number as sender-phone is mandatory. See SMS FAQs  Click the button against the field to choose any Phone Number you have purchased. In case you don’t have any, you might like to place an order to buy a Long Code number
  3. Sender-ID: An Alphanumeric Code used as Sender for SMS. This is optional.  
  4. Delivery Notification Web Hook URL: Instant Delivery Notifications will be posted to the Web Hook URL using HTTP Post.
  5. Web Hook URL Auth Information: We support only HTTP Basic Authentication to be used in your Web Hook URL. Provide related access credentials here.

Use API to send SMS

Use SMS API to send out messages. Use APP-ID and APP-KEY of your Project to authenticate yourself to access API.

Sample API Request to send SMS:

POST https://api.enablex.io/sms/v1/messages
Authorization: Basic XXXXXXX
Content-Type: application/json
{
       “from”: “+44xxxxxxxx”,
       “body”: “$name you are due to pay Rs. $amount”,
       “recipient”: [    
            {
                “to”: “+91xxxxxx”,
                “name”: “Kamal”,“amount”: “30” 
            }
        ],
       “type”: “sms”,
       “reference”: “XOXO”,
       “validity”: “30”,
       “type_details”: “”,
       “data_coding”: “plain”,
       “flash_message”: false,
       “scheduled_dt”: “2019-12-17T14:26:57+00:00”,
       “created_dt”: “2019-12-15T14:26:57+00:00”,
       “campaign_id”: “XX”,
       “template_id”: “37081401”
}

Ordering Resources

With reference to the above section, you know that different type of resources you need to subscribe by placing order or request to get for free in order to receive and send SMS. Follow the sections given below to be explained on ordering and requesting processes:

Phone Number (Long Code / Short Code)

To use Incoming and Outgoing SMS Service, you need to get a Phone Number configured against your Campaign. You need place an order for Phone Number (Either Short Code or Long Code), you may opt either to choose one from EnableX Phone Inventory or get a new one.

To Place your Order follow this:

  • Navigate: (Main Menu) SMS / My Inventory / Phone Number
  • Click: Place Order Button – To reach Phone Ordering Form

Explanation of the Form Elements:

Given below explanation of different options to choose in the form:

  • Type of Phone – Choose among the following:
    • Long Code
    • Short Code
  • Service Direction – Choose among the following support on the phone number:
    • Incoming Only
    • Outgoing Only
    • Both Incoming & Outgoing
  • Country – Choose the country from where you like to get the phone number

You will be presented with a list of available Phone Numbers from EnableX Phone Inventory with Price to pay for subscription. You are free to choose one from given list or place order for a new phone number.

Keyword

For onward delivery of Incoming SMS received through Shared Phone Number, a Keyword is used. Keyword is “short” Alphanumeric String that appears as first word in the SMS body which is parsed to decide onward delivery through respective Web Hook URL. You need place an order for Keyword for your Campaigns.

To place your Order follow this:

  • Navigate: (Main Menu) SMS / My Inventory / Keywords
  • Click: (Keyword Page Sidebar) Order New Keyword – To reach Keyword Ordering Form

In a single order form:

  • You can input 3 keywords in order of preference.
  • We would provision whichever is available first as per given order.

Sender ID

Sender ID is used as SMS Sender name. It’s an Alphanumeric String of predefined length used as Sender. Sender ID procured from one country appears uniformly across all receiving devices in that country. For example Sender ID is mandatory for India, Indonesia, Vietnam and Thailand. Please refer to SMS FAQs.

Shared Sender IDs are assigned for free during trial. Once the account is upgraded a monthly rental applies. You need to place an order if you need to get your own dedicated Sender ID from EnableX.

To place your request, follow this:

  • Navigate: (Main Menu) SMS / My Inventory / Sender ID
  • Click: (SenderID Page Sidebar) Request New Sender ID – To reach Sender ID Request Form

In a single order form:

  • You can input 3 Sender ID in order of preference. We would provision whichever is available first as per given order.
  • Some countries require a sample SMS body to be given along with Sender ID request.