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

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

Retrieve Mail2Fax profiles

Request

Retrieve Mail2Fax profiles.

Query
limitinteger(int32)

Limit the amount of profiles returned

Default 100
offsetinteger(int32)

Skip the specified amount of profiles #FIXME

Default 0
curl -i -X GET \
  -u <username>:<password> \
  'https://developers.retarus.com/_mock/fax/fax-config-api/outbound/profiles?limit=100&offset=0'

Responses

List of Mail2Fax profiles matching the search criteria

Bodyapplication/jsonArray [
namestring
generalobject(GeneralProfileSettings)
faxobject(FaxSettings)
dialingobject(DialingSettings)
reportEmailobject(ReportEmailSettings)
coverSheetobject(CoverSheetSettings)
personalizationobject
]
Response
application/json
[
  {
    "name": "Retarus-USA-Sales",
    "dialing": { … },
    "reportEmail": { … },
    "coverSheet": { … },
    "personalization": { … },
    "general": { … },
    "fax": { … }
  },
  {
    "name": "Retarus-DE-Sales",
    "dialing": { … },
    "reportEmail": { … },
    "coverSheet": { … },
    "personalization": { … },
    "general": { … },
    "fax": { … }
  }
]

Retrieve a Mail2Fax profile

Request

Retrieve a specifc Mail2Fax profile

Path
profilestringrequired

The profile name

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

Responses

The requested Mail2Fax profile

Bodyapplication/json
namestring
generalobject(GeneralProfileSettings)
faxobject(FaxSettings)
dialingobject(DialingSettings)
reportEmailobject(ReportEmailSettings)
coverSheetobject(CoverSheetSettings)
personalizationobject
Response
application/json
{
  "name": "Retarus-USA-Sales",
  "dialing": {
    "countryCode": 1,
    "areaCode": 201
  },
  "reportEmail": {
    "language": "en"
  },
  "coverSheet": {
    "dateFormat": "MM/dd/yyyy",
    "timeFormat": "h:mm a"
  },
  "personalization": {
    "company": "retarus (North America) Inc."
  },
  "general": {
    "timezone": "US/Eastern"
  },
  "fax": {
    "csid": "Retarus USA",
    "costCenter": "Retarus-USA-Sales",
    "paperSize": "letter"
  }
}

Insert or update a Mail2Fax profile

Request

Create a new or update an existing Mail2Fax profile

Path
profilestringrequired

The profile name

Example: default
Bodyapplication/jsonrequired

A complete Mail2Fax profile representation

namestring
generalobject(GeneralProfileSettings)
faxobject(FaxSettings)
dialingobject(DialingSettings)
reportEmailobject(ReportEmailSettings)
coverSheetobject(CoverSheetSettings)
personalizationobject
curl -i -X PUT \
  -u <username>:<password> \
  'https://developers.retarus.com/_mock/fax/fax-config-api/outbound/profiles/{profile}' \
  -H 'Content-Type: application/json' \
  -d '{
    "serviceType": "Fax2Mail"
  }'

Responses

Mail2Fax profile updated

Bodyapplication/json
namestring
generalobject(GeneralProfileSettings)
faxobject(FaxSettings)
dialingobject(DialingSettings)
reportEmailobject(ReportEmailSettings)
coverSheetobject(CoverSheetSettings)
personalizationobject
Response
application/json
{
  "name": "string",
  "general": {
    "name": "string",
    "active": true,
    "timezone": "string"
  },
  "fax": {
    "csid": "string",
    "costCenter": "string",
    "header": "string",
    "blacklist": true,
    "paperSize": "string",
    "resolution": "string",
    "preferredMimeType": "string",
    "attachmentsOnly": true,
    "suppressBlankPages": true
  },
  "dialing": {
    "countryCode": "string",
    "areaCode": "string"
  },
  "reportEmail": {
    "language": "string",
    "reportFormat": "string",
    "sender": "string",
    "recipients": "string",
    "recipientsIfError": "string",
    "recipientsCc": "string",
    "attachTiff": true,
    "attachTiffOnlyIfError": true,
    "attachPdf": true,
    "sortByStatus": "string",
    "reportRecipients": "string",
    "errorReportRecipients": "string",
    "copyStatusReports": "string"
  },
  "coverSheet": {
    "fileName": "string",
    "dateFormat": "string",
    "timeFormat": "string"
  },
  "personalization": {
    "property1": "string",
    "property2": "string"
  }
}

Delete a Mail2Fax profile

Request

Delete the specified Mail2Fax profile

Path
profilestringrequired

The profile name

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

Responses

Mail2Fax profile deleted

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

Patch a single outbound fax profile

Request

Patch a single outbound fax profile. #FIXME this description

Path
profilestringrequired

The profile name

Example: default
Bodyapplication/jsonrequired

A json patch object according to RFC 6902

Array [
opstringrequired

The operation to be performed

Enum"add""remove""replace""move""copy""test"
pathstringrequired

A JSON-Pointer

valueobject

The value to be used within the operations.

fromstring

A string containing a JSON Pointer value.

]
curl -i -X PATCH \
  -u <username>:<password> \
  'https://developers.retarus.com/_mock/fax/fax-config-api/outbound/profiles/{profile}' \
  -H 'Content-Type: application/json' \
  -d '[
    {
      "op": "add",
      "path": "string",
      "value": {},
      "from": "string"
    }
  ]'

Responses

Voilà

Bodyapplication/json
namestring
generalobject(GeneralProfileSettings)
faxobject(FaxSettings)
dialingobject(DialingSettings)
reportEmailobject(ReportEmailSettings)
coverSheetobject(CoverSheetSettings)
personalizationobject
Response
application/json
{
  "name": "string",
  "general": {
    "name": "string",
    "active": true,
    "timezone": "string"
  },
  "fax": {
    "csid": "string",
    "costCenter": "string",
    "header": "string",
    "blacklist": true,
    "paperSize": "string",
    "resolution": "string",
    "preferredMimeType": "string",
    "attachmentsOnly": true,
    "suppressBlankPages": true
  },
  "dialing": {
    "countryCode": "string",
    "areaCode": "string"
  },
  "reportEmail": {
    "language": "string",
    "reportFormat": "string",
    "sender": "string",
    "recipients": "string",
    "recipientsIfError": "string",
    "recipientsCc": "string",
    "attachTiff": true,
    "attachTiffOnlyIfError": true,
    "attachPdf": true,
    "sortByStatus": "string",
    "reportRecipients": "string",
    "errorReportRecipients": "string",
    "copyStatusReports": "string"
  },
  "coverSheet": {
    "fileName": "string",
    "dateFormat": "string",
    "timeFormat": "string"
  },
  "personalization": {
    "property1": "string",
    "property2": "string"
  }
}

Joint Outbound and Inbound

Retrieve joined Mail to Fax user and Fax to Mail number

Operations