Telnyx Advanced Number Orders API
The Advanced Number Orders API from Telnyx — 3 operation(s) for advanced number 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-advanced-number-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 Advanced Number 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 Advanced Number 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: Advanced Number Orders
paths:
/advanced_orders:
get:
summary: List Advanced Orders
tags:
- Advanced Number Orders
operationId: list_advanced_orders_v2
responses:
'200':
$ref: '#/components/responses/ListAdvancedOrderResponse'
'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'
description: Returns the advanced number orders associated with the account. Each result includes the order configuration and its current state.
post:
summary: Create Advanced Order
operationId: create_advanced_order_v2
tags:
- Advanced Number Orders
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/AdvancedOrderRequest'
responses:
'200':
description: An Advanced Order Response
content:
application/json:
schema:
$ref: '#/components/schemas/AdvancedOrder'
'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'
description: Creates an advanced number order from the requested order configuration. The response contains the resulting advanced order and its initial state.
servers:
- url: https://api.telnyx.com/v2
description: Version 2.0.0 of the Telnyx API
/advanced_orders/{advanced-order-id}/requirement_group:
patch:
summary: Update Advanced Order
operationId: update_advanced_order_v2
parameters:
- name: advanced-order-id
in: path
description: Unique identifier of the advanced order.
required: true
schema:
type: string
format: uuid
title: Order Id
tags:
- Advanced Number Orders
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/AdvancedOrderRequest'
responses:
'200':
$ref: '#/components/responses/AdvancedOrderResponse'
'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'
description: Updates the requirement-group configuration for the specified advanced number order. The response contains the updated advanced order.
servers:
- url: https://api.telnyx.com/v2
description: Version 2.0.0 of the Telnyx API
/advanced_orders/{order_id}:
get:
summary: Get Advanced Order
operationId: get_advanced_order_v2
parameters:
- name: order_id
in: path
description: Unique identifier of the order.
required: true
schema:
type: string
format: uuid
title: Order Id
tags:
- Advanced Number Orders
responses:
'200':
$ref: '#/components/responses/AdvancedOrderResponse'
'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'
description: Returns the advanced number order identified by `order_id`, including its configuration and current state.
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
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
AdvancedOrderRequest:
properties:
country_code:
type: string
maxLength: 2
minLength: 2
title: Country Code
default: US
comments:
type: string
maxLength: 255
title: Comments
default: ''
quantity:
type: integer
maximum: 10000
minimum: 1
title: Quantity
default: 1
area_code:
type: string
maxLength: 3
title: Area Code
default: ''
phone_number_type:
type: string
enum:
- local
- mobile
- toll_free
- shared_cost
- national
- landline
default: local
features:
items:
enum:
- sms
- mms
- voice
- fax
- emergency
type: array
uniqueItems: true
title: Features
customer_reference:
type: string
title: Customer Reference
default: ''
requirement_group_id:
type: string
format: uuid
title: Requirement Group ID
description: The ID of the requirement group to associate with this advanced order
example: 3fa85f64-5717-4562-b3fc-2c963f66afa6
type: object
title: AdvancedOrderRequest
AdvancedOrder:
type: object
title: Advanced Order
properties:
country_code:
type: string
maxLength: 2
minLength: 2
title: Country Code
default: US
comments:
type: string
maxLength: 255
title: Comments
default: ''
quantity:
type: integer
maximum: 10000
minimum: 1
title: Quantity
default: 1
area_code:
type: string
maxLength: 3
title: Area Code
default: ''
phone_number_type:
items:
enum:
- local
- mobile
- toll_free
- shared_cost
- national
- landline
default: ''
features:
items:
enum:
- sms
- mms
- voice
- fax
- emergency
type: array
uniqueItems: true
title: Features
customer_reference:
type: string
title: Customer Reference
default: ''
id:
type: string
format: uuid
title: Id
status:
items:
type: string
enum:
- pending
- processing
- ordered
orders:
items:
type: string
format: uuid
type: array
uniqueItems: true
title: Orders
requirement_group_id:
type: string
format: uuid
title: Requirement Group ID
description: The ID of the requirement group associated with this advanced order
example: 3fa85f64-5717-4562-b3fc-2c963f66afa6
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:
ListAdvancedOrderResponse:
description: An array of Advanced Order Responses
content:
application/json:
schema:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/AdvancedOrder'
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'
AdvancedOrderResponse:
description: An Advanced Order Response
content:
application/json:
schema:
$ref: '#/components/schemas/AdvancedOrder'
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
numbers_UnprocessableEntity:
content:
application/json:
schema:
$ref: '#/components/schemas/numbers_Errors'
description: Unprocessable entity. Check the 'detail' field in response for details.
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