SMS for Applications REST API (v1.0.0)
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.
https://developers.retarus.com/_mock/sms/sms4a-api/
https://sms4a.de2.retarus.com/rest/v1/
https://sms4a.de1.retarus.com/rest/v1/
https://sms4a.eu.retarus.com/rest/v1/
- Mock server
https://developers.retarus.com/_mock/sms/sms4a-api/jobs
- Primary data center
https://sms4a.de2.retarus.com/rest/v1/jobs
- Secondary data center
https://sms4a.de1.retarus.com/rest/v1/jobs
- HA endpoint - only to send SMS
https://sms4a.eu.retarus.com/rest/v1/jobs
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
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.
- Mock server
https://developers.retarus.com/_mock/sms/sms4a-api/jobs
- Primary data center
https://sms4a.de2.retarus.com/rest/v1/jobs
- Secondary data center
https://sms4a.de1.retarus.com/rest/v1/jobs
- HA endpoint - only to send SMS
https://sms4a.eu.retarus.com/rest/v1/jobs
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
-u <username>:<password> \
'https://developers.retarus.com/_mock/sms/sms4a-api/jobs?jobIdsOnly=true&fromTs=2022-06-13T00%3A00%2B02%3A00&toTs=2022-06-20T00%3A00%2B02%3A00&open=false&offset=0&limit=100'
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": [ … ] } ]
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
- Mock server
https://developers.retarus.com/_mock/sms/sms4a-api/jobs/{jobId}
- Primary data center
https://sms4a.de2.retarus.com/rest/v1/jobs/{jobId}
- Secondary data center
https://sms4a.de1.retarus.com/rest/v1/jobs/{jobId}
- HA endpoint - only to send SMS
https://sms4a.eu.retarus.com/rest/v1/jobs/{jobId}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
-u <username>:<password> \
https://developers.retarus.com/_mock/sms/sms4a-api/jobs/J.20180620-085038.561-0jimrdkk7SOILYBNMK
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" ] }