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 Number Settings API

Configure your phone numbers

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

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

This API exposes 5 operations across 4 paths, and defines 9 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.

5 operations 4 paths 9 schemas 3 GET1 PATCH1 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 Number Settings 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 5

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

Number Settings 5

Configure your phone numbers

POST
/messaging_numbers_bulk_updates
Bulk update phone number profiles
BulkUpdateMessagingSettingsOnPhoneNumbers body → 2004XX
GET
/messaging_numbers_bulk_updates/{order_id}
Retrieve bulk update status
GetBulkUpdateMessagingSettingsOnPhoneNumbersStatus 1 param → 2004XX
GET
/phone_numbers/messaging
List phone numbers with messaging settings
ListPhoneNumbersWithMessagingSettings 6 params → 2004XX
GET
/phone_numbers/{id}/messaging
Retrieve a phone number with messaging settings
GetPhoneNumberMessagingSettings 1 param → 2004XX
PATCH
/phone_numbers/{id}/messaging
Update the messaging profile and/or messaging product of a phone number
UpdatePhoneNumberMessagingSettings 1 param body → 2004XX

Schemas 9

The contract defines 9 schemas that model the data the API accepts and returns. The most detailed are PhoneNumberWithMessagingSettings (15 properties), BulkMessagingSettingsUpdatePhoneNumbers (5 properties), messaging_Error (5 properties), NumberHealthMetrics (4 properties). Each schema is shown below with its type and property counts.

messaging_Errors
object
1 property
BulkMessagingSettingsUpdatePhoneNumbersRequest
object
3 properties 2 required
UpdatePhoneNumberMessagingSettingsRequest
object
3 properties
messaging_PaginationMeta
object
4 properties 4 required
MessagingFeatureSet
objectnull
The set of features available for a specific messaging use case (SMS or MMS). Features can vary depending on the characteristics the phone number, as well as i…
3 properties 3 required
messaging_Error
object
5 properties 2 required
PhoneNumberWithMessagingSettings
object
15 properties
BulkMessagingSettingsUpdatePhoneNumbers
object
5 properties
NumberHealthMetrics
object
High level health metrics about the number and it's messaging sending patterns.
4 properties 4 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

telnyx-number-settings-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