Skip to main content
POST
/
inexplicit_number_orders
JavaScript
import Telnyx from 'telnyx';

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

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",
        "quickship": true,
        "exclude_held_numbers": true,
        "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"
  }
}

Documentation Index

Fetch the complete documentation index at: https://developers.telnyx.com/llms.txt

Use this file to discover all available pages before exploring further.

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.

​
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