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-room-recordings-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 Room Recordings 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 Room Recordings 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: Room Recordings
description: Rooms Recordings operations.
paths:
/room_recordings:
delete:
summary: Delete several room recordings in a bulk
description: Deletes the room recordings that match the supplied filters and returns the number of recordings affected. Filters support room, session, participant, recording type, status, duration, and start or end dates.
operationId: DeleteRoomRecordings
x-endpoint-cost: heavy
tags:
- Room Recordings
parameters:
- name: filter
in: query
style: deepObject
explode: true
required: false
description: 'Consolidated filter parameter (deepObject style). Originally: filter[date_ended_at][eq], filter[date_ended_at][gte], filter[date_ended_at][lte], filter[date_started_at][eq], filter[date_started_at][gte], filter[date_started_at][lte], filter[room_id], filter[participant_id], filter[session_id], filter[status], filter[type], filter[duration_secs]'
schema:
type: object
properties:
date_ended_at:
type: object
properties:
eq:
type: string
format: date
example: '2021-04-25'
description: ISO 8601 date for filtering room recordings ended on that date.
gte:
type: string
format: date
example: '2021-04-25'
description: ISO 8601 date for filtering room recordings ended on or after that date.
lte:
type: string
format: date
example: '2021-04-25'
description: ISO 8601 date for filtering room recordings ended on or before that date.
date_started_at:
type: object
properties:
eq:
type: string
format: date
example: '2021-04-25'
description: ISO 8601 date for filtering room recordings started on that date.
gte:
type: string
format: date
example: '2021-04-25'
description: ISO 8601 date for filtering room recordings started on or after that date.
lte:
type: string
format: date
example: '2021-04-25'
description: ISO 8601 date for filtering room recordings started on or before that date.
room_id:
type: string
format: uuid
example: 0ccc7b54-4df3-4bca-a65a-3da1ecc777f0
description: room_id for filtering room recordings.
participant_id:
type: string
format: uuid
example: 0ccc7b54-4df3-4bca-a65a-3da1ecc777f0
description: participant_id for filtering room recordings.
session_id:
type: string
format: uuid
example: 0ccc7b54-4df3-4bca-a65a-3da1ecc777f0
description: session_id for filtering room recordings.
status:
type: string
example: completed
description: status for filtering room recordings.
type:
type: string
example: audio
description: type for filtering room recordings.
duration_secs:
type: integer
example: 20
description: duration_secs greater or equal for filtering room recordings.
- $ref: '#/components/parameters/video_PageConsolidated'
responses:
'201':
description: Successful response for Bulk Delete Room recordings requests
content:
application/json:
schema:
type: object
title: Bulk Room Recordings Delete Response
properties:
data:
type: object
properties:
room_recordings:
type: integer
description: Amount of room recordings affected
example: 5
'422':
$ref: '#/components/responses/UnprocessableEntity'
get:
summary: View a list of room recordings
description: Returns a paginated list of room recordings. Filter recordings by room, session, participant, recording type, status, duration, or start and end dates.
operationId: ListRoomRecordings
x-endpoint-cost: medium
tags:
- Room Recordings
parameters:
- name: filter
in: query
style: deepObject
explode: true
required: false
description: 'Consolidated filter parameter (deepObject style). Originally: filter[date_ended_at][eq], filter[date_ended_at][gte], filter[date_ended_at][lte], filter[date_started_at][eq], filter[date_started_at][gte], filter[date_started_at][lte], filter[room_id], filter[participant_id], filter[session_id], filter[status], filter[type], filter[duration_secs]'
schema:
type: object
properties:
date_ended_at:
type: object
properties:
eq:
type: string
format: date
example: '2021-04-25'
description: ISO 8601 date for filtering room recordings ended on that date.
gte:
type: string
format: date
example: '2021-04-25'
description: ISO 8601 date for filtering room recordings ended on or after that date.
lte:
type: string
format: date
example: '2021-04-25'
description: ISO 8601 date for filtering room recordings ended on or before that date.
date_started_at:
type: object
properties:
eq:
type: string
format: date
example: '2021-04-25'
description: ISO 8601 date for filtering room recordings started on that date.
gte:
type: string
format: date
example: '2021-04-25'
description: ISO 8601 date for filtering room recordings started on or after that date.
lte:
type: string
format: date
example: '2021-04-25'
description: ISO 8601 date for filtering room recordings started on or before that date.
room_id:
type: string
format: uuid
example: 0ccc7b54-4df3-4bca-a65a-3da1ecc777f0
description: room_id for filtering room recordings.
participant_id:
type: string
format: uuid
example: 0ccc7b54-4df3-4bca-a65a-3da1ecc777f0
description: participant_id for filtering room recordings.
session_id:
type: string
format: uuid
example: 0ccc7b54-4df3-4bca-a65a-3da1ecc777f0
description: session_id for filtering room recordings.
status:
type: string
example: completed
description: status for filtering room recordings.
type:
type: string
example: audio
description: type for filtering room recordings.
duration_secs:
type: integer
example: 20
description: duration_secs greater or equal for filtering room recordings.
- $ref: '#/components/parameters/video_PageConsolidated'
responses:
'200':
description: List room recordings response.
content:
application/json:
schema:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/RoomRecording'
meta:
$ref: '#/components/schemas/PaginationMeta'
4XX:
$ref: '#/components/responses/video_GenericErrorResponse'
servers:
- url: https://api.telnyx.com/v2
description: Version 2.0.0 of the Telnyx API
/room_recordings/{room_recording_id}:
delete:
summary: Delete a room recording
description: Synchronously deletes the specified video room recording. The recording's media is removed permanently.
operationId: DeleteRoomRecording
tags:
- Room Recordings
x-endpoint-cost: medium
parameters:
- name: room_recording_id
in: path
description: The unique identifier of a room recording.
required: true
schema:
type: string
format: uuid
example: 0ccc7b54-4df3-4bca-a65a-3da1ecc777f0
responses:
'204':
description: The resource was deleted successfully.
'404':
$ref: '#/components/responses/video_ResourceNotFound'
get:
summary: View a room recording
operationId: ViewRoomRecording
tags:
- Room Recordings
x-endpoint-cost: light
parameters:
- name: room_recording_id
in: path
description: The unique identifier of a room recording.
required: true
schema:
type: string
format: uuid
example: 0ccc7b54-4df3-4bca-a65a-3da1ecc777f0
responses:
'200':
description: Get room recording response.
content:
application/json:
schema:
type: object
properties:
data:
$ref: '#/components/schemas/RoomRecording'
'404':
$ref: '#/components/responses/video_ResourceNotFound'
description: Returns the recording identified by `room_recording_id`, including its room, session, participant, status, media details, lifecycle timestamps, and download URL.
servers:
- url: https://api.telnyx.com/v2
description: Version 2.0.0 of the Telnyx API
components:
responses:
video_GenericErrorResponse:
description: Unexpected error
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
example: false
message:
type: string
example: Error
video_ResourceNotFound:
description: Resource not found
content:
application/json:
schema:
$ref: '#/components/schemas/video_Error'
example:
code: string
title: string
detail: string
source:
pointer: string
parameter: string
UnprocessableEntity:
description: Unprocessable entity. Check the 'detail' field in response for details.
content:
application/json:
schema:
$ref: '#/components/schemas/Errors'
example:
errors:
- code: '10027'
title: Unprocessable Entity
detail: The server understood the syntax of the request but was unable to process the instructions.
ListRoomRecordingsResponse:
content:
application/json:
schema:
properties:
data:
items:
$ref: '#/components/schemas/RoomRecording'
type: array
meta:
$ref: '#/components/schemas/PaginationMeta'
type: object
description: List room recordings response.
video_UnprocessableEntity:
content:
application/json:
schema:
$ref: '#/components/schemas/video_Errors'
description: Unprocessable entity. Check the 'detail' field in response for details.
video_ResourceNotFound_2:
content:
application/json:
schema:
$ref: '#/components/schemas/video_Error'
description: Resource not found
GetRoomRecordingResponse:
content:
application/json:
schema:
properties:
data:
$ref: '#/components/schemas/RoomRecording'
type: object
description: Get room recording response.
BulkDeleteRoomRecordingsResponse:
content:
application/json:
schema:
properties:
data:
properties:
room_recordings:
description: Amount of room recordings affected
example: 5
type: integer
type: object
title: Bulk Room Recordings Delete Response
type: object
description: Successful response for Bulk Delete Room recordings requests
video_UnprocessableEntity_2:
description: Unprocessable entity. Check the 'detail' field in response for details.
content:
application/json:
schema:
$ref: '#/components/schemas/Errors_2'
example:
errors:
- code: '10027'
title: Unprocessable Entity
detail: The server understood the syntax of the request but was unable to process the instructions.
schemas:
RoomRecording:
type: object
properties:
id:
description: A unique identifier for the room recording.
type: string
format: uuid
example: 0ccc7b54-4df3-4bca-a65a-3da1ecc777f0
room_id:
description: Identify the room associated with the room recording.
type: string
format: uuid
example: 0ccc7b54-4df3-4bca-a65a-3da1ecc777b0
session_id:
description: Identify the room session associated with the room recording.
type: string
format: uuid
example: 0ccc7b54-4df3-4bca-a65a-3da1ecc777b0
participant_id:
description: Identify the room participant associated with the room recording.
type: string
format: uuid
example: 0ccc7b54-4df3-4bca-a65a-3da1ecc777b0
status:
description: Shows the room recording status.
type: string
example: completed
enum:
- completed
- processing
type:
description: Shows the room recording type.
type: string
example: audio
enum:
- audio
- video
size_mb:
description: Shows the room recording size in MB.
type: number
format: float
example: 10.5
download_url:
description: Url to download the recording.
type: string
example: https://www.example.com
codec:
description: Shows the codec used for the room recording.
type: string
example: opus
duration_secs:
description: Shows the room recording duration in seconds.
type: integer
example: 67
created_at:
description: ISO 8601 timestamp when the room recording was created.
type: string
format: date-time
example: '2021-03-26T17:51:59.588408Z'
updated_at:
description: ISO 8601 timestamp when the room recording was updated.
type: string
format: date-time
example: '2021-03-26T17:51:59.588408Z'
ended_at:
description: ISO 8601 timestamp when the room recording has ended.
type: string
format: date-time
example: '2021-03-26T17:51:59.588408Z'
started_at:
description: ISO 8601 timestamp when the room recording has stated.
type: string
format: date-time
example: '2021-03-26T17:51:59.588408Z'
completed_at:
description: ISO 8601 timestamp when the room recording has completed.
type: string
format: date-time
example: '2021-03-26T17:51:59.588408Z'
record_type:
type: string
example: room_recording
readOnly: true
example:
id: 6b61621f-62e0-4aad-ab11-9fd19e272e73
room_id: 7b61621f-5fe4-4aad-ab11-9fd19e272e73
session_id: 8b61621f-5fe4-4aad-ab11-9fd19e272e73
participant_id: 9b61621f-5fe4-4aad-ab11-9fd19e272e73
status: completed
download_url: https://www.example.com
type: audio
duration_secs: 3660
size_mb: 5.6
codec: opus
created_at: '2021-04-16T09:46:20.954863Z'
updated_at: '2021-04-16T10:24:55.962200Z'
started_at: '2021-04-16T09:24:55.962200Z'
ended_at: '2021-04-16T10:24:55.962200Z'
completed_at: '2021-04-16T10:25:55.962200Z'
record_type: room_session
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
video_Error:
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
additionalProperties: true
type: object
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
video_Errors:
properties:
errors:
items:
$ref: '#/components/schemas/video_Error'
type: array
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
parameters:
video_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.
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