The Retarus SMS for Applications REST API is a service to send SMS and lookup the status.
To obtain a test account for this service or any of our other SMS services, please contact Retarus.
The Retarus SMS for Applications REST API is a service to send SMS and lookup the status.
To obtain a test account for this service or any of our other SMS services, please contact Retarus.
curl -i -X POST \
-u <username>:<password> \
https://developers.retarus.com/_mock/sms/sms4a-api/jobs \
-H 'Content-Type: application/json' \
-d '{
"messages": [
{
"text": "Your access code is ABC1234",
"recipients": [
{
"dst": "+4917600000000"
}
]
}
]
}'
{ "jobId": "J.20221116-102407.583-0lajfsfmoXIZJO93PQ" }
From timestamp (ISO-8601). The interval between fromTs and toTs can be a maximum of 30 days.
To timestamp (ISO-8601). The interval between fromTs and toTs can be a maximum of 30 days.
Parameter used for pagination. Retrieve a subset of records starting with the offset value.
curl -i -X GET \
-u <username>:<password> \
'https://developers.retarus.com/_mock/sms/sms4a-api/jobs?fromTs=2022-06-13T00%3A00%2B02%3A00&jobIdsOnly=true&limit=100&offset=0&open=false&toTs=2022-06-20T00%3A00%2B02%3A00'
List jobs successful.
Recommended max. 64 characters.
Timestamp indicating when the job was received by Retarus (iso-8601).
Timestamp indicating when the SMS received its final status (iso-8601).
[ { "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": [ … ] } ]
curl -i -X GET \
-u <username>:<password> \
'https://developers.retarus.com/_mock/sms/sms4a-api/jobs/{jobId}'
Get report for job ID successful.
Recommended max. 64 characters.
Timestamp indicating when the job was received by Retarus (iso-8601).
Timestamp indicating when the SMS received its final status (iso-8601).
{ "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" ] }