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 numberReservation of client.numberReservations.list()) {
  console.log(numberReservation.id);
}

{
  "data": [
    {
      "id": "12ade33a-21c0-473b-b055-b3c836e1c292",
      "record_type": "number_reservation",
      "phone_numbers": [
        {
          "id": "12ade33a-21c0-473b-b055-b3c836e1c292",
          "record_type": "reserved_phone_number",
          "phone_number": "+19705555098",
          "status": "pending",
          "created_at": "2018-01-01T00:00:00.000000Z",
          "updated_at": "2018-01-01T00:00:00.000000Z",
          "expired_at": "2018-01-01T00:00:00.000000Z",
          "errors": ""
        }
      ],
      "status": "pending",
      "customer_reference": "MY REF 001",
      "created_at": "2018-01-01T00:00:00.000000Z",
      "updated_at": "2018-01-01T00:00:00.000000Z"
    }
  ],
  "meta": {
    "total_pages": 3,
    "page_number": 2,
    "total_results": 55,
    "page_size": 25
  }
}

GET

number_reservations

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 numberReservation of client.numberReservations.list()) {
  console.log(numberReservation.id);
}

{
  "data": [
    {
      "id": "12ade33a-21c0-473b-b055-b3c836e1c292",
      "record_type": "number_reservation",
      "phone_numbers": [
        {
          "id": "12ade33a-21c0-473b-b055-b3c836e1c292",
          "record_type": "reserved_phone_number",
          "phone_number": "+19705555098",
          "status": "pending",
          "created_at": "2018-01-01T00:00:00.000000Z",
          "updated_at": "2018-01-01T00:00:00.000000Z",
          "expired_at": "2018-01-01T00:00:00.000000Z",
          "errors": ""
        }
      ],
      "status": "pending",
      "customer_reference": "MY REF 001",
      "created_at": "2018-01-01T00:00:00.000000Z",
      "updated_at": "2018-01-01T00:00:00.000000Z"
    }
  ],
  "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

filter

object

Consolidated filter parameter (deepObject style). Originally: filter[status], filter[created_at], filter[phone_numbers.phone_number], filter[customer_reference]

Show child attributes

filter[status]

string

Filter number reservations by status.

filter[created_at]

object

Filter number reservations by date range.

Show child attributes

filter[created_at][gt]

string

Filter number reservations later than this value.

filter[created_at][lt]

string

Filter number reservations earlier than this value.

filter[phone_numbers.phone_number]

string

Filter number reservations having these phone numbers.

filter[customer_reference]

string

Filter number reservations via the customer reference set.

Response

Successful response with a list of number reservations.

data

object[]

Show child attributes

data.id

string<uuid>

Example:

"12ade33a-21c0-473b-b055-b3c836e1c292"

data.record_type

string

Example:

"number_reservation"

data.phone_numbers

object[]

Show child attributes

data.phone_numbers.id

string<uuid>

Example:

"12ade33a-21c0-473b-b055-b3c836e1c292"

data.phone_numbers.record_type

string

Example:

"reserved_phone_number"

data.phone_numbers.phone_number

string

Example:

"+19705555098"

data.phone_numbers.status

enum<string>

The status of the phone number's reservation.

Available options:

pending,

success,

failure

Example:

"success"

data.phone_numbers.created_at

string<date-time>

An ISO 8901 datetime string denoting when the individual number reservation was created.

Example:

"2018-01-01T00:00:00.000000Z"

data.phone_numbers.updated_at

string<date-time>

An ISO 8901 datetime string for when the the individual number reservation was updated.

Example:

"2018-01-01T00:00:00.000000Z"

data.phone_numbers.expired_at

string<date-time>

An ISO 8901 datetime string for when the individual number reservation is going to expire

Example:

"2018-01-01T00:00:00.000000Z"

data.status

enum<string>

The status of the entire reservation.

Available options:

pending,

success,

failure

data.customer_reference

string

A customer reference string for customer look ups.

Example:

"MY REF 001"

data.created_at

string<date-time>

An ISO 8901 datetime string denoting when the numbers reservation was created.

Example:

"2018-01-01T00:00:00.000000Z"

data.updated_at

string<date-time>

An ISO 8901 datetime string for when the number reservation was updated.

Example:

"2018-01-01T00:00:00.000000Z"

Coverage

Regulatory

Searching

Ordering

Port In

Port Out

Management & Configurations

All Others

List number reservations

Authorizations

Query Parameters

Response