Faxbox API

Fax boxes are used to receive, send, and store incoming or outgoing faxes, allowing for configuration of individual fax virtual machines. Use the Faxbox API to manage faxboxes on your account.

API calls

Click on each call to view the endpoint, method, and request example.

Get faxboxes
Create a faxbox
Get a faxbox
Change a faxbox
Update a faxbox
Remove a faxbox

Parameters

The table shows the possible parameters available for faxbox requests.

Key	Description	Type	Options/Min/Max/Default
attempts	The number of attempts made, this will be set by the system and reset automatically on put/post.	integer	The default is `0`.
caller_id	The caller ID number.	string
caller_name	The caller ID name. For example `IP Telecom Fax Printer`.	string
custom_smtp_email_address	The custom_smtp_email_address is a configurable parameter on the faxbox. This is used when the owner of the faxbox wants to register a unique domain name for the smtp server MX record instead of generating an address from defaults.	string
fax_header	The name printed at the top of the fax.	string
fax_identity	The number printed at the top of the fax.	string
fax_timezone	The timezone used for fax operations.	string
media.fax_option	Indicates if T.38 is supported?	boolean	The default is `false`.
media	The faxbox media parameters.	object
name	Required. A friendly name for the faxbox.	string	(1..128)
notifications.inbound.callback.method	The Method and endpoint to use when sending the results.	string	`post`, `put`
notifications.inbound.callback.type	The content-type to use when sending the results.	string	`json`, `www-url-form-encoded`
notifications.inbound.callback.url	The URL to call back with the results.	string
notifications.inbound.callback	A URL to send results to.	object
notifications.inbound.email.send_to.[]	Specific inbound email recipient.	string
notifications.inbound.email.send_to	A list or string of email recipient(s).	string, array
notifications.inbound.email	A list of string of inbound email notifications.	object
notifications.inbound.sms.send_to.[]	Specific inbound SMS recipient.	string
notifications.inbound.sms.send_to	A list or string of SMS recipients.	string, array
notifications.inbound.sms	SMS notifications.	object
notifications.inbound	Inbound status notifications.	object
notifications.outbound.callback.method	The Method and endpoint to use when sending the results.	string	`post`,`put`
notifications.outbound.callback.type	The content-type to use when sending the results.	string	`json`,`www-url-form-encoded`
notifications.outbound.callback.url	The URL to call back with the results.	string
notifications.outbound.callback	A URL to send results to.	object
notifications.outbound.email.send_to.[]	Specific email recipient.	string
notifications.outbound.email.send_to	A list or string of email recipients.	string, array
notifications.outbound.email	Email notifications.	object
notifications.outbound.sms.send_to.[]	Specific SMS recipient.	string
notifications.outbound.sms.send_to	A list or string of SMS recipients.	string, array
notifications.outbound.sms	SMS notifications.	object
notifications.outbound	Outbound status notifications.	object
notifications	Status notifications.	object
retries	The number of times to retry.	integer	The default is `1`.
smtp_permission_list.[]	Specific SMTP permission.	string
smtp_permission_list	SMTP permission list, accepts regular expressions.	array, string

Get faxboxes

Returns a list of faxboxes.

Method and endpoint

GET /v2/accounts/{ACCOUNT_ID}/faxboxes

Request

curl -v -X GET \
    -H "X-Auth-Token: {AUTH_TOKEN}" \
    http://{SERVER}:8000/v2/accounts/{ACCOUNT_ID}/faxboxes

Create a faxbox

Creates a faxbox.

Method and endpoint

PUT /v2/accounts/{ACCOUNT_ID}/faxboxes

Request

curl -v -X PUT \
    -H "X-Auth-Token: {AUTH_TOKEN}" \
    http://{SERVER}:8000/v2/accounts/{ACCOUNT_ID}/faxboxes

Fetch a faxbox

Returns details of a specific faxbox, using the faxbox ID.

Method and endpoint

  GET /v2/accounts/{ACCOUNT_ID}/faxboxes/{FAXBOX_ID}

Request

curl -v -X GET \
    -H "X-Auth-Token: {AUTH_TOKEN}" \
    http://{SERVER}:8000/v2/accounts/{ACCOUNT_ID}/faxboxes/{FAXBOX_ID}

Change a faxbox

Changes details of a faxbox.

Method and endpoint

POST /v2/accounts/{ACCOUNT_ID}/faxboxes/{FAXBOX_ID}

Request

curl -v -X POST \
    -H "X-Auth-Token: {AUTH_TOKEN}" \
    http://{SERVER}:8000/v2/accounts/{ACCOUNT_ID}/faxboxes/{FAXBOX_ID}

Update a faxbox

Partially updates a faxbox.

Method and endpoint

  PATCH /v2/accounts/{ACCOUNT_ID}/faxboxes/{FAXBOX_ID}

Request

curl -v -X PATCH \
    -H "X-Auth-Token: {AUTH_TOKEN}" \
    http://{SERVER}:8000/v2/accounts/{ACCOUNT_ID}/faxboxes/{FAXBOX_ID}

Remove a faxbox

Deletes a faxbox from the account.

Method and endpoint

DELETE /v2/accounts/{ACCOUNT_ID}/faxboxes/{FAXBOX_ID}

Request

curl -v -X DELETE \
    -H "X-Auth-Token: {AUTH_TOKEN}" \
    http://{SERVER}:8000/v2/accounts/{ACCOUNT_ID}/faxboxes/{FAXBOX_ID}