Http API


SMS Api


SMS Api allows you to integrate our sms service to your own web based / stand alone applications.

http://login.messageaspire.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 27c60becba5bf19b92589d1c344a80ba
2 sender Sender id ALERTS
3 number Destination numbers 99XXXXXXXX,98XXXXXXXX
4 route Route you want to send SMS ( Transactional - 1, Promo SID - 2, Promotional - 3, Promo DND - 4, Trans OTP - 6, Service Implicit - 7, Service Explicit - 8) 2
5 sms SMS content (Url encoded) Hello+user
6 templateid DLT Template ID 123XXXXXXXXXXXXXXXX
* All special character included content should be in urlencode format.
  • Error Codes

    • 101 : Invalid user
    • 102 : Invalid sender ID
    • 103 : Invalid contact(s)
    • 104 : Invalid route
    • 105 : Invalid message
    • 106 : Spam blocked
    • 107 : Promotional block
    • 108 : Low credits in the specified route
    • 109 : Promotional route will be working from 9am to 8:45pm only
    • 110 : Invalid DLT Template ID

* 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


SMS Delivery Report Api allows you to get delivery report of a slot sent via Api as JSON format.

http://login.messageaspire.com/api/dlrapi?key=Account key&messageid=Unique id

Description


# Parameter Description Example
1 key Your account API key 27c60becba5bf19b92589d1c344a80ba
2 messageid Unique message id returned by SMS Api 987650
* Give the exact message id.
  • Error Codes

    • 101 : Invalid user
    • 110 : Invalid message id

* A successive api return a JSON file containing the sent destination numbers with delivery report


Sample JSON will be like

[["Number 1","Status 1","Time 1"],["Number 2","Status 2","Time 2"],["Number 3","Status 3","Time 3"]]


Credits Check Api


Available credits Api allows you to get currently available credits of a given route.

http://login.messageaspire.com/api/creditapi?key=Account key&route=Route

Description



# Parameter Description Example
1 key Your account API key 27c60becba5bf19b92589d1c344a80ba
2 route Route you want to check credits ( Transactional - 1, Promo SID - 2, Promotional - 3, Promo DND - 4, Trans OTP - 6, Service Implicit - 7, Service Explicit - 8) 2
* Give the exact route id.
  • Error Codes

    • 101 : Invalid user
    • 104 : Invalid route

* A successive api return a JSON file containing the route name and credits


Sample JSON will be like


{"Route","Route","Credits","Credits"}

NOTE:- API Key Will Be in your Account