Send SMS messages via HTTP requests. Below are supported formats.
http://1.1.1.1:8001/api?username=<username>&password=<password>&ani=<ani>&dnis=<dnis>&message=<message>&command=submit&serviceType=<type>&longMessageMode=<mode>
https://domainname:8002/api?...same as above...
curl -X POST -H 'Content-Type: application/json' -d '{"ani":"ani","dnis":"dnis","message":"test"}' 'http://1.1.1.1:8001/api?command=submit&username=username&password=password'
curl -X POST -H 'Content-Type: application/json' -d '{"username":"username","password":"password","command":"submit","ani":"ani","dnis":"dnis","message":"test"}' 'http://1.1.1.1:8001/api'
Parameter | Description | Required |
---|---|---|
command | submit / query / mo | Yes |
dnis | Destination (E.164 format) | Yes |
message | Message content | Yes |
username | API username | Yes |
password | API password | Yes |
serviceType | Service code | No |
{"message_id":"alss-a1b2c3d4-e5f67890"}
Use this to check delivery status of previously sent SMS.
http://1.1.1.1:8001/api?username=<username>&password=<password>&messageId=<msgId>&command=query
Parameter | Description | Required |
---|---|---|
username | API username | Yes |
password | API password | Yes |
messageId | Message ID from submission | Yes |
command | Set to “query” | Yes |
{"status": "DELIVRD", "delivery_time": "20210922093309", ...}