Skip to main content

Getting started with Telnyx Porting API

Introduction​

Welcome to the Telnyx Porting API. Our API’s make it as easy as possible for you to port your phone numbers in or out of our platform.

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 porting process, timelines, international requirements, and more!

Example​

Let’s start by checking the portability of one of your phone numbers. Here's a simple cURL command to check whether a phone number is portable to Telnyx:

curl --location --request POST 'https://api.telnyx.com/v2/portability_checks' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer [REDACTED]' \
--data-raw '{
   "phone_numbers": [
       "{{e.164_phone_number}}"
   ]
}'

Note: Replace [REDACTED] with your API token. And replace {{e.164_phone_number}} with the phone number you would like to check its portability. Please ensure the phone number is entered in E.164 format.

Next Steps​

  • Explore tutorials: Once you've checked the portability of your phone number, follow our Quickstart Guide to see how you can create and submit a port order.
  • API reference: For a complete list of API endpoints and their functionalities, check out our API reference.

Additional resources​

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.

On this page​