This is the API V2 documentation. To switch out of beta revert back to our API V1.

Open SidemenuDocs
Docs
Close Sidemenu

Quickstartquickstart

In this guide, you’ll learn how to get started with Telnyx Programmable Fax within the Telnyx Portal. Just follow these simple steps:

  1. 1Sign up for a Telnyx Account.
  2. 2Create a Call Control/Fax Application to configure how you connect your calls.
  3. 3Buy or port a Phone Number.
  4. 4Assign your number to the Programmable Fax Application.
  5. 5Create an Outbound Voice Profile to configure your outbound call settings and assign it to your Call Control/Fax Application.

Step 1: Sign Up for a Telnyx Mission Control Portal Accountstep-1--sign-up-for-a-telnyx-mission-control-portal-account

Head to telnyx.com/sign-upTelnyx Developers to sign up for your free Telnyx account. It’ll give you access to our Mission Control Portal where you can buy phone numbers, set up and manage Programmable Fax Applications, and more.

Step 2: Create a Programmable Fax Application in the Telnyx Portalstep-2--create-a-programmable-fax-application-in-the-telnyx-portal

  • Select "Programmable Fax"PORTAL in the left-hand navigation menu
  • Click "Add New App".
  • For testing purposes, you can set the webhook URL using an endpoint you create at https://hookbin.comTelnyx Developers.

Step 3: Buy a Phone Numberstep-3--buy-a-phone-number

You can search for, buy, and provision new numbers, or port existing numbers - all within the Numbers section of the Telnyx PortalPORTAL.

Simply click on "Numbers", then either "Search & Buy Numbers" or "Port Numbers" and follow the prompts.

You can also do this programmatically via our RESTful API. Check out our documentation for number searchingAPI and orderingAPI.

Step 4: Assign Your Phone Number to the Programmable Fax Applicationstep-4--assign-your-phone-number-to-the-programmable-fax-application

Once your number has been purchased or ported, assign it to the Programmable Fax Application that you created in step 2. You can do this via the My NumbersPORTAL section of the Portal.

Docs Images (1)

Step 5: Create an Outbound Voice Profile (not required for Inbound)step-5--create-an-outbound-voice-profile--not-required-for-inbound-

To initiate an outbound fax, you must create an Outbound Voice Profile and assign your Programmable Fax Application to it.

Select "Outbound Voice Profiles"PORTAL on the left-hand navigation menu, click "+Add New Profile" and set up your profile name. Add the Programmable Fax Application you just created above, the traffic type, the service plan, and your desired billing method.

You can also do this programmatically via our RESTful API. Check out our documentation for Outbound Voice ProfilesAPI.

That’s it. You're all set to start integrating Telnyx with your applications.

Where to next?where-to-next-

Head over to our tutorials to learn how to send a fax and receive a fax via API.

After you setup your development environment you can also dive deeper into sending commands and receiving webhooks.

Was this page helpful?was-this-page-helpful