Telnyx

JavaScript

import Telnyx from 'telnyx';

const client = new Telnyx({
  apiKey: 'My API Key',
});

const portingOrders = await client.portingOrders.list();

console.log(portingOrders.data);

{
  "data": [
    {
      "id": "f1486bae-f067-460c-ad43-73a92848f902",
      "customer_reference": "Acct 123abc",
      "customer_group_reference": "Group-456",
      "created_at": "2021-03-19T10:07:15.527Z",
      "updated_at": "2021-03-19T10:07:15.527Z",
      "status": {
        "details": [
          {
            "code": "ENTITY_NAME_MISMATCH",
            "description": "Entity name does not match that on the CSR"
          }
        ],
        "value": "ported"
      },
      "support_key": "sr_123abc",
      "parent_support_key": "pr_123abc",
      "porting_phone_numbers_count": 1,
      "old_service_provider_ocn": "Unreal Communications",
      "documents": {
        "loa": "64ffb720-04c7-455b-92d6-20fcca92e935",
        "invoice": "ce74b771-d23d-4960-81ec-8741b3862146"
      },
      "misc": {
        "type": "full",
        "remaining_numbers_action": "disconnect",
        "new_billing_phone_number": "<string>"
      },
      "end_user": {
        "admin": {
          "entity_name": "Porter McPortersen",
          "auth_person_name": "Porter McPortersen II",
          "billing_phone_number": 13035551234,
          "account_number": "123abc",
          "tax_identifier": "1234abcd",
          "pin_passcode": 1234,
          "business_identifier": "abc123"
        },
        "location": {
          "street_address": "600 Congress Avenue",
          "extended_address": "14th Floor",
          "locality": "Austin",
          "administrative_area": "TX",
          "postal_code": "78701",
          "country_code": "US"
        }
      },
      "activation_settings": {
        "foc_datetime_requested": "2021-03-19T10:07:15.527Z",
        "foc_datetime_actual": "2021-03-19T10:07:15.527Z",
        "fast_port_eligible": true,
        "activation_status": "Active"
      },
      "phone_number_configuration": {
        "billing_group_id": "f1486bae-f067-460c-ad43-73a92848f902",
        "connection_id": "f1486bae-f067-460c-ad43-73a92848f902",
        "messaging_profile_id": "f1486bae-f067-460c-ad43-73a92848f901",
        "emergency_address_id": "f1486bae-f067-460c-ad43-73a92848f902",
        "tags": [
          "abc",
          "123"
        ]
      },
      "phone_number_type": "local",
      "description": "FP Telnyx",
      "requirements": [
        {
          "field_type": "document",
          "field_value": "9787fb5f-cbe5-4de4-b765-3303774ee9fe",
          "requirement_type_id": "59b0762a-b274-4f76-ac32-4d5cf0272e66",
          "record_type": "porting_requirement"
        }
      ],
      "requirements_met": false,
      "user_feedback": {
        "user_rating": 5,
        "user_comment": "I loved my experience porting numbers with Telnyx"
      },
      "user_id": "40d68ba2-0847-4df2-be9c-b0e0cb673e75",
      "webhook_url": "https://example.com/porting_webhooks",
      "record_type": "porting_order",
      "messaging": {
        "messaging_capable": true,
        "enable_messaging": true,
        "messaging_port_status": "pending",
        "messaging_port_completed": false
      },
      "additional_steps": [
        "associated_phone_numbers"
      ]
    }
  ],
  "meta": {
    "page_number": 2,
    "page_size": 25,
    "total_pages": 3,
    "total_results": 55
  }
}

GET

porting_orders

JavaScript

import Telnyx from 'telnyx';

const client = new Telnyx({
  apiKey: 'My API Key',
});

const portingOrders = await client.portingOrders.list();

console.log(portingOrders.data);

{
  "data": [
    {
      "id": "f1486bae-f067-460c-ad43-73a92848f902",
      "customer_reference": "Acct 123abc",
      "customer_group_reference": "Group-456",
      "created_at": "2021-03-19T10:07:15.527Z",
      "updated_at": "2021-03-19T10:07:15.527Z",
      "status": {
        "details": [
          {
            "code": "ENTITY_NAME_MISMATCH",
            "description": "Entity name does not match that on the CSR"
          }
        ],
        "value": "ported"
      },
      "support_key": "sr_123abc",
      "parent_support_key": "pr_123abc",
      "porting_phone_numbers_count": 1,
      "old_service_provider_ocn": "Unreal Communications",
      "documents": {
        "loa": "64ffb720-04c7-455b-92d6-20fcca92e935",
        "invoice": "ce74b771-d23d-4960-81ec-8741b3862146"
      },
      "misc": {
        "type": "full",
        "remaining_numbers_action": "disconnect",
        "new_billing_phone_number": "<string>"
      },
      "end_user": {
        "admin": {
          "entity_name": "Porter McPortersen",
          "auth_person_name": "Porter McPortersen II",
          "billing_phone_number": 13035551234,
          "account_number": "123abc",
          "tax_identifier": "1234abcd",
          "pin_passcode": 1234,
          "business_identifier": "abc123"
        },
        "location": {
          "street_address": "600 Congress Avenue",
          "extended_address": "14th Floor",
          "locality": "Austin",
          "administrative_area": "TX",
          "postal_code": "78701",
          "country_code": "US"
        }
      },
      "activation_settings": {
        "foc_datetime_requested": "2021-03-19T10:07:15.527Z",
        "foc_datetime_actual": "2021-03-19T10:07:15.527Z",
        "fast_port_eligible": true,
        "activation_status": "Active"
      },
      "phone_number_configuration": {
        "billing_group_id": "f1486bae-f067-460c-ad43-73a92848f902",
        "connection_id": "f1486bae-f067-460c-ad43-73a92848f902",
        "messaging_profile_id": "f1486bae-f067-460c-ad43-73a92848f901",
        "emergency_address_id": "f1486bae-f067-460c-ad43-73a92848f902",
        "tags": [
          "abc",
          "123"
        ]
      },
      "phone_number_type": "local",
      "description": "FP Telnyx",
      "requirements": [
        {
          "field_type": "document",
          "field_value": "9787fb5f-cbe5-4de4-b765-3303774ee9fe",
          "requirement_type_id": "59b0762a-b274-4f76-ac32-4d5cf0272e66",
          "record_type": "porting_requirement"
        }
      ],
      "requirements_met": false,
      "user_feedback": {
        "user_rating": 5,
        "user_comment": "I loved my experience porting numbers with Telnyx"
      },
      "user_id": "40d68ba2-0847-4df2-be9c-b0e0cb673e75",
      "webhook_url": "https://example.com/porting_webhooks",
      "record_type": "porting_order",
      "messaging": {
        "messaging_capable": true,
        "enable_messaging": true,
        "messaging_port_status": "pending",
        "messaging_port_completed": false
      },
      "additional_steps": [
        "associated_phone_numbers"
      ]
    }
  ],
  "meta": {
    "page_number": 2,
    "page_size": 25,
    "total_pages": 3,
    "total_results": 55
  }
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

page

object

Consolidated page parameter (deepObject style). Originally: page[size], page[number]

Show child attributes

page[number]

integer

default:1

The page number to load

Required range: x >= 1

page[size]

integer

default:20

The size of the page

Required range: 1 <= x <= 250

include_phone_numbers

boolean

default:true

Include the first 50 phone number objects in the results

filter

object

Consolidated filter parameter (deepObject style). Originally: filter[customer_reference], filter[customer_group_reference], filter[parent_support_key], filter[phone_numbers.country_code], filter[phone_numbers.carrier_name], filter[misc.type], filter[end_user.admin.entity_name], filter[end_user.admin.auth_person_name], filter[activation_settings.fast_port_eligible], filter[activation_settings.foc_datetime_requested][gt], filter[activation_settings.foc_datetime_requested][lt], filter[phone_numbers.phone_number][contains]

Show child attributes

filter[customer_reference]

string

Filter results by customer_reference

filter[customer_group_reference]

string

Filter results by customer_group_reference

filter[parent_support_key]

string

Filter results by parent_support_key

filter[phone_numbers]

object

Show child attributes

filter[phone_numbers][country_code]

string

Filter results by country ISO 3166-1 alpha-2 code

filter[phone_numbers][carrier_name]

string

Filter results by old service provider

filter[phone_numbers][phone_number]

object

Phone number pattern filtering operations

Show child attributes

filter[phone_numbers][phone_number][contains]

string

Filter results by full or partial phone_number

filter[misc]

object

Show child attributes

filter[misc][type]

enum<string>

Filter results by porting order type

Available options:

full,

partial

Example:

"full"

filter[end_user]

object

Show child attributes

filter[end_user][admin]

object

Show child attributes

filter[end_user][admin][entity_name]

string

Filter results by person or company name

filter[end_user][admin][auth_person_name]

string

Filter results by authorized person

filter[activation_settings]

object

Show child attributes

filter[activation_settings][fast_port_eligible]

boolean

Filter results by fast port eligible

filter[activation_settings][foc_datetime_requested]

object

FOC datetime range filtering operations

Show child attributes

filter[activation_settings][foc_datetime_requested][gt]

string

Filter results by foc date later than this value

Example:

"2021-03-25T10:00:00.000Z"

filter[activation_settings][foc_datetime_requested][lt]

string

Filter results by foc date earlier than this value

Example:

"2021-03-25T10:00:00.000Z"

sort

object

Consolidated sort parameter (deepObject style). Originally: sort[value]

Show child attributes

sort[value]

enum<string>

Specifies the sort order for results. If not given, results are sorted by created_at in descending order.

Available options:

created_at,

-created_at,

activation_settings.foc_datetime_requested,

-activation_settings.foc_datetime_requested

Example:

"created_at"

Response

Successful response

data

object[]

Show child attributes

data.id

string<uuid>

Uniquely identifies this porting order

Example:

"f1486bae-f067-460c-ad43-73a92848f902"

data.customer_reference

string

A customer-specified reference number for customer bookkeeping purposes

Example:

"Acct 123abc"

data.customer_group_reference

string

A customer-specified group reference for customer bookkeeping purposes

Example:

"Group-456"

data.created_at

string<date-time>

ISO 8601 formatted date indicating when the resource was created.

Example:

"2021-03-19T10:07:15.527Z"

data.updated_at

string<date-time>

ISO 8601 formatted date indicating when the resource was created.

Example:

"2021-03-19T10:07:15.527Z"

data.status

object

Porting order status

Show child attributes

data.status.details

object[]

A list of 0 or more details about this porting order's status

Show child attributes

data.status.details.code

enum<string>

Identifier of an exception type

Available options:

ACCOUNT_NUMBER_MISMATCH,

AUTH_PERSON_MISMATCH,

BTN_ATN_MISMATCH,

ENTITY_NAME_MISMATCH,

FOC_EXPIRED,

FOC_REJECTED,

LOCATION_MISMATCH,

LSR_PENDING,

MAIN_BTN_PORTING,

OSP_IRRESPONSIVE,

OTHER,

PASSCODE_PIN_INVALID,

PHONE_NUMBER_HAS_SPECIAL_FEATURE,

PHONE_NUMBER_MISMATCH,

PHONE_NUMBER_NOT_PORTABLE,

PORT_TYPE_INCORRECT,

PORTING_ORDER_SPLIT_REQUIRED,

POSTAL_CODE_MISMATCH,

RATE_CENTER_NOT_PORTABLE,

SV_CONFLICT,

SV_UNKNOWN_FAILURE

Example:

"ENTITY_NAME_MISMATCH"

data.status.details.description

string

Description of an exception type

Example:

"Entity name does not match that on the CSR"

data.status.value

enum<string>

The current status of the porting order

Available options:

draft,

in-process,

submitted,

exception,

foc-date-confirmed,

ported,

cancelled,

cancel-pending

Example:

"ported"

data.support_key

string

A key to reference this porting order when contacting Telnyx customer support. This information is not available in draft porting orders.

Example:

"sr_123abc"

data.parent_support_key

string

A key to reference for the porting order group when contacting Telnyx customer support. This information is not available for porting orders in draft state

Example:

"pr_123abc"

data.porting_phone_numbers_count

integer

Count of phone numbers associated with this porting order

Example:

1

data.old_service_provider_ocn

string

Identifies the old service provider

Example:

"Unreal Communications"

data.documents

object

Can be specified directly or via the requirement_group_id parameter.

Show child attributes

data.documents.loa

string<uuid>

Returned ID of the submitted LOA via the Documents endpoint

Example:

"64ffb720-04c7-455b-92d6-20fcca92e935"

data.documents.invoice

string<uuid>

Returned ID of the submitted Invoice via the Documents endpoint

Example:

"ce74b771-d23d-4960-81ec-8741b3862146"

data.misc

object

Show child attributes

data.misc.type

enum<string>

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

Available options:

full,

partial

Example:

"full"

data.misc.remaining_numbers_action

enum<string>

Remaining numbers can be either kept with their current service provider or disconnected. 'new_billing_telephone_number' is required when 'remaining_numbers_action' is 'keep'.

Available options:

keep,

disconnect

Example:

"disconnect"

data.misc.new_billing_phone_number

string

New billing phone number for the remaining numbers. Used in case the current billing phone number is being ported to Telnyx. This will be set on your account with your current service provider and should be one of the numbers remaining on that account.

data.end_user

object

Show child attributes

data.end_user.admin

object

Show child attributes

data.end_user.admin.entity_name

string

Person Name or Company name requesting the port

Example:

"Porter McPortersen"

data.end_user.admin.auth_person_name

string

Name of person authorizing the porting order

Example:

"Porter McPortersen II"

data.end_user.admin.billing_phone_number

string

Billing phone number associated with these phone numbers

Example:

13035551234

data.end_user.admin.account_number

string

The authorized person's account number with the current service provider

Example:

"123abc"

data.end_user.admin.tax_identifier

string

European tax identification number. Applicable only in the European Union

Example:

"1234abcd"

data.end_user.admin.pin_passcode

string

PIN/passcode possibly required by the old service provider for extra verification

Example:

1234

data.end_user.admin.business_identifier

string

European business identification number. Applicable only in the European Union

Example:

"abc123"

data.end_user.location

object

Show child attributes

data.end_user.location.street_address

string

First line of billing address

Example:

"600 Congress Avenue"

data.end_user.location.extended_address

string

Second line of billing address

Example:

"14th Floor"

data.end_user.location.locality

string

City or municipality of billing address

Example:

"Austin"

data.end_user.location.administrative_area

string

State, province, or similar of billing address

Example:

"TX"

data.end_user.location.postal_code

string

Postal Code of billing address

Example:

"78701"

data.end_user.location.country_code

string

ISO3166-1 alpha-2 country code of billing address

Example:

"US"

data.activation_settings

object

Show child attributes

data.activation_settings.foc_datetime_requested

string<date-time>

ISO 8601 formatted Date/Time requested for the FOC date

Example:

"2021-03-19T10:07:15.527Z"

data.activation_settings.foc_datetime_actual

string<date-time>

ISO 8601 formatted Date/Time of the FOC date

Example:

"2021-03-19T10:07:15.527Z"

data.activation_settings.fast_port_eligible

boolean

Indicates whether this porting order is eligible for FastPort

Example:

true

data.activation_settings.activation_status

enum<string>

Activation status

Available options:

New,

Pending,

Conflict,

Cancel Pending,

Failed,

Concurred,

Activate RDY,

Disconnect Pending,

Concurrence Sent,

Old,

Sending,

Active,

Cancelled

Example:

"Active"

data.phone_number_configuration

object

Show child attributes

data.phone_number_configuration.billing_group_id

string

identifies the billing group to set on the numbers when ported

Example:

"f1486bae-f067-460c-ad43-73a92848f902"

data.phone_number_configuration.connection_id

string

identifies the connection to set on the numbers when ported

Example:

"f1486bae-f067-460c-ad43-73a92848f902"

data.phone_number_configuration.messaging_profile_id

string

identifies the messaging profile to set on the numbers when ported

Example:

"f1486bae-f067-460c-ad43-73a92848f901"

data.phone_number_configuration.emergency_address_id

string

identifies the emergency address to set on the numbers when ported

Example:

"f1486bae-f067-460c-ad43-73a92848f902"

data.phone_number_configuration.tags

string[]

Tag to set on the numbers when ported

Example:

["abc", "123"]

data.phone_number_type

enum<string>

The type of the phone number

Available options:

landline,

local,

mobile,

national,

shared_cost,

toll_free

Example:

"local"

data.description

string

A description of the porting order

Example:

"FP Telnyx"

data.requirements

object[]

List of documentation requirements for porting numbers. Can be set directly or via the requirement_group_id parameter.

Show child attributes

data.requirements.field_type

enum<string>

Type of value expected on field_value field

Available options:

document

Example:

"document"

data.requirements.field_value

string

identifies the document that satisfies this requirement

Example:

"9787fb5f-cbe5-4de4-b765-3303774ee9fe"

data.requirements.requirement_type_id

string

Identifies the requirement type that meets this requirement

Example:

"59b0762a-b274-4f76-ac32-4d5cf0272e66"

data.requirements.record_type

string

Identifies the type of the resource.

Example:

"porting_requirement"

data.requirements_met

boolean

Is true when the required documentation is met

Example:

false

data.user_feedback

object

Show child attributes

data.user_feedback.user_rating

integer

Once an order is ported, cancellation is requested or the request is cancelled, the user may rate their experience

Example:

5

data.user_feedback.user_comment

string

A comment related to the customer rating.

Example:

"I loved my experience porting numbers with Telnyx"

data.user_id

string<uuid>

Identifies the user (or organization) who requested the porting order

Example:

"40d68ba2-0847-4df2-be9c-b0e0cb673e75"

data.webhook_url

string<uri>

Example:

"https://example.com/porting_webhooks"

data.record_type

string

Identifies the type of the resource.

Example:

"porting_order"

data.messaging

object

Information about messaging porting process.

Show child attributes

data.messaging.messaging_capable

boolean

Indicates whether the porting order can also port messaging capabilities.

Example:

true

data.messaging.enable_messaging

boolean

Indicates whether Telnyx will port messaging capabilities from the losing carrier. If false, any messaging capabilities will stay with their current provider.

Example:

true

data.messaging.messaging_port_status

enum<string>

The current status of the messaging porting.

Available options:

not_applicable,

pending,

activating,

exception,

canceled,

partial_port_complete,

ported

Example:

"pending"

data.messaging.messaging_port_completed

boolean

Indicates whether the messaging porting has been completed.

Example:

false

data.additional_steps

enum<string>[]

For specific porting orders, we may require additional steps to be taken before submitting the porting order.

Available options:

associated_phone_numbers,

phone_number_verification_codes

OAuth Discovery

IP Addresses

IP Ranges

SIM Cards

Addresses

Advanced Number Orders

Assistants

Audio

Chat

Clusters

Conversations

Embeddings

Fine Tuning

Integrations

MCP Servers

Audit Logs

Authentication Providers

Phone Number Search

Billing

Billing Groups

Brands

SIM Card Actions

Bundles

User Bundles

Call Control Applications

Debugging

Call Commands

Call Information

Campaign

Voice Channels

API Reference

Phone Number Orders

Conference Commands

Connections

Country Coverage

Credential Connections

Call Recordings

Customer Service Record

Detail Records

Dialogflow Integration

Documents

Dynamic Emergency Addresses

Dynamic Emergency Endpoints

Enum

External Connections

Programmable Fax Applications

Programmable Fax Commands

FQDN Connections

FQDNs

Global IPs

Inexplicit Number Orders

Integration Secrets

Inventory Level

IP Connections

IPs

Reports

MDR Detailed Reports

Speech to Text Batch Reports

CDR Reports

MDR Usage Reports

Telco Data Usage Reports

Speech to text Usage Reports

CDR Usage Reports

Managed Accounts

Media Storage API

Messages

RCS messaging

Messaging Hosted Number

Number Configurations

Advanced OptIn/OptOut

Messaging Profiles

Messaging Tollfree Verification

Messaging URL Domains

Mobile Network Operators

Push Credentials

Coverage

Networks

Notifications

Phone Number Block Orders

Number Lookup