Telnyx

import Telnyx from 'telnyx'; const client = new Telnyx({ apiKey: 'My API Key', }); const inexplicitNumberOrder = await client.inexplicitNumberOrders.create({ ordering_groups: [ { count_requested: 'count_requested', country_iso: 'US', phone_number_type: 'phone_number_type' }, ], }); console.log(inexplicitNumberOrder.data);

{ "data": { "id": "<string>", "connection_id": "<string>", "messaging_profile_id": "<string>", "customer_reference": "<string>", "billing_group_id": "<string>", "ordering_groups": [ { "country_iso": "<string>", "phone_number_type": "<string>", "count_requested": 123, "count_allocated": 123, "status": "pending", "national_destination_code": "<string>", "phone_number[starts_with]": "<string>", "phone_number[ends_with]": "<string>", "phone_number[contains]": "<string>", "administrative_area": "<string>", "strategy": "always", "error_reason": "<string>", "orders": [ { "number_order_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a", "sub_number_order_ids": [ "3c90c3cc-0d44-4b50-8888-8dd25736052a" ] } ], "created_at": "2023-11-07T05:31:56Z", "updated_at": "2023-11-07T05:31:56Z" } ], "created_at": "2023-11-07T05:31:56Z", "updated_at": "2023-11-07T05:31:56Z" } }

Authorizations

Authorization

string

header

required

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

Body

application/json

ordering_groups

object[]

required

Group(s) of numbers to order. You can have multiple ordering_groups objects added to a single request.

Show child attributes

ordering_groups.country_iso

enum<string>

required

Country where you would like to purchase phone numbers. Allowable values: US, CA

Available options:

US,

CA

ordering_groups.count_requested

string

required

Quantity of phone numbers to order

ordering_groups.phone_number_type

string

required

Number type (local, toll-free, etc.)

ordering_groups.national_destination_code

string

Filter by area code

ordering_groups.phone_number

object

Phone number search criteria

Show child attributes

ordering_groups.phone_number.starts_with

string

Filter by the starting digits of the phone number

ordering_groups.phone_number.ends_with

string

Filter by the ending digits of the phone number

ordering_groups.phone_number.contains

string

Filter for phone numbers that contain the digits specified

ordering_groups.administrative_area

string

Filter for phone numbers in a given state / province

ordering_groups.locality

string

Filter for phone numbers in a given city / region / rate center

ordering_groups.features

string[]

Filter for phone numbers that have the features to satisfy your use case (e.g., ["voice"])

ordering_groups.strategy

enum<string>

default:always

Ordering strategy. Define what action should be taken if we don't have enough phone numbers to fulfill your request. Allowable values are: always = proceed with ordering phone numbers, regardless of current inventory levels; never = do not place any orders unless there are enough phone numbers to satisfy the request. If not specified, the always strategy will be enforced.

Available options:

always,

never

connection_id

string

Connection id to apply to phone numbers that are purchased

messaging_profile_id

string

Messaging profile id to apply to phone numbers that are purchased

customer_reference

string

Reference label for the customer

billing_group_id

string

Billing group id to apply to phone numbers that are purchased

Response

Successful response with details about an inexplicit number order.

data

object

Show child attributes

data.id

string

Unique identifier for the inexplicit number order

data.connection_id

string

Connection id to apply to phone numbers that are purchased

data.messaging_profile_id

string

Messaging profile id to apply to phone numbers that are purchased

data.customer_reference

string

Reference label for the customer

data.billing_group_id

string

Billing group id to apply to phone numbers that are purchased

data.ordering_groups

object[]

Show child attributes

data.ordering_groups.country_iso

string

Country where you would like to purchase phone numbers

data.ordering_groups.phone_number_type

string

Number type

data.ordering_groups.count_requested

integer

Quantity of phone numbers requested

data.ordering_groups.count_allocated

integer

Quantity of phone numbers allocated

data.ordering_groups.status

enum<string>

Status of the ordering group

Available options:

pending,

processing,

failed,

success,

partial_success

data.ordering_groups.national_destination_code

string

Filter by area code

data.ordering_groups.phone_number[starts_with]

string

Filter by the starting digits of the phone number

data.ordering_groups.phone_number[ends_with]

string

Filter by the ending digits of the phone number

data.ordering_groups.phone_number[contains]

string

Filter for phone numbers that contain the digits specified

data.ordering_groups.administrative_area

string

Filter for phone numbers in a given state / province

data.ordering_groups.strategy

enum<string>

Ordering strategy used

Available options:

always,

never

data.ordering_groups.error_reason

string

Error reason if applicable

data.ordering_groups.orders

object[]

Array of orders created to fulfill the inexplicit order

Show child attributes

data.ordering_groups.orders.number_order_id

string<uuid>

required

ID of the main number order

data.ordering_groups.orders.sub_number_order_ids

string<uuid>[]

required

Array of sub number order IDs

data.ordering_groups.created_at

string<date-time>

ISO 8601 formatted date indicating when the ordering group was created

data.ordering_groups.updated_at

string<date-time>

ISO 8601 formatted date indicating when the ordering group was updated

data.created_at

string<date-time>

ISO 8601 formatted date indicating when the resource was created

data.updated_at

string<date-time>

ISO 8601 formatted date indicating when the resource was updated

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