Telnyx Requirement Types API
Types of requirements for international numbers and porting orders
Telnyx Requirement Types API is one of 168 APIs that Telnyx publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Requirement Types. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.
This API exposes 2 operations across 2 paths, and defines 5 schemas. It is described by OpenAPI 3.1.0, at version 2.0.0.
Requests are made against a single base URL, https://api.telnyx.com/v2.
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 6
Telnyx Requirement Types API declares
6 security schemes
for authenticating requests.
It accepts HTTP bearer tokens (bearerAuth).
It accepts HTTP bearer tokens (branded-calling_bearerAuth).
It supports OAuth 2.0 (oauthClientAuth) using the authorizationCode and clientCredentials flows, exposing 1 scope.
It accepts HTTP bearer tokens (JWT) (outbound-voice-profiles_bearerAuth).
It accepts HTTP bearer tokens (pronunciation-dicts_bearerAuth).
It accepts HTTP bearer tokens (JWT) (stored-payment-transactions_bearerAuth).
By default, every request must be authenticated.
branded-calling_bearerAuth— API key passed as a Bearer token in the Authorization headeroauthClientAuth— OAuth 2.0 authentication for Telnyx API and MCP integrationspronunciation-dicts_bearerAuth— Telnyx API v2 key. Obtain from https://portal.telnyx.com
Paths & Operations 2
Across 2 paths, the API surfaces 2 operations — 2 GET. Each is listed below with its method, path, parameters, and response codes.
Types of requirements for international numbers and porting orders
Schemas 5
The contract defines 5 schemas that model the data the API accepts and returns. The most detailed are DocReqsRequirementType (9 properties), documents_Error (5 properties), PaginationMeta (4 properties), documents_Errors (1 property). Each schema is shown below with its type and property counts.
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Telnyx 12
Other APIs Telnyx publishes across the network.