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 numberBlockOrder = await client.numberBlockOrders.retrieve('number_block_order_id');

console.log(numberBlockOrder.data);

{
  "data": {
    "id": "12ade33a-21c0-473b-b055-b3c836e1c292",
    "starting_number": "+19705555000",
    "range": 10,
    "record_type": "number_block_order",
    "connection_id": "346789098765567",
    "messaging_profile_id": "abc85f64-5717-4562-b3fc-2c9600",
    "phone_numbers_count": 10,
    "status": "pending",
    "customer_reference": "MY REF 001",
    "created_at": "2018-01-01T00:00:00.000000Z",
    "updated_at": "2018-01-01T00:00:00.000000Z",
    "requirements_met": true
  }
}

GET

number_block_orders

{number_block_order_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 numberBlockOrder = await client.numberBlockOrders.retrieve('number_block_order_id');

console.log(numberBlockOrder.data);

{
  "data": {
    "id": "12ade33a-21c0-473b-b055-b3c836e1c292",
    "starting_number": "+19705555000",
    "range": 10,
    "record_type": "number_block_order",
    "connection_id": "346789098765567",
    "messaging_profile_id": "abc85f64-5717-4562-b3fc-2c9600",
    "phone_numbers_count": 10,
    "status": "pending",
    "customer_reference": "MY REF 001",
    "created_at": "2018-01-01T00:00:00.000000Z",
    "updated_at": "2018-01-01T00:00:00.000000Z",
    "requirements_met": true
  }
}

Authorizations

Authorization

string

header

required

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

Path Parameters

number_block_order_id

string

required

The number block order ID.

Response

Successful response with details about a number block order.

data

object

Show child attributes

data.id

string<uuid>

Example:

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

data.record_type

string

Example:

"number_block_order"

data.starting_number

string

Starting phone number block

Example:

"+19705555000"

data.range

integer

The phone number range included in the block.

Example:

10

data.phone_numbers_count

integer

The count of phone numbers in the number order.

Example:

1

data.connection_id

string

Identifies the connection associated to all numbers in the phone number block.

Example:

"346789098765567"

data.messaging_profile_id

string

Identifies the messaging profile associated to all numbers in the phone number block.

Example:

"abc85f64-5717-4562-b3fc-2c9600"

data.status

enum<string>

The status of the order.

Available options:

pending,

success,

failure

Example:

"success"

data.customer_reference

string

A customer reference string for customer look ups.

Example:

"MY REF 001"

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

Example:

{
  "id": "12ade33a-21c0-473b-b055-b3c836e1c292",
  "starting_number": "+19705555000",
  "range": 10,
  "record_type": "number_block_order",
  "connection_id": "346789098765567",
  "messaging_profile_id": "abc85f64-5717-4562-b3fc-2c9600",
  "phone_numbers_count": 10,
  "status": "pending",
  "customer_reference": "MY REF 001",
  "created_at": "2018-01-01T00:00:00.000000Z",
  "updated_at": "2018-01-01T00:00:00.000000Z",
  "requirements_met": true
}

Create a number block order Update requirement group for a phone number order

⌘I

Coverage

Regulatory

Searching

Ordering

Port In

Port Out

Management & Configurations

All Others

Retrieve a number block order

Authorizations

Path Parameters

Response