Telnyx Inexplicit Number Orders API
Inexplicit number orders for bulk purchasing without specifying exact numbers
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-inexplicit-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 Inexplicit 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 Inexplicit 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: Inexplicit Number Orders
description: Inexplicit number orders for bulk purchasing without specifying exact numbers
paths:
/inexplicit_number_orders:
get:
summary: List inexplicit number orders
description: Get a paginated list of inexplicit number orders.
operationId: ListInexplicitNumberOrders
tags:
- Inexplicit Number Orders
parameters:
- name: page_number
in: query
description: The page number to load
schema:
type: integer
minimum: 1
default: 1
- name: page_size
in: query
description: The size of the page
schema:
type: integer
minimum: 1
maximum: 250
default: 20
responses:
'200':
description: Successful response with a list of inexplicit number orders.
content:
application/json:
schema:
type: object
title: List Inexplicit Number Orders Response
properties:
data:
type: array
items:
$ref: '#/components/schemas/InexplicitNumberOrderResponse'
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 an inexplicit number order
description: Create an inexplicit number order to programmatically purchase phone numbers without specifying exact numbers.
operationId: CreateInexplicitNumberOrder
tags:
- Inexplicit Number Orders
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/InexplicitNumberOrderRequest'
example:
ordering_groups:
- country_iso: US
count_requested: '5'
phone_number_type: local
administrative_area: CA
features:
- voice
responses:
'200':
description: Successful response with details about an inexplicit number order.
content:
application/json:
schema:
type: object
title: Inexplicit Number Order Response
properties:
data:
$ref: '#/components/schemas/InexplicitNumberOrderResponse'
example:
data:
id: string
connection_id: string
messaging_profile_id: string
customer_reference: string
billing_group_id: string
ordering_groups:
- country_iso: string
phone_number_type: string
count_requested: 0
count_allocated: 0
status: pending
national_destination_code: string
phone_number[starts_with]: string
phone_number[ends_with]: string
phone_number[contains]: string
administrative_area: string
strategy: always
quickship: false
exclude_held_numbers: false
error_reason: string
orders:
- number_order_id: 3fa85f64-5717-4562-b3fc-2c963f66afa6
sub_number_order_ids:
- 3fa85f64-5717-4562-b3fc-2c963f66afa6
created_at: '2024-01-23T18:10:02.574Z'
updated_at: '2024-01-23T18:10:02.574Z'
created_at: '2024-01-23T18:10:02.574Z'
updated_at: '2024-01-23T18:10:02.574Z'
'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
/inexplicit_number_orders/{id}:
get:
summary: Retrieve an inexplicit number order
description: Get an existing inexplicit number order by ID.
operationId: RetrieveInexplicitNumberOrder
tags:
- Inexplicit Number Orders
parameters:
- name: id
in: path
required: true
description: Identifies the inexplicit number order
schema:
type: string
format: uuid
responses:
'200':
description: Successful response with details about an inexplicit number order.
content:
application/json:
schema:
type: object
title: Inexplicit Number Order Response
properties:
data:
$ref: '#/components/schemas/InexplicitNumberOrderResponse'
example:
data:
id: string
connection_id: string
messaging_profile_id: string
customer_reference: string
billing_group_id: string
ordering_groups:
- country_iso: string
phone_number_type: string
count_requested: 0
count_allocated: 0
status: pending
national_destination_code: string
phone_number[starts_with]: string
phone_number[ends_with]: string
phone_number[contains]: string
administrative_area: string
strategy: always
quickship: false
exclude_held_numbers: false
error_reason: string
orders:
- number_order_id: 3fa85f64-5717-4562-b3fc-2c963f66afa6
sub_number_order_ids:
- 3fa85f64-5717-4562-b3fc-2c963f66afa6
created_at: '2024-01-23T18:10:02.574Z'
updated_at: '2024-01-23T18:10:02.574Z'
created_at: '2024-01-23T18:10:02.574Z'
updated_at: '2024-01-23T18:10:02.574Z'
'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
InexplicitNumberOrderRequest:
type: object
properties:
ordering_groups:
type: array
description: Group(s) of numbers to order. You can have multiple ordering_groups objects added to a single request.
items:
type: object
properties:
country_iso:
type: string
description: 'Country where you would like to purchase phone numbers. Allowable values: US, CA'
enum:
- US
- CA
count_requested:
type: string
description: Quantity of phone numbers to order
phone_number_type:
type: string
description: Number type (local, toll-free, etc.)
national_destination_code:
type: string
description: Filter by area code
phone_number:
type: object
description: Phone number search criteria
properties:
starts_with:
type: string
description: Filter by the starting digits of the phone number
ends_with:
type: string
description: Filter by the ending digits of the phone number
contains:
type: string
description: Filter for phone numbers that contain the digits specified
administrative_area:
type: string
description: Filter for phone numbers in a given state / province
locality:
type: string
description: Filter for phone numbers in a given city / region / rate center
features:
type: array
description: Filter for phone numbers that have the features to satisfy your use case (e.g., ["voice"])
items:
type: string
strategy:
type: string
description: 'Ordering strategy. Define what action should be taken if we don''t have enough phone numbers to fulfill your request. Allowable values are: always = proceed with ordering phone numbers, regardless of current inventory levels; never = do not place any orders unless there are enough phone numbers to satisfy the request. If not specified, the always strategy will be enforced.'
enum:
- always
- never
default: always
quickship:
type: boolean
description: Filter to exclude phone numbers that need additional time after to purchase to activate. Only applicable for +1 toll_free numbers.
exclude_held_numbers:
type: boolean
description: Filter to exclude phone numbers that are currently on hold/reserved for your account.
required:
- country_iso
- count_requested
- phone_number_type
connection_id:
type: string
description: Connection id to apply to phone numbers that are purchased
messaging_profile_id:
type: string
description: Messaging profile id to apply to phone numbers that are purchased
customer_reference:
type: string
description: Reference label for the customer
billing_group_id:
type: string
description: Billing group id to apply to phone numbers that are purchased
required:
- ordering_groups
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
InexplicitNumberOrderResponse:
type: object
properties:
id:
type: string
description: Unique identifier for the inexplicit number order
connection_id:
type: string
description: Connection id to apply to phone numbers that are purchased
messaging_profile_id:
type: string
description: Messaging profile id to apply to phone numbers that are purchased
customer_reference:
type: string
description: Reference label for the customer
billing_group_id:
type: string
description: Billing group id to apply to phone numbers that are purchased
ordering_groups:
type: array
items:
type: object
properties:
country_iso:
type: string
description: Country where you would like to purchase phone numbers
phone_number_type:
type: string
description: Number type
count_requested:
type: integer
description: Quantity of phone numbers requested
count_allocated:
type: integer
description: Quantity of phone numbers allocated
status:
type: string
description: Status of the ordering group
enum:
- pending
- processing
- failed
- success
- partial_success
national_destination_code:
type: string
description: Filter by area code
phone_number[starts_with]:
type: string
description: Filter by the starting digits of the phone number
phone_number[ends_with]:
type: string
description: Filter by the ending digits of the phone number
phone_number[contains]:
type: string
description: Filter for phone numbers that contain the digits specified
administrative_area:
type: string
description: Filter for phone numbers in a given state / province
strategy:
type: string
description: Ordering strategy used
enum:
- always
- never
quickship:
type: boolean
description: Filter to exclude phone numbers that need additional time after to purchase to activate. Only applicable for +1 toll_free numbers.
exclude_held_numbers:
type: boolean
description: Filter to exclude phone numbers that are currently on hold/reserved for your account.
error_reason:
type: string
description: Error reason if applicable
orders:
type: array
description: Array of orders created to fulfill the inexplicit order
items:
type: object
properties:
number_order_id:
type: string
format: uuid
description: ID of the main number order
sub_number_order_ids:
type: array
items:
type: string
format: uuid
description: Array of sub number order IDs
required:
- number_order_id
- sub_number_order_ids
created_at:
type: string
format: date-time
description: ISO 8601 formatted date indicating when the ordering group was created
updated_at:
type: string
format: date-time
description: ISO 8601 formatted date indicating when the ordering group was updated
created_at:
type: string
format: date-time
description: ISO 8601 formatted date indicating when the resource was created
updated_at:
type: string
format: date-time
description: ISO 8601 formatted date indicating when the resource was updated
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.
InexplicitNumberOrdersResponse:
content:
application/json:
schema:
properties:
data:
items:
$ref: '#/components/schemas/InexplicitNumberOrderResponse'
type: array
meta:
$ref: '#/components/schemas/PaginationMeta'
title: List Inexplicit Number Orders Response
type: object
description: Successful response with a list of inexplicit number orders.
InexplicitNumberOrderResponse:
content:
application/json:
schema:
properties:
data:
$ref: '#/components/schemas/InexplicitNumberOrderResponse'
title: Inexplicit Number Order Response
type: object
description: Successful response with details about an inexplicit number order.
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