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
Languages
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

Retrieve inbound number configurations

Request

Retrieve inbound number configurations.

Query
assignedboolean

Retrieve only numbers that are assigned to a profile

prefixstring

Retrieve only numbers that begin with the specified prefix

Example: prefix=+4989
activeboolean

Retrieve only numbers that are active

cost-centerstring

Retrieve only numbers where the cost-center matches the specified value

Example: cost-center=ABC123
inheritboolean

Toggle whether to show settings inherited from the profile

Default false
curl -i -X GET \
  -u <username>:<password> \
  'https://developers.retarus.com/_mock/fax/fax-config-api/inbound/numbers?active=true&assigned=true&cost-center=string&inherit=false&prefix=string'

Responses

Array of numbers and their settings

Bodyapplication/jsonArray [
One of:
numberstringread-only
displayNumberstring

The display number is used in the meta provided to the user or application, and in reporting. If it is null, the actual number will be used.

commentsstring
faxIdstring

CSID

costCenterstring
activeboolean

If the number should be active or not. If it is not active, when the number is called the repsonse will be wrong number.

profilestringread-only

The assigned profile display name.

]
Response
application/json
[
  {
    "number": "+498955281201",
    "displayNumber": "+4980012345678",
    "profile": "Fax2FTP Orders",
    "ftp": { … }
  },
  {
    "number": "+498955281919",
    "profile": "Fax2FTP Orders",
    "ftp": {}
  },
  {
    "number": "+33187166310",
    "profile": "Fax2WS Lab Reports",
    "webservice": {}
  },
  {
    "number": "+12012051606",
    "profile": "Fax2Mail USA",
    "email": { … }
  },
  {
    "number": "+12012051606",
    "comments": "Sales fax number USA - New York Office",
    "costCenter": "USA - Sales",
    "profile": "Fax2Mail USA",
    "email": { … }
  },
  {
    "number": "+498955281919"
  }
]

Retrieve a single inbound fax number

Request

Retrieve the configuration for the single specified inbound fax number.

Path
numberstringrequired

The inbound fax number

Example: +443069990000
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/numbers/{number}?inherit=false'

Responses

Inbound fax number configuration for the specififed number.

Bodyapplication/json
One of:
numberstringread-only
displayNumberstring

The display number is used in the meta provided to the user or application, and in reporting. If it is null, the actual number will be used.

commentsstring
faxIdstring

CSID

costCenterstring
activeboolean

If the number should be active or not. If it is not active, when the number is called the repsonse will be wrong number.

profilestringread-only

The assigned profile display name.

Response
application/json
{
  "number": "0049/89/208076-5001",
  "profile": "FaxToEmail",
  "email": {
    "recipients": [ … ]
  }
}

Update a single inbound fax number

Request

Update a single inbound fax number. Any omitted fields are automatically defaulted to null, where null is equivalent to Default ie the value will be inherited from the assigned profile.

Path
numberstringrequired

The inbound fax number

Example: +498900000000
Bodyapplication/jsonrequired

A list of recipient email addresses, for now

One of:
displayNumberstring

The display number is used in the meta provided to the user or application, and in reporting. If it is null, the actual number will be used.

commentsstring
faxIdstring

CSID

costCenterstring
activeboolean

If the number should be active or not. If it is not active, when the number is called the repsonse will be wrong number.

curl -i -X PUT \
  -u <username>:<password> \
  'https://developers.retarus.com/_mock/fax/fax-config-api/inbound/numbers/{number}' \
  -H 'Content-Type: application/json' \
  -d '{
    "email": {
      "recipients": [
        "john.smith@acme.com"
      ]
    }
  }'

Responses

Successful

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

Inbound Fax Profiles

View and configure inbound fax profiles

Operations

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