| Operation |
URL |
Method |
Params details |
Response |
Additional information |
| Send |
http(s)://apps.lsim.az/quicksms/v1/send?
login=LOGIN
&msisdn=MSISDN
&text=MSG_BODY
&sender=SENDER
&key=KEY
[&unicode=UNICODE]
|
HTTP GET |
| LOGIN |
your login |
| MSISDN |
subscriber number (country code + operator code + number)
Ex:99450XXXXXXX |
| MSG_BODY |
message |
| SENDER |
title to use when sending message (will be supplied) |
| KEY |
md5 of ( (md5 of your password) + LOGIN + MSG_BODY + MSISDN + SENDER ) |
| UNICODE |
(&unicode=false) - default;
(&unicode=true) - use true, when you intend to send Unicode character inside msg_body
* before use Unicode take a look this page |
|
you will get json object:
{"successMessage":null,"errorMessage":null,"obj":long,"errorCode":integer}
| successMessage |
Success message of operation |
| errorMessage |
Error message of operation if some error occured |
| obj |
integer that represents transactionId |
| errorCode |
If some error occured then it will show error code |
|
* parameters inside square parentheses [] are not mandatory
* if you intend to use optional parameters use without parentheses
* before use Unicode take a look this page
|
| Send |
https://apps.lsim.az/quicksms/v1/smssender
|
HTTP POST |
| REQUEST BODY (in JSON) |
{
"login": login
"key": md5 of ( (md5 of your password) + LOGIN + MSG_BODY + MSISDN + SENDER )
"msisdn": subscriber number (country code + operator code + number) Ex:99450XXXXXXX
"text": message body
"sender": title to use when sending message (will be supplied)
"scheduled": NOW or date-time( 2023-05-19 15:40:05 ) (default=NOW)
"unicode": false or true (default=false)
}
|
|
you will get json object:
{"successMessage":null,"errorMessage":null,"obj":long,"errorCode":integer}
| successMessage |
Success message of operation |
| errorMessage |
Error message of operation if some error occured |
| obj |
integer that represents transactionId |
| errorCode |
If some error occured then it will show error code |
|
|
| Check balance |
http(s)://apps.lsim.az/quicksms/v1/balance?
login=LOGIN
&key=KEY
|
HTTP GET |
| LOGIN |
your login |
| KEY |
md5 of (md5 of your password) + LOGIN |
|
you will get json object:
{"successMessage":null,"errorMessage":null,"obj":integer,"errorCode":integer}
| successMessage |
Success message of operation |
| errorMessage |
Error message of operation if some error occured |
| obj |
integer that represents balance |
| errorCode |
If some error occured then it will show error code |
|
|
| Get report |
https://apps.lsim.az/quicksms/v1/smsreporter |
HTTP POST |
| REQUEST BODY (in JSON) |
{
"login": login
"transid": transaction id received upon successfull sms submit operation
}
|
|
| Positive responses |
| 100 |
In queue |
| 101 |
Delivered |
| 102 |
Undelivered |
| 103 |
Expired |
| 104 |
Rejected |
| 105 |
Cancelled |
| 106 |
Error |
| 107 |
Unknown (contact us) |
108 |
Sent |
109 |
Black list |
|
| Error responses |
| -100 |
invalid key |
| -101 |
text more than allowed length |
| -102 |
wrong number format |
| -103 |
invalid sender name |
| -104 |
insufficient balance |
| -105 |
number in black list |
| -106 |
invalid transaction id |
| -107 |
IP address not allowed |
| -108 |
invalid hash |
| -109 |
no host |
| -110 |
reporting limit exceed |
| -500 |
internal error |
|
* From 01.02.2019 we defined reporting limit per minute. If you exceed the limit you will receive -110 response. The beginning of every minute system reset the counter. Default TPM(transaction per minute) limit is 150 transaction.
|
|
| Get report |
http(s)://apps.lsim.az/quicksms/v1/report?
login=LOGIN
&trans_id=TRANS_ID |
HTTP GET |
| Params |
| LOGIN |
your login |
| TRANS_ID |
transaction id received upon successfull sms submit operation |
|
| Positive responses |
| 100 |
In queue |
| 101 |
Delivered |
| 102 |
Undelivered |
| 103 |
Expired |
| 104 |
Rejected |
| 105 |
Cancelled |
| 106 |
Error |
| 107 |
Unknown (contact us) |
108 |
Sent |
109 |
Black list |
|
| Error responses |
| -100 |
invalid key |
| -101 |
text more than allowed length |
| -102 |
wrong number format |
| -103 |
invalid sender name |
| -104 |
insufficient balance |
| -105 |
number in black list |
| -106 |
invalid transaction id |
| -107 |
IP address not allowed |
| -108 |
invalid hash |
| -109 |
no host |
| -110 |
reporting limit exceed |
| -500 |
internal error |
|
* From 01.02.2019 we defined reporting limit per minute. If you exceed the limit you will receive -110 response. The beginning of every minute system reset the counter. Default TPM(transaction per minute) limit is 150 transaction.
|
Delivery reports can also be pushed by HTTP GET to you if you provide us a URL in
the following form:
http[s]://hostname/?trans_id={trans_id}&status={status}
{trans_id} will be replaced with transaction id
{status} will be replaced with one of above delivery reports
|