This article is for API V1, please use the Developer Center for API V2 guides.

Using the API is an alternative way to configure and use your Mission Control account. This can be useful if you are interested in writing programs to explore and automate the use of our features.

In this guide we will give you an example of using our API docs GUI. Hopefully this will give you a base for writing programs to interact with our API.

Before we begin, we must tell the API our credentials so the API knows which portal account we will be using it with(and who we are).

For how to do this, please refer to our article on "Authentication and Tokens" after updating your credentials you can follow on from here.

checks a list of numbers to see if they're portable to Telnyx or not. You can request for an array of numbers/for a single number. To do this double click on the body sample on the right hand corner and it will copy over to the parameters section where you can edit and then click on the "TRY IT OUT" button. Please see screen prints below of both request and response respectively:

In this case the number in question is not portable, if it is portable you will get the response accordingly.

This returns all the port requests that have been made on your account both complete and incomplete. Under parameters you will be able to specify how you want the output/response to be generated. Please see the screen print below for sample request:

This returns a single port request that is not canceled or completed based on the id supplied. Under parameters, simply input the Port Request Id and select how you want the response to look like or leave the rest of the parameters as default. Please see screen print of both request and response below:

In this response the port request in question was canceled and hence the error message, otherwise the details will be returned.

This returns all sub requests for a given port request. To do this simply input the port request id which you got after making a port request in the parameters section and click the "TRY IT OUT" button. Please see screen print of a request and sample output to expect below:

This will return a sub request belonging to the given port request id. Simply input both port request id and sub request id and then click the "TRY IT OUT" button. Please see screen print of request and response below:

In this response we got "401 unauthorized" because this particular port request was canceled.

To get a successful response, you must ensure the port request is not canceled and also ensure the details are correct.

This returns all the comments made on a given port request. Simply input the port request id and click on the "TRY IT OUT" button. Please see screen print of request and sample output:

This allows you to post a comment on a port request by simply inputting the port request id and the comment, then click on the "TRY IT OUT" button. Please see screen print of request and sample output below:

This action will return a list of all documents needed for a particular port request by simply inputting the port request id and clicking the "TRY IT OUT" button. Please find screen print of request and a sample output below:

This action will return a supporting document needed for a particular port request by simply inputting the port request and supporting document id( this can be gotten from the "Get supporting documents for a port request") and clicking the "TRY IT OUT" button. Please find screen print of request and a sample output below:

​

This action will create a link to allow you download supporting documents. Expires in 1 hour. To do this simply input the port request and document id and then click on the 'TRY IT OUT" button. Please see sample parameters and response in the below print screen:

Learn About Pending Order Errors When Porting Numbers

US & Canada Only

"Pending Order", "Pending Order on TN" and "Port in Progress"

The losing carrier gives a pending order exception when there is a change currently being made to your account. Typically the losing carrier will not provide Telnyx with the exact nature of the change but it may encompass any of the following:

Please remember never to make any changes to an account immediately before or during the porting process.

To expedite your port request, you must contact the losing carrier directly and ask what change is being made and to cancel them if necessary. Telnyx is never able to cancel pending orders on your behalf.

Changes can take several weeks to clear out of the losing carrier's system. It is not uncommon for changes to get "stuck" in a pending state and remain there indefinitely. As long as changes are in progress, Telnyx cannot port the numbers.

Your end customer may have initiated a port-out through another reseller or carrier without your knowledge. It is best to contact the end customer and verify that your customer is not porting numbers to another carrier.

Congratulations! You are all set to successfully port a number into us