Telnyx

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

Authorizations

Authorization

string

header

required

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

Query Parameters

page

object

Consolidated page parameter (deepObject style). Originally: page[size], page[number]

Show child attributes

page[number]

integer

default:1

The page number to load

Required range: x >= 1

page[size]

integer

default:20

The size of the page

Required range: 1 <= x <= 250

filter

object

Consolidated filter parameter (deepObject style). Originally: filter[status], filter[created_at], filter[phone_numbers.starting_number]

Show child attributes

filter[status]

string

Filter number block orders by status.

Example:

"pending"

filter[created_at]

object

Filter number block orders by date range.

Show child attributes

filter[created_at][gt]

string

Filter number block orders later than this value.

Example:

"2018-01-01T00:00:00.000000Z"

filter[created_at][lt]

string

Filter number block orders earlier than this value.

Example:

"2018-01-01T00:00:00.000000Z"

filter[phone_numbers.starting_number]

string

Filter number block orders having these phone numbers.

Example:

"+19705555000"

Response

Successful response with a list of number block orders.

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

OAuth Discovery

IP Addresses

IP Ranges

SIM Cards

Addresses

Advanced Number Orders

Assistants

Audio

Chat

Clusters

Conversations

Embeddings

Fine Tuning

Integrations

MCP Servers

Audit Logs

Authentication Providers

Phone Number Search

Billing

Billing Groups

Brands

SIM Card Actions

Bundles

User Bundles

Call Control Applications

Debugging

Call Commands

Call Information

Campaign

Voice Channels

API Reference

Phone Number Orders

Conference Commands

Connections

Country Coverage

Credential Connections

Call Recordings

Customer Service Record

Detail Records

Dialogflow Integration

Documents

Dynamic Emergency Addresses

Dynamic Emergency Endpoints

Enum

External Connections

Programmable Fax Applications

Programmable Fax Commands

FQDN Connections

FQDNs

Global IPs

Inexplicit Number Orders

Integration Secrets

Inventory Level

IP Connections

IPs

Reports

MDR Detailed Reports

Speech to Text Batch Reports

CDR Reports

MDR Usage Reports

Telco Data Usage Reports

Speech to text Usage Reports

CDR Usage Reports

Managed Accounts

Media Storage API

Messages

RCS messaging

Messaging Hosted Number

Number Configurations

Advanced OptIn/OptOut

Messaging Profiles

Messaging Tollfree Verification

Messaging URL Domains

Mobile Network Operators

Push Credentials

Coverage

Networks

Notifications

Phone Number Block Orders

Number Lookup