Skip to content

Get all jobs for given criteria.

Request

Get a list of job IDs for a specified time period and corresponding to the other optional filters.

Security
httpBasicAuth
Query
jobIdsOnlybooleanrequired

Return only jobIDs. Currently only 'true' is supported.

Default:true
fromTsstring, (date-time)

From timestamp (ISO-8601). The interval between fromTs and toTs can be a maximum of 30 days.

toTsstring, (date-time)

To timestamp (ISO-8601). The interval between fromTs and toTs can be a maximum of 30 days.

openboolean

Return only open jobs.

Default:false
offsetinteger, (int64), >= 0

Parameter used for pagination. Retrieve a subset of records starting with the offset value.

Default:0
limitinteger, (int64), [ 1 .. 1000 ]

Limit number of results returned. Value must be between 0 and 1000.

Default:100
curl -i -X GET \
  -u '<username>:<password>' \
  'https://developers.retarus.com/_mock/sms/sms4a-api/jobs?jobIdsOnly=true&fromTs=2022-06-13T00%3A00%3A00%2B02%3A00&toTs=2022-06-20T00%3A00%3A00%2B02%3A00&open=false&offset=0&limit=100'

Responses

List jobs successful.

Bodyapplication/json
Array [
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": [ … ]
  }
]