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
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Kin Lane

Chat with Kin

AI assistant · trained on my blog

Telnyx

Telnyx Messaging API

The Messaging API from Telnyx — 8 operation(s) for messaging.

Documentation Provider Profile APIs.io OpenAPI GitHub

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

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

This API exposes 11 operations across 8 paths, and defines 15 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 15 schemas 1 DELETE7 GET1 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
Contact
support@telnyx.com
Resource Areas
1

Authentication & Security 6

Telnyx Messaging 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, 7 GET, 1 PATCH, 2 POST. Each is listed below with its method, path, parameters, and response codes.

Messaging 11
GET
/alphanumeric_sender_ids
List alphanumeric sender IDs
ListAlphanumericSenderIds 3 params → 200401422
POST
/alphanumeric_sender_ids
Create an alphanumeric sender ID
CreateAlphanumericSenderId body → 201401422
DELETE
/alphanumeric_sender_ids/{id}
Delete an alphanumeric sender ID
DeleteAlphanumericSenderId 1 param → 200401404
GET
/alphanumeric_sender_ids/{id}
Retrieve an alphanumeric sender ID
GetAlphanumericSenderId 1 param → 200401404
GET
/messaging_hosted_numbers
List messaging hosted numbers
ListMessagingHostedNumbers 6 params → 200401
GET
/messaging_hosted_numbers/{id}
Retrieve a messaging hosted number
GetMessagingHostedNumber 1 param → 200401404
PATCH
/messaging_hosted_numbers/{id}
Update a messaging hosted number
UpdateMessagingHostedNumber 1 param body → 200401404
GET
/messaging_profile_metrics
List high-level messaging profile metrics
GetProfileMetrics 1 param → 200400401
POST
/messaging_profiles/{id}/actions/regenerate_secret
Regenerate messaging profile secret
RegenerateMessagingProfileSecret 1 param → 200401404
GET
/messaging_profiles/{id}/alphanumeric_sender_ids
List alphanumeric sender IDs for a messaging profile
ListProfileAlphanumericSenderIds 3 params → 200401404
GET
/messaging_profiles/{id}/metrics
Get detailed messaging profile metrics
GetDetailedProfileMetrics 2 params → 200400401404

Schemas 15

The contract defines 15 schemas that model the data the API accepts and returns. The most detailed are MessagingProfile (26 properties), PhoneNumberWithMessagingSettings (15 properties), AlphanumericSenderId (6 properties), NumberPoolSettings (5 properties). Each schema is shown below with its type and property counts.

ProfileMetrics
object
Detailed metrics for a messaging profile.
AlphanumericSenderId
object
6 properties
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
NumberPoolSettings
objectnull
Number Pool allows you to send messages from a pool of numbers of different types, assigning weights to each type. The pool consists of all the long code and t…
5 properties 3 required
MessagingProfile
object
26 properties
ProfileMetricsHighLevel
object
High-level metrics summary for a messaging profile.
UrlShortenerSettings
objectnull
The URL shortener feature allows automatic replacement of URLs that were generated using a public URL shortener service. Some examples include bit.do, bit.ly,…
4 properties 1 required
MessagingMetricsTimeFrame
string
The time frame for metrics aggregation.
messaging_Errors
object
1 property
UpdatePhoneNumberMessagingSettingsRequest
object
3 properties
messaging_PaginationMeta
object
4 properties 4 required
messaging_Error
object
5 properties 2 required
CreateAlphanumericSenderIdRequest
object
3 properties 2 required
PhoneNumberWithMessagingSettings
object
15 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-messaging-api-openapi.yml Raw ↑

Other APIs Telnyx publishes across the network.

Telnyx Access Tokens API
AE Profile APIs.io
Telnyx Addresses API
AE Profile APIs.io
Telnyx Advanced Number Orders API
AE Profile APIs.io
Telnyx Assistants API
AE Profile APIs.io
Telnyx Audio API
AE Profile APIs.io
Telnyx Audit Logs API
AE Profile APIs.io
Telnyx Authentication Providers API
AE Profile APIs.io
Telnyx AutoRechargePreferences API
AE Profile APIs.io
Telnyx Billing API
AE Profile APIs.io
Telnyx Billing Groups API
AE Profile APIs.io
Telnyx Brands API
AE Profile APIs.io
Telnyx Bucket SSL Certificate API
AE Profile APIs.io
#Messaging
← Back to T APIs
API Details
ID
telnyx:telnyx-messaging-api
Base URL
https://api.telnyx.com/v2
Docs
https://developers.telnyx.com/api
Provider
Telnyx
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network