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

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

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

Documentation Index

Authorizations

Body

Response