Skip to main content
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);
}
import os
from telnyx import Telnyx

client = Telnyx(
api_key=os.environ.get("TELNYX_API_KEY"), # This is the default and can be omitted
)
page = client.private_wireless_gateways.list()
page = page.data[0]
print(page.id)
package main

import (
"context"
"fmt"

"github.com/team-telnyx/telnyx-go"
"github.com/team-telnyx/telnyx-go/option"
)

func main() {
client := telnyx.NewClient(
option.WithAPIKey("My API Key"),
)
page, err := client.PrivateWirelessGateways.List(context.TODO(), telnyx.PrivateWirelessGatewayListParams{})
if err != nil {
panic(err.Error())
}
fmt.Printf("%+v\n", page)
}
package com.telnyx.sdk.example;

import com.telnyx.sdk.client.TelnyxClient;
import com.telnyx.sdk.client.okhttp.TelnyxOkHttpClient;
import com.telnyx.sdk.models.privatewirelessgateways.PrivateWirelessGatewayListPage;
import com.telnyx.sdk.models.privatewirelessgateways.PrivateWirelessGatewayListParams;

public final class Main {
private Main() {}

public static void main(String[] args) {
TelnyxClient client = TelnyxOkHttpClient.fromEnv();

PrivateWirelessGatewayListPage page = client.privateWirelessGateways().list();
}
}
require "telnyx"

telnyx = Telnyx::Client.new(api_key: "My API Key")

page = telnyx.private_wireless_gateways.list

puts(page)
<?php

require_once dirname(__DIR__) . '/vendor/autoload.php';

use Telnyx\Client;
use Telnyx\Core\Exceptions\APIException;

$client = new Client(apiKey: getenv('TELNYX_API_KEY') ?: 'My API Key');

try {
$page = $client->privateWirelessGateways->list(
filterCreatedAt: 'filter[created_at]',
filterIPRange: 'filter[ip_range]',
filterName: 'filter[name]',
filterRegionCode: 'filter[region_code]',
filterUpdatedAt: 'filter[updated_at]',
pageNumber: 1,
pageSize: 1,
);

var_dump($page);
} catch (APIException $e) {
echo $e->getMessage();
}
telnyx private-wireless-gateways list \
--api-key 'My API Key'
curl --request GET \
--url https://api.telnyx.com/v2/private_wireless_gateways \
--header 'Authorization: Bearer <token>'
{
  "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,
    "total_results": 55,
    "page_number": 2,
    "page_size": 25
  }
}
{
"errors": [
{
"code": "<string>",
"title": "<string>",
"detail": "<string>",
"source": {
"pointer": "<string>",
"parameter": "<string>"
},
"meta": {}
}
]
}

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[]
meta
object