Skip to content

Retrieve a single inbound fax number

Request

Retrieve the configuration for the single specified inbound fax number.

Security
http-basic-auth
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/+443069990000?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
{
  "number": "0049/89/208076-5001",
  "profile": "FaxToEmail",
  "email": {
    "recipients": [ … ]
  }
}