Telnyx

import Telnyx from 'telnyx'; const client = new Telnyx({ apiKey: 'My API Key', }); const subNumberOrder = await client.subNumberOrders.update('sub_number_order_id'); console.log(subNumberOrder.data);

{ "data": { "id": "12ade33a-21c0-473b-b055-b3c836e1c292", "order_request_id": "12ade33a-21c0-473b-b055-b3c836e1c293", "country_code": "US", "phone_number_type": "local", "user_id": "d70873cd-7c98-401a-81b6-b1ae08246995", "regulatory_requirements": [ { "record_type": "phone_number_regulatory_requirement", "requirement_id": "8ffb3622-7c6b-4ccc-b65f-7a3dc0099576", "field_type": "address" } ], "record_type": "sub_number_order", "phone_numbers_count": 1, "created_at": "2018-01-01T00:00:00.000000Z", "updated_at": "2018-01-01T00:00:00.000000Z", "requirements_met": true, "status": "pending", "customer_reference": "MY REF 001", "is_block_sub_number_order": false } }

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

sub_number_order_id

string

required

The sub number order ID.

Body

application/json

regulatory_requirements

object[]

Show child attributes

regulatory_requirements.requirement_id

string<uuid>

Unique id for a requirement.

Example:

"8ffb3622-7c6b-4ccc-b65f-7a3dc0099576"

regulatory_requirements.field_value

string

The value of the requirement. For address and document requirements, this should be the ID of the resource. For textual, this should be the value of the requirement.

Example:

"45f45a04-b4be-4592-95b1-9306b9db2b21"

Response

Successful response with details about a sub number order.

data

object

Show child attributes

data.id

string<uuid>

Example:

"12ade33a-21c0-473b-b055-b3c836e1c292"

data.order_request_id

string<uuid>

Example:

"12ade33a-21c0-473b-b055-b3c836e1c293"

data.country_code

string

Example:

"US"

data.phone_number_type

enum<string>

Available options:

local,

toll_free,

mobile,

national,

shared_cost,

landline

Example:

"local"

data.user_id

string<uuid>

Example:

"d70873cd-7c98-401a-81b6-b1ae08246995"

data.regulatory_requirements

object[]

Show child attributes

data.regulatory_requirements.record_type

string

Example:

"phone_number_regulatory_requirement"

data.regulatory_requirements.requirement_id

string<uuid>

Unique id for a requirement.

Example:

"8ffb3622-7c6b-4ccc-b65f-7a3dc0099576"

data.regulatory_requirements.field_type

enum<string>

Available options:

textual,

datetime,

address,

document

Example:

"address"

data.record_type

string

Example:

"sub_number_order"

data.phone_numbers_count

integer

The count of phone numbers in the number order.

Example:

1

data.created_at

string<date-time>

An ISO 8901 datetime string denoting when the number order was created.

Example:

"2018-01-01T00:00:00.000000Z"

data.updated_at

string<date-time>

An ISO 8901 datetime string for when the number order was updated.

Example:

"2018-01-01T00:00:00.000000Z"

data.requirements_met

boolean

True if all requirements are met for every phone number, false otherwise.

Example:

true

data.status

enum<string>

The status of the order.

Available options:

pending,

success,

failure

data.customer_reference

string

A customer reference string for customer look ups.

Example:

"MY REF 001"

data.is_block_sub_number_order

boolean

True if the sub number order is a block sub number order

Example:

false

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