Fax2WSPull (v0)

Fax2WSPull allows clients to actively retrieve faxes received for you via the Retarus cloud-based infrastructure instead of passively waiting for them to be delivered to a web service. The unit of organization for this process is the topic. A topic represents one or more fax numbers that are used to receive faxes.

For each topic, the API provides information about received faxes, including the URL to the fax documents itself.

Every inbound document showed as available is hidden after retrieval. However, fax receipt should be acknowledged by the client in the retrieval process. If this doesn't happen within a pre-defined timeout period, the document is made available again, assuming that there was some issue with the application during the retrieval process.

Each request or response in this document is JSON serialized and encoded using the UTF-8 character set.

The fax documents themselves are automatically deleted 7 days after receipt by default, regardless of whether they were downloaded or not.

Download OpenAPI description
Languages
Servers
Mock server
https://developers.retarus.com/_mock/fax/fax2ws-pull-api/
Retarus data center in Frankfurt, Germany
https://api.de1.retarus.com/faxin/rest/v1/
Retarus data center in Munich, Germany
https://api.de2.retarus.com/faxin/rest/v1/
Retarus data center in Ashburn, United States
https://api.us1.retarus.com/faxin/rest/v1/
Retarus data center in Secaucus, United States
https://api.us2.retarus.com/faxin/rest/v1/
Retarus data center in Zurich, Switzerland
https://api.ch1.retarus.com/faxin/rest/v1/
Retarus data center in Singapore
https://api.sg1.retarus.com/faxin/rest/v1/

Fax2WSPull Client

Operations