Fax Configuration API (2.0)
The fax configuration API allows you to administer:
- Mail to Fax
- Fax to Email
- Fax to FTP
- Fax to Webservice
Download OpenAPI description
Languages
Servers
Mock server
https://developers.retarus.com/_mock/fax/fax-config-api/
Production
https://fax-config.de2.retarus.com/v2/
- Mock server
https://developers.retarus.com/_mock/fax/fax-config-api/inbound/profiles
- Production
https://fax-config.de2.retarus.com/v2/inbound/profiles
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
-u <username>:<password> \
'https://developers.retarus.com/_mock/fax/fax-config-api/inbound/profiles?inherit=false&serviceType=Fax2Mail&name=Fax2Mail+USA'
Response
application/json
[ { "name": "Fax2FTP Orders", "serviceType": "Fax2FTP" }, { "name": "Fax2WS Lab Reports", "serviceType": "Fax2WS" }, { "name": "Fax2Mail USA", "serviceType": "Fax2Mail" } ]
- Mock server
https://developers.retarus.com/_mock/fax/fax-config-api/inbound/profiles/{profile}
- Production
https://fax-config.de2.retarus.com/v2/inbound/profiles/{profile}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
-u <username>:<password> \
'https://developers.retarus.com/_mock/fax/fax-config-api/inbound/profiles/Fax2Mail USA?inherit=false'
Response
application/json
{ "name": "FaxToEmail-USA", "serviceType": "Fax2Mail" }
- Mock server
https://developers.retarus.com/_mock/fax/fax-config-api/inbound/profiles/{profile}
- Production
https://fax-config.de2.retarus.com/v2/inbound/profiles/{profile}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X PUT \
-u <username>:<password> \
https://developers.retarus.com/_mock/fax/fax-config-api/inbound/profiles/FaxToEmail-USA \
-H 'Content-Type: application/json' \
-d '{
"serviceType": "Fax2Mail"
}'
Response
application/json
{ "name": "FaxToEmail-USA", "serviceType": "Fax2Mail" }
- Mock server
https://developers.retarus.com/_mock/fax/fax-config-api/inbound/profiles/{profile}
- Production
https://fax-config.de2.retarus.com/v2/inbound/profiles/{profile}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X DELETE \
-u <username>:<password> \
https://developers.retarus.com/_mock/fax/fax-config-api/inbound/profiles/FaxToEmail-USA