Skip to content

Get job status

Request

Get the job status and the list SMS IDs for the job. In order to get the individual SMS status for all SMS's of a job, use the SMS status endpoint /sms with the corresponding jobId parameter - eg /sms?jobId=J.20180620-085038.561-0jimrdkk7SOILYBNMK

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

The Retarus job ID.

curl -i -X GET \
  -u '<username>:<password>' \
  'https://developers.retarus.com/_mock/sms/sms4a-api/jobs/{jobId}'

Responses

Get report for job ID successful.

Bodyapplication/json
jobIdstringread-only
srcstringread-only

Sender ID.

encodingstringread-only
Enum:"standard""utf-16"
billcodestringread-only
statusRequestedbooleanread-only

Delivery notification requested.

flashbooleanread-only
validityMininteger, (int64)read-only

Validity of the SMS in minutes.

customerRefstringread-only

Recommended max. 64 characters.

qosstringread-only

Quality of Service.

Enum:"EXPRESS""NORMAL"
receiptTsstring, (date-time)read-only

Timestamp indicating when the job was received by Retarus (iso-8601).

finishedTsstring, (date-time)read-only

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

recipientIdsArray of stringsread-only
Response
{
  "jobId": "J.20220928-125820.020-0l8likuetGNOTM4A4U",
  "src": "retarus",
  "encoding": "standard",
  "billcode": "Campaign123",
  "statusRequested": true,
  "flash": false,
  "validityMin": 2880,
  "customerRef": "InternalID: ABC1234 Tag: Marketing",
  "qos": "NORMAL",
  "receiptTs": "2022-09-01T10:25:00.000Z",
  "finishedTs": "2022-09-30T10:25:00.000Z",
  "recipientIds": [
    "S.20220928-125820.022-0l8likueyRB3CT8FTG"
  ]
}