Getting Started with Programmable Fax API

Requirements

Outbound faxes can be initiated without the purchase or porting of a number. There are two requirements:

  • A Programmable Fax Application configured to send webhook events related to Programmable Faxes.
  • For outbound faxing, an outbound profile associated with the Programmable Fax Application.

Configuration and Usage

Telnyx Programmable Fax is enabled using Connections. You can set up several connections to differentiate between use cases.

Outbound calls, initiated through the Dial and Transfer commands, are configured through an Outbound Profile that must be created and associated with the connection. The outbound profile allows you to initiate outbound traffic, and configure how that traffic is charged, managed and to which destinations it is permitted.

To issue Programmable Fax API commands, use our HTTPS API and authenticate using the API Key/Secret associated with your Mission Control account under API Keys.

To receive Programmable Fax API webhooks, set the webhook URL on your programmable fax connection to a publicly accessible endpoint on your server.

Glossary

TermDescription
Progammable Fax ApplicationUsed to configure the URL for which Telnyx will deliver webhooks for Programmable Fax API events
Outbound ProfileUsed to configure outbound traffic and billing for one or more phone numbers.
WebhookAn HTTP callback used to notify your server that you have received a message.
Guided Example

Follow our guided example to set up Programmable Fax API, send commands and receive webhooks, using the Telnyx API.

Was this page helpful?