Skip to main content
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
  }
}

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.

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