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 subNumberOrders = await client.subNumberOrders.list();

console.log(subNumberOrders.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
    }
  ],
  "meta": {
    "total_pages": 3,
    "page_number": 2,
    "total_results": 55,
    "page_size": 25
  }
}

GET

sub_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 subNumberOrders = await client.subNumberOrders.list();

console.log(subNumberOrders.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
    }
  ],
  "meta": {
    "total_pages": 3,
    "page_number": 2,
    "total_results": 55,
    "page_size": 25
  }
}

Authorizations

Authorization

string

header

required

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

Query Parameters

filter

object

Consolidated filter parameter (deepObject style). Originally: filter[status], filter[order_request_id], filter[country_code], filter[phone_number_type], filter[phone_numbers_count]

Show child attributes

filter[status]

string

Filter sub number orders by status.

filter[order_request_id]

string<uuid>

ID of the number order the sub number order belongs to

Example:

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

filter[country_code]

string

ISO alpha-2 country code.

Example:

"US"

filter[phone_number_type]

string

Phone Number Type

Example:

"local"

filter[phone_numbers_count]

integer

Amount of numbers in the sub number order

Example:

1

Response

Successful response with a list of sub number orders.

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

Coverage

Regulatory

Searching

Ordering

Port In

Port Out

Management & Configurations

All Others

List sub number orders

Authorizations

Query Parameters

Response