Telnyx

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.retrieve(
  '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
);

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

GET

inexplicit_number_orders

{id}

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.retrieve(
  '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
);

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

Authorizations

Authorization

string

header

required

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

Path Parameters

string<uuid>

required

Identifies the inexplicit number order

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.quickship

boolean

Filter to exclude phone numbers that need additional time after to purchase to activate. Only applicable for +1 toll_free numbers.

data.ordering_groups.exclude_held_numbers

boolean

Filter to exclude phone numbers that are currently on hold/reserved for your account.

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

Create an inexplicit number order Number order status update

⌘I

Coverage

Regulatory

Searching

Ordering

Port In

Port Out

Management & Configurations

All Others

Retrieve an inexplicit number order

Authorizations

Path Parameters

Response