Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Telnyx Phone Number Configurations API

Configure your phone numbers

Telnyx Phone Number Configurations API is one of 168 APIs that Telnyx publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Phone Number Configurations. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 11 operations across 8 paths, and defines 19 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.

11 operations 8 paths 19 schemas 1 DELETE5 GET3 PATCH2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
2.0.0
Base URL
https://api.telnyx.com/v2
Authentication
HTTP Bearer, HTTP Bearer, OAuth 2.0, HTTP Bearer, HTTP Bearer, HTTP Bearer
Resource Areas
1

Authentication & Security 6

Telnyx Phone Number Configurations 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 header
  • oauthClientAuth — OAuth 2.0 authentication for Telnyx API and MCP integrations
  • pronunciation-dicts_bearerAuth — Telnyx API v2 key. Obtain from https://portal.telnyx.com

Paths & Operations 11

Across 8 paths, the API surfaces 11 operations — 1 DELETE, 5 GET, 3 PATCH, 2 POST. Each is listed below with its method, path, parameters, and response codes.

Phone Number Configurations 11

Configure your phone numbers

GET
/phone_numbers
List phone numbers
ListPhoneNumbers 4 params → 200400401404422500
POST
/phone_numbers/actions/verify_ownership
Verify ownership of phone numbers
VerifyPhoneNumberOwnership body → 200400401404422500
GET
/phone_numbers/slim
Slim List phone numbers
SlimListPhoneNumbers 5 params → 200400401404422500
GET
/phone_numbers/voice
List phone numbers with voice settings
ListPhoneNumbersWithVoiceSettings 3 params → 200400401404422500
DELETE
/phone_numbers/{id}
Delete a phone number
DeletePhoneNumber 1 param → 200400401404422500
GET
/phone_numbers/{id}
Retrieve a phone number
RetrievePhoneNumber 1 param → 200400401404422500
PATCH
/phone_numbers/{id}
Update a phone number
UpdatePhoneNumber 1 param body → 200400401404422500
PATCH
/phone_numbers/{id}/actions/bundle_status_change
Change the bundle status for a phone number (set to being in a bundle or remove from a bundle)
PhoneNumberBundleStatusChange 1 param body → 200400401404422500
POST
/phone_numbers/{id}/actions/enable_emergency
Enable emergency for a phone number
EnablePhoneNumberEmergency 1 param body → 200202400401404422500
GET
/phone_numbers/{id}/voice
Retrieve a phone number with voice settings
GetPhoneNumberVoiceSettings 1 param → 200400401404422500
PATCH
/phone_numbers/{id}/voice
Update a phone number with voice settings
UpdatePhoneNumberVoiceSettings 1 param body → 200400401404422500

Schemas 19

The contract defines 19 schemas that model the data the API accepts and returns. The most detailed are PhoneNumberDetailed (29 properties), PhoneNumberDeletedDetailed (25 properties), SlimPhoneNumberDetailed (23 properties), PhoneNumberWithVoiceSettings (14 properties). Each schema is shown below with its type and property counts.

UpdatePhoneNumberVoiceSettingsRequest
object
9 properties
PhoneNumberVerifyOwnershipRequest
object
1 property 1 required
numbers_IntId
string
Identifies the resource.
PhoneNumberEnableEmergencyRequest
object
2 properties 2 required
PhoneNumberDeletedDetailed
object
25 properties
EmergencySettings
object
The emergency services settings for a phone number.
3 properties
PhoneNumberWithVoiceSettings
object
14 properties
CnamListing
object
The CNAM listing settings for a phone number.
2 properties
numbers_Error
object
5 properties
PhoneNumberVerifyOwnershipResponse
object
3 properties
SlimPhoneNumberDetailed
object
23 properties
CallForwarding
object
The call forwarding settings for a phone number.
3 properties
UpdatePhoneNumberRequest
object
8 properties
CallRecording
object
The call recording settings for a phone number.
3 properties
numbers_Errors
object
1 property
MediaFeatures
object
The media features settings for a phone number.
3 properties
PaginationMeta
object
4 properties
PhoneNumberBundleStatusChangeRequest
object
1 property 1 required
PhoneNumberDetailed
object
29 properties 11 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

telnyx-phone-number-configurations-api-openapi.yml Raw ↑

Other APIs Telnyx publishes across the network.

Telnyx Access Tokens API
Telnyx Addresses API
Telnyx Advanced Number Orders API
Telnyx Assistants API
Telnyx Audio API
Telnyx Audit Logs API
Telnyx Authentication Providers API
Telnyx AutoRechargePreferences API
Telnyx Billing API
Telnyx Billing Groups API
Telnyx Brands API
Telnyx Bucket SSL Certificate API