Welcome to Telnyx! This quickstart is designed to get you started right away with creating your account and using the developer portal to do some common actions. You will:
- Sign up for a Telnyx Account
- Buy a Phone Number
- Create a SIP Connection to configure how you connect your calls
- Create an Outbound Voice Profile to configure your outbound calling settings
- Obtain your API keys to prepare you for developing with our APIs
Head to telnyx.com/sign-up 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 SIP Connections and more.
You can search for, buy, and provision new numbers, or port existing numbers - all within the Numbers section of the Telnyx Portal .
Simply click on "Numbers", then either "Search & Buy Numbers" or "Port Numbers" and follow the prompts.
Select SIP Connections on the left-hand navigation menu, click "+Add SIP Connection" and set up your Connection authentication mode and any expert settings you'd like. Now go to your number and add the Connection you just created.
You can also do this programmatically via our RESTful API. Check out our documentation for SIP Connections.
Select Outbound Voice Profiles on the left-hand navigation menu, click "+Add New Profile" and set up your profile name. Add the SIP 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 Voice Profiles.
When you are ready to start developing with our APIs, you will need your API Keys. Telnyx authenticates your API requests using your account’s API Key. If you do not include your key when making an API request, or use one that is incorrect or outdated, Telnyx returns an error.
Your API Keys are available in the Auth section of the Portal. Once you create an API Key you must save it for future use. You will only see your API Key once, on creation.
Note: Your API Keys carry many privileges, so be sure to keep them secure! Do not share your secret API Keys in publicly accessible areas such as GitHub, client-side code, and so forth.
YOUR_API_KEY in our code examples. Replace this text with your own API Key.
All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. Below is an example of a cURL authenticated request:
curl -X GET \ --header "Authorization: Bearer YOUR_API_KEY" \ --globoff "https://api.telnyx.com/v2/messaging_profiles?page[size]=10"
Note: After pasting the above content, Kindly check and remove any new line added
If you cannot see your API keys in the Portal, this means you do not have access to them. Only Telnyx account owners can access API Keys.
That’s it. You're all set to start integrating Telnyx with your applications! You can check out the Telnyx configuration guides here or learn how to setup your development environment to start building your own application.