Telnyx UserAddresses API
Operations for working with UserAddress records. UserAddress records are stored addresses that users can use for non-emergency-calling purposes, such as for shipping addresses for orders of wireless SIMs (or other physical items). They cannot be used for emergency calling and are distinct from Address records, which are used on phone numbers.
Telnyx UserAddresses API is one of 168 APIs that Telnyx publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include UserAddresses. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.
This API exposes 3 operations across 2 paths, and defines 17 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 UserAddresses 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 3
Across 2 paths, the API surfaces 3 operations — 2 GET, 1 POST. Each is listed below with its method, path, parameters, and response codes.
Operations for working with UserAddress records. UserAddress records are stored addresses that users can use for non-emergency-calling purposes, such as for shipping addresses for…
Schemas 17
The contract defines 17 schemas that model the data the API accepts and returns. The most detailed are UserAddress (17 properties), UserAddressCreate (14 properties), PaginationMeta (4 properties). 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.