Send an SMS

HTTP API sends a text message using POST and form-encoded data. The URL you use to send a text message has a required field called api_key, which is unique and assigned to your account.

The other required parameters for the Request are method, sender, to and message, which are used to define the destination phone number and the message body. If you want to send to multiple phone numbers, provide the numbers in comma separated format.

To send an SMS using the HTTP API, the following URL format is used:

curl -X POST \
'<BASE_URL>&method=sms&message=Test+sms&to=9172xxxxxxxx&sender=BRAND'

API Parameter Specifications

The API parameter specifications are described in the following sections.

Mandatory Parameters

The mandatory parameters in the HTTP API are tabulated below:

Optional Parameters

The optional parameters in the HTTP API are tabulated below:

Advanced Parameters(Optional)

The advanced parameters in the HTTP API are tabulated below:

Example Responses

1. JSON

{
  "status": "OK",
  "data": [
    {
      "id": "811436f5-0053-4ea6-8cac-b035880b8473:1",
      "customid": "1",
      "customid1": "11",
      "customid2": "22",
      "mobile": "95XXXXXXXXX",
      "status": "AWAITED-DLR"
    },
    {
      "id": "811436f5-0053-4ea6-8cac-b035880b8473:2",
      "customid": "2",
      "customid1": "1",
      "customid2": "2",
      "mobile": "97XXXXXXXX",
      "status": "AWAITED-DLR"
    }
  ],
  "message": "Campaign of 2 numbers Submitted successfully."
}

2. XML

 <?xml version="1.0" encoding="UTF-8" ?>
<api>
    <status>OK</status>
    <data>
        <sms>
            <id>e6bf8207-d226-4429-a1f0-ba0506efa539:1</id>
            <customid>1</customid>
            <customid1>11</customid1>
            <customid2>22</customid2>
            <mobile>95XXXXXXXX</mobile>
            <status>AWAITED-DLR</status>
        </sms>
        <sms>
            <id>e6bf8207-d226-4429-a1f0-ba0506efa539:2</id>
            <customid>2</customid>
            <customid1>1</customid1>
            <customid2>2</customid2>
            <mobile>99XXXXXXXX</mobile>
            <status>AWAITED-DLR</status>
        </sms>
    </data>
    <message>Campaign of 2 numbers Submitted successfully.</message>
</api>

Error Responses

{
  "status":"A404",
  "message": "Your api account got suspended"
}

Response Data

Send a Unicode SMS

Unicode SMS is basically a message which can be in regional language. In India, SMS can be sent in Tamil, Kannada, Hindi, English, etc type of languages. To send a unicode SMS using the HTTP API, the following URL format is used:

API Parameter Specifications

Additional API parameter specifications are described in the following sections.

curl -X POST \
'<BASE_URL>&method=sms&message=Test+sms&to=9172xxxxxxxx&sender=BRAND&unicode=1'

Mandatory Parameters

The mandatory parameters in the HTTP API are tabulated below:

Schedule an SMS

This API can let user schedule SMS to single as well as multiple recipients at anytime. SMS cannot be scheduled before 5 minutes and after 3 months from the date of scheduling the SMS. To schedule an SMS using the HTTP API, the following URL format is used:

API Parameter Specifications

Additional API parameter specifications are described in the following sections.

curl -X POST \
'<BASE_URL>&method=sms&message=Test+sms&to=9172xxxxxxxx&sender=BRAND&time=dd%2Fmm%2Fyyyy%20hh%3Amm%20PM'

Mandatory Parameters

The mandatory parameters in the HTTP API are tabulated below:

Sending a Port SMS

Using the below API, one can send a normal or unicode SMS to a particular port. Application port numbers can be used in SMS messages to deliver a particular SMS to an application on a mobile phone. If any application is present and running in that particular port, the text will be received as port SMS else the message will hit the native inbox of the mobile phone.

NOTE: The API tries to hit the application(port) for 10 seconds, if unsuccessful the message is delivered on the native inbox

To send a port SMS using the HTTP API, the following URL format is used:

API Parameter Specifications

The API parameter specifications are described in the following sections.

curl -X POST \
'<BASE_URL>&method=sms&message=Test+sms&to=9172xxxxxxxx&sender=BRAND&port=8xxx'

Mandatory Parameters

The mandatory parameters in the HTTP API are tabulated below: