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

fax-config-api.json

fax-config-api.yaml

Servers

Mock server

https://developers.retarus.com/_mock/fax/fax-config-api/

Production

https://fax-config.de2.retarus.com/v2/

Inbound Fax

View and configure inbound fax numbers

Operations

Inbound Fax Profiles

View and configure inbound fax profiles

Operations

Retrieve inbound profile configurations

Request

Retrieve inbound fax profile configurations.

Query

inheritboolean

Toggle whether to show inherited fields

Default false

serviceTypestring(InboundProfileServiceType)

Enum"Fax2Mail""Fax2WS""Fax2FTP"

namestring

Example: name=Fax2Mail USA

curl -i -X GET \
  -u <username>:<password> \
  'https://developers.retarus.com/_mock/fax/fax-config-api/inbound/profiles?inherit=false&name=string&serviceType=Fax2Mail'

Responses

List of inbound fax profiles

Bodyapplication/jsonArray [

namestring

serviceTypestring(InboundProfileServiceType)

Enum"Fax2Mail""Fax2WS""Fax2FTP"

]

Response

application/json

[
  {
    "name": "Fax2FTP Orders",
    "serviceType": "Fax2FTP"
  },
  {
    "name": "Fax2WS Lab Reports",
    "serviceType": "Fax2WS"
  },
  {
    "name": "Fax2Mail USA",
    "serviceType": "Fax2Mail"
  }
]

Retrieve a single inbound fax profile

Request

Retrieve a specific inbound fax profile.

Path

profilestringrequired

The inbound fax profile name

Example: Fax2Mail USA

Query

inheritboolean

Toggle whether to show inherited fields

Default false

curl -i -X GET \
  -u <username>:<password> \
  'https://developers.retarus.com/_mock/fax/fax-config-api/inbound/profiles/{profile}?inherit=false'

Responses

Voilà

Bodyapplication/json

namestring

serviceTypestring(InboundProfileServiceType)

Enum"Fax2Mail""Fax2WS""Fax2FTP"

Response

application/json

{
  "name": "FaxToEmail-USA",
  "serviceType": "Fax2Mail"
}

Create an inbound fax profile

Request

Create an inbound fax profile.

Path

profilestringrequired

Example: FaxToEmail-USA

Bodyapplication/jsonrequired

A complete profile representation

serviceTypestring(InboundProfileServiceType)

Enum"Fax2Mail""Fax2WS""Fax2FTP"

curl -i -X PUT \
  -u <username>:<password> \
  'https://developers.retarus.com/_mock/fax/fax-config-api/inbound/profiles/{profile}' \
  -H 'Content-Type: application/json' \
  -d '{
    "serviceType": "Fax2Mail"
  }'

Responses

Inbound fax profile updated

Bodyapplication/json

namestring

serviceTypestring(InboundProfileServiceType)

Enum"Fax2Mail""Fax2WS""Fax2FTP"

Response

application/json

{
  "name": "FaxToEmail-USA",
  "serviceType": "Fax2Mail"
}

Delete an inbound fax profile

Request

Delete an inbound fax profile.

Path

profilestringrequired

The profile name

Example: FaxToEmail-USA

curl -i -X DELETE \
  -u <username>:<password> \
  'https://developers.retarus.com/_mock/fax/fax-config-api/inbound/profiles/{profile}'

Responses

Inbound fax profile was deleted

Response

application/json

{
  "code": 401,
  "message": "Credentials are required to access this resource."
}

Mail to Fax

View and configure email to fax users

Operations

Mail to Fax Profiles

View and configure email to fax profiles

Operations

Joint Outbound and Inbound

Retrieve joined Mail to Fax user and Fax to Mail number

Operations