Skip to content

SMS Status

Operations

Get status for all recipients of a job.

Request

Get the individual SMS status for all SMS's of a job

Security
httpBasicAuth
Query
jobIdstringJ\..{18,38}required

The Retarus job ID.

Example:jobId=J.20180620-085038.561-0jimrdkk7SOILYBNMK
curl -i -X GET \
  -u '<username>:<password>' \
  'https://developers.retarus.com/_mock/sms/sms4a-api/sms?jobId=J.20180620-085038.561-0jimrdkk7SOILYBNMK'

Responses

Get report for all recipients of job ID successful.

Bodyapplication/json
Array [
smsIdstringread-only
Example:"S.20220928-125820.022-0l8likueyRB3CT8FTG"
dststringread-only

Recipient’s mobile phone number.

Example:"+4917600000000"
processStatusstringread-only

Current process status (see SMS Outbound Status Codes).

Example:"DONE"
statusstringread-only

Status (see SMS Outbound Status Codes).

Example:"SUC_FIN"
customerRefstringread-only

Recommended max. 64 characters.

Example:"TransactionID: ABC123"
reasonstringread-only
Example:"message_state:DELIVERED [00000002] (Final) (Message is delivered to destination.)"
sentTsstring, (date-time)read-only

Timestamp when the SMS was sent (iso-8601).

Example:"2022-09-28T10:58:30.022Z"
finishedTsstring, (date-time)read-only

Timestamp which indicates when the SMS received its final status (iso-8601).

Example:"2022-09-28T10:59:34.150Z"
]
Response
[
  {
    "smsId": "S.20220928-125820.022-0l8likueyRB3CT8FTG",
    "dst": "+4917600000000",
    "processStatus": "DONE",
    "status": "SUC_FIN",
    "customerRef": "TransactionID: ABC123",
    "reason": "message_state:DELIVERED [00000002] (Final) (Message is delivered to destination.)",
    "sentTs": "2022-09-28T10:58:30.022Z",
    "finishedTs": "2022-09-28T10:59:34.150Z"
  }
]