openapi: 3.1.0
info:
contact:
email: support@telnyx.com
description: Telnyx provides global communications and connectivity APIs for developers — including SIP trunking, programmable voice, SMS, MMS, WhatsApp Business Messaging, Call Control, Fax, Wireless (IoT & eSIM), Phone Numbers (DID provisioning & porting), Emergency Services, and Network APIs for private interconnects and edge connectivity. Build, scale, and manage voice, messaging, and data networks with Telnyx's carrier-grade global infrastructure and API-first platform.
title: Telnyx Access Tokens Terms of Service API
version: 2.0.0
x-endpoint-cost: light
servers:
- description: Version 2.0.0 of the Telnyx API
url: https://api.telnyx.com/v2
security:
- bearerAuth: []
tags:
- description: Terms of Service agreement endpoints
name: Terms of Service
paths:
/terms_of_service/number_reputation/agree:
post:
description: 'Accept the Terms of Service for the Number Reputation product. Must be called before using Number Reputation endpoints.
Returns `400` with error code `10015` if the user has already agreed to the current ToS version.'
operationId: AgreeNumberReputationTermsOfService
responses:
'200':
description: Terms of Service accepted successfully
'400':
$ref: '#/components/responses/BadRequestTelnyx'
description: Bad request — e.g. user has already agreed to this Terms of Service version (error code 10015)
'401':
$ref: '#/components/responses/Unauthorized'
'422':
$ref: '#/components/responses/UnprocessableEntity'
summary: Agree to Number Reputation Terms of Service
tags:
- Terms of Service
x-latency-category: responsive
components:
responses:
Unauthorized:
content:
application/json:
schema:
$ref: '#/components/schemas/branded-calling_ErrorResponse'
description: Unauthorized — missing or invalid API key
BadRequestTelnyx:
content:
application/json:
schema:
$ref: '#/components/schemas/branded-calling_ErrorResponse'
description: Bad request
UnprocessableEntity:
content:
application/json:
schema:
$ref: '#/components/schemas/branded-calling_ErrorResponse'
description: Unprocessable entity — request structure is valid but contains semantic errors
schemas:
branded-calling_ErrorResponse:
properties:
errors:
items:
$ref: '#/components/schemas/TelnyxError'
type: array
type: object
TelnyxError:
properties:
code:
description: Telnyx error code
example: '10015'
type: string
detail:
description: Human-readable error detail
example: User has already agreed to Terms of Service version v1.0.0
type: string
meta:
properties:
url:
description: Link to error documentation
format: uri
type: string
type: object
source:
description: Reference to the field that caused the error
properties:
pointer:
description: JSON pointer (RFC6901) to the field that caused the error
example: /body/organization_type
type: string
type: object
title:
description: Short error title
example: Bad Request
type: string
required:
- code
- title
type: object
securitySchemes:
bearerAuth:
scheme: bearer
type: http
branded-calling_bearerAuth:
description: API key passed as a Bearer token in the Authorization header
scheme: bearer
type: http
oauthClientAuth:
description: OAuth 2.0 authentication for Telnyx API and MCP integrations
flows:
authorizationCode:
authorizationUrl: https://api.telnyx.com/v2/oauth/authorize
refreshUrl: https://api.telnyx.com/v2/oauth/token
scopes:
admin: Administrative access to Telnyx resources
tokenUrl: https://api.telnyx.com/v2/oauth/token
clientCredentials:
scopes:
admin: Administrative access to Telnyx resources
tokenUrl: https://api.telnyx.com/v2/oauth/token
type: oauth2
outbound-voice-profiles_bearerAuth:
bearerFormat: JWT
scheme: bearer
type: http
pronunciation-dicts_bearerAuth:
description: Telnyx API v2 key. Obtain from https://portal.telnyx.com
scheme: bearer
type: http
stored-payment-transactions_bearerAuth:
bearerFormat: JWT
scheme: bearer
type: http