Faxboxes

About Faxboxes

Fax boxes are used to receive, send and store incoming or outgoing faxes, allowing for configuration of individual fax virtual machines.

Schema

KeyDescriptionTypeDefaultRequiredSupport Level
attemptsThe number of attempts made, this will be set by the system and reset automatically on put/postinteger()0false
caller_idThe Caller-ID-Numberstring()falsesupported
caller_nameThe Caller-ID-Namestring()Kazoo Fax Printerfalsesupported
custom_smtp_email_addresscustom smtp addressstring()falsesupported
fax_headerThe name printed at the top of the faxstring()Kazoo Fax Printerfalsesupported
fax_identityThe number printed at the top of the faxstring()falsesupported
fax_timezoneThe timezone announcedstring()falsesupported
media.fax_optionIs T.38 Supported?boolean()falsebeta
mediaThe faxbox media parametersobject(){}falsebeta
nameA friendly name for the faxboxstring(1..128)truesupported
notifications.inbound.callback.methodThe http method to use when sending the results`string(‘post''put’)`false
notifications.inbound.callback.typeThe content-type to use when sending the results`string(‘json''www-url-form-encoded’)`false
notifications.inbound.callback.urlThe URL to call back with the resultsstring()false
notifications.inbound.callbackA URL to send results toobject()falsebeta
notifications.inbound.email.send_to.[]string()false
notifications.inbound.email.send_toA list or string of email recipient(s)`string()array(string())`false
notifications.inbound.emailInbound Email Notificationsobject()falsesupported
notifications.inbound.sms.send_to.[]string()false
notifications.inbound.sms.send_toA list or string of sms recipient(s)`string()array(string())`false
notifications.inbound.smsSMS notificationsobject()falsebeta
notifications.inboundInbound Status notificationsobject()falsesupported
notifications.outbound.callback.methodThe http method to use when sending the results`string(‘post''put’)`false
notifications.outbound.callback.typeThe content-type to use when sending the results`string(‘json''www-url-form-encoded’)`false
notifications.outbound.callback.urlThe URL to call back with the resultsstring()false
notifications.outbound.callbackA URL to send results toobject()falsebeta
notifications.outbound.email.send_to.[]string()false
notifications.outbound.email.send_toA list or string of email recipient(s)`string()array(string())`false
notifications.outbound.emailEmail notificationsobject()falsesupported
notifications.outbound.sms.send_to.[]string()false
notifications.outbound.sms.send_toA list or string of sms recipient(s)`string()array(string())`false
notifications.outbound.smsSMS notificationsobject()falsebeta
notifications.outboundOutbound Status notificationsobject()falsesupported
notificationsStatus notificationsobject()falsesupported
retriesThe number of times to retryinteger()1falsesupported
smtp_permission_list.[]string()falsesupported
smtp_permission_listsmtp permission list. accepts regular expressionsarray(string())[]falsesupported

Fetch

GET /v2/accounts/{ACCOUNT_ID}/faxboxes

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

Create

PUT /v2/accounts/{ACCOUNT_ID}/faxboxes

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

Fetch

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

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

Change

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

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

Patch

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

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

Remove

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

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

On this page