http API
Developer / Http API
Http API
smtp API
SMS Api allows you to integrate our sms service to your own web based / stand alone applications.
https://app.smslocal.com/api/smsapi?key=Account key&route=Route&sender=Sender id&number=Number(s)&sms=Message &templateid=DLT_Templateid
description
| # | Parameter | Description | Example |
|---|---|---|---|
| 1 | key | Your account API key | 0ec0e29706c4e213a2918b54047c1d5c |
| 2 | sender | Sender id | ALERTS |
| 3 | number | Destination numbers | 97XXXXXXXX,93XXXXXXXX |
| 4 | route | Route you want to send SMS (Transactional - 1) | 3 |
| 5 | sms | SMS content (Url encoded) | Hello+useID |
| 6 | templateid | DLT Template ID | 456XXXXXXXXXXXXXXXX |
Code errors
- 101: User not recognized
- 102: Sender ID is not valid
- 103: Invalid contact(s) provided
- 104: Invalid route specified
- 105: Message format is incorrect
- 106: Message flagged as spam
- 107: Promotional messages are blocked
- 108: Insufficient credits for the specified route
- 109: Promotional route available from 9 AM to 8:45 PM only
- 110: DLT Template ID is not valid
- 111: No SMS message available
* A numeric value other than these error codes is the unique message id for the sent slot. Keep this message id for delivery report.
Delivery Report Api
The SMS Delivery Report API enables you to retrieve the delivery report for a slot sent through the API in JSON format.
https://app.smslocal.com/api/dlrapi?key=Account key&messageid=Unique id
description
| # | Parameter | Description | Example |
|---|---|---|---|
| 1 | key | Your account API key | 0ec0e24706c4e213a2910b618147c1d5c |
| 2 | sender | Sender id | ALERTS |
Code errors
- 101: User is not valid
- 110: Message ID is invalid
* A successive api return a JSON file containing the sent destination numbers with delivery report.
Sample JSON will be like
[[“Number 4″,”Status 4″,”Time 4”],[“Number 7″,”Status 7″,”Time 7”],[“Number 9″,”Status 9″,”Time 9”]]
Credits Check Api
Available credits Api allows you to get currently available credits of a given route.
description
| # | Parameter | Description | Example |
|---|---|---|---|
| 1 | key | Your account API key | 0ec0e23406c4e213a2910b55137c1d5c |
| 2 | sender | Sender id | ALERTS |
Code errors
- 101: User is invalid
- 104: Route is invalid
* A successive api return a JSON file containing the route name and credits
