API Manual - REST
Retarus Fax-for-Applications Webservice facilitates automation of the fax transmission process. In addition, it also allows you to monitor the status of a sent fax and delete archived reports. The Webservice communicates via REST 1.0 (JSON). The programming language with which the Webservice client is implemented is not restricted by the Webservice itself.
Fax transmission is generally divided into the following steps:
Create a fax job and send it to the Webservice
Output: Job ID
Resource:
sendJobRequest
Optional: Retrieve the job status (Status report: by ID or all available)
Output: status report, including transmission status for each recipient
Resources:
getStatusReport,getAllStatusReports,bulkStatusReports
Alternative: push service via HTTP or mail receipt
Optional: Delete job reports
Job data has a configurable retention time, but can be deleted immediately using this method
Resources:
deleteStatusReport,bulkStatusReports
The service is reachable via high availability URL (HA URL) or URLs for specific data centers.
For processing in the European Union: HA-URL: https://faxws-ha.de.retarus.com/rest/v1
or
For processing in USA: HA-URL: https://faxws-ha.us.retarus.com/rest/v1
For further connection options, contact Retarus.
Version information
Version: v1
URI scheme
Host : faxws.de1.retarus.com
BasePath : /rest/v1
Schemes : HTTPS
Consumes
application/json
Produces
application/json