Telnyx Phone Number Block Orders API
The Phone Number Block Orders API from Telnyx — 2 operation(s) for phone number block orders.
Work with this as data
Every API here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for apis
7 MCP tools reach this
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/telnyx:telnyx-phone-number-block-orders-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
OpenAPI Specification
openapi: 3.2.0
info:
title: Telnyx Phone Number Block Orders API
version: 2.0.0
contact:
email: support@telnyx.com
x-endpoint-cost: light
x-refined-note:
- x-latency-category differs across the merged source definitions and was not carried
description: 'Operations tagged Phone Number Block Orders across 3 of this provider''s published API definitions: telnyx-openapi.json, telnyx-openapi.yml, telnyx-openapi_2.json. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api.telnyx.com/v2
description: Version 2.0.0 of the Telnyx API
security:
- bearerAuth: []
tags:
- name: Phone Number Block Orders
paths:
/number_block_orders:
get:
summary: List number block orders
description: Get a paginated list of number block orders.
operationId: ListNumberBlockOrders
tags:
- Phone Number Block Orders
parameters:
- $ref: '#/components/parameters/numbers_PageConsolidated_73c9788e53'
- name: filter
in: query
style: deepObject
explode: true
description: 'Consolidated filter parameter (deepObject style). Originally: filter[status], filter[created_at], filter[phone_numbers.starting_number]'
schema:
type: object
properties:
status:
type: string
example: pending
description: Filter number block orders by status.
created_at:
type: object
description: Filter number block orders by date range.
properties:
gt:
type: string
example: '2018-01-01T00:00:00.000000Z'
description: Filter number block orders later than this value.
lt:
type: string
example: '2018-01-01T00:00:00.000000Z'
description: Filter number block orders earlier than this value.
additionalProperties: false
phone_numbers.starting_number:
type: string
example: '+19705555000'
description: Filter number block orders having these phone numbers.
responses:
'200':
description: Successful response with a list of number block orders.
content:
application/json:
schema:
type: object
title: List Number Block Orders Response
properties:
data:
type: array
items:
$ref: '#/components/schemas/NumberBlockOrder'
meta:
$ref: '#/components/schemas/PaginationMeta'
'400':
$ref: '#/components/responses/numbers_BadRequestResponse_73c9788e53'
'401':
$ref: '#/components/responses/numbers_UnauthorizedResponse_73c9788e53'
'404':
$ref: '#/components/responses/numbers_NotFoundResponse_73c9788e53'
'422':
$ref: '#/components/responses/numbers_UnprocessableEntity_73c9788e53'
'500':
$ref: '#/components/responses/GenericErrorResponse'
post:
summary: Create a number block order
description: Creates an order for a block of consecutive phone numbers and returns the created order. Track fulfillment through the order's status.
operationId: CreateNumberBlockOrder
tags:
- Phone Number Block Orders
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/CreateNumberBlockOrderRequest'
responses:
'200':
description: Successful response with details about a number block order.
content:
application/json:
schema:
type: object
title: Number Block Order Response
properties:
data:
$ref: '#/components/schemas/NumberBlockOrder'
'400':
$ref: '#/components/responses/numbers_BadRequestResponse_73c9788e53'
'401':
$ref: '#/components/responses/numbers_UnauthorizedResponse_73c9788e53'
'404':
$ref: '#/components/responses/numbers_NotFoundResponse_73c9788e53'
'422':
$ref: '#/components/responses/numbers_UnprocessableEntity_73c9788e53'
'500':
$ref: '#/components/responses/GenericErrorResponse'
servers:
- url: https://api.telnyx.com/v2
description: Version 2.0.0 of the Telnyx API
/number_block_orders/{number_block_order_id}:
get:
summary: Retrieve a number block order
description: Get an existing phone number block order.
operationId: RetrieveNumberBlockOrder
tags:
- Phone Number Block Orders
parameters:
- name: number_block_order_id
in: path
description: The number block order ID.
required: true
schema:
type: string
responses:
'200':
description: Successful response with details about a number block order.
content:
application/json:
schema:
type: object
title: Number Block Order Response
properties:
data:
$ref: '#/components/schemas/NumberBlockOrder'
'400':
$ref: '#/components/responses/numbers_BadRequestResponse_73c9788e53'
'401':
$ref: '#/components/responses/numbers_UnauthorizedResponse_73c9788e53'
'404':
$ref: '#/components/responses/numbers_NotFoundResponse_73c9788e53'
'422':
$ref: '#/components/responses/numbers_UnprocessableEntity_73c9788e53'
'500':
$ref: '#/components/responses/GenericErrorResponse'
servers:
- url: https://api.telnyx.com/v2
description: Version 2.0.0 of the Telnyx API
components:
schemas:
Errors:
properties:
errors:
type: array
items:
$ref: '#/components/schemas/billing-group_Error'
type: object
CreateNumberBlockOrderRequest:
required:
- starting_number
- range
properties:
id:
type: string
format: uuid
example: 12ade33a-21c0-473b-b055-b3c836e1c292
readOnly: true
record_type:
type: string
example: number_block_order
readOnly: true
starting_number:
type: string
description: Starting phone number block
example: '+19705555000'
writeOnly: true
range:
type: integer
description: The phone number range included in the block.
example: 10
writeOnly: true
phone_numbers_count:
type: integer
description: The count of phone numbers in the number order.
example: 10
readOnly: true
connection_id:
type: string
example: '346789098765567'
description: Identifies the connection associated with this phone number.
messaging_profile_id:
type: string
example: abc85f64-5717-4562-b3fc-2c9600
description: Identifies the messaging profile associated with the phone number.
status:
type: string
enum:
- pending
- success
- failure
description: The status of the order.
readOnly: true
customer_reference:
type: string
description: A customer reference string for customer look ups.
example: MY REF 001
created_at:
type: string
format: date-time
description: An ISO 8901 datetime string denoting when the number order was created.
example: '2018-01-01T00:00:00.000000Z'
readOnly: true
updated_at:
type: string
format: date-time
description: An ISO 8901 datetime string for when the number order was updated.
example: '2018-01-01T00:00:00.000000Z'
readOnly: true
requirements_met:
type: boolean
description: True if all requirements are met for every phone number, false otherwise.
example: true
readOnly: true
errors:
type: string
description: Errors the reservation could happen upon
example: Number is already on hold
readOnly: true
example:
starting_number: '+19705555000'
range: 10
type: object
PaginationMeta:
type: object
properties:
total_pages:
type: integer
example: 3
total_results:
type: integer
example: 55
page_number:
type: integer
example: 2
page_size:
type: integer
example: 25
billing-group_Error:
type: object
required:
- code
- title
properties:
code:
type: integer
format: int32
title:
type: string
detail:
type: string
source:
type: object
properties:
pointer:
description: JSON pointer (RFC6901) to the offending entity.
type: string
parameter:
description: Indicates which query parameter caused the error.
type: string
meta:
type: object
properties: {}
additionalProperties: true
NumberBlockOrder:
properties:
id:
type: string
format: uuid
example: 12ade33a-21c0-473b-b055-b3c836e1c292
readOnly: true
record_type:
type: string
example: number_block_order
readOnly: true
starting_number:
type: string
description: Starting phone number block
example: '+19705555000'
range:
type: integer
description: The phone number range included in the block.
example: 10
phone_numbers_count:
type: integer
description: The count of phone numbers in the number order.
example: 1
readOnly: true
connection_id:
type: string
example: '346789098765567'
description: Identifies the connection associated to all numbers in the phone number block.
messaging_profile_id:
type: string
example: abc85f64-5717-4562-b3fc-2c9600
description: Identifies the messaging profile associated to all numbers in the phone number block.
status:
type: string
enum:
- pending
- success
- failure
example: success
description: The status of the order.
readOnly: true
customer_reference:
type: string
description: A customer reference string for customer look ups.
example: MY REF 001
created_at:
type: string
format: date-time
description: An ISO 8901 datetime string denoting when the number order was created.
example: '2018-01-01T00:00:00.000000Z'
readOnly: true
updated_at:
type: string
format: date-time
description: An ISO 8901 datetime string for when the number order was updated.
example: '2018-01-01T00:00:00.000000Z'
readOnly: true
requirements_met:
type: boolean
description: True if all requirements are met for every phone number, false otherwise.
example: true
readOnly: 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
type: object
numbers_Errors:
properties:
errors:
items:
$ref: '#/components/schemas/numbers_Error'
type: array
type: object
numbers_Error:
properties:
code:
example: '10007'
type: string
detail:
example: An unexpected error occured.
type: string
meta:
properties:
url:
description: URL with additional information on the error.
example: https://developers.telnyx.com/docs/overview/errors/10015
type: string
type: object
source:
properties:
parameter:
description: Indicates which query parameter caused the error.
type: string
pointer:
description: JSON pointer (RFC6901) to the offending entity.
example: /base
type: string
type: object
title:
example: Unexpected error
type: string
type: object
Errors_2:
properties:
errors:
type: array
items:
$ref: '#/components/schemas/Error'
type: object
Error:
required:
- code
- title
properties:
code:
type: string
x-format: int64
title:
type: string
detail:
type: string
description: A human-readable explanation of the error.
description:
type: string
source:
type: object
properties:
pointer:
description: JSON pointer (RFC6901) to the offending entity.
type: string
format: json-pointer
parameter:
description: Indicates which query parameter caused the error.
type: string
meta:
type: object
additionalProperties: true
example:
title: Invalid street address
source:
pointer: /street_address
code: '20207'
description: The street address provided is invalid.
type: object
responses:
numbers_UnprocessableEntity_73c9788e53:
description: Unprocessable entity. Check the 'detail' field in response for details.
content:
application/json:
schema:
$ref: '#/components/schemas/Errors'
GenericErrorResponse:
description: Unexpected error
content:
application/json:
schema:
$ref: '#/components/schemas/Errors'
numbers_UnauthorizedResponse_73c9788e53:
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/Errors'
examples:
Authentication Failed:
value:
errors:
- code: '10009'
title: Authentication failed
detail: Could not understand the provided credentials.
meta:
url: https://developers.telnyx.com/docs/overview/errors/10009
numbers_BadRequestResponse_73c9788e53:
description: Bad request, the request was unacceptable, often due to missing a required parameter.
content:
application/json:
schema:
$ref: '#/components/schemas/Errors'
numbers_NotFoundResponse_73c9788e53:
description: The requested resource doesn't exist.
content:
application/json:
schema:
$ref: '#/components/schemas/Errors'
numbers_BadRequestResponse:
content:
application/json:
schema:
$ref: '#/components/schemas/numbers_Errors'
description: Bad request, the request was unacceptable, often due to missing a required parameter.
numbers_GenericErrorResponse:
content:
application/json:
schema:
$ref: '#/components/schemas/numbers_Errors'
description: Unexpected error
numbers_NotFoundResponse:
content:
application/json:
schema:
$ref: '#/components/schemas/numbers_Errors'
description: The requested resource doesn't exist.
numbers_UnauthorizedResponse:
content:
application/json:
examples:
Authentication Failed:
value:
errors:
- code: '10009'
detail: Could not understand the provided credentials.
meta:
url: https://developers.telnyx.com/docs/overview/errors/10009
title: Authentication failed
schema:
$ref: '#/components/schemas/numbers_Errors'
description: Unauthorized
ListNumberBlockOrdersResponse:
content:
application/json:
schema:
properties:
data:
items:
$ref: '#/components/schemas/NumberBlockOrder'
type: array
meta:
$ref: '#/components/schemas/PaginationMeta'
title: List Number Block Orders Response
type: object
description: Successful response with a list of number block orders.
numbers_UnprocessableEntity:
content:
application/json:
schema:
$ref: '#/components/schemas/numbers_Errors'
description: Unprocessable entity. Check the 'detail' field in response for details.
NumberBlockOrderResponse:
content:
application/json:
schema:
properties:
data:
$ref: '#/components/schemas/NumberBlockOrder'
title: Number Block Order Response
type: object
description: Successful response with details about a number block order.
parameters:
numbers_PageConsolidated_73c9788e53:
name: page
in: query
style: deepObject
explode: true
description: 'Consolidated page parameter (deepObject style). Originally: page[size], page[number]'
schema:
type: object
properties:
size:
type: integer
minimum: 1
maximum: 250
default: 20
description: The size of the page
number:
type: integer
minimum: 1
default: 1
description: The page number to load
numbers_PageConsolidated:
description: 'Consolidated page parameter (deepObject style). Originally: page[size], page[number]'
explode: true
in: query
name: page
schema:
properties:
number:
default: 1
description: The page number to load
minimum: 1
type: integer
size:
default: 20
description: The size of the page
maximum: 250
minimum: 1
type: integer
type: object
style: deepObject
securitySchemes:
BearerAuth:
type: http
scheme: bearer
bearerFormat: API key
description: 'Telnyx API key supplied as `Authorization: Bearer <token>`. In production, auth may be validated by the API gateway and forwarded via Telnyx auth headers.'
Payment:
type: apiKey
in: header
name: Authorization
description: 'Machine Payment Protocol credential used on paid retries, sent as `Authorization: Payment ...`. Obtained by paying a challenge returned in the `WWW-Authenticate` header of a 402 response. This is not a Telnyx API key; initial challenge requests use standard bearer authentication instead.'
agent-memory_bearerAuth:
type: http
scheme: bearer
description: Telnyx API key
bearerAuth:
type: http
scheme: bearer
branded-calling_bearerAuth:
type: http
scheme: bearer
description: Telnyx API key. Generate one at https://portal.telnyx.com/#/app/api-keys.
collections_bearerAuth:
type: http
scheme: bearer
description: Telnyx API key. Collections and results are automatically scoped to the authenticated user's organization.
number-reputation_bearerAuth:
type: http
scheme: bearer
description: Telnyx API key. Generate one at https://portal.telnyx.com/#/app/api-keys.
oauthClientAuth:
type: oauth2
flows:
clientCredentials:
tokenUrl: https://api.telnyx.com/v2/oauth/token
scopes:
admin: Administrative access to Telnyx resources
authorizationCode:
authorizationUrl: https://api.telnyx.com/v2/oauth/authorize
tokenUrl: https://api.telnyx.com/v2/oauth/token
refreshUrl: https://api.telnyx.com/v2/oauth/token
scopes:
admin: Administrative access to Telnyx resources
description: OAuth 2.0 authentication for Telnyx API and MCP integrations
outbound-voice-profiles_bearerAuth:
type: http
scheme: bearer
bearerFormat: JWT
pronunciation-dicts_bearerAuth:
type: http
scheme: bearer
description: Telnyx API v2 key. Obtain from https://portal.telnyx.com
rcs-registration_bearerAuth:
type: http
scheme: bearer
bearerFormat: API key
stored-payment-transactions_bearerAuth:
type: http
scheme: bearer
bearerFormat: JWT
transcriptions-search_bearerAuth:
type: http
scheme: bearer
description: Telnyx API key. Results are automatically scoped to the authenticated user's organization.
web-search_bearerAuth:
type: http
scheme: bearer
description: Telnyx API key
pay-connectors_bearerAuth:
type: http
scheme: bearer
description: Telnyx API key, not the processor bearer token.
telnyxApiKey:
type: http
scheme: bearer
description: Management-only Telnyx account credential.
x-refined-from:
- telnyx-openapi.json
- telnyx-openapi.yml
- telnyx-openapi_2.json
x-service-info:
categories:
- communication
- developer-tools
docs:
apiReference: https://developers.telnyx.com
homepage: https://telnyx.com
llms: https://telnyx.com/llms.txt