Getting started with Telnyx Phone Number APIs
Introduction
Welcome to the Telnyx Phone Number APIs. Our API’s make it as easy as possible for you to search, order, and manage your phone numbers
Prerequisites
- Telnyx account: Ensure you have an active account. Sign up for one if you haven't already.
- API key: You'll need an API key for authentication. You can obtain one from the Telnyx Mission Control Portal.
- Telnyx SDK: While not mandatory, using one of our SDKs (available for cURL, Python, Node, .NET, and Ruby) can simplify the process. Instructions for setting up the SDK can be found in our Development environment setup guide.
Core Concepts
Support Articles: Check out our library of support articles here to learn about the ordering process, timelines, international requirements, and more!
Example
Let’s start by searching for a phone number to potentially purchase. Here's a simple cURL command that will search for available US local phone numbers:
curl --location --request GET 'https://api.telnyx.com/v2/available_phone_numbers?filter[country_code]=US&filter[phone_number_type]=local' \
--header 'Authorization: Bearer [REDACTED]'
Note: Replace [REDACTED] with your API token.
Next Steps
- Explore additional search parameters: Once you've made your first successful number search, explore our Quickstart Guide and Advanced Search Guide to see how you can further refine your number searches.
- API reference: For a complete list of API endpoints and their functionalities, check out our API reference.
Additional resources
- International Search and Ordering: You may be interested in purchasing a phone number outside the US. If you are, check out our guide on international number searching and our support center on international number requirements.
- Global Coverage: Check out which countries and phone numbers Telnyx supports on our global coverage page.
Feedback
Have questions or need help troubleshooting? Our support team is here to assist you. Join our Slack community to connect with other developers and the Telnyx team.