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-voice-channels-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 Voice Channels 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 Voice Channels 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: Voice Channels
description: Voice Channels
paths:
/channel_zones:
get:
summary: List your voice channels for non-US zones
description: Returns the non-US voice channels for your account. voice channels allow you to use Channel Billing for calls to your Telnyx phone numbers. Please check the Telnyx Support Articles section for full information and examples of how to utilize Channel Billing.
operationId: GetChannelZones
tags:
- Voice Channels
parameters:
- $ref: '#/components/parameters/voice-channels_PageConsolidated'
responses:
'200':
$ref: '#/components/responses/GetGcbChannelZonesRequestResponse'
'400':
description: Bad request
'401':
description: Unauthorized
'404':
description: Resource not found
servers:
- url: https://api.telnyx.com/v2
description: Version 2.0.0 of the Telnyx API
/channel_zones/{channel_zone_id}:
parameters:
- $ref: '#/components/parameters/GcbChannelZoneId'
put:
summary: Update voice channels for non-US Zones
description: Update the number of Voice Channels for the Non-US Zones. This allows your account to handle multiple simultaneous inbound calls to Non-US numbers. Use this endpoint to increase or decrease your capacity based on expected call volume.
operationId: PatchChannelZone
tags:
- Voice Channels
requestBody:
description: Quantity of reserved channels and organizational update option
content:
application/json:
schema:
type: object
properties:
channels:
type: integer
format: int64
description: The number of reserved channels
required:
- channels
example:
channels: 0
required: true
responses:
'200':
description: Successfuly patched channel zone
content:
application/json:
schema:
$ref: '#/components/schemas/GcbChannelZone'
'400':
description: Bad request
'401':
description: Unauthorized
'404':
description: Resource not found
default:
$ref: '#/components/responses/voice-channels_GenericErrorResponse'
x-codegen-request-body-name: body
servers:
- url: https://api.telnyx.com/v2
description: Version 2.0.0 of the Telnyx API
/inbound_channels:
get:
summary: List your voice channels for US Zone
description: Returns the US Zone voice channels for your account. voice channels allows you to use Channel Billing for calls to your Telnyx phone numbers. Please check the Telnyx Support Articles section for full information and examples of how to utilize Channel Billing.
operationId: ListInboundChannels
tags:
- Voice Channels
x-endpoint-cost: medium
responses:
'200':
description: voice channels Response
content:
application/json:
schema:
type: object
properties:
data:
type: object
properties:
channels:
type: integer
description: The current number of concurrent channels set for the account
example: 7
record_type:
description: Identifies the type of the response
type: string
example: inbound_channels
'401':
description: Unauthorized
'404':
description: Resource not found
'422':
description: Unprocessable entity. Check message field in response for details.
patch:
summary: Update voice channels for US Zone
operationId: UpdateOutboundChannels
description: Update the number of Voice Channels for the US Zone. This allows your account to handle multiple simultaneous inbound calls to US numbers. Use this endpoint to increase or decrease your capacity based on expected call volume.
tags:
- Voice Channels
x-endpoint-cost: medium
requestBody:
description: Voice channels update
required: true
content:
application/json:
schema:
type: object
required:
- channels
properties:
channels:
type: integer
description: The new number of concurrent channels for the account
example: 7
responses:
'200':
description: Expected Update response
content:
application/json:
schema:
type: object
properties:
data:
type: object
properties:
channels:
type: integer
description: The number of channels set for the account
example: 7
record_type:
description: Identifies the type of the response
type: string
example: inbound_channels
'400':
description: Bad request
'401':
description: Unauthorized
'404':
description: Resource not found
default:
description: Unexpected error
content:
application/json:
schema:
properties:
errors:
type: array
items:
required:
- code
- title
properties:
code:
type: string
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
example:
errors:
- code: '10007'
title: Unexpected error
detail: An unexpected error occured.
servers:
- url: https://api.telnyx.com/v2
description: Version 2.0.0 of the Telnyx API
/list:
get:
summary: List All Numbers using Channel Billing
description: Retrieve a list of all phone numbers using Channel Billing, grouped by Zone.
operationId: GetAllNumbersChannelZones
tags:
- Voice Channels
responses:
'200':
description: A list of numbers using GCB, grouped by channel zone
content:
application/json:
schema:
type: object
properties:
data:
type: array
items:
type: object
properties:
zone_name:
type: string
example: Euro channel zone
zone_id:
type: string
example: 1653e6a1-4bfd-4857-97c6-6a51e1c34477
number_of_channels:
type: integer
example: 7
numbers:
type: array
items:
type: object
properties:
number:
type: string
example: '+15554441234'
country:
type: string
example: FR
meta:
$ref: '#/components/schemas/PaginationMeta'
'400':
description: Bad request
'401':
description: Unauthorized
'404':
description: Resource not found
servers:
- url: https://api.telnyx.com/v2
description: Version 2.0.0 of the Telnyx API
/list/{channel_zone_id}:
get:
summary: List Numbers using Channel Billing for a specific Zone
description: Retrieve a list of phone numbers using Channel Billing for a specific Zone.
operationId: GetNumbersChannelZones
tags:
- Voice Channels
parameters:
- $ref: '#/components/parameters/GcbChannelNumberZoneId'
responses:
'200':
description: A list of numbers using GCB, grouped by channel zone
content:
application/json:
schema:
type: object
properties:
data:
type: array
items:
type: object
properties:
zone_name:
type: string
example: Euro channel zone
zone_id:
type: string
example: 1653e6a1-4bfd-4857-97c6-6a51e1c34477
number_of_channels:
type: integer
example: 7
numbers:
type: array
items:
type: object
properties:
number:
type: string
example: '+15554441234'
country:
type: string
example: FR
meta:
$ref: '#/components/schemas/PaginationMeta'
'400':
description: Bad request
'401':
description: Unauthorized
'404':
description: Resource not found
servers:
- url: https://api.telnyx.com/v2
description: Version 2.0.0 of the Telnyx API
components:
parameters:
GcbChannelNumberZoneId:
name: channel_zone_id
in: path
description: Channel zone identifier
required: true
schema:
type: string
voice-channels_PageConsolidated:
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
GcbChannelZoneId:
name: channel_zone_id
in: path
description: Channel zone identifier
required: true
schema:
type: string
schemas:
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
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
GcbChannelZone:
title: Channel zone object
required:
- record_type
- countries
- id
- name
- channels
type: object
properties:
record_type:
type: string
enum:
- channel_zone
example: channel_zone
countries:
type: array
items:
type: string
description: List of countries (in ISO 3166-2, capitalized) members of the billing channel zone
example:
- BE
- EL
- LT
- PT
- BG
- ES
- LU
- RO
- CZ
- FR
- HU
- SI
- DK
- HR
- MT
- SK
- DE
- IT
- NL
- FI
- EE
- CY
- AT
- SE
- IE
- LV
- PL
id:
type: string
example: 1653e6a1-4bfd-4857-97c6-6a51e1c34477
name:
type: string
example: Euro channel zone
channels:
type: integer
format: int64
example: 7
created_at:
type: string
description: ISO 8601 formatted date of when the channel zone was created
example: '2019-01-23T18:10:02.574Z'
updated_at:
type: string
description: ISO 8601 formatted date of when the channel zone was updated
example: '2019-01-23T18:10:02.574Z'
voice-channels_Errors:
properties:
errors:
items:
$ref: '#/components/schemas/voice-channels_Error'
type: array
type: object
voice-channels_Error:
properties:
code:
type: string
detail:
type: string
meta:
additionalProperties: true
type: object
source:
properties:
parameter:
description: Indicates which query parameter caused the error.
type: string
pointer:
description: JSON pointer (RFC6901) to the offending entity.
type: string
type: object
title:
type: string
required:
- code
- title
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:
GetGcbChannelZonesRequestResponse:
description: A list of channel zones
content:
application/json:
schema:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/GcbChannelZone'
meta:
$ref: '#/components/schemas/PaginationMeta'
voice-channels_GenericErrorResponse:
description: Unexpected error
content:
application/json:
schema:
$ref: '#/components/schemas/Errors'
example:
errors:
- code: '10007'
title: Unexpected error
detail: An unexpected error occured.
PatchGcbChannelZoneRequestResponse:
content:
application/json:
schema:
$ref: '#/components/schemas/GcbChannelZone'
description: Successfuly patched channel zone
GetGcbNumbersResponse:
content:
application/json:
schema:
properties:
data:
items:
properties:
number_of_channels:
example: 7
type: integer
numbers:
items:
properties:
country:
example: FR
type: string
number:
example: '+15554441234'
type: string
type: object
type: array
zone_id:
example: 1653e6a1-4bfd-4857-97c6-6a51e1c34477
type: string
zone_name:
example: Euro channel zone
type: string
type: object
type: array
meta:
$ref: '#/components/schemas/PaginationMeta'
type: object
description: A list of numbers using GCB, grouped by channel zone
voice-channels_GenericErrorResponse_2:
content:
application/json:
schema:
$ref: '#/components/schemas/voice-channels_Errors'
description: Unexpected error
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