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 phoneNumberConfigurationListResponse of client.portingOrders.phoneNumberConfigurations.list()) {
  console.log(phoneNumberConfigurationListResponse.id);
}

{
  "data": [
    {
      "id": "eef3340b-8903-4466-b445-89b697315a3a",
      "user_bundle_id": "daa4308e-742f-4867-97f2-3073db13319a",
      "porting_phone_number_id": "f1486bae-f067-460c-ad43-73a92848f902",
      "record_type": "porting_phone_number_configuration",
      "created_at": "2021-03-19T10:07:15.527000Z",
      "updated_at": "2021-03-19T10:07:15.527000Z"
    }
  ],
  "meta": {
    "total_pages": 3,
    "page_number": 2,
    "total_results": 55,
    "page_size": 25
  }
}

GET

porting_orders

phone_number_configurations

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 phoneNumberConfigurationListResponse of client.portingOrders.phoneNumberConfigurations.list()) {
  console.log(phoneNumberConfigurationListResponse.id);
}

{
  "data": [
    {
      "id": "eef3340b-8903-4466-b445-89b697315a3a",
      "user_bundle_id": "daa4308e-742f-4867-97f2-3073db13319a",
      "porting_phone_number_id": "f1486bae-f067-460c-ad43-73a92848f902",
      "record_type": "porting_phone_number_configuration",
      "created_at": "2021-03-19T10:07:15.527000Z",
      "updated_at": "2021-03-19T10:07:15.527000Z"
    }
  ],
  "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][in][], filter[porting_phone_number][in][], filter[user_bundle_id][in][]

Show child attributes

filter[porting_order]

object

Show child attributes

filter[porting_order][status]

enum<string>[]

Filter results by specific porting order statuses

Available options:

activation-in-progress,

cancel-pending,

cancelled,

draft,

exception,

foc-date-confirmed,

in-process,

ported,

submitted

filter[porting_phone_number]

string<uuid>[]

Filter results by a list of porting phone number IDs

filter[user_bundle_id]

string<uuid>[]

Filter results by a list of user bundle IDs

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

Example:

"created_at"

Response

Successful response

data

object[]

Show child attributes

data.id

string<uuid>

Uniquely identifies this phone number configuration

Example:

"eef3340b-8903-4466-b445-89b697315a3a"

data.user_bundle_id

string<uuid>

Identifies the associated user bundle

Example:

"daa4308e-742f-4867-97f2-3073db13319a"

data.porting_phone_number_id

string<uuid>

Identifies the associated porting phone number

Example:

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

data.record_type

string

Identifies the type of the resource.

Example:

"porting_phone_number_configuration"

data.created_at

string<date-time>

ISO 8601 formatted date indicating when the resource was created.

Example:

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

data.updated_at

string<date-time>

ISO 8601 formatted date indicating when the resource was updated.

Example:

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

Coverage

Regulatory

Searching

Ordering

Port In

Port Out

Management & Configurations

All Others

List all phone number configurations

Authorizations

Query Parameters

Response