Telnyx Porting Orders API

Endpoints related to porting orders management.

Documentation Provider Profile APIs.io OpenAPI GitHub

Telnyx Porting Orders API is one of 168 APIs that Telnyx publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Porting Orders. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 53 operations across 39 paths, and defines 47 schemas. It is described by OpenAPI 3.1.0, at version 2.0.0.

Requests are made against a single base URL, https://api.telnyx.com/v2.

53 operations 39 paths 47 schemas 6 DELETE26 GET3 PATCH18 POST

Metadata

The identity and technical contract details declared by the specification.

Specification

OpenAPI 3.1.0

API Version

2.0.0

Base URL

https://api.telnyx.com/v2

Authentication

HTTP Bearer, HTTP Bearer, OAuth 2.0, HTTP Bearer, HTTP Bearer, HTTP Bearer

Contact

support@telnyx.com

Resource Areas

Authentication & Security 6

Telnyx Porting Orders API declares 6 security schemes for authenticating requests. It accepts HTTP bearer tokens (bearerAuth). It accepts HTTP bearer tokens (branded-calling_bearerAuth). It supports OAuth 2.0 (oauthClientAuth) using the authorizationCode and clientCredentials flows, exposing 1 scope. It accepts HTTP bearer tokens (JWT) (outbound-voice-profiles_bearerAuth). It accepts HTTP bearer tokens (pronunciation-dicts_bearerAuth). It accepts HTTP bearer tokens (JWT) (stored-payment-transactions_bearerAuth). By default, every request must be authenticated.

branded-calling_bearerAuth — API key passed as a Bearer token in the Authorization header
oauthClientAuth — OAuth 2.0 authentication for Telnyx API and MCP integrations
pronunciation-dicts_bearerAuth — Telnyx API v2 key. Obtain from https://portal.telnyx.com

Paths & Operations 53

Across 39 paths, the API surfaces 53 operations — 6 DELETE, 26 GET, 3 PATCH, 18 POST. Each is listed below with its method, path, parameters, and response codes.

Porting Orders 53

Endpoints related to porting orders management.

GET

/porting/events

List all porting events

listPortingEvents 2 params → 200422500

GET

/porting/events/{id}

Show a porting event

showPortingEvent 1 param → 200404500

POST

/porting/events/{id}/republish

Republish a porting event

republishPortingEvent 1 param → 204404500

GET

/porting/loa_configurations

List LOA configurations

ListLoaConfigurations 1 param → 200422500

POST

/porting/loa_configurations

Create a LOA configuration

CreateLoaConfiguration body → 201422500

POST

/porting/loa_configurations/preview

Preview the LOA configuration parameters

PreviewLoaConfigurationParams body → 200422500

DELETE

/porting/loa_configurations/{id}

Delete a LOA configuration

DeleteLoaConfiguration 1 param → 204404500

GET

/porting/loa_configurations/{id}

Retrieve a LOA configuration

GetLoaConfiguration 1 param → 200404500

PATCH

/porting/loa_configurations/{id}

Update a LOA configuration

UpdateLoaConfiguration 1 param body → 200404422500

GET

/porting/loa_configurations/{id}/preview

Preview a LOA configuration

PreviewLoaConfiguration 1 param → 200404500

GET

/porting/reports

List porting related reports

ListPortingReports 2 params → 200422500

POST

/porting/reports

Create a porting related report

CreatePortingReport body → 201422500

GET

/porting/reports/{id}

Retrieve a report

GetPortingReport 1 param → 200404500

GET

/porting/uk_carriers

List available carriers in the UK

listPortingUKCarriers → 200422500

GET

/porting_orders

List all porting orders

ListPortingOrders 4 params → 200401422

POST

/porting_orders

Create a porting order

CreatePortingOrder body → 201401422

GET

/porting_orders/exception_types

List all exception types

ListExceptionTypes → 200401422

GET

/porting_orders/phone_number_configurations

List all phone number configurations

ListPhoneNumberConfigurations 3 params → 200401422

POST

/porting_orders/phone_number_configurations

Create a list of phone number configurations

CreatePhoneNumberConfigurations body → 201401422

DELETE

/porting_orders/{id}

Delete a porting order

DeletePortingOrder 1 param → 204401422

GET

/porting_orders/{id}

Retrieve a porting order

GetPortingOrder 2 params → 200401

PATCH

/porting_orders/{id}

Edit a porting order

UpdatePortingOrder 1 param body → 200401422

POST

/porting_orders/{id}/actions/activate

Activate every number in a porting order asynchronously.

ActivatePortingOrder 1 param → 202401422

POST

/porting_orders/{id}/actions/cancel

Cancel a porting order

CancelPortingOrder 1 param → 200401422

POST

/porting_orders/{id}/actions/confirm

Submit a porting order.

ConfirmPortingOrder 1 param → 200401422

POST

/porting_orders/{id}/actions/share

Share a porting order

SharePortingOrder 1 param body → 201401404

GET

/porting_orders/{id}/activation_jobs

List all porting activation jobs

ListPortingOrderActivationJobs 2 params → 200401422

GET

/porting_orders/{id}/activation_jobs/{activationJobId}

Retrieve a porting activation job

GetPortingOrdersActivationJob 2 params → 200401422

PATCH

/porting_orders/{id}/activation_jobs/{activationJobId}

Update a porting activation job

UpdatePortingOrdersActivationJob 2 params body → 200404422

GET

/porting_orders/{id}/additional_documents

List additional documents

ListAdditionalDocuments 4 params → 200401404

POST

/porting_orders/{id}/additional_documents

Create a list of additional documents

CreateAdditionalDocuments 1 param body → 201401404422

DELETE

/porting_orders/{id}/additional_documents/{additional_document_id}

Delete an additional document

DeleteAdditionalDocument 2 params → 204401404

GET

/porting_orders/{id}/allowed_foc_windows

List allowed FOC dates

ListAllowedFocWindows 1 param → 200401

GET

/porting_orders/{id}/comments

List all comments of a porting order

ListPortingOrderComments 2 params → 200401422

POST

/porting_orders/{id}/comments

Create a comment for a porting order

CreatePortingOrderComment 1 param body → 201401422

GET

/porting_orders/{id}/loa_template

Download a porting order loa template

GetPortingOrderLoaTemplate 2 params → 200401

GET

/porting_orders/{id}/requirements

List porting order requirements

ListPortingOrderRequirements 2 params → 200401422

GET

/porting_orders/{id}/sub_request

Retrieve the associated V1 subrequestid and portrequestid

GetPortingOrderSubRequest 1 param → 200401404

GET

/porting_orders/{id}/verification_codes

List verification codes

ListVerificationCodes 4 params → 200401404

POST

/porting_orders/{id}/verification_codes/send

Send the verification codes

SendPortingVerificationCodes 1 param body → 204401404422

POST

/porting_orders/{id}/verification_codes/verify

Verify the verification code for a list of phone numbers

VerifyPortingVerificationCodes 1 param body → 200401404422

GET

/porting_orders/{porting_order_id}/action_requirements

List action requirements for a porting order

listPortingActionRequirements 4 params → 200401404500

POST

/porting_orders/{porting_order_id}/action_requirements/{id}/initiate

Initiate an action requirement

initiatePortingActionRequirement 2 params body → 200400401404422500

GET

/porting_orders/{porting_order_id}/associated_phone_numbers

List all associated phone numbers

listPortingAssociatedPhoneNumbers 4 params → 200401404422

POST

/porting_orders/{porting_order_id}/associated_phone_numbers

Create an associated phone number

createPortingAssociatedPhoneNumber 1 param body → 201404422

DELETE

/porting_orders/{porting_order_id}/associated_phone_numbers/{id}

Delete an associated phone number

deletePortingAssociatedPhoneNumber 2 params → 200404422

GET

/porting_orders/{porting_order_id}/phone_number_blocks

List all phone number blocks

listPortingPhoneNumberBlocks 4 params → 200401404422

POST

/porting_orders/{porting_order_id}/phone_number_blocks

Create a phone number block

createPortingPhoneNumberBlock 1 param body → 201404422

DELETE

/porting_orders/{porting_order_id}/phone_number_blocks/{id}

Delete a phone number block

deletePortingPhoneNumberBlock 2 params → 200404422

GET

/porting_orders/{porting_order_id}/phone_number_extensions

List all phone number extensions

listPortingPhoneNumberExtensions 4 params → 200401404422

POST

/porting_orders/{porting_order_id}/phone_number_extensions

Create a phone number extension

createPortingPhoneNumberExtension 1 param body → 201404422

DELETE

/porting_orders/{porting_order_id}/phone_number_extensions/{id}

Delete a phone number extension

deletePortingPhoneNumberExtension 2 params → 200404422

GET

/porting_phone_numbers

List all porting phone numbers

ListPortingPhoneNumbers 2 params → 200401422

Schemas 47

The contract defines 47 schemas that model the data the API accepts and returns. The most detailed are PortingOrder (26 properties), UpdatePortingOrder (12 properties), PortingLOAConfiguration (10 properties), PortingActionRequirement (10 properties). Each schema is shown below with its type and property counts.

PortingEventDeletedPayload

object

6 properties

PortingOrdersExceptionType

object

2 properties

PortingOrderActivationStatus

string

Activation status

UpdatePortingOrderRequirement

object

Specifies a value for a requirement on the Porting Order.

2 properties 2 required

PortingEventMessagingChangedPayload

object

9 properties

PortingOrderUserFeedback

object

2 properties

PortingEventWithoutWebhook

object

9 properties

PortingOrdersAllowedFocWindow

object

3 properties

PortingPhoneNumberConfiguration

object

6 properties

PortingVerificationCode

object

7 properties

PaginationMeta

object

4 properties

PortingOrdersActivationJob

object

8 properties

PortabilityStatus

string

Specifies whether Telnyx is able to confirm portability this number in the United States & Canada. International phone numbers are provisional by default.

PortingPhoneNumberBlock

object

8 properties

PortingOrderPhoneNumberConfiguration

object

5 properties

PortingOrderEndUserLocation

object

6 properties

PortingOrderRequirementDetail

object

5 properties

PortingPhoneNumberExtension

object

7 properties

PortingEventNewCommentEvent

object

9 properties

PortingEvent

object

PortingLOAConfiguration

object

10 properties

PortingOrderEndUserAdmin

object

7 properties

PortingOrder

object

26 properties

PortingPhoneNumber

object

9 properties

PortingOrderSharingToken

object

8 properties

PortingOrdersComment

object

6 properties

PortingAdditionalDocument

object

9 properties

UpdatePortingOrder

object

12 properties

PortingAssociatedPhoneNumber

object

9 properties

PortingActionRequirement

object

10 properties

PortingReport

object

8 properties

CreatePortingOrder

object

3 properties 1 required

PortingOrderMessaging

object

Information about messaging porting process.

4 properties

PortingOrderType

string

A port can be either 'full' or 'partial'. When type is 'full' the other attributes should be omitted.

PortingEventSplitEvent

object

9 properties

PortingOrderMisc

object

3 properties

GetSubRequestByPortingOrder

object

2 properties

ExportPortingOrdersCSVReport

object

The parameters for generating a porting orders CSV report.

1 property 1 required

PortingOrderDocuments

object

Can be specified directly or via the requirementgroupid parameter.

2 properties

CreatePortingOrderComment

object

1 property

AUIdVerificationParams

object

Required information for initiating the action requirement for AU ID verification.

2 properties 2 required

PortingUKCarrier

object

7 properties

PortingOrderStatus

object

Porting order status

2 properties

PortingOrderEndUser

object

2 properties

PortingOrderActivationSettings

object

4 properties

PortingEventStatusChangedEvent

object

9 properties

PortingOrderRequirement

object

4 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

Other APIs Telnyx publishes across the network.

Telnyx Access Tokens API

AE Profile APIs.io

Telnyx Addresses API

AE Profile APIs.io

Telnyx Advanced Number Orders API

AE Profile APIs.io

Telnyx Assistants API

AE Profile APIs.io

Telnyx Audio API

AE Profile APIs.io

Telnyx Audit Logs API

AE Profile APIs.io

Telnyx Authentication Providers API

AE Profile APIs.io

Telnyx AutoRechargePreferences API

AE Profile APIs.io

Telnyx Billing API

AE Profile APIs.io

Telnyx Billing Groups API

AE Profile APIs.io

Telnyx Brands API

AE Profile APIs.io

Telnyx Bucket SSL Certificate API

AE Profile APIs.io

#Porting Orders

← Back to T APIs

Discovery

Learnings

Guidance

Toolbox

Alignment

API Evangelist LLC

Telnyx Porting Orders API

Metadata

Authentication & Security 6

Paths & Operations 53

Schemas 47

Specification

Source

API Details

Provider

Explore more

Discovery

Learnings

Guidance

Toolbox

Alignment

API Evangelist LLC

Telnyx Porting Orders API

Metadata

Authentication & Security 6

Paths & Operations 53

Schemas 47

Specification

Source

More from Telnyx 12

API Details

Provider

Explore more