Track an SMS
GET https://api.getaureusdesk.com/v1/sms/messages/:id
Returns the state of a message of your account, as a message object. The text is never returned and the number is masked.
Statuses
status |
Meaning |
|---|---|
QUEUED |
Queued, credits reserved. A scheduled SMS stays here until its date; part 2 of a 2-SMS message stays here until part 1 is delivered |
SENDING |
Being sent |
SENT |
Accepted by the operator; delivery receipt awaited (tracked for 72 h) |
DELIVERED |
Received by the phone |
FAILED |
Failed; errorCode gives the reason (list). Credits given back if the SMS was not sent |
CANCELLED |
Scheduled SMS cancelled by you (credits given back), or cancelled by the operator |
DELIVERED, FAILED and CANCELLED are final.
2-SMS message
Each part is a separate message, with its own id, its own status and part ("1/2" or "2/2"), linked by the same groupId. The send request returns both in parts. Part 2 is only sent after part 1 has been delivered. If that delivery is not confirmed within 15 minutes, part 2 ends in FAILED with PART1_NOT_DELIVERED, and its credits are given back: the message is then partial.
Recommended polling pace
Poll shortly after sending, then less and less often: a few seconds, one minute, a few minutes. An SMS still SENT without a delivery receipt after 72 h is no longer tracked.