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

{
  "data": [
    {
      "id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
      "network_id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
      "record_type": "private_wireless_gateway",
      "created_at": "2018-02-02T22:25:27.521Z",
      "updated_at": "2018-02-02T22:25:27.521Z",
      "name": "My private wireless gateway",
      "region_code": "dc2",
      "status": {
        "value": "provisioned",
        "error_description": null,
        "error_code": null
      },
      "ip_range": "100.64.1.0/24",
      "assigned_resources": [
        {
          "record_type": "sim_card_group",
          "count": 1
        }
      ]
    }
  ],
  "meta": {
    "total_pages": 3,
    "page_number": 2,
    "total_results": 55,
    "page_size": 25
  }
}

GET

private_wireless_gateways

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

{
  "data": [
    {
      "id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
      "network_id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
      "record_type": "private_wireless_gateway",
      "created_at": "2018-02-02T22:25:27.521Z",
      "updated_at": "2018-02-02T22:25:27.521Z",
      "name": "My private wireless gateway",
      "region_code": "dc2",
      "status": {
        "value": "provisioned",
        "error_description": null,
        "error_code": null
      },
      "ip_range": "100.64.1.0/24",
      "assigned_resources": [
        {
          "record_type": "sim_card_group",
          "count": 1
        }
      ]
    }
  ],
  "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[number]

integer

default:1

The page number to load.

Required range: x >= 1

page[size]

integer

default:20

The size of the page.

Required range: 1 <= x <= 250

filter[name]

string

The name of the Private Wireless Gateway.

filter[ip_range]

string

The IP address range of the Private Wireless Gateway.

filter[region_code]

string

The name of the region where the Private Wireless Gateway is deployed.

filter[created_at]

string

Private Wireless Gateway resource creation date.

filter[updated_at]

string

When the Private Wireless Gateway was last updated.

Response

Successful Response

data

object[]

Show child attributes

data.id

string<uuid>

Identifies the resource.

Example:

"6a09cdc3-8948-47f0-aa62-74ac943d6c58"

data.network_id

string<uuid>

The identification of the related network resource.

Example:

"6a09cdc3-8948-47f0-aa62-74ac943d6c58"

data.record_type

string

Example:

"private_wireless_gateway"

data.created_at

string

ISO 8601 formatted date-time indicating when the resource was created.

Example:

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

data.updated_at

string

ISO 8601 formatted date-time indicating when the resource was updated.

Example:

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

data.name

string

The private wireless gateway name.

Example:

"My private wireless gateway"

data.region_code

string

The name of the region where the Private Wireless Gateway is deployed.

Example:

"dc2"

data.status

object

The current status or failure details of the Private Wireless Gateway.

Show child attributes

data.status.value

enum<string>

default:provisioning

The current status or failure details of the Private Wireless Gateway.

provisioning - the Private Wireless Gateway is being provisioned.
provisioned - the Private Wireless Gateway was provisioned and able to receive connections.
failed - the provisioning had failed for a reason and it requires an intervention.
decommissioning - the Private Wireless Gateway is being removed from the network.

Transitioning between the provisioning and provisioned states may take some time.

Available options:

provisioning,

provisioned,

failed,

decommissioning

Example:

"provisioned"

data.status.error_description

string | null

This attribute provides a human-readable explanation of why a failure happened.

Example:

null

data.status.error_code

string | null

This attribute is an error code related to the failure reason.

Example:

null

data.ip_range

string

IP block used to assign IPs to the SIM cards in the Private Wireless Gateway.

Example:

"100.64.1.0/24"

data.assigned_resources

object[]

A list of the resources that have been assigned to the Private Wireless Gateway.

Show child attributes

data.assigned_resources.record_type

string

The type of the resource assigned to the Private Wireless Gateway.

Example:

"sim_card_group"

data.assigned_resources.count

integer

The current count of a resource type assigned to the Private Wireless Gateway.

Example:

1

IoT

Networking

Get all Private Wireless Gateways

Authorizations

Query Parameters

Response