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-ota-updates-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 OTA updates 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 OTA updates 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: OTA Updates
description: OTA updates operations
paths:
/ota_updates:
get:
summary: List OTA updates
operationId: ListOtaUpdates
tags:
- OTA Updates
parameters:
- $ref: '#/components/parameters/FilterOTAUpdatesConsolidated'
- $ref: '#/components/parameters/wireless_PageConsolidated_c5290d5308'
responses:
'200':
description: Successful response
content:
application/json:
schema:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/SimplifiedOTAUpdate'
meta:
$ref: '#/components/schemas/PaginationMeta'
'401':
description: Unauthorized
default:
$ref: '#/components/responses/wireless_GenericErrorResponse_c5290d5308'
description: Retrieve a paginated list of over-the-air (OTA) update operations for your SIM cards.
servers:
- url: https://api.telnyx.com/v2
description: Version 2.0.0 of the Telnyx API
/ota_updates/{id}:
get:
summary: Get OTA update
description: This API returns the details of an Over the Air (OTA) update.
operationId: GetOtaUpdate
tags:
- OTA Updates
parameters:
- $ref: '#/components/parameters/ResourceId'
responses:
'200':
description: Successful response
content:
application/json:
schema:
type: object
properties:
data:
$ref: '#/components/schemas/CompleteOTAUpdate'
'401':
description: Unauthorized
default:
$ref: '#/components/responses/wireless_GenericErrorResponse_c5290d5308'
servers:
- url: https://api.telnyx.com/v2
description: Version 2.0.0 of the Telnyx API
components:
responses:
wireless_GenericErrorResponse_c5290d5308:
description: Unexpected error
content:
application/json:
schema:
$ref: '#/components/schemas/Errors'
examples:
unexpectedError:
summary: Unexpected API error
value:
errors:
- code: '10007'
title: Unexpected error
detail: An unexpected error occured.
wireless_GenericErrorResponse:
content:
application/json:
schema:
$ref: '#/components/schemas/wireless_Errors'
description: Unexpected error
OTAUpdateResponse:
content:
application/json:
schema:
properties:
data:
$ref: '#/components/schemas/CompleteOTAUpdate'
type: object
description: Successful response
SearchOTAUpdateResponse:
content:
application/json:
schema:
properties:
data:
items:
$ref: '#/components/schemas/SimplifiedOTAUpdate'
type: array
meta:
$ref: '#/components/schemas/PaginationMeta'
type: object
description: Successful response
schemas:
SimplifiedOTAUpdate:
type: object
title: OTAUpdate
description: This object represents an Over the Air (OTA) update request. It allows tracking the current status of a operation that apply settings in a particular SIM card. <br/><br/>
properties:
id:
type: string
format: uuid
description: Identifies the resource.
readOnly: true
example: 6a09cdc3-8948-47f0-aa62-74ac943d6c58
record_type:
type: string
example: ota_update
readOnly: true
sim_card_id:
type: string
format: uuid
description: The identification UUID of the related SIM card resource.
example: 6a09cdc3-8948-47f0-aa62-74ac943d6c58
type:
type: string
description: Represents the type of the operation requested. This will relate directly to the source of the request.
enum:
- sim_card_network_preferences
example: sim_card_network_preferences
status:
type: string
enum:
- in-progress
- completed
- failed
example: in-progress
created_at:
type: string
description: ISO 8601 formatted date-time indicating when the resource was created.
readOnly: true
example: '2018-02-02T22:25:27.521Z'
updated_at:
type: string
description: ISO 8601 formatted date-time indicating when the resource was updated.
readOnly: true
example: '2018-02-02T22:25:27.521Z'
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
CompleteOTAUpdate:
type: object
title: OTAUpdate
description: This object represents an Over the Air (OTA) update request. It allows tracking the current status of a operation that apply settings in a particular SIM card. <br/><br/>
properties:
id:
type: string
format: uuid
description: Identifies the resource.
readOnly: true
example: 6a09cdc3-8948-47f0-aa62-74ac943d6c58
record_type:
type: string
example: ota_update
readOnly: true
sim_card_id:
type: string
format: uuid
description: The identification UUID of the related SIM card resource.
example: 6a09cdc3-8948-47f0-aa62-74ac943d6c58
type:
type: string
description: Represents the type of the operation requested. This will relate directly to the source of the request.
enum:
- sim_card_network_preferences
example: sim_card_network_preferences
status:
type: string
enum:
- in-progress
- completed
- failed
example: in-progress
settings:
type: object
description: A JSON object representation of the operation. The information present here will relate directly to the source of the OTA request.
properties:
mobile_network_operators_preferences:
$ref: '#/components/schemas/MobileNetworkOperatorsPreferencesResponse'
created_at:
type: string
description: ISO 8601 formatted date-time indicating when the resource was created.
readOnly: true
example: '2018-02-02T22:25:27.521Z'
updated_at:
type: string
description: ISO 8601 formatted date-time indicating when the resource was updated.
readOnly: true
example: '2018-02-02T22:25:27.521Z'
example:
created_at: '2018-02-02T22:25:27.521Z'
id: 6a09cdc3-8948-47f0-aa62-74ac943d6c58
record_type: ota_update
settings:
mobile_network_operators_preferences:
- mobile_network_operator_id: 6a09cdc3-8948-47f0-aa62-74ac943d6c58
mobile_network_operator_name: AT&T Mobility (USACG)
priority: 0
sim_card_id: 6a09cdc3-8948-47f0-aa62-74ac943d6c58
status: in-progress
type: sim_card_network_preferences
updated_at: '2018-02-02T22:25:27.521Z'
MobileNetworkOperatorsPreferencesResponse:
type: array
description: A list of mobile network operators and the priority that should be applied when the SIM is connecting to the network.
items:
$ref: '#/components/schemas/MobileNetworkOperatorPreferencesResponse'
MobileNetworkOperatorPreferencesResponse:
description: ''
type: object
properties:
mobile_network_operator_id:
type: string
format: uuid
description: The mobile network operator resource identification UUID.
example: 6a09cdc3-8948-47f0-aa62-74ac943d6c58
mobile_network_operator_name:
type: string
description: The mobile network operator resource name.
example: AT&T Mobility (USACG)
priority:
type: integer
description: It determines what is the priority of a specific network operator that should be assumed by a SIM card when connecting to a network. The highest priority is 0, the second highest is 1 and so on.
example: 0
wireless_Errors:
properties:
errors:
items:
$ref: '#/components/schemas/wireless_Error'
type: array
type: object
wireless_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
parameters:
FilterOTAUpdatesConsolidated:
name: filter
in: query
explode: true
description: 'Consolidated filter parameter for OTA updates (deepObject style). Originally: filter[status], filter[sim_card_id], filter[type]'
schema:
type: object
properties:
status:
type: string
enum:
- in-progress
- completed
- failed
example: in-progress
description: Filter by a specific status of the resource's lifecycle.
sim_card_id:
type: string
description: The SIM card identification UUID.
type:
type: string
enum:
- sim_card_network_preferences
example: sim_card_network_preferences
description: Filter by type.
wireless_PageConsolidated_c5290d5308:
name: page
in: query
explode: true
description: 'Consolidated pagination parameter (deepObject style). Originally: page[number], page[size]'
schema:
type: object
properties:
number:
type: integer
minimum: 1
default: 1
description: The page number to load.
size:
type: integer
minimum: 1
maximum: 250
default: 20
description: The size of the page.
ResourceId:
name: id
description: Identifies the resource.
in: path
required: true
schema:
format: uuid
type: string
example: 6a09cdc3-8948-47f0-aa62-74ac943d6c58
wireless_PageConsolidated:
description: 'Consolidated pagination parameter (deepObject style). Originally: page[number], page[size]'
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
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