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 Hosted Numbers API

Manage your messaging hosted numbers

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

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

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

9 operations 7 paths 14 schemas 2 DELETE2 GET5 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 Hosted Numbers 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 9

Across 7 paths, the API surfaces 9 operations — 2 DELETE, 2 GET, 5 POST. Each is listed below with its method, path, parameters, and response codes.

Hosted Numbers 9

Manage your messaging hosted numbers

GET
/messaging_hosted_number_orders
List messaging hosted number orders
ListMessagingHostedNumberOrders 1 param → 2004XX
POST
/messaging_hosted_number_orders
Create a messaging hosted number order
CreateMessagingHostedNumberOrder body → 2004XX
POST
/messaging_hosted_number_orders/eligibility_numbers_check
Check hosted messaging eligibility
CheckEligibilityNumbers body → 200400401
DELETE
/messaging_hosted_number_orders/{id}
Delete a messaging hosted number order
DeleteMessagingHostedNumberOrder 1 param → 2004XX
GET
/messaging_hosted_number_orders/{id}
Retrieve a messaging hosted number order
GetMessagingHostedNumberOrder 1 param → 2004XX
POST
/messaging_hosted_number_orders/{id}/actions/file_upload
Upload hosted number document
UploadMessagingHostedNumberOrderFile 1 param body → 2004XX
POST
/messaging_hosted_number_orders/{id}/validation_codes
Validate hosted number codes
ValidateVerificationCodesForMessagingHostedNumberOrder 1 param body → 2004XX
POST
/messaging_hosted_number_orders/{id}/verification_codes
Create hosted number verification codes
CreateVerificationCodesForMessagingHostedNumberOrder 1 param body → 2004XX
DELETE
/messaging_hosted_numbers/{id}
Delete a messaging hosted number
DeleteMessagingHostedNumber 1 param → 2004XX

Schemas 14

The contract defines 14 schemas that model the data the API accepts and returns. The most detailed are messaging_Error (5 properties), MessagingHostedNumberOrder (5 properties), messaging_PaginationMeta (4 properties), HostedNumber (4 properties). Each schema is shown below with its type and property counts.

CreateMessagingHostedNumberOrderRequest
object
2 properties
MessagingHostedNumberOrder
object
5 properties
HostedNumber
object
4 properties
EligibilityNumbersResponse
object
1 property
CreatedVerificationCodesResponse
object
1 property 1 required
ValidationCodes
object
2 properties 2 required
EligibilityNumberResponse
object
4 properties
VerificationCodesRequest
object
2 properties 2 required
UploadFileMessagingHostedNumberOrderRequest
object
2 properties
messaging_Errors
object
1 property
EligibilityNumbersRequest
object
1 property 1 required
ValidationCodesRequest
object
1 property 1 required
messaging_PaginationMeta
object
4 properties 4 required
messaging_Error
object
5 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

telnyx-hosted-numbers-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