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 Orders API

Number orders

Telnyx Phone Number Orders 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 Orders. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 18 operations across 13 paths, and defines 20 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.

18 operations 13 paths 20 schemas 10 GET5 PATCH3 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 Orders 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 18

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

Phone Number Orders 18

Number orders

GET
/comments
Retrieve all comments
ListComments 1 param → 200400401404422500
POST
/comments
Create a comment
CreateComment body → 200400401404422500
GET
/comments/{id}
Retrieve a comment
RetrieveComment 1 param → 200400401404422500
PATCH
/comments/{id}/read
Mark a comment as read
MarkCommentRead 1 param → 200400401404422500
GET
/number_order_phone_numbers
Retrieve a list of phone numbers associated to orders
RetrieveOrderPhoneNumbers 1 param → 200400401404422500
GET
/number_order_phone_numbers/{number_order_phone_number_id}
Retrieve a single phone number within a number order.
GetNumberOrderPhoneNumber 1 param → 200400401404422500
PATCH
/number_order_phone_numbers/{number_order_phone_number_id}
Update requirements for a single phone number within a number order.
UpdateNumberOrderPhoneNumber 1 param body → 200400401404422500
GET
/number_orders
List number orders
ListNumberOrders 2 params → 200400401404422500
POST
/number_orders
Create a number order
CreateNumberOrder body → 200400401404422500
GET
/number_orders/{number_order_id}
Retrieve a number order
RetrieveNumberOrder 1 param → 200400401404422500
PATCH
/number_orders/{number_order_id}
Update a number order
UpdateNumberOrder 1 param body → 200400401404422500
GET
/sub_number_orders
List sub number orders
ListSubNumberOrders 1 param → 200400401404422500
GET
/sub_number_orders/{sub_number_order_id}
Retrieve a sub number order
GetSubNumberOrder 2 params → 200400401404422500
PATCH
/sub_number_orders/{sub_number_order_id}
Update a sub number order's requirements
UpdateSubNumberOrder 1 param body → 200400401404422500
PATCH
/sub_number_orders/{sub_number_order_id}/cancel
Cancel a sub number order
CancelSubNumberOrder 1 param → 200400401404422500
POST
/sub_number_orders_report
Create a sub number orders report
CreateSubNumberOrdersReport body → 202400401422500
GET
/sub_number_orders_report/{report_id}
Retrieve a sub number orders report
GetSubNumberOrdersReport 1 param → 200400401404422500
GET
/sub_number_orders_report/{report_id}/download
Download a sub number orders report
DownloadSubNumberOrdersReport 1 param → 200400401404422500

Schemas 20

The contract defines 20 schemas that model the data the API accepts and returns. The most detailed are NumberOrderPhoneNumber (15 properties), SubNumberOrder (14 properties), NumberOrderWithPhoneNumbers (13 properties), NumberOrder (13 properties). Each schema is shown below with its type and property counts.

SubNumberOrderRegulatoryRequirement
object
3 properties
Comment
object
9 properties
NumberOrderPhoneNumber
object
15 properties
NumberOrder
object
13 properties
PhoneNumber
object
11 properties
UpdateNumberOrderRequest
object
2 properties
ReadComment
numbers_Error
object
5 properties
UpdateNumberOrderPhoneNumberRequest
object
1 property
NumberOrderWithPhoneNumbers
object
13 properties
UpdateRegulatoryRequirement
object
2 properties
CreateNumberOrderRequest
object
5 properties
CreateSubNumberOrdersReportRequest
object
6 properties
numbers_Errors
object
1 property
UpdateSubNumberOrderRequest
object
1 property
SubNumberOrder
object
14 properties
PaginationMeta
object
4 properties
SubNumberOrdersReport
object
7 properties
PhoneNumbersJobPhoneNumber
object
2 properties
SubNumberOrderRegulatoryRequirementWithValue
object
4 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

telnyx-phone-number-orders-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