JavaScript

import Telnyx from 'telnyx';

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

const response = await client.phoneNumberBlocks.jobs.deletePhoneNumberBlock({
  phone_number_block_id: 'f3946371-7199-4261-9c3d-81a0d7935146',
});

console.log(response.data);

{
  "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": []
  }
}

Deletes all numbers associated with a phone number block

Creates a new background job to delete all the phone numbers associated with the given block. We will only consider the phone number block as deleted after all phone numbers associated with it are removed, so multiple executions of this job may be necessary in case some of the phone numbers present errors during the deletion process.

POST

phone_number_blocks

jobs

delete_phone_number_block

JavaScript

import Telnyx from 'telnyx';

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

const response = await client.phoneNumberBlocks.jobs.deletePhoneNumberBlock({
  phone_number_block_id: 'f3946371-7199-4261-9c3d-81a0d7935146',
});

console.log(response.data);

{
  "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": []
  }
}

Authorizations

Authorization

string

header

required

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

Body

application/json

phone_number_block_id

string

required

Response

Phone number blocks job delete phone numbers requested.

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"

Example:

{
  "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": []
}

Retrieves a phone number blocks job List phone numbers

⌘I

Coverage

Regulatory

Searching

Ordering

Port In

Port Out

Management & Configurations

All Others

Deletes all numbers associated with a phone number block

Authorizations

Body

Response