# SMS for Applications REST API

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.

Version: v1.0.0

## Servers

Primary data center
```
https://sms4a.de2.retarus.com/rest/v1
```

Secondary data center
```
https://sms4a.de1.retarus.com/rest/v1
```

HA endpoint - only to send SMS
```
https://sms4a.eu.retarus.com/rest/v1
```

## Security

### httpBasicAuth

Type: http
Scheme: basic

## Download OpenAPI description

[SMS for Applications REST API](https://developers.retarus.com/_bundle/sms/sms4a-api.yaml)

## SMS Jobs

### Send SMS Job.

 - [POST /jobs](https://developers.retarus.com/sms/sms4a-api/sms-jobs/postjob.md): Send one or more SMS with one or more recipients each. The total number of recipients is limited to 3000 per job. The response contains the job ID (jobId) of your new SMS job.

### Get all jobs for given criteria.

 - [GET /jobs](https://developers.retarus.com/sms/sms4a-api/sms-jobs/listjobs.md): Get a list of job IDs for a specified time period and corresponding to the other optionla filters.

### Get job status

 - [GET /jobs/{jobId}](https://developers.retarus.com/sms/sms4a-api/sms-jobs/getjob.md): 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

## SMS Status

### Get status for all recipients of a job.

 - [GET /sms](https://developers.retarus.com/sms/sms4a-api/sms-status/listrecipients.md): Get the individual SMS status for all SMS's of a job

## Version

### Get version information

 - [GET /version](https://developers.retarus.com/sms/sms4a-api/version/get.md): Get the version informantion for the API.