Telnyx

JavaScript

import Telnyx from 'telnyx';

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

const job = await client.phoneNumbers.jobs.retrieve('id');

console.log(job.data);

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

GET

phone_numbers

jobs

{id}

JavaScript

import Telnyx from 'telnyx';

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

const job = await client.phoneNumbers.jobs.retrieve('id');

console.log(job.data);

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

Authorizations

Authorization

string

header

required

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

Path Parameters

string

required

Identifies the Phone Numbers Job.

Response

Phone numbers job details.

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

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

Lists the phone numbers jobs Delete a batch of numbers

⌘I

AI

Real-Time Communications

WebRTC

Messaging

Numbers & Identity

IoT & Wireless

Networking

Storage & Data

Account & Billing

Other Products

SETI

OAuth

Retrieve a phone numbers job

Authorizations

Path Parameters

Response