Telnyx Porting In - JavaScript

Installation

bash

npm install telnyx

Setup

javascript

import Telnyx from 'telnyx';

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

All examples below assume

client

is already initialized as shown above.

Error Handling

All API calls can fail with network errors, rate limits (429), validation errors (422), or authentication errors (401). Always handle errors in production code:

javascript

try {
  const result = await client.messages.send({ to: '+13125550001', from: '+13125550002', text: 'Hello' });
} catch (err) {
  if (err instanceof Telnyx.APIConnectionError) {
    console.error('Network error — check connectivity and retry');
  } else if (err instanceof Telnyx.RateLimitError) {
    // 429: rate limited — wait and retry with exponential backoff
    const retryAfter = err.headers?.['retry-after'] || 1;
    await new Promise(r => setTimeout(r, retryAfter * 1000));
  } else if (err instanceof Telnyx.APIError) {
    console.error(`API error ${err.status}: ${err.message}`);
    if (err.status === 422) {
      console.error('Validation error — check required fields and formats');
    }
  }
}

Common error codes:

invalid API key,

insufficient permissions,

resource not found,

validation error (check field formats),

rate limited (retry with exponential backoff).

Important Notes

Phone numbers must be in E.164 format (e.g.,
```
+13125550001
```
). Include the
```
+
```
prefix and country code. No spaces, dashes, or parentheses.
Pagination: List methods return an auto-paginating iterator. Use
```
for await (const item of result) { ... }
```
to iterate through all pages automatically.

Run a portability check

Runs a portability check, returning the results immediately.

POST /portability_checks

Optional:

phone_numbers

(array[string])

javascript

const response = await client.portabilityChecks.run({
    phoneNumbers: ["+18005550101"],
});

console.log(response.data);

Returns:

fast_portable

(boolean),

not_portable_reason

(string),

phone_number

(string),

portable

(boolean),

record_type

(string)

List all porting events

Returns a list of all porting events.

GET /porting/events

javascript

// Automatically fetches more pages as needed.
for await (const eventListResponse of client.porting.events.list()) {
  console.log(eventListResponse);
}

Returns:

available_notification_methods

(array[string]),

event_type

(enum: porting_order.deleted),

id

(uuid),

payload

(object),

payload_status

(enum: created, completed),

porting_order_id

(uuid)

Show a porting event

Show a specific porting event.

GET /porting/events/{id}

javascript

const event = await client.porting.events.retrieve('182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e');

console.log(event.data);

Returns:

available_notification_methods

(array[string]),

event_type

(enum: porting_order.deleted),

id

(uuid),

payload

(object),

payload_status

(enum: created, completed),

porting_order_id

(uuid)

Republish a porting event

Republish a specific porting event.

POST /porting/events/{id}/republish

javascript

await client.porting.events.republish('182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e');

List LOA configurations

List the LOA configurations.

GET /porting/loa_configurations

javascript

// Automatically fetches more pages as needed.
for await (const portingLoaConfiguration of client.porting.loaConfigurations.list()) {
  console.log(portingLoaConfiguration.id);
}

Returns:

address

(object),

company_name

(string),

contact

(object),

created_at

(date-time),

id

(uuid),

logo

(object),

name

(string),

organization_id

(string),

record_type

(string),

updated_at

(date-time)

Create a LOA configuration

Create a LOA configuration.

POST /porting/loa_configurations

javascript

const loaConfiguration = await client.porting.loaConfigurations.create({
  address: {
    city: 'Austin',
    country_code: 'US',
    state: 'TX',
    street_address: '600 Congress Avenue',
    zip_code: '78701',
  },
  company_name: 'Telnyx',
  contact: { email: 'testing@telnyx.com', phone_number: '+12003270001' },
  logo: { document_id: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e' },
  name: 'My LOA Configuration',
});

console.log(loaConfiguration.data);

Returns:

address

(object),

company_name

(string),

contact

(object),

created_at

(date-time),

id

(uuid),

logo

(object),

name

(string),

organization_id

(string),

record_type

(string),

updated_at

(date-time)

Preview the LOA configuration parameters

Preview the LOA template that would be generated without need to create LOA configuration.

POST /porting/loa_configurations/preview

javascript

const response = await client.porting.loaConfigurations.preview({
  address: {
    city: 'Austin',
    country_code: 'US',
    state: 'TX',
    street_address: '600 Congress Avenue',
    zip_code: '78701',
  },
  company_name: 'Telnyx',
  contact: { email: 'testing@telnyx.com', phone_number: '+12003270001' },
  logo: { document_id: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e' },
  name: 'My LOA Configuration',
});

console.log(response);

const content = await response.blob();
console.log(content);

Retrieve a LOA configuration

Retrieve a specific LOA configuration.

GET /porting/loa_configurations/{id}

javascript

const loaConfiguration = await client.porting.loaConfigurations.retrieve(
  '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
);

console.log(loaConfiguration.data);

Returns:

address

(object),

company_name

(string),

contact

(object),

created_at

(date-time),

id

(uuid),

logo

(object),

name

(string),

organization_id

(string),

record_type

(string),

updated_at

(date-time)

Update a LOA configuration

Update a specific LOA configuration.

PATCH /porting/loa_configurations/{id}

javascript

const loaConfiguration = await client.porting.loaConfigurations.update(
  '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
  {
    address: {
      city: 'Austin',
      country_code: 'US',
      state: 'TX',
      street_address: '600 Congress Avenue',
      zip_code: '78701',
    },
    company_name: 'Telnyx',
    contact: { email: 'testing@telnyx.com', phone_number: '+12003270001' },
    logo: { document_id: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e' },
    name: 'My LOA Configuration',
  },
);

console.log(loaConfiguration.data);

Returns:

address

(object),

company_name

(string),

contact

(object),

created_at

(date-time),

id

(uuid),

logo

(object),

name

(string),

organization_id

(string),

record_type

(string),

updated_at

(date-time)

Delete a LOA configuration

Delete a specific LOA configuration.

DELETE /porting/loa_configurations/{id}

javascript

await client.porting.loaConfigurations.delete('182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e');

Preview a LOA configuration

Preview a specific LOA configuration.

GET /porting/loa_configurations/{id}/preview

javascript

const response = await client.porting.loaConfigurations.preview1(
  '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
);

console.log(response);

const content = await response.blob();
console.log(content);

List porting related reports

List the reports generated about porting operations.

GET /porting/reports

javascript

// Automatically fetches more pages as needed.
for await (const portingReport of client.porting.reports.list()) {
  console.log(portingReport.id);
}

Returns:

created_at

(date-time),

document_id

(uuid),

id

(uuid),

params

(object),

record_type

(string),

report_type

(enum: export_porting_orders_csv),

status

(enum: pending, completed),

updated_at

(date-time)

Create a porting related report

Generate reports about porting operations.

POST /porting/reports

javascript

const report = await client.porting.reports.create({
  params: { filters: {} },
  report_type: 'export_porting_orders_csv',
});

console.log(report.data);

Returns:

created_at

(date-time),

document_id

(uuid),

id

(uuid),

params

(object),

record_type

(string),

report_type

(enum: export_porting_orders_csv),

status

(enum: pending, completed),

updated_at

(date-time)

Retrieve a report

Retrieve a specific report generated.

GET /porting/reports/{id}

javascript

const report = await client.porting.reports.retrieve('182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e');

console.log(report.data);

Returns:

created_at

(date-time),

document_id

(uuid),

id

(uuid),

params

(object),

record_type

(string),

report_type

(enum: export_porting_orders_csv),

status

(enum: pending, completed),

updated_at

(date-time)

List available carriers in the UK

List available carriers in the UK.

GET /porting/uk_carriers

javascript

const response = await client.porting.listUkCarriers();

console.log(response.data);

Returns:

alternative_cupids

(array[string]),

created_at

(date-time),

cupid

(string),

id

(uuid),

name

(string),

record_type

(string),

updated_at

(date-time)

List all porting orders

Returns a list of your porting order.

GET /porting_orders

javascript

// Automatically fetches more pages as needed.
for await (const portingOrder of client.portingOrders.list()) {
  console.log(portingOrder.id);
}

Returns:

activation_settings

(object),

additional_steps

(array[string]),

created_at

(date-time),

customer_group_reference

(string | null),

customer_reference

(string | null),

description

(string),

documents

(object),

end_user

(object),

id

(uuid),

messaging

(object),

misc

(object),

old_service_provider_ocn

(string),

parent_support_key

(string | null),

phone_number_configuration

(object),

phone_number_type

(enum: landline, local, mobile, national, shared_cost, toll_free),

phone_numbers

(array[object]),

porting_phone_numbers_count

(integer),

record_type

(string),

requirements

(array[object]),

requirements_met

(boolean),

status

(object),

support_key

(string | null),

updated_at

(date-time),

user_feedback

(object),

user_id

(uuid),

webhook_url

(uri)

Create a porting order

Creates a new porting order object.

POST /porting_orders

— Required:

phone_numbers

Optional:

customer_group_reference

(string),

customer_reference

(string | null)

javascript

const portingOrder = await client.portingOrders.create({
  phone_numbers: ['+13035550000', '+13035550001', '+13035550002'],
});

console.log(portingOrder.data);

Returns:

activation_settings

(object),

additional_steps

(array[string]),

created_at

(date-time),

customer_group_reference

(string | null),

customer_reference

(string | null),

description

(string),

documents

(object),

end_user

(object),

id

(uuid),

messaging

(object),

misc

(object),

old_service_provider_ocn

(string),

parent_support_key

(string | null),

phone_number_configuration

(object),

phone_number_type

(enum: landline, local, mobile, national, shared_cost, toll_free),

phone_numbers

(array[object]),

porting_phone_numbers_count

(integer),

record_type

(string),

requirements

(array[object]),

requirements_met

(boolean),

status

(object),

support_key

(string | null),

updated_at

(date-time),

user_feedback

(object),

user_id

(uuid),

webhook_url

(uri)

List all exception types

Returns a list of all possible exception types for a porting order.

GET /porting_orders/exception_types

javascript

const response = await client.portingOrders.retrieveExceptionTypes();

console.log(response.data);

Returns:

code

(enum: 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),

description

(string)

List all phone number configurations

Returns a list of phone number configurations paginated.

GET /porting_orders/phone_number_configurations

javascript

// Automatically fetches more pages as needed.
for await (const phoneNumberConfigurationListResponse of client.portingOrders.phoneNumberConfigurations.list()) {
  console.log(phoneNumberConfigurationListResponse.id);
}

Returns:

created_at

(date-time),

id

(uuid),

porting_phone_number_id

(uuid),

record_type

(string),

updated_at

(date-time),

user_bundle_id

(uuid)

Create a list of phone number configurations

Creates a list of phone number configurations.

POST /porting_orders/phone_number_configurations

javascript

const phoneNumberConfiguration = await client.portingOrders.phoneNumberConfigurations.create();

console.log(phoneNumberConfiguration.data);

Returns:

created_at

(date-time),

id

(uuid),

porting_phone_number_id

(uuid),

record_type

(string),

updated_at

(date-time),

user_bundle_id

(uuid)

Retrieve a porting order

Retrieves the details of an existing porting order.

GET /porting_orders/{id}

javascript

const portingOrder = await client.portingOrders.retrieve('182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e');

console.log(portingOrder.data);

Returns:

activation_settings

(object),

additional_steps

(array[string]),

created_at

(date-time),

customer_group_reference

(string | null),

customer_reference

(string | null),

description

(string),

documents

(object),

end_user

(object),

id

(uuid),

messaging

(object),

misc

(object),

old_service_provider_ocn

(string),

parent_support_key

(string | null),

phone_number_configuration

(object),

phone_number_type

(enum: landline, local, mobile, national, shared_cost, toll_free),

phone_numbers

(array[object]),

porting_phone_numbers_count

(integer),

record_type

(string),

requirements

(array[object]),

requirements_met

(boolean),

status

(object),

support_key

(string | null),

updated_at

(date-time),

user_feedback

(object),

user_id

(uuid),

webhook_url

(uri)

Edit a porting order

Edits the details of an existing porting order. Any or all of a porting orders attributes may be included in the resource object included in a PATCH request. If a request does not include all of the attributes for a resource, the system will interpret the missing attributes as if they were included with their current values.

PATCH /porting_orders/{id}

Optional:

activation_settings

(object),

customer_group_reference

(string),

customer_reference

(string),

documents

(object),

end_user

(object),

messaging

(object),

misc

(object),

phone_number_configuration

(object),

requirement_group_id

(uuid),

requirements

(array[object]),

user_feedback

(object),

webhook_url

(uri)

javascript

const portingOrder = await client.portingOrders.update('182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e');

console.log(portingOrder.data);

Returns:

activation_settings

(object),

additional_steps

(array[string]),

created_at

(date-time),

customer_group_reference

(string | null),

customer_reference

(string | null),

description

(string),

documents

(object),

end_user

(object),

id

(uuid),

messaging

(object),

misc

(object),

old_service_provider_ocn

(string),

parent_support_key

(string | null),

phone_number_configuration

(object),

phone_number_type

(enum: landline, local, mobile, national, shared_cost, toll_free),

phone_numbers

(array[object]),

porting_phone_numbers_count

(integer),

record_type

(string),

requirements

(array[object]),

requirements_met

(boolean),

status

(object),

support_key

(string | null),

updated_at

(date-time),

user_feedback

(object),

user_id

(uuid),

webhook_url

(uri)

Delete a porting order

Deletes an existing porting order. This operation is restrict to porting orders in draft state.

DELETE /porting_orders/{id}

javascript

await client.portingOrders.delete('182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e');

Activate every number in a porting order asynchronously.

Activate each number in a porting order asynchronously. This operation is limited to US FastPort orders only.

POST /porting_orders/{id}/actions/activate

javascript

const response = await client.portingOrders.actions.activate(
  '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
);

console.log(response.data);

Returns:

activate_at

(date-time),

activation_type

(enum: scheduled, on-demand),

activation_windows

(array[object]),

created_at

(date-time),

id

(uuid),

record_type

(string),

status

(enum: created, in-process, completed, failed),

updated_at

(date-time)

Cancel a porting order

POST /porting_orders/{id}/actions/cancel

javascript

const response = await client.portingOrders.actions.cancel('182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e');

console.log(response.data);

Returns:

activation_settings

(object),

additional_steps

(array[string]),

created_at

(date-time),

customer_group_reference

(string | null),

customer_reference

(string | null),

description

(string),

documents

(object),

end_user

(object),

id

(uuid),

messaging

(object),

misc

(object),

old_service_provider_ocn

(string),

parent_support_key

(string | null),

phone_number_configuration

(object),

phone_number_type

(enum: landline, local, mobile, national, shared_cost, toll_free),

phone_numbers

(array[object]),

porting_phone_numbers_count

(integer),

record_type

(string),

requirements

(array[object]),

requirements_met

(boolean),

status

(object),

support_key

(string | null),

updated_at

(date-time),

user_feedback

(object),

user_id

(uuid),

webhook_url

(uri)

Submit a porting order.

Confirm and submit your porting order.

POST /porting_orders/{id}/actions/confirm

javascript

const response = await client.portingOrders.actions.confirm('182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e');

console.log(response.data);

Returns:

activation_settings

(object),

additional_steps

(array[string]),

created_at

(date-time),

customer_group_reference

(string | null),

customer_reference

(string | null),

description

(string),

documents

(object),

end_user

(object),

id

(uuid),

messaging

(object),

misc

(object),

old_service_provider_ocn

(string),

parent_support_key

(string | null),

phone_number_configuration

(object),

phone_number_type

(enum: landline, local, mobile, national, shared_cost, toll_free),

phone_numbers

(array[object]),

porting_phone_numbers_count

(integer),

record_type

(string),

requirements

(array[object]),

requirements_met

(boolean),

status

(object),

support_key

(string | null),

updated_at

(date-time),

user_feedback

(object),

user_id

(uuid),

webhook_url

(uri)

Share a porting order

Creates a sharing token for a porting order. The token can be used to share the porting order with non-Telnyx users.

POST /porting_orders/{id}/actions/share

javascript

const response = await client.portingOrders.actions.share('182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e');

console.log(response.data);

Returns:

created_at

(date-time),

expires_at

(date-time),

expires_in_seconds

(integer),

id

(uuid),

permissions

(array[string]),

porting_order_id

(uuid),

record_type

(string),

token

(string)

List all porting activation jobs

Returns a list of your porting activation jobs.

GET /porting_orders/{id}/activation_jobs

javascript

// Automatically fetches more pages as needed.
for await (const portingOrdersActivationJob of client.portingOrders.activationJobs.list(
  '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
)) {
  console.log(portingOrdersActivationJob.id);
}

Returns:

activate_at

(date-time),

activation_type

(enum: scheduled, on-demand),

activation_windows

(array[object]),

created_at

(date-time),

id

(uuid),

record_type

(string),

status

(enum: created, in-process, completed, failed),

updated_at

(date-time)

Retrieve a porting activation job

Returns a porting activation job.

GET /porting_orders/{id}/activation_jobs/{activationJobId}

javascript

const activationJob = await client.portingOrders.activationJobs.retrieve(
  '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
  { id: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e' },
);

console.log(activationJob.data);

Returns:

activate_at

(date-time),

activation_type

(enum: scheduled, on-demand),

activation_windows

(array[object]),

created_at

(date-time),

id

(uuid),

record_type

(string),

status

(enum: created, in-process, completed, failed),

updated_at

(date-time)

Update a porting activation job

Updates the activation time of a porting activation job.

PATCH /porting_orders/{id}/activation_jobs/{activationJobId}

javascript

const activationJob = await client.portingOrders.activationJobs.update(
  '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
  { id: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e' },
);

console.log(activationJob.data);

Returns:

activate_at

(date-time),

activation_type

(enum: scheduled, on-demand),

activation_windows

(array[object]),

created_at

(date-time),

id

(uuid),

record_type

(string),

status

(enum: created, in-process, completed, failed),

updated_at

(date-time)

List additional documents

Returns a list of additional documents for a porting order.

GET /porting_orders/{id}/additional_documents

javascript

// Automatically fetches more pages as needed.
for await (const additionalDocumentListResponse of client.portingOrders.additionalDocuments.list(
  '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
)) {
  console.log(additionalDocumentListResponse.id);
}

Returns:

content_type

(string),

created_at

(date-time),

document_id

(uuid),

document_type

(enum: loa, invoice, csr, other),

filename

(string),

id

(uuid),

porting_order_id

(uuid),

record_type

(string),

updated_at

(date-time)

Create a list of additional documents

Creates a list of additional documents for a porting order.

POST /porting_orders/{id}/additional_documents

javascript

const additionalDocument = await client.portingOrders.additionalDocuments.create(
  '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
);

console.log(additionalDocument.data);

Returns:

content_type

(string),

created_at

(date-time),

document_id

(uuid),

document_type

(enum: loa, invoice, csr, other),

filename

(string),

id

(uuid),

porting_order_id

(uuid),

record_type

(string),

updated_at

(date-time)

Delete an additional document

Deletes an additional document for a porting order.

DELETE /porting_orders/{id}/additional_documents/{additional_document_id}

javascript

await client.portingOrders.additionalDocuments.delete('182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e', {
  id: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
});

List allowed FOC dates

Returns a list of allowed FOC dates for a porting order.

GET /porting_orders/{id}/allowed_foc_windows

javascript

const response = await client.portingOrders.retrieveAllowedFocWindows(
  '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
);

console.log(response.data);

Returns:

ended_at

(date-time),

record_type

(string),

started_at

(date-time)

List all comments of a porting order

Returns a list of all comments of a porting order.

GET /porting_orders/{id}/comments

javascript

// Automatically fetches more pages as needed.
for await (const commentListResponse of client.portingOrders.comments.list(
  '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
)) {
  console.log(commentListResponse.id);
}

Returns:

body

(string),

created_at

(date-time),

id

(uuid),

porting_order_id

(uuid),

record_type

(string),

user_type

(enum: admin, user, system)

Create a comment for a porting order

Creates a new comment for a porting order.

POST /porting_orders/{id}/comments

Optional:

body

(string)

javascript

const comment = await client.portingOrders.comments.create('182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e');

console.log(comment.data);

Returns:

body

(string),

created_at

(date-time),

id

(uuid),

porting_order_id

(uuid),

record_type

(string),

user_type

(enum: admin, user, system)

Download a porting order loa template

GET /porting_orders/{id}/loa_template

javascript

const response = await client.portingOrders.retrieveLoaTemplate(
  '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
);

console.log(response);

const content = await response.blob();
console.log(content);

List porting order requirements

Returns a list of all requirements based on country/number type for this porting order.

GET /porting_orders/{id}/requirements

javascript

// Automatically fetches more pages as needed.
for await (const portingOrderRetrieveRequirementsResponse of client.portingOrders.retrieveRequirements(
  '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
)) {
  console.log(portingOrderRetrieveRequirementsResponse.field_type);
}

Returns:

field_type

(enum: document, textual),

field_value

(string),

record_type

(string),

requirement_status

(string),

requirement_type

(object)

Retrieve the associated V1 sub_request_id and port_request_id

GET /porting_orders/{id}/sub_request

javascript

const response = await client.portingOrders.retrieveSubRequest(
  '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
);

console.log(response.data);

Returns:

port_request_id

(string),

sub_request_id

(string)

List verification codes

Returns a list of verification codes for a porting order.

GET /porting_orders/{id}/verification_codes

javascript

// Automatically fetches more pages as needed.
for await (const verificationCodeListResponse of client.portingOrders.verificationCodes.list(
  '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
)) {
  console.log(verificationCodeListResponse.id);
}

Returns:

created_at

(date-time),

id

(uuid),

phone_number

(string),

porting_order_id

(uuid),

record_type

(string),

updated_at

(date-time),

verified

(boolean)

Send the verification codes

Send the verification code for all porting phone numbers.

POST /porting_orders/{id}/verification_codes/send

javascript

await client.portingOrders.verificationCodes.send('182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e');

Verify the verification code for a list of phone numbers

Verifies the verification code for a list of phone numbers.

POST /porting_orders/{id}/verification_codes/verify

javascript

const response = await client.portingOrders.verificationCodes.verify(
  '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
);

console.log(response.data);

Returns:

created_at

(date-time),

id

(uuid),

phone_number

(string),

porting_order_id

(uuid),

record_type

(string),

updated_at

(date-time),

verified

(boolean)

List action requirements for a porting order

Returns a list of action requirements for a specific porting order.

GET /porting_orders/{porting_order_id}/action_requirements

javascript

// Automatically fetches more pages as needed.
for await (const actionRequirementListResponse of client.portingOrders.actionRequirements.list(
  'porting_order_id',
)) {
  console.log(actionRequirementListResponse.id);
}

Returns:

action_type

(string),

action_url

(string | null),

cancel_reason

(string | null),

created_at

(date-time),

id

(string),

porting_order_id

(string),

record_type

(enum: porting_action_requirement),

requirement_type_id

(string),

status

(enum: created, pending, completed, cancelled, failed),

updated_at

(date-time)

Initiate an action requirement

Initiates a specific action requirement for a porting order.

POST /porting_orders/{porting_order_id}/action_requirements/{id}/initiate

javascript

const response = await client.portingOrders.actionRequirements.initiate('id', {
  porting_order_id: '550e8400-e29b-41d4-a716-446655440000',
  params: { first_name: 'John', last_name: 'Doe' },
});

console.log(response.data);

Returns:

action_type

(string),

action_url

(string | null),

cancel_reason

(string | null),

created_at

(date-time),

id

(string),

porting_order_id

(string),

record_type

(enum: porting_action_requirement),

requirement_type_id

(string),

status

(enum: created, pending, completed, cancelled, failed),

updated_at

(date-time)

List all associated phone numbers

Returns a list of all associated phone numbers for a porting order. Associated phone numbers are used for partial porting in GB to specify which phone numbers should be kept or disconnected.

GET /porting_orders/{porting_order_id}/associated_phone_numbers

javascript

// Automatically fetches more pages as needed.
for await (const portingAssociatedPhoneNumber of client.portingOrders.associatedPhoneNumbers.list(
  '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
)) {
  console.log(portingAssociatedPhoneNumber.id);
}

Returns:

action

(enum: keep, disconnect),

country_code

(string),

created_at

(date-time),

id

(uuid),

phone_number_range

(object),

phone_number_type

(enum: landline, local, mobile, national, shared_cost, toll_free),

porting_order_id

(uuid),

record_type

(string),

updated_at

(date-time)

Create an associated phone number

Creates a new associated phone number for a porting order. This is used for partial porting in GB to specify which phone numbers should be kept or disconnected.

POST /porting_orders/{porting_order_id}/associated_phone_numbers

javascript

const associatedPhoneNumber = await client.portingOrders.associatedPhoneNumbers.create(
  '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
  {
    action: 'keep',
    phone_number_range: {},
  },
);

console.log(associatedPhoneNumber.data);

Returns:

action

(enum: keep, disconnect),

country_code

(string),

created_at

(date-time),

id

(uuid),

phone_number_range

(object),

phone_number_type

(enum: landline, local, mobile, national, shared_cost, toll_free),

porting_order_id

(uuid),

record_type

(string),

updated_at

(date-time)

Delete an associated phone number

Deletes an associated phone number from a porting order.

DELETE /porting_orders/{porting_order_id}/associated_phone_numbers/{id}

javascript

const associatedPhoneNumber = await client.portingOrders.associatedPhoneNumbers.delete(
  '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
  { porting_order_id: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e' },
);

console.log(associatedPhoneNumber.data);

Returns:

action

(enum: keep, disconnect),

country_code

(string),

created_at

(date-time),

id

(uuid),

phone_number_range

(object),

phone_number_type

(enum: landline, local, mobile, national, shared_cost, toll_free),

porting_order_id

(uuid),

record_type

(string),

updated_at

(date-time)

List all phone number blocks

Returns a list of all phone number blocks of a porting order.

GET /porting_orders/{porting_order_id}/phone_number_blocks

javascript

// Automatically fetches more pages as needed.
for await (const portingPhoneNumberBlock of client.portingOrders.phoneNumberBlocks.list(
  '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
)) {
  console.log(portingPhoneNumberBlock.id);
}

Returns:

activation_ranges

(array[object]),

country_code

(string),

created_at

(date-time),

id

(uuid),

phone_number_range

(object),

phone_number_type

(enum: landline, local, mobile, national, shared_cost, toll_free),

record_type

(string),

updated_at

(date-time)

Create a phone number block

Creates a new phone number block.

POST /porting_orders/{porting_order_id}/phone_number_blocks

javascript

const phoneNumberBlock = await client.portingOrders.phoneNumberBlocks.create(
  '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
  {
    activation_ranges: [{ end_at: '+4930244999910', start_at: '+4930244999901' }],
    phone_number_range: { end_at: '+4930244999910', start_at: '+4930244999901' },
  },
);

console.log(phoneNumberBlock.data);

Returns:

activation_ranges

(array[object]),

country_code

(string),

created_at

(date-time),

id

(uuid),

phone_number_range

(object),

phone_number_type

(enum: landline, local, mobile, national, shared_cost, toll_free),

record_type

(string),

updated_at

(date-time)

Delete a phone number block

Deletes a phone number block.

DELETE /porting_orders/{porting_order_id}/phone_number_blocks/{id}

javascript

const phoneNumberBlock = await client.portingOrders.phoneNumberBlocks.delete(
  '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
  { porting_order_id: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e' },
);

console.log(phoneNumberBlock.data);

Returns:

activation_ranges

(array[object]),

country_code

(string),

created_at

(date-time),

id

(uuid),

phone_number_range

(object),

phone_number_type

(enum: landline, local, mobile, national, shared_cost, toll_free),

record_type

(string),

updated_at

(date-time)

List all phone number extensions

Returns a list of all phone number extensions of a porting order.

GET /porting_orders/{porting_order_id}/phone_number_extensions

javascript

// Automatically fetches more pages as needed.
for await (const portingPhoneNumberExtension of client.portingOrders.phoneNumberExtensions.list(
  '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
)) {
  console.log(portingPhoneNumberExtension.id);
}

Returns:

activation_ranges

(array[object]),

created_at

(date-time),

extension_range

(object),

id

(uuid),

porting_phone_number_id

(uuid),

record_type

(string),

updated_at

(date-time)

Create a phone number extension

Creates a new phone number extension.

POST /porting_orders/{porting_order_id}/phone_number_extensions

javascript

const phoneNumberExtension = await client.portingOrders.phoneNumberExtensions.create(
  '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
  {
    activation_ranges: [{ end_at: 10, start_at: 1 }],
    extension_range: { end_at: 10, start_at: 1 },
    porting_phone_number_id: 'f24151b6-3389-41d3-8747-7dd8c681e5e2',
  },
);

console.log(phoneNumberExtension.data);

Returns:

activation_ranges

(array[object]),

created_at

(date-time),

extension_range

(object),

id

(uuid),

porting_phone_number_id

(uuid),

record_type

(string),

updated_at

(date-time)

Delete a phone number extension

Deletes a phone number extension.

DELETE /porting_orders/{porting_order_id}/phone_number_extensions/{id}

javascript

const phoneNumberExtension = await client.portingOrders.phoneNumberExtensions.delete(
  '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
  { porting_order_id: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e' },
);

console.log(phoneNumberExtension.data);

Returns:

activation_ranges

(array[object]),

created_at

(date-time),

extension_range

(object),

id

(uuid),

porting_phone_number_id

(uuid),

record_type

(string),

updated_at

(date-time)

List all porting phone numbers

Returns a list of your porting phone numbers.

GET /porting_phone_numbers

javascript

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

Returns:

activation_status

(enum: New, Pending, Conflict, Cancel Pending, Failed, Concurred, Activate RDY, Disconnect Pending, Concurrence Sent, Old, Sending, Active, Cancelled),

phone_number

(string),

phone_number_type

(enum: landline, local, mobile, national, shared_cost, toll_free),

portability_status

(enum: pending, confirmed, provisional),

porting_order_id

(uuid),

porting_order_status

(enum: draft, in-process, submitted, exception, foc-date-confirmed, cancel-pending, ported, cancelled),

record_type

(string),

requirements_status

(enum: requirement-info-pending, requirement-info-under-review, requirement-info-exception, approved),

support_key

(string)

telnyx-porting-in-javascript

NPX Install

Tags

SKILL.md Content

Telnyx Porting In - JavaScript

Installation

Setup

Error Handling

Important Notes

Run a portability check

List all porting events

Show a porting event

Republish a porting event

List LOA configurations

Create a LOA configuration

Preview the LOA configuration parameters

Retrieve a LOA configuration

Update a LOA configuration

Delete a LOA configuration

Preview a LOA configuration

List porting related reports

Create a porting related report

Retrieve a report

List available carriers in the UK

List all porting orders

Create a porting order

List all exception types

List all phone number configurations

Create a list of phone number configurations

Retrieve a porting order

Edit a porting order

Delete a porting order

Activate every number in a porting order asynchronously.

Cancel a porting order

Submit a porting order.

Share a porting order

List all porting activation jobs

Retrieve a porting activation job

Update a porting activation job

List additional documents

Create a list of additional documents

Delete an additional document

List allowed FOC dates

List all comments of a porting order

Create a comment for a porting order

Download a porting order loa template

List porting order requirements

Retrieve the associated V1 sub_request_id and port_request_id

List verification codes

Send the verification codes

Verify the verification code for a list of phone numbers

List action requirements for a porting order

Initiate an action requirement

List all associated phone numbers

Create an associated phone number

Delete an associated phone number

List all phone number blocks

Create a phone number block

Delete a phone number block

List all phone number extensions

Create a phone number extension

Delete a phone number extension

List all porting phone numbers