SMS API reference
Base URL: https://api.getaureusdesk.com/v1 · Authentication: Authorization: Bearer adk_sms_YOUR_KEY · Format: JSON, UTF-8.
| Method | Route | Purpose | Details |
|---|---|---|---|
POST |
/sms/messages |
Send an SMS (or 2 SMS), right away or on a scheduled date | Send, Schedule |
GET |
/sms/messages/:id |
State of a message | Track |
DELETE |
/sms/messages/:id |
Cancel a scheduled SMS that has not gone out yet (credits given back) | Schedule |
GET |
/sms/balance |
Purchased credits, free credits, low balance alert | Balance and top-ups |
GET |
/sms/coverage |
Open countries, price of one SMS in credits, networks served | Balance and top-ups |
GET |
/sms/price-tiers |
Volume price grid (top-up bonus) | Balance and top-ups |
GET |
/sms/senders |
Your senders and their status | Senders |
POST |
/sms/senders |
Request an own sender (organisations) | Senders |
Message object
| Field | Type | Description |
|---|---|---|
id |
string (UUID) | Message identifier (of part 1 for a 2-SMS message) |
status |
string | QUEUED, SENDING, SENT, DELIVERED, FAILED or CANCELLED |
to |
string | Masked number (+237*******56) |
operator |
string or null | MTN, ORANGE… |
countryIso |
string | Recipient's country (CM) |
priceCredits |
number | Credits for this SMS |
senderId |
string | Sender used |
errorCode |
string or null | Reason for a failure |
groupId |
string or null | 2-SMS message: identifier shared by both parts |
part |
string or null | "1/2" or "2/2"; null for a single SMS |
scheduledAt |
string or null | Scheduled sending date (ISO 8601) |
createdAt, sentAt, deliveredAt |
string or null | Dates (ISO 8601, UTC) |
On sending only: likelyUndelivered (operator not served today), normalized (text converted to the SMS alphabet), smsCount (1 or 2), totalCredits, parts (both parts of a 2-SMS message), and replayed when an Idempotency-Key replays an existing message.
The text of a message is never returned.