Telnyx

JavaScript

import Telnyx from 'telnyx';

const client = new Telnyx({
  apiKey: process.env['TELNYX_API_KEY'], // This is the default and can be omitted
});

// Automatically fetches more pages as needed.
for await (const job of client.phoneNumberBlocks.jobs.list()) {
  console.log(job.id);
}

{
  "data": [
    {
      "id": "42587e44-3a3e-46de-9255-0c9a7a1d1ec7",
      "record_type": "phone_numbers_job",
      "status": "pending",
      "type": "delete_phone_number_block",
      "etc": "2020-10-30T18:10:00.000Z",
      "created_at": "2020-10-23T18:10:00.000Z",
      "updated_at": "2020-10-23T18:10:01.000Z",
      "successful_operations": [],
      "failed_operations": []
    }
  ],
  "meta": {
    "total_pages": 3,
    "page_number": 2,
    "total_results": 55,
    "page_size": 25
  }
}

GET

phone_number_blocks

jobs

JavaScript

import Telnyx from 'telnyx';

const client = new Telnyx({
  apiKey: process.env['TELNYX_API_KEY'], // This is the default and can be omitted
});

// Automatically fetches more pages as needed.
for await (const job of client.phoneNumberBlocks.jobs.list()) {
  console.log(job.id);
}

{
  "data": [
    {
      "id": "42587e44-3a3e-46de-9255-0c9a7a1d1ec7",
      "record_type": "phone_numbers_job",
      "status": "pending",
      "type": "delete_phone_number_block",
      "etc": "2020-10-30T18:10:00.000Z",
      "created_at": "2020-10-23T18:10:00.000Z",
      "updated_at": "2020-10-23T18:10:01.000Z",
      "successful_operations": [],
      "failed_operations": []
    }
  ],
  "meta": {
    "total_pages": 3,
    "page_number": 2,
    "total_results": 55,
    "page_size": 25
  }
}

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[size]

integer

default:20

The size of the page

Required range: 1 <= x <= 250

page[number]

integer

default:1

The page number to load

Required range: x >= 1

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], filter[status]

Show child attributes

filter[type]

enum<string>

Identifies the type of the background job.

Available options:

delete_phone_number_block

Example:

"delete_phone_number_block"

filter[status]

enum<string>

Identifies the status of the background job.

Available options:

pending,

in_progress,

completed,

failed

Example:

"in_progress"

Response

Successful response with a list of phone number blocks 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_number_block_job"

data.status

enum<string>

default:pending

Indicates the completion status of the background operation.

Available options:

pending,

in_progress,

completed,

failed

Example:

"pending"

data.type

enum<string>

Identifies the type of the background job.

Available options:

delete_phone_number_block

Example:

"delete_phone_number_block"

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.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.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

Example:

"10007"

data.failed_operations.errors.title

string

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"

Coverage

Regulatory

Searching

Ordering

Port In

Port Out

Management & Configurations

All Others

Lists the phone number blocks jobs

Authorizations

Query Parameters

Response