SMS API

SMS Endpoints

Send messages and check delivery status

GET/api/sender

Retrieve available sender IDs

No parameters required.

Request

curl \
  "{{api_url}}/api/sender" \
  -H "Authorization: Bearer {{access_token}}"

Response

200 Success

{
  "status": "success",
  "result": {
    "Sender": [
      "sender_id_1",
      "sender_id_2"
    ]
  }
}

POST/api/sms/send

Send single or multiple SMS messages

Parameters

tostringrequired

Phone numbers separated by commas, no spaces

fromstringrequired

Sender ID

textstringrequired

Message content

callbackstringoptional

URL for delivery callbacks

Request

curl \
  -X POST \
  "{{api_url}}/api/sms/send" \
  -H "Authorization: Bearer {{access_token}}" \
  -H "Content-Type: application/json" \
  -d '{
  "to": "61444444444,61488888888",
  "from": "ATOM",
  "text": "Testing from the API",
  "callback": "https://myurl.com/receive"
}'

Response

200 Success

{
  "status": "success",
  "result": {
    "message_id": "00029910-000000382d3bf",
    "status": "pending"
  }
}

POST/api/sms/status

Check SMS delivery status

⚠

Status values: Scheduled (intermediate), Enroute (intermediate), Delivered (final), Expired (final), Deleted (final), Undeliverable (final), Accepted (final), Unknown (intermediate), Rejected (final), Skipped (final)

Parameters

message_idstringrequired

ID of sent SMS message

Request

curl \
  -X POST \
  "{{api_url}}/api/sms/status" \
  -H "Authorization: Bearer {{access_token}}" \
  -H "Content-Type: application/json" \
  -d '{
  "message_id": "00029910-000000382d3bf"
}'

Response200 Success

{
  "status": "success",
  "result": {
    "message_id": "00029910-000000382d3bf",
    "status": "Delivered"
  }
}

Back to API Documentation