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 Bulk Phone Number Operations API

Background jobs performed over a batch of phone numbers

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

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

This API exposes 5 operations across 5 paths, and defines 16 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 5 paths 16 schemas 2 GET3 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 Bulk Phone Number Operations 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 5 paths, the API surfaces 5 operations — 2 GET, 3 POST. Each is listed below with its method, path, parameters, and response codes.

Bulk Phone Number Operations 5

Background jobs performed over a batch of phone numbers

GET
/phone_numbers/jobs
Lists the phone numbers jobs
ListPhoneNumbersJobs 3 params → 200400401422500
POST
/phone_numbers/jobs/delete_phone_numbers
Delete a batch of numbers
CreateDeletePhoneNumbersJob body → 202400401403422500
POST
/phone_numbers/jobs/update_emergency_settings
Update the emergency settings from a batch of numbers
CreatePhoneNumbersJobUpdateEmergencySettings body → 202400401403422500
POST
/phone_numbers/jobs/update_phone_numbers
Update a batch of numbers
CreateUpdatePhoneNumbersJob 1 param body → 202400401403422500
GET
/phone_numbers/jobs/{id}
Retrieve a phone numbers job
RetrievePhoneNumbersJob 1 param → 200400401404422500

Schemas 16

The contract defines 16 schemas that model the data the API accepts and returns. The most detailed are PhoneNumbersJob (11 properties), PhoneNumbersJobUpdatePhoneNumbersRequest (9 properties), UpdatePhoneNumberVoiceSettingsRequest (9 properties), numbers_Error (5 properties). Each schema is shown below with its type and property counts.

PhoneNumbersJobDeletePhoneNumbersRequest
object
1 property 1 required
PhoneNumbersJobPendingOperation
object
2 properties
UpdatePhoneNumberVoiceSettingsRequest
object
9 properties
PhoneNumbersJobSuccessfulOperation
object
2 properties
CnamListing
object
The CNAM listing settings for a phone number.
2 properties
numbers_Error
object
5 properties
PhoneNumbersJobUpdatePhoneNumbersRequest
object
9 properties 1 required
PhoneNumbersJobFailedOperation
object
3 properties
PhoneNumbersJob
object
11 properties
PhoneNumbersJobUpdateEmergencySettingsRequest
object
3 properties 2 required
CallForwarding
object
The call forwarding settings for a phone number.
3 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
PhoneNumbersJobPhoneNumber
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

telnyx-bulk-phone-number-operations-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