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 3 sections which you can configure: App Info, Inbound Settings & Outbound Settings.
Fax Application Settings
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.
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'.
Custom webhook timeout (seconds)
Specify time, in seconds, for Telnyx to wait for a response to a webhook request.
Email address for inbound faxes
Specifies an email address for sending inbound faxes.
"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.
Enable capture of RTCP reports to build QoS Reports (found under Debugging > SIP Call Flow Tool)
You can configure your global application settings for inbound calls over here.
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.
Enable Shaken Stir headers
By default, the radio button for no is checked. Select yes and save your settings if you want receive attestation information in the webhooks for incoming calls.
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.
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.
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.
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.