Telnyx

JavaScript

import Telnyx from 'telnyx';

const client = new Telnyx({
  apiKey: process.env['TELNYX_API_KEY'], // This is the default and can be omitted
});

// Automatically fetches more pages as needed.
for await (const portingPhoneNumberListResponse of client.portingPhoneNumbers.list()) {
  console.log(portingPhoneNumberListResponse.porting_order_id);
}

{
  "data": [
    {
      "porting_order_status": "in-process",
      "phone_number_type": "local",
      "phone_number": "13035550987",
      "porting_order_id": "f1486bae-f067-460c-ad43-73a92848f902",
      "support_key": "sr_a12345",
      "activation_status": "Active",
      "portability_status": "confirmed",
      "requirements_status": "approved",
      "record_type": "porting_phone_number"
    }
  ],
  "meta": {
    "total_pages": 3,
    "page_number": 2,
    "total_results": 55,
    "page_size": 25
  }
}

GET

porting

phone_numbers

JavaScript

import Telnyx from 'telnyx';

const client = new Telnyx({
  apiKey: process.env['TELNYX_API_KEY'], // This is the default and can be omitted
});

// Automatically fetches more pages as needed.
for await (const portingPhoneNumberListResponse of client.portingPhoneNumbers.list()) {
  console.log(portingPhoneNumberListResponse.porting_order_id);
}

{
  "data": [
    {
      "porting_order_status": "in-process",
      "phone_number_type": "local",
      "phone_number": "13035550987",
      "porting_order_id": "f1486bae-f067-460c-ad43-73a92848f902",
      "support_key": "sr_a12345",
      "activation_status": "Active",
      "portability_status": "confirmed",
      "requirements_status": "approved",
      "record_type": "porting_phone_number"
    }
  ],
  "meta": {
    "total_pages": 3,
    "page_number": 2,
    "total_results": 55,
    "page_size": 25
  }
}

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[size]

integer

default:20

The size of the page

Required range: 1 <= x <= 250

page[number]

integer

default:1

The page number to load

Required range: x >= 1

filter

object

Consolidated filter parameter (deepObject style). Originally: filter[porting_order_status]

Show child attributes

filter[porting_order_status]

enum<string>

Filter results by porting order status

Available options:

draft,

in-process,

submitted,

exception,

foc-date-confirmed,

cancel-pending,

ported,

cancelled

Example:

"in-process"

Response

Successful response

data

object[]

Show child attributes

data.porting_order_status

enum<string>

The current status of the porting order

Available options:

draft,

in-process,

submitted,

exception,

foc-date-confirmed,

cancel-pending,

ported,

cancelled

Example:

"in-process"

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.phone_number

string

E164 formatted phone number

Example:

"13035550987"

data.porting_order_id

string<uuid>

Identifies the associated port request

Example:

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

data.support_key

string

A key to reference this porting order when contacting Telnyx customer support

Example:

"sr_a12345"

data.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.portability_status

enum<string>

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

Available options:

pending,

confirmed,

provisional

Example:

"confirmed"

data.requirements_status

enum<string>

The current status of the requirements in a INTL porting order

Available options:

requirement-info-pending,

requirement-info-under-review,

requirement-info-exception,

approved

Example:

"approved"

data.record_type

string

Identifies the type of the resource.

Example:

"porting_phone_number"

Coverage

Regulatory

Searching

Ordering

Port In

Port Out

Management & Configurations

All Others

List all porting phone numbers

Authorizations

Query Parameters

Response