API detail with example – https://bitbucket.org/aakashsms/api/src/v4
Send SMS
API Endpoint : https://sms.aakashsms.com/sms/v3/send
/send
Request
Field | Type | Description |
---|---|---|
auth_token |
string |
Token generated from our website. |
to |
string |
Comma Separated 10-digit mobile numbers. |
text |
string |
SMS Message to be sent. |
Response
Success Responses
{ "error": false, "message": "1 messages has been queued for delivery.", "data": { "valid": [ { "id": 2673160, "mobile": "977981*******", "text": "v3 sms test", "credit": 1, "network": "ncell", "status": "queued" } ], "invalid": [ { "mobile": "988585584", "text": "v3 sms test", "credit": 0, "network": "N/A", "status": "aborted" } ] } }
Error Responses
# if auth token is invalid. { "error": true, "message": "The provided Auth Token is not valid.", "data": [] } # if auth token field is missing. { "error": true, "message": "The auth token field is required.", "data": [] } # if to field is missing. { "error": true, "message": "The to field is required.", "data": [] } # if text field is missing. { "error": true, "message": "The text field is required.", "data": [] } # if credit is not enough. { "error": true, "message": "Not enough balance.", "data": [] }
Report
API Endpoint: https://sms.aakashsms.com/sms/v1/report/api
/report
Request
Field | Type | Description |
---|---|---|
auth_token |
string |
Token generated from our website. |
page |
integer |
Start from 1,2…… |
Response
{ "error": false, "total_page": 1, "response_code": "201", "data": [ { "id": 1968977, "receiver": "984*******", "network": "ntc", "message": "Test from aakashsms", "api_credit": "1", "delivery_at": "2019-05-30 16:35:01" }, { "id": 1967677, "receiver": "984*******", "network": "ntc", "message": "Test from aakashsms", "api_credit": "1", "delivery_at": "2019-05-30 12:29:13" } ] }
Credit
API Endpoint: https://sms.aakashsms.com/sms/v1/credit
/credit
Request
Field | Type | Description |
---|---|---|
auth_token |
string |
Token generated from our website. |
Response
{ "available_credit": ****, "total_sms_sent": ****, "response_code": 202 }