import Telnyx from 'telnyx';
const client = new Telnyx({
apiKey: 'My API Key',
});
const privateWirelessGateways = await client.privateWirelessGateways.list();
console.log(privateWirelessGateways.data);{
"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": {
"page_number": 2,
"page_size": 25,
"total_pages": 3,
"total_results": 55
}
}Get all Private Wireless Gateways belonging to the user.
import Telnyx from 'telnyx';
const client = new Telnyx({
apiKey: 'My API Key',
});
const privateWirelessGateways = await client.privateWirelessGateways.list();
console.log(privateWirelessGateways.data);{
"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": {
"page_number": 2,
"page_size": 25,
"total_pages": 3,
"total_results": 55
}
}Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
The page number to load.
x >= 1The size of the page.
1 <= x <= 250The name of the Private Wireless Gateway.
The IP address range of the Private Wireless Gateway.
The name of the region where the Private Wireless Gateway is deployed.
Private Wireless Gateway resource creation date.
When the Private Wireless Gateway was last updated.
Successful Response
Show child attributes
Identifies the resource.
"6a09cdc3-8948-47f0-aa62-74ac943d6c58"
The identification of the related network resource.
"6a09cdc3-8948-47f0-aa62-74ac943d6c58"
"private_wireless_gateway"
ISO 8601 formatted date-time indicating when the resource was created.
"2018-02-02T22:25:27.521Z"
ISO 8601 formatted date-time indicating when the resource was updated.
"2018-02-02T22:25:27.521Z"
The private wireless gateway name.
"My private wireless gateway"
The name of the region where the Private Wireless Gateway is deployed.
"dc2"
The current status or failure details of the Private Wireless Gateway.
Show child attributes
The current status or failure details of the Private Wireless Gateway. <ul>
<li><code>provisioning</code> - the Private Wireless Gateway is being provisioned.</li> <li><code>provisioned</code> - the Private Wireless Gateway was provisioned and able to receive connections.</li> <li><code>failed</code> - the provisioning had failed for a reason and it requires an intervention.</li> <li><code>decommissioning</code> - the Private Wireless Gateway is being removed from the network.</li> </ul> Transitioning between the provisioning and provisioned states may take some time.provisioning, provisioned, failed, decommissioning "provisioned"
This attribute provides a human-readable explanation of why a failure happened.
null
This attribute is an error code related to the failure reason.
null
IP block used to assign IPs to the SIM cards in the Private Wireless Gateway.
"100.64.1.0/24"
A list of the resources that have been assigned to the Private Wireless Gateway.
Was this page helpful?