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 portingAssociatedPhoneNumber of client.portingOrders.associatedPhoneNumbers.list(
  '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
)) {
  console.log(portingAssociatedPhoneNumber.id);
}

{
  "data": [
    {
      "id": "f24151b6-3389-41d3-8747-7dd8c681e5e2",
      "porting_order_id": "a24151b6-3389-41d3-8747-7dd8c681e5e2",
      "country_code": "GB",
      "phone_number_type": "local",
      "phone_number_range": {
        "start_at": "+441234567890",
        "end_at": "+441234567899"
      },
      "action": "keep",
      "record_type": "porting_associated_phone_number",
      "created_at": "2021-03-19T10:07:15.527Z",
      "updated_at": "2021-03-19T10:07:15.527Z"
    }
  ],
  "meta": {
    "total_pages": 3,
    "page_number": 2,
    "total_results": 55,
    "page_size": 25
  }
}

GET

porting_orders

{porting_order_id}

associated_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 portingAssociatedPhoneNumber of client.portingOrders.associatedPhoneNumbers.list(
  '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
)) {
  console.log(portingAssociatedPhoneNumber.id);
}

{
  "data": [
    {
      "id": "f24151b6-3389-41d3-8747-7dd8c681e5e2",
      "porting_order_id": "a24151b6-3389-41d3-8747-7dd8c681e5e2",
      "country_code": "GB",
      "phone_number_type": "local",
      "phone_number_range": {
        "start_at": "+441234567890",
        "end_at": "+441234567899"
      },
      "action": "keep",
      "record_type": "porting_associated_phone_number",
      "created_at": "2021-03-19T10:07:15.527Z",
      "updated_at": "2021-03-19T10:07:15.527Z"
    }
  ],
  "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.

Path Parameters

porting_order_id

string<uuid>

required

Identifies the Porting Order associated with the phone numbers

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[phone_number], filter[action]

Show child attributes

filter[phone_number]

string

Filter results by a phone number. It should be in E.164 format.

Example:

"+441234567890"

filter[action]

enum<string>

Filter results by action type

Available options:

keep,

disconnect

Example:

"keep"

sort

object

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

Show child attributes

sort[value]

enum<string>

default:-created_at

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

Available options:

-created_at,

created_at

Example:

"-created_at"

Response

Successful response

data

object[]

Show child attributes

data.id

string<uuid>

Uniquely identifies this associated phone number.

Example:

"f24151b6-3389-41d3-8747-7dd8c681e5e2"

data.porting_order_id

string<uuid>

Identifies the porting order associated with this phone number.

Example:

"a24151b6-3389-41d3-8747-7dd8c681e5e2"

data.country_code

string

Specifies the country code for this associated phone number. It is a two-letter ISO 3166-1 alpha-2 country code.

Example:

"GB"

data.phone_number_type

enum<string>

Specifies the phone number type for this associated phone number.

Available options:

landline,

local,

mobile,

national,

shared_cost,

toll_free

Example:

"local"

data.phone_number_range

object

Specifies the phone number range for this associated phone number.

Show child attributes

data.phone_number_range.start_at

string

Specifies the start of the phone number range for this associated phone number.

Example:

"+441234567890"

data.phone_number_range.end_at

string

Specifies the end of the phone number range for this associated phone number.

Example:

"+441234567899"

data.action

enum<string>

Specifies the action to take with this phone number during partial porting.

Available options:

keep,

disconnect

Example:

"keep"

data.record_type

string

Identifies the type of the resource.

Example:

"porting_associated_phone_number"

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 last updated.

Example:

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

Coverage

Regulatory

Searching

Ordering

Port In

Port Out

Management & Configurations

All Others

List all associated phone numbers

Authorizations

Path Parameters

Query Parameters

Response