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-reporting-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 Reporting 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 Reporting 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: Reporting
description: Wireless reporting operations
paths:
/wireless/detail/records/reports:
get:
summary: Get all Wireless Detail Records (WDRs) Reports
description: Returns the WDR Reports that match the given parameters.
operationId: GetWdrReports
tags:
- Reporting
parameters:
- $ref: '#/components/parameters/wireless_PageNumber'
- $ref: '#/components/parameters/wireless_PageSize'
responses:
'200':
description: Successful response
content:
application/json:
schema:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/WdrReport'
'401':
description: Unauthorized
default:
$ref: '#/components/responses/sim-cards-monitoring_wireless_GenericErrorResponse'
x-latency-category: responsive
post:
x-latency-category: background
summary: Create a Wireless Detail Records (WDRs) Report
description: Asynchronously create a report containing Wireless Detail Records (WDRs) for the SIM cards that consumed wireless data in the given time period.
operationId: CreateWdrReport
tags:
- Reporting
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/WdrReportRequest'
responses:
'201':
description: Successful response
content:
application/json:
schema:
type: object
properties:
data:
$ref: '#/components/schemas/WdrReport'
'422':
$ref: '#/components/responses/sim-cards-monitoring_wireless_UnprocessableEntity'
default:
$ref: '#/components/responses/sim-cards-monitoring_wireless_GenericErrorResponse'
servers:
- url: https://api.telnyx.com/v2
description: Version 2.0.0 of the Telnyx API
/wireless/detail/records/reports/{id}:
delete:
summary: Delete a Wireless Detail Record (WDR) Report
description: Permanently deletes the specified Wireless Detail Record (WDR) report.
operationId: DeleteWdrReport
tags:
- Reporting
parameters:
- $ref: '#/components/parameters/ResourceId'
responses:
'200':
description: Successful response
content:
application/json:
schema:
type: object
properties:
data:
$ref: '#/components/schemas/WdrReport'
'404':
$ref: '#/components/responses/wireless_ResourceNotFound'
default:
$ref: '#/components/responses/sim-cards-monitoring_wireless_GenericErrorResponse'
x-latency-category: responsive
get:
x-latency-category: background
summary: Get a Wireless Detail Record (WDR) Report
description: Returns a single Wireless Detail Record (WDR) report by its identifier, including its parameters and current status.
operationId: GetWdrReport
tags:
- Reporting
parameters:
- $ref: '#/components/parameters/ResourceId'
responses:
'200':
description: Successful response
content:
application/json:
schema:
type: object
properties:
data:
$ref: '#/components/schemas/WdrReport'
'404':
$ref: '#/components/responses/wireless_ResourceNotFound'
default:
$ref: '#/components/responses/sim-cards-monitoring_wireless_GenericErrorResponse'
servers:
- url: https://api.telnyx.com/v2
description: Version 2.0.0 of the Telnyx API
/wireless/detail_records_reports:
get:
summary: Get all Wireless Detail Records (WDRs) Reports
description: Returns the WDR Reports that match the given parameters.
operationId: GetWdrReports_2
tags:
- Reporting
parameters:
- $ref: '#/components/parameters/wireless_PageNumber_c5290d5308'
- $ref: '#/components/parameters/wireless_PageSize_c5290d5308'
responses:
'200':
description: Successful response
content:
application/json:
schema:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/WdrReport'
'401':
description: Unauthorized
default:
$ref: '#/components/responses/wireless_GenericErrorResponse_c5290d5308'
post:
x-latency-category: background
summary: Create a Wireless Detail Records (WDRs) Report
description: Asynchronously create a report containing Wireless Detail Records (WDRs) for the SIM cards that consumed wireless data in the given time period.
operationId: CreateWdrReport_2
tags:
- Reporting
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/WdrReportRequest'
responses:
'201':
description: Successful response
content:
application/json:
schema:
type: object
properties:
data:
$ref: '#/components/schemas/WdrReport'
'422':
$ref: '#/components/responses/wireless_UnprocessableEntity_c5290d5308'
default:
$ref: '#/components/responses/wireless_GenericErrorResponse_c5290d5308'
servers:
- url: https://api.telnyx.com/v2
description: Version 2.0.0 of the Telnyx API
/wireless/detail_records_reports/{id}:
delete:
summary: Delete a Wireless Detail Record (WDR) Report
description: Permanently deletes the specified Wireless Detail Record (WDR) report.
operationId: DeleteWdrReport_2
tags:
- Reporting
parameters:
- $ref: '#/components/parameters/ResourceId'
responses:
'200':
description: Successful response
content:
application/json:
schema:
type: object
properties:
data:
$ref: '#/components/schemas/WdrReport'
'404':
$ref: '#/components/responses/ResourceNotFound'
default:
$ref: '#/components/responses/wireless_GenericErrorResponse_c5290d5308'
get:
x-latency-category: background
summary: Get a Wireless Detail Record (WDR) Report
description: Returns a single Wireless Detail Record (WDR) report by its identifier, including its parameters and current status.
operationId: GetWdrReport_2
tags:
- Reporting
parameters:
- $ref: '#/components/parameters/ResourceId'
responses:
'200':
description: Successful response
content:
application/json:
schema:
type: object
properties:
data:
$ref: '#/components/schemas/WdrReport'
'404':
$ref: '#/components/responses/ResourceNotFound'
default:
$ref: '#/components/responses/wireless_GenericErrorResponse_c5290d5308'
servers:
- url: https://api.telnyx.com/v2
description: Version 2.0.0 of the Telnyx API
components:
parameters:
wireless_PageSize_c5290d5308:
name: page[size]
in: query
description: The size of the page.
schema:
type: integer
minimum: 1
maximum: 250
default: 20
wireless_PageNumber:
name: page[number]
in: query
description: The page number to load.
schema:
type: integer
minimum: 1
default: 1
wireless_PageNumber_c5290d5308:
name: page[number]
in: query
description: The page number to load.
schema:
type: integer
minimum: 1
default: 1
wireless_PageSize:
name: page[size]
in: query
description: The size of the page.
schema:
type: integer
minimum: 1
maximum: 250
default: 20
ResourceId:
name: id
description: Identifies the resource.
in: path
required: true
schema:
format: uuid
type: string
example: 6a09cdc3-8948-47f0-aa62-74ac943d6c58
schemas:
documents_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
WdrReportRequest:
type: object
properties:
start_time:
description: ISO 8601 formatted date-time indicating the start time.
type: string
example: '2018-02-02T22:25:27.521Z'
end_time:
description: ISO 8601 formatted date-time indicating the end time.
type: string
example: '2018-02-02T22:25:27.521Z'
example:
start_time: '2018-02-02T22:25:27.521Z'
end_time: '2018-02-02T22:25:27.521Z'
wireless_Errors:
properties:
errors:
type: array
items:
$ref: '#/components/schemas/wireless_Error'
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
WdrReport:
type: object
properties:
id:
type: string
format: uuid
description: Identifies the resource.
readOnly: true
example: 6a09cdc3-8948-47f0-aa62-74ac943d6c58
record_type:
type: string
readOnly: true
example: detail_records_report
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'
start_time:
description: ISO 8601 formatted date-time indicating the start time.
type: string
example: '2018-02-02T22:25:27.521Z'
end_time:
description: ISO 8601 formatted date-time indicating the end time.
type: string
example: '2018-02-02T22:25:27.521Z'
status:
description: Indicates the status of the report, which is updated asynchronously.
type: string
enum:
- pending
- complete
- failed
- deleted
example: pending
report_url:
description: The URL where the report content, when generated, will be published to.
type: string
example: http://example.com
wireless_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_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:
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.
ResourceNotFound:
description: Resource not found
content:
application/json:
schema:
$ref: '#/components/schemas/documents_Error'
wireless_ResourceNotFound:
description: Resource not found
content:
application/json:
schema:
$ref: '#/components/schemas/wireless_Error'
wireless_UnprocessableEntity_c5290d5308:
description: Unprocessable entity. Check the 'detail' field in response for details.
content:
application/json:
schema:
$ref: '#/components/schemas/Errors'
examples:
unprocessableEntity:
summary: Request could not be processed
value:
errors:
- code: '10027'
title: Unprocessable Entity
detail: The server understood the syntax of the request but was unable to process the instructions.
sim-cards-monitoring_wireless_UnprocessableEntity:
description: Unprocessable entity. Check the 'detail' field in response for details.
content:
application/json:
schema:
$ref: '#/components/schemas/wireless_Errors'
example:
errors:
- code: '10027'
title: Unprocessable Entity
detail: The server understood the syntax of the request but was unable to process the instructions.
sim-cards-monitoring_wireless_GenericErrorResponse:
description: Unexpected error
content:
application/json:
schema:
$ref: '#/components/schemas/wireless_Errors'
example:
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
CreateWdrReportResponse:
content:
application/json:
schema:
properties:
data:
$ref: '#/components/schemas/WdrReport'
type: object
description: Successful response
GetWdrReportResponse:
content:
application/json:
schema:
properties:
data:
$ref: '#/components/schemas/WdrReport'
type: object
description: Successful response
DeleteWdrReportResponse:
content:
application/json:
schema:
properties:
data:
$ref: '#/components/schemas/WdrReport'
type: object
description: Successful response
wireless_UnprocessableEntity:
content:
application/json:
schema:
$ref: '#/components/schemas/wireless_Errors'
description: Unprocessable entity. Check the 'detail' field in response for details.
GetWdrReportsResponse:
content:
application/json:
schema:
properties:
data:
items:
$ref: '#/components/schemas/WdrReport'
type: array
type: object
description: Successful response
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