Skip to content

Inbound Fax

View and configure inbound fax numbers

Operations

Retrieve inbound number configurations

Request

Retrieve inbound number configurations.

Security
http-basic-auth
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?assigned=true&prefix=%2B4989&active=true&cost-center=ABC123&inherit=false'

Responses

Array of numbers and their settings

Bodyapplication/json
Array [
One of:
]
Response
[
  {
    "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"
  }
]