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-reservations-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 Reservations 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 Reservations 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 Reservations
description: Number reservations
paths:
/number_reservations:
get:
summary: List number reservations
description: Gets a paginated list of phone number reservations.
operationId: ListNumberReservations
tags:
- Phone Number Reservations
x-group-parameters: 'true'
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.phone_number], filter[customer_reference]'
schema:
type: object
properties:
status:
type: string
description: Filter number reservations by status.
created_at:
type: object
description: Filter number reservations by date range.
properties:
gt:
type: string
description: Filter number reservations later than this value.
lt:
type: string
description: Filter number reservations earlier than this value.
additionalProperties: false
phone_numbers.phone_number:
type: string
description: Filter number reservations having these phone numbers.
customer_reference:
type: string
description: Filter number reservations via the customer reference set.
responses:
'200':
description: Successful response with a list of number reservations.
content:
application/json:
schema:
type: object
title: List Number Reservations Response
properties:
data:
type: array
items:
$ref: '#/components/schemas/NumberReservation'
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 reservation
description: Creates a Phone Number Reservation for multiple numbers.
operationId: CreateNumberReservation
tags:
- Phone Number Reservations
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/CreateNumberReservationRequest'
responses:
'200':
description: Successful response with details about a number reservation.
content:
application/json:
schema:
type: object
title: Number Reservation Response
properties:
data:
$ref: '#/components/schemas/NumberReservation'
'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_reservations/{number_reservation_id}:
get:
summary: Retrieve a number reservation
description: Returns the details of a single phone number reservation, including its status and the reserved numbers.
operationId: RetrieveNumberReservation
tags:
- Phone Number Reservations
parameters:
- name: number_reservation_id
in: path
description: The number reservation ID.
required: true
schema:
type: string
responses:
'200':
description: Successful response with details about a number reservation.
content:
application/json:
schema:
type: object
title: Number Reservation Response
properties:
data:
$ref: '#/components/schemas/NumberReservation'
'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_reservations/{number_reservation_id}/actions/extend:
post:
summary: Extend a number reservation
description: Extends reservation expiry time on all phone numbers.
operationId: ExtendNumberReservationExpiryTime
tags:
- Phone Number Reservations
parameters:
- name: number_reservation_id
in: path
description: The number reservation ID.
required: true
schema:
type: string
responses:
'200':
description: Successful response with details about a number reservation.
content:
application/json:
schema:
type: object
title: Number Reservation Response
properties:
data:
$ref: '#/components/schemas/NumberReservation'
'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:
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
schemas:
CreateNumberReservationRequest:
properties:
id:
type: string
format: uuid
example: 12ade33a-21c0-473b-b055-b3c836e1c292
readOnly: true
record_type:
type: string
example: number_reservation
readOnly: true
phone_numbers:
type: array
items:
$ref: '#/components/schemas/ReservedPhoneNumber'
status:
type: string
enum:
- pending
- success
- failure
description: The status of the entire reservation.
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 numbers reservation 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 reservation was updated.
example: '2018-01-01T00:00:00.000000Z'
readOnly: true
example:
id: 12ade33a-21c0-473b-b055-b3c836e1c292
record_type: number_reservation
phone_numbers:
- id: 12ade33a-21c0-473b-b055-b3c836e1c292
record_type: reserved_phone_number
phone_number: '+19705555098'
status: pending
created_at: '2018-01-01T00:00:00.000000Z'
updated_at: '2018-01-01T00:00:00.000000Z'
expired_at: '2018-01-01T00:00:00.000000Z'
errors: Number is already on hold
status: pending
customer_reference: MY REF 001
created_at: '2018-01-01T00:00:00.000000Z'
updated_at: '2018-01-01T00:00:00.000000Z'
type: object
ReservedPhoneNumber:
properties:
id:
type: string
format: uuid
example: 12ade33a-21c0-473b-b055-b3c836e1c292
readOnly: true
errors:
type: string
description: Errors the reservation could happen upon
example: Number is already on hold
readOnly: true
record_type:
type: string
example: reserved_phone_number
readOnly: true
phone_number:
type: string
example: '+19705555098'
status:
type: string
enum:
- pending
- success
- failure
description: The status of the phone number's reservation.
example: success
readOnly: true
created_at:
type: string
format: date-time
description: An ISO 8901 datetime string denoting when the individual number reservation 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 the individual number reservation was updated.
example: '2018-01-01T00:00:00.000000Z'
readOnly: true
expired_at:
type: string
format: date-time
description: An ISO 8901 datetime string for when the individual number reservation is going to expire
example: '2018-01-01T00:00:00.000000Z'
readOnly: true
example:
id: 12ade33a-21c0-473b-b055-b3c836e1c292
record_type: reserved_phone_number
phone_number: '+19705555098'
status: pending
created_at: '2018-01-01T00:00:00.000000Z'
updated_at: '2018-01-01T00:00:00.000000Z'
expired_at: '2018-01-01T00:00:00.000000Z'
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
Errors:
properties:
errors:
type: array
items:
$ref: '#/components/schemas/billing-group_Error'
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
NumberReservation:
properties:
id:
type: string
format: uuid
example: 12ade33a-21c0-473b-b055-b3c836e1c292
readOnly: true
record_type:
type: string
example: number_reservation
readOnly: true
phone_numbers:
type: array
items:
$ref: '#/components/schemas/ReservedPhoneNumber'
status:
type: string
enum:
- pending
- success
- failure
description: The status of the entire reservation.
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 numbers reservation was created.
example: '2018-01-01T00:00:00.000000Z'
readOnly: true
errors:
type: string
description: Errors the reservation could happen upon
example: Number is already on hold
readOnly: true
updated_at:
type: string
format: date-time
description: An ISO 8901 datetime string for when the number reservation was updated.
example: '2018-01-01T00:00:00.000000Z'
readOnly: true
example:
id: 12ade33a-21c0-473b-b055-b3c836e1c292
record_type: number_reservation
phone_numbers:
- id: 12ade33a-21c0-473b-b055-b3c836e1c292
record_type: reserved_phone_number
phone_number: '+19705555098'
status: pending
created_at: '2018-01-01T00:00:00.000000Z'
updated_at: '2018-01-01T00:00:00.000000Z'
expired_at: '2018-01-01T00:00:00.000000Z'
errors: Number is already on hold
status: pending
customer_reference: MY REF 001
created_at: '2018-01-01T00:00:00.000000Z'
updated_at: '2018-01-01T00:00:00.000000Z'
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_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_UnprocessableEntity_73c9788e53:
description: Unprocessable entity. Check the 'detail' field in response for details.
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_73c9788e53:
description: Bad request, the request was unacceptable, often due to missing a required parameter.
content:
application/json:
schema:
$ref: '#/components/schemas/Errors'
GenericErrorResponse:
description: Unexpected error
content:
application/json:
schema:
$ref: '#/components/schemas/Errors'
NumberReservationResponse:
content:
application/json:
schema:
properties:
data:
$ref: '#/components/schemas/NumberReservation'
title: Number Reservation Response
type: object
description: Successful response with details about a number reservation.
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_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_UnprocessableEntity:
content:
application/json:
schema:
$ref: '#/components/schemas/numbers_Errors'
description: Unprocessable entity. Check the 'detail' field in response for details.
ListNumberReservationsResponse:
content:
application/json:
schema:
properties:
data:
items:
$ref: '#/components/schemas/NumberReservation'
type: array
meta:
$ref: '#/components/schemas/PaginationMeta'
title: List Number Reservations Response
type: object
description: Successful response with a list of number reservations.
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