This is the current API V1 documentation. Explore our API V2 beta if you’d like to test new features.

Docs

Quickstartquickstart

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

  1. 1Sign up for a Telnyx Account.
  2. 2Create a Connection to configure how you connect your calls.
  3. 3Buy or port a Phone Number (required for inbound calls).
  4. 4Assign your number to the Connection.
  5. 5Create an Outbound Profile to configure your outbound call settings.

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 numbers, set up and manage Call Control Connections, and more.

Step 2: Create a Connectionstep-2--create-a-connection

  • Select "Connections"PORTAL on the left-hand navigation menu, click "+Add Connection".
  • Set the connection authentication type to call control.
  • For testing purposes, you can set the webhook URL using an endpoint you create at https://hookbin.comTelnyx Developers.

You can also do this programmatically via our RESTful API. Check out our documentation for ConnectionsAPI.

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 Number to the Connectionstep-4--assign-your-number-to-the-connection

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

Step 5: Create an Outbound Profilestep-5--create-an-outbound-profile

To use the Dial and Transfer commands, you must first create an Outbound Profile and assign your Call Control Connection to it.

Select "Outbound"PORTAL on the left-hand navigation menu, click "+Add Outbound Profile" and set up your profile name. Add the Connection 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 ProfilesAPI.

That’s it. You're all set to start integrating Telnyx with your applications. After you setup your development environment you can learn how to send commands and receive webhooks.