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-queue-commands-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 Queue Commands 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 Queue Commands 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: Queue Commands
description: Queue commands operations
paths:
/queues:
get:
summary: List queues
description: List all queues for the authenticated user.
operationId: ListQueues
tags:
- Queue Commands
parameters:
- name: page[number]
in: query
description: The page number to load
required: false
schema:
type: integer
minimum: 1
default: 1
- name: page[size]
in: query
description: The size of the page
required: false
schema:
type: integer
minimum: 1
maximum: 250
default: 20
responses:
'200':
description: Successful response with a list of queues.
content:
application/json:
schema:
type: object
title: List Queues Response
properties:
data:
type: array
items:
$ref: '#/components/schemas/Queue'
meta:
$ref: '#/components/schemas/PaginationMeta'
'401':
$ref: '#/components/responses/UnauthorizedResponse'
'422':
$ref: '#/components/responses/UnprocessableEntityResponse'
post:
summary: Create a queue
description: Creates a new call queue with the provided configuration and returns the created queue.
operationId: CreateQueue
tags:
- Queue Commands
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CreateQueueRequest'
responses:
'200':
description: Successful response with details about a queue.
content:
application/json:
schema:
type: object
title: Queue Response
properties:
data:
$ref: '#/components/schemas/Queue'
'401':
$ref: '#/components/responses/UnauthorizedResponse'
'422':
$ref: '#/components/responses/UnprocessableEntityResponse'
servers:
- url: https://api.telnyx.com/v2
description: Version 2.0.0 of the Telnyx API
/queues/{queue_name}:
delete:
summary: Delete a queue
description: Permanently deletes the specified call queue from your account.
operationId: DeleteQueue
tags:
- Queue Commands
parameters:
- name: queue_name
description: Uniquely identifies the queue by name
in: path
required: true
schema:
type: string
responses:
'204':
description: Queue deleted successfully.
'401':
$ref: '#/components/responses/UnauthorizedResponse'
'404':
$ref: '#/components/responses/NotFoundResponse'
get:
summary: Retrieve a call queue
description: Returns the details of an existing call queue, including its current configuration.
operationId: RetrieveCallQueue
tags:
- Queue Commands
parameters:
- name: queue_name
description: Uniquely identifies the queue by name
in: path
required: true
schema:
type: string
responses:
'200':
description: Successful response with details about a queue.
content:
application/json:
schema:
type: object
title: Queue Response
properties:
data:
$ref: '#/components/schemas/Queue'
'404':
$ref: '#/components/responses/NotFoundResponse'
post:
summary: Update a queue
description: Update properties of an existing call queue.
operationId: UpdateQueue
tags:
- Queue Commands
parameters:
- name: queue_name
description: Uniquely identifies the queue by name
in: path
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateQueueRequest'
responses:
'200':
description: Successful response with details about a queue.
content:
application/json:
schema:
type: object
title: Queue Response
properties:
data:
$ref: '#/components/schemas/Queue'
'401':
$ref: '#/components/responses/UnauthorizedResponse'
'404':
$ref: '#/components/responses/NotFoundResponse'
'422':
$ref: '#/components/responses/UnprocessableEntityResponse'
servers:
- url: https://api.telnyx.com/v2
description: Version 2.0.0 of the Telnyx API
/queues/{queue_name}/calls:
get:
summary: Retrieve calls from a queue
description: Retrieve the list of calls in an existing queue
operationId: ListQueueCalls
tags:
- Queue Commands
parameters:
- name: queue_name
description: Uniquely identifies the queue by name
in: path
required: true
schema:
type: string
- $ref: '#/components/parameters/call-control_PageConsolidated'
responses:
'200':
description: Successful response with a list of calls in a queue.
content:
application/json:
schema:
type: object
title: List Queue Calls Response
properties:
data:
type: array
items:
$ref: '#/components/schemas/QueueCall'
meta:
$ref: '#/components/schemas/PaginationMeta'
'404':
$ref: '#/components/responses/NotFoundResponse'
servers:
- url: https://api.telnyx.com/v2
description: Version 2.0.0 of the Telnyx API
/queues/{queue_name}/calls/{call_control_id}:
delete:
summary: Force remove a call from a queue
description: Removes an inactive call from a queue. If the call is no longer active, use this command to remove it from the queue.
operationId: RemoveQueueCall
tags:
- Queue Commands
parameters:
- name: queue_name
description: Uniquely identifies the queue by name
in: path
required: true
schema:
type: string
- $ref: '#/components/parameters/CallControlId'
responses:
'204':
description: Call successfully removed from the queue
'404':
$ref: '#/components/responses/NotFoundResponse'
get:
summary: Retrieve a call from a queue
description: Retrieve an existing call from an existing queue
operationId: RetrieveCallFromQueue
tags:
- Queue Commands
parameters:
- name: queue_name
description: Uniquely identifies the queue by name
in: path
required: true
schema:
type: string
- $ref: '#/components/parameters/CallControlId'
responses:
'200':
description: Successful response with details about a call in a queue.
content:
application/json:
schema:
type: object
title: Queue Call Response
properties:
data:
$ref: '#/components/schemas/QueueCall'
'404':
$ref: '#/components/responses/NotFoundResponse'
patch:
summary: Update queued call
description: Update queued call's keep_after_hangup flag
operationId: UpdateCallInQueue
tags:
- Queue Commands
parameters:
- name: queue_name
description: Uniquely identifies the queue by name
in: path
required: true
schema:
type: string
- $ref: '#/components/parameters/CallControlId'
requestBody:
description: Update queued call request.
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateQueuedCallRequest'
responses:
'204':
description: Call has been successfully updated.
'404':
$ref: '#/components/responses/NotFoundResponse'
servers:
- url: https://api.telnyx.com/v2
description: Version 2.0.0 of the Telnyx API
components:
parameters:
call-control_PageConsolidated:
name: page
in: query
style: deepObject
explode: true
description: 'Consolidated page parameter (deepObject style). Originally: page[after], page[before], page[limit], page[size], page[number]'
schema:
type: object
properties:
after:
type: string
default: 'null'
description: Opaque identifier of next page
before:
type: string
default: 'null'
description: Opaque identifier of previous page
limit:
type: integer
minimum: 1
maximum: 250
default: 20
description: Limit of records per single page
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
CallControlId:
name: call_control_id
description: Unique identifier and token for controlling the call
in: path
required: true
schema:
type: string
responses:
UnauthorizedResponse:
description: Unauthorized. Authentication failed - the required authentication headers were either invalid or not included in the request.
content:
application/json:
schema:
$ref: '#/components/schemas/call-control_Errors'
example:
errors:
- code: '10009'
title: Authentication failed
detail: The required authentication headers were either invalid or not included in the request.
meta:
url: https://developers.telnyx.com/docs/overview/errors/10009
UnprocessableEntityResponse:
description: Unprocessable entity. The request was well-formed but could not be processed due to semantic errors. This includes validation errors, invalid parameter values, call state errors, conference errors, queue errors, recording/transcription errors, and business logic violations.
content:
application/json:
schema:
$ref: '#/components/schemas/call-control_Errors'
examples:
missing_required_parameter:
summary: Missing required parameter
value:
errors:
- code: '10004'
title: Missing required parameter
detail: The 'to' parameter is required and cannot be blank.
source:
pointer: /to
invalid_call_control_id:
summary: Invalid call control ID
value:
errors:
- code: '90015'
title: Invalid Call Control ID
detail: The call_control_id provided was not valid.
source:
pointer: /call_control_id
call_already_ended:
summary: Call has already ended
value:
errors:
- code: '90018'
title: Call has already ended
detail: This call is no longer active and can't receive commands.
call_not_answered:
summary: Call not answered yet
value:
errors:
- code: '90034'
title: Call not answered yet
detail: This call can't receive this command because it has not been answered yet.
cannot_record_before_audio_started:
summary: Cannot record before audio started
value:
errors:
- code: '90020'
title: Call recording triggered before audio started
detail: Call recording cannot be started until audio has commenced on the call.
transcription_already_active:
summary: Transcription already active
value:
errors:
- code: '90054'
title: Call transcription is already in progress
detail: Call transcription can not be started more than once.
ai_assistant_already_active:
summary: AI Assistant already active
value:
errors:
- code: '90061'
title: AI Assistant is already in progress
detail: AI Assistant cannot be started more than once.
conference_already_ended:
summary: Conference has already ended
value:
errors:
- code: '90019'
title: Conference has already ended
detail: This conference is no longer active and can't receive commands.
conference_name_conflict:
summary: Conference name conflict
value:
errors:
- code: '90033'
title: Unable to execute command
detail: Conference with given name already exists and it's active.
max_participants_reached:
summary: Maximum participants reached
value:
errors:
- code: '90032'
title: Maximum number of participants reached
detail: The maximum allowed value of `max_participants` has been reached at 100.
queue_full:
summary: Queue is full
value:
errors:
- code: '90036'
title: Queue full
detail: The 'support' queue is full and can't accept more calls.
call_already_in_queue:
summary: Call already in queue
value:
errors:
- code: '90038'
title: Call already in queue
detail: Call can't be added to a queue it's already in.
invalid_connection_id:
summary: Invalid connection ID
value:
errors:
- code: '10015'
title: Invalid value for connection_id (Call Control App ID)
detail: The requested connection_id (Call Control App ID) is either invalid or does not exist. Only Call Control Apps with valid webhook URL are accepted.
source:
pointer: /connection_id
invalid_phone_number_format:
summary: Invalid phone number format
value:
errors:
- code: '10016'
title: Phone number must be in +E164 format
detail: The 'to' parameter must be in E164 format.
source:
pointer: /to
srtp_not_supported_for_pstn:
summary: SRTP not supported for PSTN calls
value:
errors:
- source:
pointer: /media_encryption
title: Media encryption not supported for PSTN calls
detail: SRTP media encryption is not supported for PSTN calls.
code: '10011'
fork_not_found:
summary: Call is not forked
value:
errors:
- code: '90031'
title: Call is not currently forked
detail: Can't stop forking, because the call isn't currently forked.
media_streaming_used:
summary: Media streaming in use
value:
errors:
- code: '90045'
title: Media Streaming is used
detail: This command can't be issued when media streaming is used.
invalid_enumerated_value:
summary: Invalid enumerated value
value:
errors:
- code: '10032'
title: Invalid enumerated value
detail: 'The value must be one of: dual, single.'
source:
pointer: /record_channels
value_outside_range:
summary: Value outside of range
value:
errors:
- code: '10033'
title: Value outside of range
detail: The value is outside of allowed range 1 to 5000
source:
pointer: /max_participants
NotFoundResponse:
description: 'Resource not found. The requested resource does not exist. Common causes include: invalid call_control_id, conference not found, audio file not found, or recording not found.'
content:
application/json:
schema:
$ref: '#/components/schemas/call-control_Errors'
examples:
resource_not_found:
summary: Generic resource not found
value:
errors:
- code: '10007'
title: Resource not found
detail: Resource not found
conference_not_found:
summary: Conference not found
value:
errors:
- code: '90058'
title: Invalid conference_id
detail: The conference does not exist.
audio_file_not_found:
summary: Audio file not found
value:
errors:
- code: '10005'
title: Audio file not found
detail: Provided audio file URL couldn't be found.
recording_not_found:
summary: Recording not found
value:
errors:
- code: '10005'
title: Recording not found
detail: The recording could not be found. Please check the recording_id and try again.
source:
pointer: /recording_id
QueueCallResponse:
content:
application/json:
schema:
properties:
data:
$ref: '#/components/schemas/QueueCall'
title: Queue Call Response
type: object
description: Successful response with details about a call in a queue.
ListQueueCallsResponse:
content:
application/json:
schema:
properties:
data:
items:
$ref: '#/components/schemas/QueueCall'
type: array
meta:
$ref: '#/components/schemas/PaginationMeta'
title: List Queue Calls Response
type: object
description: Successful response with a list of calls in a queue.
QueueResponse:
content:
application/json:
schema:
properties:
data:
$ref: '#/components/schemas/Queue'
title: Queue Response
type: object
description: Successful response with details about a queue.
ListQueuesResponse:
content:
application/json:
schema:
properties:
data:
items:
$ref: '#/components/schemas/Queue'
type: array
meta:
$ref: '#/components/schemas/PaginationMeta'
title: List Queues Response
type: object
description: Successful response with a list of queues.
schemas:
call-control_Error:
required:
- code
- title
properties:
code:
type: string
format: integer
title:
type: string
detail:
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
UpdateQueueRequest:
type: object
title: Update Queue Request
required:
- max_size
properties:
max_size:
description: The maximum number of calls allowed in the queue.
type: integer
minimum: 1
example: 200
example:
max_size: 200
CreateQueueRequest:
type: object
title: Create Queue Request
required:
- queue_name
properties:
queue_name:
description: The name of the queue. Must be between 1 and 255 characters.
type: string
minLength: 1
maxLength: 255
example: tier_1_support
max_size:
description: The maximum number of calls allowed in the queue.
type: integer
minimum: 1
default: 300
example: 100
example:
queue_name: tier_1_support
max_size: 100
UpdateQueuedCallRequest:
type: object
title: Update Queued Call Request
properties:
keep_after_hangup:
description: Whether the call should remain in queue after hangup.
example: true
type: boolean
example:
keep_after_hangup: true
call-control_Errors:
properties:
errors:
type: array
items:
$ref: '#/components/schemas/call-control_Error'
Queue:
type: object
title: Queue
required:
- record_type
- id
- name
- current_size
- max_size
- average_wait_time_secs
- created_at
- updated_at
properties:
record_type:
type: string
enum:
- queue
example: queue
id:
type: string
description: Uniquely identifies the queue
example: 3fa85f64-5717-4562-b3fc-2c963f66afa6
name:
type: string
description: Name of the queue
example: support
created_at:
type: string
description: ISO 8601 formatted date of when the queue was created
example: '2019-01-23T18:10:02.574Z'
updated_at:
type: string
description: ISO 8601 formatted date of when the queue was last updated
example: '2019-01-23T18:10:02.574Z'
current_size:
type: integer
description: The number of calls currently in the queue
example: 20
max_size:
type: integer
description: The maximum number of calls allowed in the queue
example: 50
average_wait_time_secs:
type: integer
description: The average time that the calls currently in the queue have spent waiting, given in seconds.
example: 175
example:
record_type: queue
id: 3fa85f64-5717-4562-b3fc-2c963f66afa6
name: support
created_at: '2019-01-23T18:10:02.574Z'
updated_at: '2019-01-23T18:10:02.574Z'
current_size: 20
max_size: 50
average_wait_time_secs: 175
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
QueueCall:
type: object
title: QueueCall
required:
- call_control_id
- call_leg_id
- call_session_id
- is_alive
- record_type
- connection_id
- from
- to
- enqueued_at
- wait_time_secs
- queue_position
- queue_id
example:
call_control_id: v3:MdI91X4lWFEs7IgbBEOT9M4AigoY08M0WWZFISt1Yw2axZ_IiE4pqg
call_leg_id: 2dc6fc34-f9e0-11ea-b68e-02420a0f7768
call_session_id: 2dc1b3c8-f9e0-11ea-bc5a-02420a0f7768
record_type: queue_call
connection_id: 7267xxxxxxxxxxxxxx
from: '+18005550101'
to: '+18005550102'
enqueued_at: '2019-01-23T18:10:02.574Z'
wait_time_secs: 145
queue_position: 3
queue_id: ae1626cc-6f42-11ea-becd-02420a0f8b69
is_alive: true
properties:
record_type:
type: string
enum:
- queue_call
example: queue_call
call_session_id:
description: ID that is unique to the call session and can be used to correlate webhook events. Call session is a group of related call legs that logically belong to the same phone call, e.g. an inbound and outbound leg of a transferred call
type: string
example: 428c31b6-7af4-4bcb-b68e-5013ef9657c1
call_leg_id:
description: ID that is unique to the call and can be used to correlate webhook events
type: string
example: 428c31b6-7af4-4bcb-b7f5-5013ef9657c1
call_control_id:
description: Unique identifier and token for controlling the call.
type: string
example: v3:MdI91X4lWFEs7IgbBEOT9M4AigoY08M0WWZFISt1Yw2axZ_IiE4pqg
connection_id:
type: string
example: 7267xxxxxxxxxxxxxx
description: Call Control App ID (formerly Telnyx connection ID) used in the call.
from:
type: string
example: '+35319605860'
description: Number or SIP URI placing the call.
to:
type: string
example: '+13129457420'
description: Destination number or SIP URI of the call.
enqueued_at:
type: string
description: ISO 8601 formatted date of when the call was put in the queue
example: '2019-01-23T18:10:02.574Z'
wait_time_secs:
type: integer
description: The time the call has been waiting in the queue, given in seconds
example: 272
queue_position:
type: integer
description: Current position of the call in the queue
example: 3
queue_id:
type: string
description: Unique identifier of the queue the call is in.
example: ae1626cc-6f42-11ea-becd-02420a0f8b69
is_alive:
type: boolean
description: Indicates whether the call is still active in the queue.
example: true
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