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

{
  "data": [
    {
      "house_number": "600",
      "street_name": "Congress",
      "locality": "Austin",
      "administrative_area": "TX",
      "postal_code": "78701",
      "country_code": "US",
      "id": "0ccc7b54-4df3-4bca-a65a-3da1ecc777f1",
      "record_type": "dynamic_emergency_address",
      "sip_geolocation_id": "XYZ123",
      "status": "pending",
      "house_suffix": "<string>",
      "street_pre_directional": "<string>",
      "street_suffix": "St",
      "street_post_directional": "<string>",
      "extended_address": "<string>",
      "created_at": "2018-02-02T22:25:27.521Z",
      "updated_at": "2018-02-02T22:25:27.521Z"
    }
  ],
  "meta": {
    "total_pages": 13,
    "page_number": 3,
    "total_results": 13,
    "page_size": 1
  }
}

GET

dynamic_emergency_addresses

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

{
  "data": [
    {
      "house_number": "600",
      "street_name": "Congress",
      "locality": "Austin",
      "administrative_area": "TX",
      "postal_code": "78701",
      "country_code": "US",
      "id": "0ccc7b54-4df3-4bca-a65a-3da1ecc777f1",
      "record_type": "dynamic_emergency_address",
      "sip_geolocation_id": "XYZ123",
      "status": "pending",
      "house_suffix": "<string>",
      "street_pre_directional": "<string>",
      "street_suffix": "St",
      "street_post_directional": "<string>",
      "extended_address": "<string>",
      "created_at": "2018-02-02T22:25:27.521Z",
      "updated_at": "2018-02-02T22:25:27.521Z"
    }
  ],
  "meta": {
    "total_pages": 13,
    "page_number": 3,
    "total_results": 13,
    "page_size": 1
  }
}

Authorizations

Authorization

string

header

required

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

Query Parameters

filter

object

Consolidated filter parameter (deepObject style). Originally: filter[status], filter[country_code]

Show child attributes

filter[status]

enum<string>

Filter by status.

Available options:

pending,

activated,

rejected

filter[country_code]

string

Filter by country code.

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

Response

Dynamic Emergency Address Responses

data

object[]

Show child attributes

data.house_number

string

required

Example:

"600"

data.street_name

string

required

Example:

"Congress"

data.locality

string

required

Example:

"Austin"

data.administrative_area

string

required

Example:

"TX"

data.postal_code

string

required

Example:

"78701"

data.country_code

enum<string>

required

Available options:

US,

CA,

PR

Example:

"US"

data.id

string

Example:

"0ccc7b54-4df3-4bca-a65a-3da1ecc777f1"

data.record_type

string

Identifies the type of the resource.

Example:

"dynamic_emergency_address"

data.sip_geolocation_id

string

Unique location reference string to be used in SIP INVITE from / p-asserted headers.

Example:

"XYZ123"

data.status

enum<string>

Status of dynamic emergency address

Available options:

pending,

activated,

rejected

Example:

"pending"

data.house_suffix

string

data.street_pre_directional

string

data.street_suffix

string

Example:

"St"

data.street_post_directional

string

data.extended_address

string

data.created_at

string

ISO 8601 formatted date of when the resource was created

Example:

"2018-02-02T22:25:27.521Z"

data.updated_at

string

ISO 8601 formatted date of when the resource was last updated

Example:

"2018-02-02T22:25:27.521Z"

Coverage

Regulatory

Searching

Ordering

Port In

Port Out

Management & Configurations

All Others

List dynamic emergency addresses

Authorizations

Query Parameters

Response