Programmable Fax Applications API

Fax Applications operations API

List all Fax Applications

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.

SecuritybearerAuth
Request
query Parameters
page[number]
integer >= 1
Default: 1

The page number to load

page[size]
integer [ 1 .. 250 ]
Default: 20

The size of the page

filter[application_name][contains]
string
Default: "null"

If present, applications with application_name containing the given value will be returned. Matching is not case-sensitive. Requires at least three characters.

filter[outbound_voice_profile_id]
string <int64>

Identifies the associated outbound voice profile.

Example: filter[outbound_voice_profile_id]=1293384261075731499
sort
string
Default: "created_at"

Specifies the sort order for results. By default sorting direction is ascending. To have the results sorted in descending order add the - prefix.

That is:

  • connection_name: sorts the result by the connection_name field in ascending order.

  • -connection_name: sorts the result by the connection_name field in descending order.

If not given, results are sorted by created_at in descending order.
Enum: "created_at" "connection_name" "active"
Example: sort=connection_name
Responses
200

Successful response

Response Schema: application/json
Array of objects (Fax Application)
object (PaginationMeta)
400

Bad request

401

Unauthorized

404

Resource not found

get/fax_applications
Request samples 
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);
}
Response samples
application/json
{
  • "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_event_failover_url": "https://failover.example.com",
      • "webhook_event_url": "https://example.com",
      • "webhook_timeout_secs": 25
      }
    ],
  • "meta": {
    • "page_number": 2,
    • "page_size": 25,
    • "total_pages": 3,
    • "total_results": 55
    }
}

Creates a Fax Application

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.

SecuritybearerAuth
Request
Request Body schema: application/json
required

Parameters that can be set when creating a Fax Application

active
boolean (ConnectionActive)

Specifies whether the connection can be used.

anchorsite_override
string (AnchorsiteOverride)

Latency directs Telnyx to route media through the site with the lowest round-trip time to the user's connection. Telnyx calculates this time using ICMP ping messages. This can be disabled by specifying a site to handle all media.

Enum: "Latency" "Chicago, IL" "Ashburn, VA" "San Jose, CA" "Sydney, Australia" "Amsterdam, Netherlands" "London, UK" "Toronto, Canada" "Vancouver, Canada" "Frankfurt, Germany"
application_name
required
string (ApplicationName)

A user-assigned name to help manage the application.

object
object
webhook_event_failover_url
string <url> (WebhookEventFailoverUrl)

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> (WebhookEventUrl)

The URL where webhooks related to this connection will be sent. Must include a scheme, such as 'https'.

webhook_timeout_secs
integer (WebhookTimeoutSecs) [ 0 .. 30 ]

Specifies how many seconds to wait before timing out a webhook.

Responses
201

Successful response

Response Schema: application/json
object (FaxApplication)
active
boolean (ConnectionActive)

Specifies whether the connection can be used.

anchorsite_override
string (AnchorsiteOverride)

Latency directs Telnyx to route media through the site with the lowest round-trip time to the user's connection. Telnyx calculates this time using ICMP ping messages. This can be disabled by specifying a site to handle all media.

Enum: "Latency" "Chicago, IL" "Ashburn, VA" "San Jose, CA" "Sydney, Australia" "Amsterdam, Netherlands" "London, UK" "Toronto, Canada" "Vancouver, Canada" "Frankfurt, Germany"
application_name
string (ApplicationName)

A user-assigned name to help manage the application.

created_at
string

ISO 8601 formatted date indicating when the resource was created.

id
string <int64> (IntId)

Uniquely identifies the resource.

object
object
record_type
string

Identifies the type of the resource.

updated_at
string

ISO 8601 formatted date indicating when the resource was updated.

webhook_event_failover_url
string <url> (WebhookEventFailoverUrl)

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
string <url> (WebhookEventUrl)

The URL where webhooks related to this connection will be sent. Must include a scheme, such as 'https'.

webhook_timeout_secs
integer (WebhookTimeoutSecs) [ 0 .. 30 ]

Specifies how many seconds to wait before timing out a webhook.

422

Bad request

post/fax_applications
Request samples
application/json
{
  • "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_event_failover_url": "https://failover.example.com",
  • "webhook_event_url": "https://example.com",
  • "webhook_timeout_secs": 25
}
Response samples
application/json
{
  • "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_event_failover_url": "https://failover.example.com",
    • "webhook_event_url": "https://example.com",
    • "webhook_timeout_secs": 25
    }
}

Deletes a Fax Application

Permanently deletes a Fax Application. Deletion may be prevented if the application is in use by phone numbers.

SecuritybearerAuth
Request
path Parameters
id
required
string <uuid>

Identifies the resource.

Example: 6a09cdc3-8948-47f0-aa62-74ac943d6c58
Responses
200

Successful response

Response Schema: application/json
object (FaxApplication)
active
boolean (ConnectionActive)

Specifies whether the connection can be used.

anchorsite_override
string (AnchorsiteOverride)

Latency directs Telnyx to route media through the site with the lowest round-trip time to the user's connection. Telnyx calculates this time using ICMP ping messages. This can be disabled by specifying a site to handle all media.

Enum: "Latency" "Chicago, IL" "Ashburn, VA" "San Jose, CA" "Sydney, Australia" "Amsterdam, Netherlands" "London, UK" "Toronto, Canada" "Vancouver, Canada" "Frankfurt, Germany"
application_name
string (ApplicationName)

A user-assigned name to help manage the application.

created_at
string

ISO 8601 formatted date indicating when the resource was created.

id
string <int64> (IntId)

Uniquely identifies the resource.

object
object
record_type
string

Identifies the type of the resource.

updated_at
string

ISO 8601 formatted date indicating when the resource was updated.

webhook_event_failover_url
string <url> (WebhookEventFailoverUrl)

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
string <url> (WebhookEventUrl)

The URL where webhooks related to this connection will be sent. Must include a scheme, such as 'https'.

webhook_timeout_secs
integer (WebhookTimeoutSecs) [ 0 .. 30 ]

Specifies how many seconds to wait before timing out a webhook.

401

Unauthorized

404

Resource not found

422

Bad request

delete/fax_applications/{id}
Request samples 
const telnyx = require('telnyx')('YOUR_API_KEY');

const { data: faxApplications } = await telnyx.faxApplications.retrieve(id);
await faxApplications.del();
Response samples
application/json
{
  • "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_event_failover_url": "https://failover.example.com",
    • "webhook_event_url": "https://example.com",
    • "webhook_timeout_secs": 25
    }
}

Retrieve a Fax Application

Return the details of an existing Fax Application inside the 'data' attribute of the response.

SecuritybearerAuth
Request
path Parameters
id
required
string <uuid>

Identifies the resource.

Example: 6a09cdc3-8948-47f0-aa62-74ac943d6c58
Responses
200

Successful response

Response Schema: application/json
object (FaxApplication)
active
boolean (ConnectionActive)

Specifies whether the connection can be used.

anchorsite_override
string (AnchorsiteOverride)

Latency directs Telnyx to route media through the site with the lowest round-trip time to the user's connection. Telnyx calculates this time using ICMP ping messages. This can be disabled by specifying a site to handle all media.

Enum: "Latency" "Chicago, IL" "Ashburn, VA" "San Jose, CA" "Sydney, Australia" "Amsterdam, Netherlands" "London, UK" "Toronto, Canada" "Vancouver, Canada" "Frankfurt, Germany"
application_name
string (ApplicationName)

A user-assigned name to help manage the application.

created_at
string

ISO 8601 formatted date indicating when the resource was created.

id
string <int64> (IntId)

Uniquely identifies the resource.

object
object
record_type
string

Identifies the type of the resource.

updated_at
string

ISO 8601 formatted date indicating when the resource was updated.

webhook_event_failover_url
string <url> (WebhookEventFailoverUrl)

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
string <url> (WebhookEventUrl)

The URL where webhooks related to this connection will be sent. Must include a scheme, such as 'https'.

webhook_timeout_secs
integer (WebhookTimeoutSecs) [ 0 .. 30 ]

Specifies how many seconds to wait before timing out a webhook.

401

Unauthorized

404

Resource not found

422

Bad request

get/fax_applications/{id}
Request samples 
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
});
Response samples
application/json
{
  • "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_event_failover_url": "https://failover.example.com",
    • "webhook_event_url": "https://example.com",
    • "webhook_timeout_secs": 25
    }
}

Update a Fax Application

Updates settings of an existing Fax Application based on the parameters of the request.

SecuritybearerAuth
Request
path Parameters
id
required
string <uuid>

Identifies the resource.

Example: 6a09cdc3-8948-47f0-aa62-74ac943d6c58
Request Body schema: application/json
required

Parameters to be updated for the Fax Application

active
boolean (ConnectionActive)

Specifies whether the connection can be used.

anchorsite_override
string (AnchorsiteOverride)

Latency directs Telnyx to route media through the site with the lowest round-trip time to the user's connection. Telnyx calculates this time using ICMP ping messages. This can be disabled by specifying a site to handle all media.

Enum: "Latency" "Chicago, IL" "Ashburn, VA" "San Jose, CA" "Sydney, Australia" "Amsterdam, Netherlands" "London, UK" "Toronto, Canada" "Vancouver, Canada" "Frankfurt, Germany"
application_name
required
string (ApplicationName)

A user-assigned name to help manage the application.

fax_email_recipient
string <email> (FaxEmailRecipient)

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> (WebhookEventFailoverUrl)

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> (WebhookEventUrl)

The URL where webhooks related to this connection will be sent. Must include a scheme, such as 'https'.

webhook_timeout_secs
integer (WebhookTimeoutSecs) [ 0 .. 30 ]

Specifies how many seconds to wait before timing out a webhook.

Responses
200

Successful response

Response Schema: application/json
object (FaxApplication)
active
boolean (ConnectionActive)

Specifies whether the connection can be used.

anchorsite_override
string (AnchorsiteOverride)

Latency directs Telnyx to route media through the site with the lowest round-trip time to the user's connection. Telnyx calculates this time using ICMP ping messages. This can be disabled by specifying a site to handle all media.

Enum: "Latency" "Chicago, IL" "Ashburn, VA" "San Jose, CA" "Sydney, Australia" "Amsterdam, Netherlands" "London, UK" "Toronto, Canada" "Vancouver, Canada" "Frankfurt, Germany"
application_name
string (ApplicationName)

A user-assigned name to help manage the application.

created_at
string

ISO 8601 formatted date indicating when the resource was created.

id
string <int64> (IntId)

Uniquely identifies the resource.

object
object
record_type
string

Identifies the type of the resource.

updated_at
string

ISO 8601 formatted date indicating when the resource was updated.

webhook_event_failover_url
string <url> (WebhookEventFailoverUrl)

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
string <url> (WebhookEventUrl)

The URL where webhooks related to this connection will be sent. Must include a scheme, such as 'https'.

webhook_timeout_secs
integer (WebhookTimeoutSecs) [ 0 .. 30 ]

Specifies how many seconds to wait before timing out a webhook.

401

Unauthorized

404

Resource not found

422

Bad request

patch/fax_applications/{id}
Request samples
application/json
{
  • "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_event_failover_url": "https://failover.example.com",
  • "webhook_event_url": "https://example.com",
  • "webhook_timeout_secs": 25
}
Response samples
application/json
{
  • "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_event_failover_url": "https://failover.example.com",
    • "webhook_event_url": "https://example.com",
    • "webhook_timeout_secs": 25
    }
}