This document refers to all available API end points.

Base URL
http://yourdomain.com/api/VERSION
Full URL Format
http://yourdomain.com/api/VERSION[/APITOKEN]/sms[/UUID]/ENDPOINT.FORMAT[?PARAMETERS]
Routes

There are five major routes — single, bulk, schedule, status and balance.

Response Formats

We support two return formats — JSON and XML. Add an format extension to the request to modify response type.

Send SMS

This endpoint sends an SMS to a mobile number - this is commonly used in transactional SMS.

Endpoint
/sms/single
Request Method
POST

Parameters

token
API Token.
msisdn
Destination mobile number.
text
Short message text.
sender_id
Six character Sender ID. Not required for Promo routes.
route
SMS gatewary route. Ex: TRANS or PROMO
unicode
Set this true if short message is in unicode format.
flash
Set this true if short message to be a flash.
{
  "uuid": UUID,
  "status": "Success",
  "description": ""
}
<results>
    <uuid>UUID</uuid>
    <status>Success</status>
    <description></description>
</results>

This endpoint sends bulk SMS. You can send an SMS to multiple mobile numbers through this endpoint.This is commonly used for promotional SMS.

Endpoint
/sms/bulk
Request Method
POST
token
API Token.
msisdn
Destination mobile numbers. Mobile numbers should be separated by comma.
text
Short message text.
sender_id
Six character Sender ID. Not required for Promo routes.
route
SMS gatewary route. Ex: TRANS or PROMO
unicode
Set this true if short message is in unicode format.
flash
Set this true if short message to be a flash.
{
  "uuid": UUID,
  "status": "Success",
  "description": ""
}
<results>
    <uuid>UUID</uuid>
    <status>Success</status>
    <description></description>
</results>

Use this endpoint to schedule SMS for later delivery. You can schedule bulk SMS.

Endpoint
/sms/schedule
Request Method
POST
token
API Token.
msisdn
Destination mobile numbers. Mobile numbers should be separated by comma.
text
Short message text.
sender_id
Six character Sender ID. Not required for Promo routes.
route
SMS gatewary route. Ex: TRANS or PROMO
schedule
Time at when the SMS should fired. Example format: 2020-04-10 13:06:42
unicode
Set this true if short message is in unicode format.
flash
Set this true if short message to be a flash.
{
  "uuid": UUID,
  "status": "Success",
  "description": ""
}
<results>
    <uuid>UUID</uuid>
    <status>Success</status>
    <description></description>
</results>

Use this endpoint to delete a scheduled job. The scheduled job is identified with it's UUID.

Endpoint
/APITOKEN/sms/schedule/UUID
Request Method
DELETE
{
  "uuid": UUID,
  "status": "Success",
  "description": ""
}
Sample XML response:
<results>
    <uuid>UUID</uuid>
    <status>Success</status>
    <description></description>
</results>

Use this endpoint to get status of a job.

Endpoint
/APITOKEN/sms/UUID/status
Request Method
GET
{
    "results" : {
        "job_id" : "JOB ID",
        "total" : 1,
        "messages" : [{
            "text" : "foo bar",
            "msisdn" : "MSISDN",
            "sender" : "FALERT",
            "parts" : 1,
            "route" : "TRANS",
            "status" : "SUBMITTED",
            "sent_at" : "2014-05-14T09:40:40.000Z"
        }]
    }
}
Sample XML Response
<results>
    <job_id>JOB ID</job_id>
    <total>1</total>
    <messages>
        <text>foo bar</text>
        <msisdn>MSISDN</msisdn>
        <sender>FALERT</sender>
        <parts>1</parts>
        <route>TRANS</route>
        <status>SUBMITTED</status>
        <sent_at>2014-05-14T09:40:40.000Z</sent_at>
    </messages>
</results>

Use this endpoint to know current credit balance.

Endpoint
/APITOKEN/balance
Request method
GET
{
    "results" : {
        "balance_info" : [{
            "route" : "TRANS",
            "credits" : "499885.0",
            "sent" : {
                "today" : 0,
                "month" : 9,
                "all" : 9
            }
        },
        {
            "route" : "PROMO",
            "credits" : "60.0",
            "sent" : {
                "today" : 0,
                "month" : 1,
                "all" : 1
            }
        }]
    }
}
Sample XML Response
<results>
    <balance_info>
        <route>TRANS</route>
        <credits>499885.0</credits>
        <sent>
            <today>0</today>
            <month>9</month>
            <all>9</all>
        </sent>
    </balance_info>
    <balance_info>
        <route>PROMO</route>
        <credits>60.0</credits>
        <sent>
            <today>0</today>
            <month>1</month>
            <all>1</all>
        </sent>
    </balance_info>
</results>

Use this endpoint to know summary.

Endpoint
/APITOKEN/summary
Request method
GET
{
    "results" : {
        "summary" : [{
            "route" : "TRANS",
            "sent" : {
                "today" : 0,
                "month" : 9,
                "all" : 9
            }
        },
        {
            "route" : "PROMO",
            "sent" : {
                "today" : 0,
                "month" : 1,
                "all" : 1
            }
        }]
    }
}
Sample XML Response
<results>
    <summary>
        <route>TRANS</route>
        <sent>
            <today>0</today>
            <month>9</month>
            <all>9</all>
        </sent>
    </summary>
    <summary>
        <route>PROMO</route>
        <sent>
            <today>0</today>
            <month>1</month>
            <all>1</all>
        </sent>
    </summary>
</results>