Telnyx

{ "data": [ { "id": "42587e44-3a3e-46de-9255-0c9a7a1d1ec7", "record_type": "phone_numbers_job", "status": "pending", "type": "update_emergency_settings", "etc": "2020-10-30T18:10:00.000Z", "created_at": "2020-10-23T18:10:00.000Z", "updated_at": "2020-10-23T18:10:01.000Z", "phone_numbers": [ { "id": "2637816387126861836" }, { "phone_number": "+19715555098" }, { "phone_number": "+19705555099" }, { "id": "3388768018273" } ], "successful_operations": [ { "id": "2637816387126861836", "phone_number": "+19705555098" }, { "id": "33081887126861836", "phone_number": "+19715555098" } ], "pending_operations": [ { "id": "2637816387126861837", "phone_number": "+19705555099" } ], "failed_operations": [ { "id": "3388768018273", "phone_number": "+19705551234", "errors": [ { "code": "10015", "title": "Bad Request", "detail": "The field is invalid.", "source": { "pointer": "/emergency_address_id" } } ] } ] } ], "meta": { "page_number": 2, "page_size": 25, "total_pages": 3, "total_results": 55 } }

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

page

object

Consolidated page parameter (deepObject style). Originally: page[size], page[number]

Show child attributes

page[number]

integer

default:1

The page number to load

Required range: x >= 1

page[size]

integer

default:20

The size of the page

Required range: 1 <= x <= 250

sort

enum<string>

Specifies the sort order for results. If not given, results are sorted by created_at in descending order.

Available options:

created_at

Example:

"created_at"

filter

object

Consolidated filter parameter (deepObject style). Originally: filter[type]

Show child attributes

filter[type]

enum<string>

Identifies the type of the background job.

Available options:

update_emergency_settings,

delete_phone_numbers,

update_phone_numbers

Example:

"update_emergency_settings"

Response

Successful response with a list of phone numbers background jobs.

data

object[]

Show child attributes

data.id

string<uuid>

Identifies the resource.

Example:

"42587e44-3a3e-46de-9255-0c9a7a1d1ec7"

data.record_type

string

Identifies the type of the resource.

Example:

"phone_numbers_job"

data.status

enum<string>

default:pending

Indicates the completion status of the background update.

Available options:

pending,

in_progress,

completed,

failed,

expired

Example:

"pending"

data.type

enum<string>

Identifies the type of the background job.

Available options:

update_emergency_settings,

delete_phone_numbers,

update_phone_numbers

Example:

"update_emergency_settings"

data.etc

string<date-time>

ISO 8601 formatted date indicating when the estimated time of completion of the background job.

data.created_at

string

ISO 8601 formatted date indicating when the resource was created.

data.updated_at

string

ISO 8601 formatted date indicating when the resource was updated.

data.phone_numbers

object[]

Show child attributes

data.phone_numbers.phone_number

string

The phone number in e164 format.

Example:

"+19705555000"

data.phone_numbers.id

string

The phone number's ID

data.successful_operations

object[]

Show child attributes

data.successful_operations.phone_number

string

The phone number in e164 format.

data.successful_operations.id

string

The phone number's ID

data.pending_operations

object[]

Show child attributes

data.pending_operations.phone_number

string

The phone number in e164 format.

data.pending_operations.id

string

The phone number's ID

data.failed_operations

object[]

Show child attributes

data.failed_operations.phone_number

string

The phone number in e164 format.

data.failed_operations.id

string

The phone number's ID

data.failed_operations.errors

object[]

Show child attributes

data.failed_operations.errors.code

string

required

Example:

"10007"

data.failed_operations.errors.title

string

required

Example:

"Unexpected error"

data.failed_operations.errors.detail

string

Example:

"An unexpected error occured."

data.failed_operations.errors.source

object

Show child attributes

data.failed_operations.errors.source.pointer

string

JSON pointer (RFC6901) to the offending entity.

Example:

"/base"

data.failed_operations.errors.source.parameter

string

Indicates which query parameter caused the error.

data.failed_operations.errors.meta

object

Show child attributes

data.failed_operations.errors.meta.url

string

URL with additional information on the error.

Example:

"https://developers.telnyx.com/docs/overview/errors/10015"

OAuth Discovery

IP Addresses

IP Ranges

SIM Cards

Addresses

Advanced Number Orders

Assistants

Audio

Chat

Clusters

Conversations

Embeddings

Fine Tuning

Integrations

MCP Servers

Audit Logs

Authentication Providers

Phone Number Search

Billing

Billing Groups

Brands

SIM Card Actions

Bundles

User Bundles

Call Control Applications

Debugging

Call Commands

Call Information

Campaign

Voice Channels

API Reference

Phone Number Orders

Conference Commands

Connections

Country Coverage

Credential Connections

Call Recordings

Customer Service Record

Detail Records

Dialogflow Integration

Documents

Dynamic Emergency Addresses

Dynamic Emergency Endpoints

Enum

External Connections

Programmable Fax Applications

Programmable Fax Commands

FQDN Connections

FQDNs

Global IPs

Inexplicit Number Orders

Integration Secrets

Inventory Level

IP Connections

IPs

Reports

MDR Detailed Reports

Speech to Text Batch Reports

CDR Reports

MDR Usage Reports

Telco Data Usage Reports

Speech to text Usage Reports

CDR Usage Reports

Managed Accounts

Media Storage API

Messages

RCS messaging

Messaging Hosted Number

Number Configurations

Advanced OptIn/OptOut

Messaging Profiles

Messaging Tollfree Verification

Messaging URL Domains

Mobile Network Operators

Push Credentials

Coverage

Networks

Notifications

Phone Number Block Orders

Number Lookup