Telnyx

import Telnyx from 'telnyx'; const client = new Telnyx({ apiKey: 'My API Key', }); const associatedPhoneNumber = await client.portingOrders.associatedPhoneNumbers.create( '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e', { action: 'keep', phone_number_range: {} }, ); console.log(associatedPhoneNumber.data);

{ "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" } }

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 number

Body

application/json

phone_number_range

object

required

Show child attributes

phone_number_range.start_at

string

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

Example:

"+441234567890"

phone_number_range.end_at

string

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

Example:

"+441234567899"

action

enum<string>

required

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

Available options:

keep,

disconnect

Example:

"keep"

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"

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