This endpoint returns a list of your Fax Applications inside the 'data' attribute of the response. You can adjust which applications are listed by using filters. Fax Applications are used to configure how you send and receive faxes using the Programmable Fax API with Telnyx.
Successful response
Array of objects (Fax Application) | |
object (PaginationMeta) |
Bad request
Unauthorized
Resource not found
const telnyx = require('telnyx')('YOUR_API_KEY'); try { const { data } = await telnyx.faxApplications.list({"page[number]":1,"page[size]":20}); } catch (error) { console.error(error); }
{- "data": [
- {
- "active": false,
- "anchorsite_override": "Amsterdam, Netherlands",
- "application_name": "fax-router",
- "created_at": "2018-02-02T22:25:27.521Z",
- "id": "1293384261075731499",
- "inbound": {
- "channel_limit": 10,
- "sip_subdomain": "example",
- "sip_subdomain_receive_settings": "only_my_connections"
}, - "outbound": {
- "channel_limit": 10,
- "outbound_voice_profile_id": "1293384261075731499"
}, - "record_type": "fax_application",
- "updated_at": "2018-02-02T22:25:27.521Z",
- "webhook_timeout_secs": 25
}
], - "meta": {
- "total_pages": 3,
- "total_results": 55,
- "page_number": 2,
- "page_size": 25
}
}
Creates a new Fax Application based on the parameters sent in the request. The application name and webhook URL are required. Once created, you can assign phone numbers to your application using the /phone_numbers
endpoint.
Parameters that can be set when creating a Fax Application
Successful response
Bad request
{- "active": false,
- "anchorsite_override": "Amsterdam, Netherlands",
- "application_name": "fax-router",
- "inbound": {
- "channel_limit": 10,
- "sip_subdomain": "example",
- "sip_subdomain_receive_settings": "only_my_connections"
}, - "outbound": {
- "channel_limit": 10,
- "outbound_voice_profile_id": "1293384261075731499"
}, - "webhook_timeout_secs": 25
}
{- "data": {
- "active": false,
- "anchorsite_override": "Amsterdam, Netherlands",
- "application_name": "fax-router",
- "created_at": "2018-02-02T22:25:27.521Z",
- "id": "1293384261075731499",
- "inbound": {
- "channel_limit": 10,
- "sip_subdomain": "example",
- "sip_subdomain_receive_settings": "only_my_connections"
}, - "outbound": {
- "channel_limit": 10,
- "outbound_voice_profile_id": "1293384261075731499"
}, - "record_type": "fax_application",
- "updated_at": "2018-02-02T22:25:27.521Z",
- "webhook_timeout_secs": 25
}
}
Permanently deletes a Fax Application. Deletion may be prevented if the application is in use by phone numbers.
Successful response
object (Fax Application) | |||||||||||||||||||||||||
|
Unauthorized
Resource not found
Bad request
const telnyx = require('telnyx')('YOUR_API_KEY'); const { data: faxApplications } = await telnyx.faxApplications.retrieve(id); await faxApplications.del();
{- "data": {
- "active": false,
- "anchorsite_override": "Amsterdam, Netherlands",
- "application_name": "fax-router",
- "created_at": "2018-02-02T22:25:27.521Z",
- "id": "1293384261075731499",
- "inbound": {
- "channel_limit": 10,
- "sip_subdomain": "example",
- "sip_subdomain_receive_settings": "only_my_connections"
}, - "outbound": {
- "channel_limit": 10,
- "outbound_voice_profile_id": "1293384261075731499"
}, - "record_type": "fax_application",
- "updated_at": "2018-02-02T22:25:27.521Z",
- "webhook_timeout_secs": 25
}
}
Return the details of an existing Fax Application inside the 'data' attribute of the response.
Successful response
object (Fax Application) | |||||||||||||||||||||||||
|
Unauthorized
Resource not found
Bad request
const telnyx = require('telnyx')('YOUR_API_KEY'); // In Node 10 const { data } = await telnyx.faxApplications.list({ "page[number]":1, "page[size]":20 }); // In other environments telnyx.faxApplications.list({ "page[number]":1, "page[size]":20 }).then(function(response){ const faxApplication = response.data; // asynchronously handled });
{- "data": {
- "active": false,
- "anchorsite_override": "Amsterdam, Netherlands",
- "application_name": "fax-router",
- "created_at": "2018-02-02T22:25:27.521Z",
- "id": "1293384261075731499",
- "inbound": {
- "channel_limit": 10,
- "sip_subdomain": "example",
- "sip_subdomain_receive_settings": "only_my_connections"
}, - "outbound": {
- "channel_limit": 10,
- "outbound_voice_profile_id": "1293384261075731499"
}, - "record_type": "fax_application",
- "updated_at": "2018-02-02T22:25:27.521Z",
- "webhook_timeout_secs": 25
}
}
Updates settings of an existing Fax Application based on the parameters of the request.
Parameters to be updated for the Fax Application
active | boolean (Connection Active) Default: true Specifies whether the connection can be used. |
anchorsite_override | string (Anchorsite Override) Default: "Latency"
|
application_name required | string (Application Name) A user-assigned name to help manage the application. |
fax_email_recipient | string <email> (Fax Email Recipient) Default: null Specifies an email address where faxes sent to this application will be forwarded to (as pdf or tiff attachments) |
object | |
object | |
webhook_event_failover_url | string <url> (Webhook Event Failover URL) Default: "" The failover URL where webhooks related to this connection will be sent if sending to the primary URL fails. Must include a scheme, such as 'https'. |
webhook_event_url required | string <url> (Webhook Event URL) The URL where webhooks related to this connection will be sent. Must include a scheme, such as 'https'. |
webhook_timeout_secs | integer (Webhook Timeout Secs) [ 0 .. 30 ] Default: null Specifies how many seconds to wait before timing out a webhook. |
Successful response
object (Fax Application) | |||||||||||||||||||||||||
|
Unauthorized
Resource not found
Bad request
{- "active": false,
- "anchorsite_override": "Amsterdam, Netherlands",
- "application_name": "fax-router",
- "inbound": {
- "channel_limit": 10,
- "sip_subdomain": "example",
- "sip_subdomain_receive_settings": "only_my_connections"
}, - "outbound": {
- "channel_limit": 10,
- "outbound_voice_profile_id": "1293384261075731499"
}, - "webhook_timeout_secs": 25
}
{- "data": {
- "active": false,
- "anchorsite_override": "Amsterdam, Netherlands",
- "application_name": "fax-router",
- "created_at": "2018-02-02T22:25:27.521Z",
- "id": "1293384261075731499",
- "inbound": {
- "channel_limit": 10,
- "sip_subdomain": "example",
- "sip_subdomain_receive_settings": "only_my_connections"
}, - "outbound": {
- "channel_limit": 10,
- "outbound_voice_profile_id": "1293384261075731499"
}, - "record_type": "fax_application",
- "updated_at": "2018-02-02T22:25:27.521Z",
- "webhook_timeout_secs": 25
}
}