<!-- Auto-generated from Telnyx OpenAPI specs. Do not edit. -->

Telnyx Porting In - curl

Installation

# curl is pre-installed on macOS, Linux, and Windows 10+

Setup

export TELNYX_API_KEY="YOUR_API_KEY_HERE"

All examples below use $TELNYXAPIKEY for authentication.

Error Handling

All API calls can fail with network errors, rate limits (429), validation errors (422), or authentication errors (401). Always handle errors in production code:

# Check HTTP status code in response
response=$(curl -s -w "\n%{http_code}" \
  -X POST "https://api.telnyx.com/v2/messages" \
  -H "Authorization: Bearer $TELNYX_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"to": "+13125550001", "from": "+13125550002", "text": "Hello"}')

http_code=$(echo "$response" | tail -1)
body=$(echo "$response" | sed '$d')

case $http_code in
  2*) echo "Success: $body" ;;
  422) echo "Validation error — check required fields and formats" ;;
  429) echo "Rate limited — retry after delay"; sleep 1 ;;
  401) echo "Authentication failed — check TELNYX_API_KEY" ;;
  *)   echo "Error $http_code: $body" ;;
esac

Common error codes: 401 invalid API key, 403 insufficient permissions, 404 resource not found, 422 validation error (check field formats), 429 rate limited (retry with exponential backoff).

Important Notes

• Phone numbers must be in E.164 format (e.g., +13125550001). Include the + prefix and country code. No spaces, dashes, or parentheses.
• Pagination: List endpoints return paginated results. Use page[number] and page[size] query parameters to navigate pages. Check meta.total_pages in the response.

Run a portability check

Runs a portability check, returning the results immediately.

POST /portability_checks

Optional: phone_numbers (array[string])

curl \
  -X POST \
  -H "Authorization: Bearer $TELNYX_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
      "phone_numbers": [
          "+18005550101"
      ]
  }' \
  "https://api.telnyx.com/v2/portability_checks"

Returns: fastportable (boolean), notportablereason (string), phonenumber (string), portable (boolean), record_type (string)

List all porting events

Returns a list of all porting events.

GET /porting/events

curl -H "Authorization: Bearer $TELNYX_API_KEY" "https://api.telnyx.com/v2/porting/events"

Returns: availablenotificationmethods (array[string]), eventtype (enum: portingorder.deleted), id (uuid), payload (object), payloadstatus (enum: created, completed), portingorder_id (uuid)

Show a porting event

Show a specific porting event.

GET /porting/events/{id}

curl -H "Authorization: Bearer $TELNYX_API_KEY" "https://api.telnyx.com/v2/porting/events/550e8400-e29b-41d4-a716-446655440000"

Returns: availablenotificationmethods (array[string]), eventtype (enum: portingorder.deleted), id (uuid), payload (object), payloadstatus (enum: created, completed), portingorder_id (uuid)

Republish a porting event

Republish a specific porting event.

POST /porting/events/{id}/republish

curl \
  -X POST \
  -H "Authorization: Bearer $TELNYX_API_KEY" \
  -H "Content-Type: application/json" \
  "https://api.telnyx.com/v2/porting/events/550e8400-e29b-41d4-a716-446655440000/republish"

List LOA configurations

List the LOA configurations.

GET /porting/loa_configurations

curl -H "Authorization: Bearer $TELNYX_API_KEY" "https://api.telnyx.com/v2/porting/loa_configurations"

Returns: address (object), companyname (string), contact (object), createdat (date-time), id (uuid), logo (object), name (string), organizationid (string), recordtype (string), updated_at (date-time)

Create a LOA configuration

Create a LOA configuration.

POST /porting/loa_configurations

curl \
  -X POST \
  -H "Authorization: Bearer $TELNYX_API_KEY" \
  -H "Content-Type: application/json" \
  "https://api.telnyx.com/v2/porting/loa_configurations"

Returns: address (object), companyname (string), contact (object), createdat (date-time), id (uuid), logo (object), name (string), organizationid (string), recordtype (string), updated_at (date-time)

Preview the LOA configuration parameters

Preview the LOA template that would be generated without need to create LOA configuration.

POST /porting/loa_configurations/preview

curl \
  -X POST \
  -H "Authorization: Bearer $TELNYX_API_KEY" \
  -H "Content-Type: application/json" \
  "https://api.telnyx.com/v2/porting/loa_configurations/preview"

Retrieve a LOA configuration

Retrieve a specific LOA configuration.

GET /porting/loa_configurations/{id}

curl -H "Authorization: Bearer $TELNYX_API_KEY" "https://api.telnyx.com/v2/porting/loa_configurations/550e8400-e29b-41d4-a716-446655440000"

Returns: address (object), companyname (string), contact (object), createdat (date-time), id (uuid), logo (object), name (string), organizationid (string), recordtype (string), updated_at (date-time)

Update a LOA configuration

Update a specific LOA configuration.

PATCH /porting/loa_configurations/{id}

curl \
  -X PATCH \
  -H "Authorization: Bearer $TELNYX_API_KEY" \
  -H "Content-Type: application/json" \
  "https://api.telnyx.com/v2/porting/loa_configurations/550e8400-e29b-41d4-a716-446655440000"

Returns: address (object), companyname (string), contact (object), createdat (date-time), id (uuid), logo (object), name (string), organizationid (string), recordtype (string), updated_at (date-time)

Delete a LOA configuration

Delete a specific LOA configuration.

DELETE /porting/loa_configurations/{id}

curl \
  -X DELETE \
  -H "Authorization: Bearer $TELNYX_API_KEY" \
  "https://api.telnyx.com/v2/porting/loa_configurations/550e8400-e29b-41d4-a716-446655440000"

Preview a LOA configuration

Preview a specific LOA configuration.

GET /porting/loa_configurations/{id}/preview

curl -H "Authorization: Bearer $TELNYX_API_KEY" "https://api.telnyx.com/v2/porting/loa_configurations/550e8400-e29b-41d4-a716-446655440000/preview"

List porting related reports

List the reports generated about porting operations.

GET /porting/reports

curl -H "Authorization: Bearer $TELNYX_API_KEY" "https://api.telnyx.com/v2/porting/reports"

Returns: createdat (date-time), documentid (uuid), id (uuid), params (object), recordtype (string), reporttype (enum: exportportingorderscsv), status (enum: pending, completed), updatedat (date-time)

Create a porting related report

Generate reports about porting operations.

POST /porting/reports

curl \
  -X POST \
  -H "Authorization: Bearer $TELNYX_API_KEY" \
  -H "Content-Type: application/json" \
  "https://api.telnyx.com/v2/porting/reports"

Returns: createdat (date-time), documentid (uuid), id (uuid), params (object), recordtype (string), reporttype (enum: exportportingorderscsv), status (enum: pending, completed), updatedat (date-time)

Retrieve a report

Retrieve a specific report generated.

GET /porting/reports/{id}

curl -H "Authorization: Bearer $TELNYX_API_KEY" "https://api.telnyx.com/v2/porting/reports/550e8400-e29b-41d4-a716-446655440000"

Returns: createdat (date-time), documentid (uuid), id (uuid), params (object), recordtype (string), reporttype (enum: exportportingorderscsv), status (enum: pending, completed), updatedat (date-time)

List available carriers in the UK

List available carriers in the UK.

GET /porting/uk_carriers

curl -H "Authorization: Bearer $TELNYX_API_KEY" "https://api.telnyx.com/v2/porting/uk_carriers"

Returns: alternativecupids (array[string]), createdat (date-time), cupid (string), id (uuid), name (string), recordtype (string), updatedat (date-time)

List all porting orders

Returns a list of your porting order.

GET /porting_orders

curl -H "Authorization: Bearer $TELNYX_API_KEY" "https://api.telnyx.com/v2/porting_orders"

Returns: activationsettings (object), additionalsteps (array[string]), createdat (date-time), customergroupreference (string | null), customerreference (string | null), description (string), documents (object), enduser (object), id (uuid), messaging (object), misc (object), oldserviceproviderocn (string), parentsupportkey (string | null), phonenumberconfiguration (object), phonenumbertype (enum: landline, local, mobile, national, sharedcost, tollfree), phonenumbers (array[object]), portingphonenumberscount (integer), recordtype (string), requirements (array[object]), requirementsmet (boolean), status (object), supportkey (string | null), updatedat (date-time), userfeedback (object), userid (uuid), webhook_url (uri)

Create a porting order

Creates a new porting order object.

POST /portingorders — Required: phonenumbers

Optional: customergroupreference (string), customer_reference (string | null)

curl \
  -X POST \
  -H "Authorization: Bearer $TELNYX_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "phone_numbers": [
    "+13035550000",
    "+13035550001",
    "+13035550002"
  ]
}' \
  "https://api.telnyx.com/v2/porting_orders"

Returns: activationsettings (object), additionalsteps (array[string]), createdat (date-time), customergroupreference (string | null), customerreference (string | null), description (string), documents (object), enduser (object), id (uuid), messaging (object), misc (object), oldserviceproviderocn (string), parentsupportkey (string | null), phonenumberconfiguration (object), phonenumbertype (enum: landline, local, mobile, national, sharedcost, tollfree), phonenumbers (array[object]), portingphonenumberscount (integer), recordtype (string), requirements (array[object]), requirementsmet (boolean), status (object), supportkey (string | null), updatedat (date-time), userfeedback (object), userid (uuid), webhook_url (uri)

List all exception types

Returns a list of all possible exception types for a porting order.

GET /portingorders/exceptiontypes

curl -H "Authorization: Bearer $TELNYX_API_KEY" "https://api.telnyx.com/v2/porting_orders/exception_types"

Returns: code (enum: ACCOUNTNUMBERMISMATCH, AUTHPERSONMISMATCH, BTNATNMISMATCH, ENTITYNAMEMISMATCH, FOCEXPIRED, FOCREJECTED, LOCATIONMISMATCH, LSRPENDING, MAINBTNPORTING, OSPIRRESPONSIVE, OTHER, PASSCODEPININVALID, PHONENUMBERHASSPECIALFEATURE, PHONENUMBERMISMATCH, PHONENUMBERNOTPORTABLE, PORTTYPEINCORRECT, PORTINGORDERSPLITREQUIRED, POSTALCODEMISMATCH, RATECENTERNOTPORTABLE, SVCONFLICT, SVUNKNOWN_FAILURE), description (string)

List all phone number configurations

Returns a list of phone number configurations paginated.

GET /portingorders/phonenumber_configurations

curl -H "Authorization: Bearer $TELNYX_API_KEY" "https://api.telnyx.com/v2/porting_orders/phone_number_configurations"

Returns: createdat (date-time), id (uuid), portingphonenumberid (uuid), recordtype (string), updatedat (date-time), userbundleid (uuid)

Create a list of phone number configurations

Creates a list of phone number configurations.

POST /portingorders/phonenumber_configurations

curl \
  -X POST \
  -H "Authorization: Bearer $TELNYX_API_KEY" \
  -H "Content-Type: application/json" \
  "https://api.telnyx.com/v2/porting_orders/phone_number_configurations"

Returns: createdat (date-time), id (uuid), portingphonenumberid (uuid), recordtype (string), updatedat (date-time), userbundleid (uuid)

Retrieve a porting order

Retrieves the details of an existing porting order.

GET /porting_orders/{id}

curl -H "Authorization: Bearer $TELNYX_API_KEY" "https://api.telnyx.com/v2/porting_orders/550e8400-e29b-41d4-a716-446655440000"

Returns: activationsettings (object), additionalsteps (array[string]), createdat (date-time), customergroupreference (string | null), customerreference (string | null), description (string), documents (object), enduser (object), id (uuid), messaging (object), misc (object), oldserviceproviderocn (string), parentsupportkey (string | null), phonenumberconfiguration (object), phonenumbertype (enum: landline, local, mobile, national, sharedcost, tollfree), phonenumbers (array[object]), portingphonenumberscount (integer), recordtype (string), requirements (array[object]), requirementsmet (boolean), status (object), supportkey (string | null), updatedat (date-time), userfeedback (object), userid (uuid), webhook_url (uri)

Edit a porting order

Edits the details of an existing porting order. Any or all of a porting orders attributes may be included in the resource object included in a PATCH request. If a request does not include all of the attributes for a resource, the system will interpret the missing attributes as if they were included with their current values.

PATCH /porting_orders/{id}

Optional: activationsettings (object), customergroupreference (string), customerreference (string), documents (object), enduser (object), messaging (object), misc (object), phonenumberconfiguration (object), requirementgroupid (uuid), requirements (array[object]), userfeedback (object), webhook_url (uri)

curl \
  -X PATCH \
  -H "Authorization: Bearer $TELNYX_API_KEY" \
  -H "Content-Type: application/json" \
  "https://api.telnyx.com/v2/porting_orders/550e8400-e29b-41d4-a716-446655440000"

Returns: activationsettings (object), additionalsteps (array[string]), createdat (date-time), customergroupreference (string | null), customerreference (string | null), description (string), documents (object), enduser (object), id (uuid), messaging (object), misc (object), oldserviceproviderocn (string), parentsupportkey (string | null), phonenumberconfiguration (object), phonenumbertype (enum: landline, local, mobile, national, sharedcost, tollfree), phonenumbers (array[object]), portingphonenumberscount (integer), recordtype (string), requirements (array[object]), requirementsmet (boolean), status (object), supportkey (string | null), updatedat (date-time), userfeedback (object), userid (uuid), webhook_url (uri)

Delete a porting order

Deletes an existing porting order. This operation is restrict to porting orders in draft state.

DELETE /porting_orders/{id}

curl \
  -X DELETE \
  -H "Authorization: Bearer $TELNYX_API_KEY" \
  "https://api.telnyx.com/v2/porting_orders/550e8400-e29b-41d4-a716-446655440000"

Activate every number in a porting order asynchronously.

Activate each number in a porting order asynchronously. This operation is limited to US FastPort orders only.

POST /porting_orders/{id}/actions/activate

curl \
  -X POST \
  -H "Authorization: Bearer $TELNYX_API_KEY" \
  -H "Content-Type: application/json" \
  "https://api.telnyx.com/v2/porting_orders/550e8400-e29b-41d4-a716-446655440000/actions/activate"

Returns: activateat (date-time), activationtype (enum: scheduled, on-demand), activationwindows (array[object]), createdat (date-time), id (uuid), recordtype (string), status (enum: created, in-process, completed, failed), updatedat (date-time)

Cancel a porting order

POST /porting_orders/{id}/actions/cancel

curl \
  -X POST \
  -H "Authorization: Bearer $TELNYX_API_KEY" \
  -H "Content-Type: application/json" \
  "https://api.telnyx.com/v2/porting_orders/550e8400-e29b-41d4-a716-446655440000/actions/cancel"

Returns: activationsettings (object), additionalsteps (array[string]), createdat (date-time), customergroupreference (string | null), customerreference (string | null), description (string), documents (object), enduser (object), id (uuid), messaging (object), misc (object), oldserviceproviderocn (string), parentsupportkey (string | null), phonenumberconfiguration (object), phonenumbertype (enum: landline, local, mobile, national, sharedcost, tollfree), phonenumbers (array[object]), portingphonenumberscount (integer), recordtype (string), requirements (array[object]), requirementsmet (boolean), status (object), supportkey (string | null), updatedat (date-time), userfeedback (object), userid (uuid), webhook_url (uri)

Submit a porting order.

Confirm and submit your porting order.

POST /porting_orders/{id}/actions/confirm

curl \
  -X POST \
  -H "Authorization: Bearer $TELNYX_API_KEY" \
  -H "Content-Type: application/json" \
  "https://api.telnyx.com/v2/porting_orders/550e8400-e29b-41d4-a716-446655440000/actions/confirm"

Returns: activationsettings (object), additionalsteps (array[string]), createdat (date-time), customergroupreference (string | null), customerreference (string | null), description (string), documents (object), enduser (object), id (uuid), messaging (object), misc (object), oldserviceproviderocn (string), parentsupportkey (string | null), phonenumberconfiguration (object), phonenumbertype (enum: landline, local, mobile, national, sharedcost, tollfree), phonenumbers (array[object]), portingphonenumberscount (integer), recordtype (string), requirements (array[object]), requirementsmet (boolean), status (object), supportkey (string | null), updatedat (date-time), userfeedback (object), userid (uuid), webhook_url (uri)

Share a porting order

Creates a sharing token for a porting order. The token can be used to share the porting order with non-Telnyx users.

POST /porting_orders/{id}/actions/share

curl \
  -X POST \
  -H "Authorization: Bearer $TELNYX_API_KEY" \
  -H "Content-Type: application/json" \
  "https://api.telnyx.com/v2/porting_orders/550e8400-e29b-41d4-a716-446655440000/actions/share"

Returns: createdat (date-time), expiresat (date-time), expiresinseconds (integer), id (uuid), permissions (array[string]), portingorderid (uuid), record_type (string), token (string)

List all porting activation jobs

Returns a list of your porting activation jobs.

GET /portingorders/{id}/activationjobs

curl -H "Authorization: Bearer $TELNYX_API_KEY" "https://api.telnyx.com/v2/porting_orders/550e8400-e29b-41d4-a716-446655440000/activation_jobs"

Returns: activateat (date-time), activationtype (enum: scheduled, on-demand), activationwindows (array[object]), createdat (date-time), id (uuid), recordtype (string), status (enum: created, in-process, completed, failed), updatedat (date-time)

Retrieve a porting activation job

Returns a porting activation job.

GET /portingorders/{id}/activationjobs/{activationJobId}

curl -H "Authorization: Bearer $TELNYX_API_KEY" "https://api.telnyx.com/v2/porting_orders/550e8400-e29b-41d4-a716-446655440000/activation_jobs/{activationJobId}"

Returns: activateat (date-time), activationtype (enum: scheduled, on-demand), activationwindows (array[object]), createdat (date-time), id (uuid), recordtype (string), status (enum: created, in-process, completed, failed), updatedat (date-time)

Update a porting activation job

Updates the activation time of a porting activation job.

PATCH /portingorders/{id}/activationjobs/{activationJobId}

curl \
  -X PATCH \
  -H "Authorization: Bearer $TELNYX_API_KEY" \
  -H "Content-Type: application/json" \
  "https://api.telnyx.com/v2/porting_orders/550e8400-e29b-41d4-a716-446655440000/activation_jobs/{activationJobId}"

Returns: activateat (date-time), activationtype (enum: scheduled, on-demand), activationwindows (array[object]), createdat (date-time), id (uuid), recordtype (string), status (enum: created, in-process, completed, failed), updatedat (date-time)

List additional documents

Returns a list of additional documents for a porting order.

GET /portingorders/{id}/additionaldocuments

curl -H "Authorization: Bearer $TELNYX_API_KEY" "https://api.telnyx.com/v2/porting_orders/550e8400-e29b-41d4-a716-446655440000/additional_documents"

Returns: contenttype (string), createdat (date-time), documentid (uuid), documenttype (enum: loa, invoice, csr, other), filename (string), id (uuid), portingorderid (uuid), recordtype (string), updatedat (date-time)

Create a list of additional documents

Creates a list of additional documents for a porting order.

POST /portingorders/{id}/additionaldocuments

curl \
  -X POST \
  -H "Authorization: Bearer $TELNYX_API_KEY" \
  -H "Content-Type: application/json" \
  "https://api.telnyx.com/v2/porting_orders/550e8400-e29b-41d4-a716-446655440000/additional_documents"

Returns: contenttype (string), createdat (date-time), documentid (uuid), documenttype (enum: loa, invoice, csr, other), filename (string), id (uuid), portingorderid (uuid), recordtype (string), updatedat (date-time)

Delete an additional document

Deletes an additional document for a porting order.

DELETE /portingorders/{id}/additionaldocuments/{additionaldocumentid}

curl \
  -X DELETE \
  -H "Authorization: Bearer $TELNYX_API_KEY" \
  "https://api.telnyx.com/v2/porting_orders/550e8400-e29b-41d4-a716-446655440000/additional_documents/{additional_document_id}"

List allowed FOC dates

Returns a list of allowed FOC dates for a porting order.

GET /portingorders/{id}/allowedfoc_windows

curl -H "Authorization: Bearer $TELNYX_API_KEY" "https://api.telnyx.com/v2/porting_orders/550e8400-e29b-41d4-a716-446655440000/allowed_foc_windows"

Returns: endedat (date-time), recordtype (string), started_at (date-time)

List all comments of a porting order

Returns a list of all comments of a porting order.

GET /porting_orders/{id}/comments

curl -H "Authorization: Bearer $TELNYX_API_KEY" "https://api.telnyx.com/v2/porting_orders/550e8400-e29b-41d4-a716-446655440000/comments"

Returns: body (string), createdat (date-time), id (uuid), portingorderid (uuid), recordtype (string), user_type (enum: admin, user, system)

Create a comment for a porting order

Creates a new comment for a porting order.

POST /porting_orders/{id}/comments

Optional: body (string)

curl \
  -X POST \
  -H "Authorization: Bearer $TELNYX_API_KEY" \
  -H "Content-Type: application/json" \
  "https://api.telnyx.com/v2/porting_orders/550e8400-e29b-41d4-a716-446655440000/comments"

Returns: body (string), createdat (date-time), id (uuid), portingorderid (uuid), recordtype (string), user_type (enum: admin, user, system)

Download a porting order loa template

GET /portingorders/{id}/loatemplate

curl -H "Authorization: Bearer $TELNYX_API_KEY" "https://api.telnyx.com/v2/porting_orders/550e8400-e29b-41d4-a716-446655440000/loa_template?loa_configuration_id=a36c2277-446b-4d11-b4ea-322e02a5c08d"

List porting order requirements

Returns a list of all requirements based on country/number type for this porting order.

GET /porting_orders/{id}/requirements

curl -H "Authorization: Bearer $TELNYX_API_KEY" "https://api.telnyx.com/v2/porting_orders/550e8400-e29b-41d4-a716-446655440000/requirements"

Returns: fieldtype (enum: document, textual), fieldvalue (string), recordtype (string), requirementstatus (string), requirement_type (object)

Retrieve the associated V1 subrequestid and portrequestid

GET /portingorders/{id}/subrequest

curl -H "Authorization: Bearer $TELNYX_API_KEY" "https://api.telnyx.com/v2/porting_orders/550e8400-e29b-41d4-a716-446655440000/sub_request"

Returns: portrequestid (string), subrequestid (string)

List verification codes

Returns a list of verification codes for a porting order.

GET /portingorders/{id}/verificationcodes

curl -H "Authorization: Bearer $TELNYX_API_KEY" "https://api.telnyx.com/v2/porting_orders/550e8400-e29b-41d4-a716-446655440000/verification_codes"

Returns: createdat (date-time), id (uuid), phonenumber (string), portingorderid (uuid), recordtype (string), updatedat (date-time), verified (boolean)

Send the verification codes

Send the verification code for all porting phone numbers.

POST /portingorders/{id}/verificationcodes/send

curl \
  -X POST \
  -H "Authorization: Bearer $TELNYX_API_KEY" \
  -H "Content-Type: application/json" \
  "https://api.telnyx.com/v2/porting_orders/550e8400-e29b-41d4-a716-446655440000/verification_codes/send"

Verify the verification code for a list of phone numbers

Verifies the verification code for a list of phone numbers.

POST /portingorders/{id}/verificationcodes/verify

curl \
  -X POST \
  -H "Authorization: Bearer $TELNYX_API_KEY" \
  -H "Content-Type: application/json" \
  "https://api.telnyx.com/v2/porting_orders/550e8400-e29b-41d4-a716-446655440000/verification_codes/verify"

Returns: createdat (date-time), id (uuid), phonenumber (string), portingorderid (uuid), recordtype (string), updatedat (date-time), verified (boolean)

List action requirements for a porting order

Returns a list of action requirements for a specific porting order.

GET /portingorders/{portingorderid}/actionrequirements

curl -H "Authorization: Bearer $TELNYX_API_KEY" "https://api.telnyx.com/v2/porting_orders/{porting_order_id}/action_requirements"

Returns: actiontype (string), actionurl (string | null), cancelreason (string | null), createdat (date-time), id (string), portingorderid (string), recordtype (enum: portingactionrequirement), requirementtypeid (string), status (enum: created, pending, completed, cancelled, failed), updatedat (date-time)

Initiate an action requirement

Initiates a specific action requirement for a porting order.

POST /portingorders/{portingorderid}/actionrequirements/{id}/initiate

curl \
  -X POST \
  -H "Authorization: Bearer $TELNYX_API_KEY" \
  -H "Content-Type: application/json" \
  "https://api.telnyx.com/v2/porting_orders/{porting_order_id}/action_requirements/550e8400-e29b-41d4-a716-446655440000/initiate"

Returns: actiontype (string), actionurl (string | null), cancelreason (string | null), createdat (date-time), id (string), portingorderid (string), recordtype (enum: portingactionrequirement), requirementtypeid (string), status (enum: created, pending, completed, cancelled, failed), updatedat (date-time)

List all associated phone numbers

Returns a list of all associated phone numbers for a porting order. Associated phone numbers are used for partial porting in GB to specify which phone numbers should be kept or disconnected.

GET /portingorders/{portingorderid}/associatedphone_numbers

curl -H "Authorization: Bearer $TELNYX_API_KEY" "https://api.telnyx.com/v2/porting_orders/{porting_order_id}/associated_phone_numbers"

Returns: action (enum: keep, disconnect), countrycode (string), createdat (date-time), id (uuid), phonenumberrange (object), phonenumbertype (enum: landline, local, mobile, national, sharedcost, tollfree), portingorderid (uuid), recordtype (string), updatedat (date-time)

Create an associated phone number

Creates a new associated phone number for a porting order. This is used for partial porting in GB to specify which phone numbers should be kept or disconnected.

POST /portingorders/{portingorderid}/associatedphone_numbers

curl \
  -X POST \
  -H "Authorization: Bearer $TELNYX_API_KEY" \
  -H "Content-Type: application/json" \
  "https://api.telnyx.com/v2/porting_orders/{porting_order_id}/associated_phone_numbers"

Returns: action (enum: keep, disconnect), countrycode (string), createdat (date-time), id (uuid), phonenumberrange (object), phonenumbertype (enum: landline, local, mobile, national, sharedcost, tollfree), portingorderid (uuid), recordtype (string), updatedat (date-time)

Delete an associated phone number

Deletes an associated phone number from a porting order.

DELETE /portingorders/{portingorderid}/associatedphone_numbers/{id}

curl \
  -X DELETE \
  -H "Authorization: Bearer $TELNYX_API_KEY" \
  "https://api.telnyx.com/v2/porting_orders/{porting_order_id}/associated_phone_numbers/550e8400-e29b-41d4-a716-446655440000"

Returns: action (enum: keep, disconnect), countrycode (string), createdat (date-time), id (uuid), phonenumberrange (object), phonenumbertype (enum: landline, local, mobile, national, sharedcost, tollfree), portingorderid (uuid), recordtype (string), updatedat (date-time)

List all phone number blocks

Returns a list of all phone number blocks of a porting order.

GET /portingorders/{portingorderid}/phonenumber_blocks

curl -H "Authorization: Bearer $TELNYX_API_KEY" "https://api.telnyx.com/v2/porting_orders/{porting_order_id}/phone_number_blocks"

Returns: activationranges (array[object]), countrycode (string), createdat (date-time), id (uuid), phonenumberrange (object), phonenumbertype (enum: landline, local, mobile, national, sharedcost, tollfree), recordtype (string), updated_at (date-time)

Create a phone number block

Creates a new phone number block.

POST /portingorders/{portingorderid}/phonenumber_blocks

curl \
  -X POST \
  -H "Authorization: Bearer $TELNYX_API_KEY" \
  -H "Content-Type: application/json" \
  "https://api.telnyx.com/v2/porting_orders/{porting_order_id}/phone_number_blocks"

Returns: activationranges (array[object]), countrycode (string), createdat (date-time), id (uuid), phonenumberrange (object), phonenumbertype (enum: landline, local, mobile, national, sharedcost, tollfree), recordtype (string), updated_at (date-time)

Delete a phone number block

Deletes a phone number block.

DELETE /portingorders/{portingorderid}/phonenumber_blocks/{id}

curl \
  -X DELETE \
  -H "Authorization: Bearer $TELNYX_API_KEY" \
  "https://api.telnyx.com/v2/porting_orders/{porting_order_id}/phone_number_blocks/550e8400-e29b-41d4-a716-446655440000"

Returns: activationranges (array[object]), countrycode (string), createdat (date-time), id (uuid), phonenumberrange (object), phonenumbertype (enum: landline, local, mobile, national, sharedcost, tollfree), recordtype (string), updated_at (date-time)

List all phone number extensions

Returns a list of all phone number extensions of a porting order.

GET /portingorders/{portingorderid}/phonenumber_extensions

curl -H "Authorization: Bearer $TELNYX_API_KEY" "https://api.telnyx.com/v2/porting_orders/{porting_order_id}/phone_number_extensions"

Returns: activationranges (array[object]), createdat (date-time), extensionrange (object), id (uuid), portingphonenumberid (uuid), recordtype (string), updatedat (date-time)

Create a phone number extension

Creates a new phone number extension.

POST /portingorders/{portingorderid}/phonenumber_extensions

curl \
  -X POST \
  -H "Authorization: Bearer $TELNYX_API_KEY" \
  -H "Content-Type: application/json" \
  "https://api.telnyx.com/v2/porting_orders/{porting_order_id}/phone_number_extensions"

Returns: activationranges (array[object]), createdat (date-time), extensionrange (object), id (uuid), portingphonenumberid (uuid), recordtype (string), updatedat (date-time)

Delete a phone number extension

Deletes a phone number extension.

DELETE /portingorders/{portingorderid}/phonenumber_extensions/{id}

curl \
  -X DELETE \
  -H "Authorization: Bearer $TELNYX_API_KEY" \
  "https://api.telnyx.com/v2/porting_orders/{porting_order_id}/phone_number_extensions/550e8400-e29b-41d4-a716-446655440000"

Returns: activationranges (array[object]), createdat (date-time), extensionrange (object), id (uuid), portingphonenumberid (uuid), recordtype (string), updatedat (date-time)

List all porting phone numbers

Returns a list of your porting phone numbers.

GET /portingphonenumbers

curl -H "Authorization: Bearer $TELNYX_API_KEY" "https://api.telnyx.com/v2/porting_phone_numbers"

Returns: activationstatus (enum: New, Pending, Conflict, Cancel Pending, Failed, Concurred, Activate RDY, Disconnect Pending, Concurrence Sent, Old, Sending, Active, Cancelled), phonenumber (string), phonenumbertype (enum: landline, local, mobile, national, sharedcost, tollfree), portabilitystatus (enum: pending, confirmed, provisional), portingorderid (uuid), portingorderstatus (enum: draft, in-process, submitted, exception, foc-date-confirmed, cancel-pending, ported, cancelled), recordtype (string), requirementsstatus (enum: requirement-info-pending, requirement-info-under-review, requirement-info-exception, approved), supportkey (string)