All Collections
Telnyx Fax Configuration & Errors
Configuring Programmable Fax Applications
Configuring Programmable Fax Applications

Learn how to configure your settings in order to send and receive faxes via API.

Dillin avatar
Written by Dillin
Updated over a week ago

This article describes the in-depth setup of Programmable Fax / Applications on your Mission Control Portal in order to send and receive faxes via our API.

Video Walk-through for Programmable Fax

How to receive a fax

How to send a fax

Configuration of Programmable Fax

The Programmable Fax applications section is located on the left hand side of the portal.

Click on this button below and it will directly get you to the Programmable Fax Applications page.

Step By Step Guide to Programmable Fax

There are 4 sections which you can configure:

  1. App Info

  2. Custom Settings

  3. Inbound Settings

  4. Outbound Settings.

Fax Application Settings

App Name

Click on " Create your first application" and assign a name to this application to better manage the application. You also have access to the quickstart guide on the top right as well as the Application ID which will be required for API Interactions.

Fax API naming section.

Send a webhook to the URL

You will need to input a URL where all the webhook events will be sent. Also, you can setup a fail-over URL. If two consecutive delivery attempts to the primary URL fail, Telnyx will attempt delivery to this URL. NOTE: Must include a scheme such as 'https'.

Webhook and URL boxes.

Custom webhook timeout (seconds)

Specify time, in seconds, for Telnyx to wait for a response to a webhook request.


Webhook timeframe.

AnchorSite® Selection

"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.

AnchorSite Selection box.

RTCP Capture

Enable capture of RTCP reports to build QoS Reports (found under Debugging > SIP Call Flow Tool)

RTCP Capture selection buttons.

Custom Headers

Customer Header screenshot

Specify the timezone and customer name which will be included in your programmable outbound faxes on the recipients side.

Inbound Settings

You can configure your global application settings for inbound calls over here.

Inbound setting screenshot

Subdomain

Specify a subdomain that can be used to receive calls to a Connection, in the same way a phone number is used, from a SIP endpoint.

  • Example: the subdomain "example.sip.telnyx.com" can be called from any SIP endpoint by using the SIP URI "sip:@example.sip.telnyx.com" where the user part can be any alphanumeric value.

  • You only need to specify the subdomain in this field, there is no need to specify a Telnyx domain after it.

  • SIP subdomain receive settings: In this field, either you setup your receive SIP subdomain connection from anyone or only connections.

Inbound Channel Limit

You can limit the total number of inbound calls to phone numbers associated with this connection.

File Type

Specify whether you want Telnyx to deliver your inbound faxes as a PDF or TIFF file type.


Outbound Settings

Outbound Voice Profile

Assign your application to an outbound voice profile in order to make outbound calls.

Outbound Channel Limit

You can limit the total number of outbound calls to phone numbers associated with this connection.

Outbound settings containing Outbound Channel limit.

Notes on Programmable Fax

Don't forget to assign the fax application to your purchased numbers, in order to receive faxes to your application and for Telnyx to send the webhook events when faxes are received to our network.

Check out our fax API quick-start guide here and more detail on the API endpoints in our developer center.

Where can I find my Fax application or app id?

Once you've successfully created your Fax application, it is given an application id that can be seen within the application settings as seen in the below picture.

Programmable Fax API settings page.

Why do I need an Fax application or app id?

The Fax application id is used to reference or trigger your API calls programmatically. Don't forget to reference our developer documentation to see how you can control your faxes.

Where can I find the developer documentation for your programmable fax product?

You can see the specific endpoints here:

Did this answer your question?