Private Wireless Gateway (PGW)

Introduction

A Private Wireless Gateway (PGW) routes traffic between a group of Telnyx SIMs and the rest of its Network. Refer to this guide for more information on PGW.

Creating a PGW

Step 1: Create a Network

Follow this guide.

Step 2: Check for Coverage

Follow this guide. Use filter[available_services][contains]=private_wireless_gateway to look for a desired site at which to create the PGW. Private Wireless Gateways are available in multiple regions including Washington DC (dc2), Frankfurt (fr5), and Sydney (sy1).

Step 3: Create a PGW

Once a PGW is created on a specific network, it cannot be “migrated” to another one; it needs to be recreated on the other network. Double check the correct network_id is used in the following API request.

POST /v2/private_wireless_gateways HTTP/1.1
Host: api.telnyx.com
Content-Type: application/json
Authorization: Bearer XXX
Content-Length: 115

{
  "network_id": "f09e6854-fdef-4581-b3bc-63c2008fc4b5",
  "name": "pgw-08160937",
  "region_code": "dc2"
}

It’s not yet ready to be used immediately after the creation since its status is provisioning.

{
    "data": {
        "assigned_resources": [
            {
                "count": null,
                "record_type": "sim_card_group"
            }
        ],
        "created_at": "2024-08-16T14:37:47Z",
        "id": "2280aa63-b9b8-4d8a-867a-ff153e5ec422",
        "ip_range": "100.64.199.0/24",
        "name": "pgw-08160937",
        "network_id": "f09e6854-fdef-4581-b3bc-63c2008fc4b5",
        "record_type": "private_wireless_gateway",
        "region_code": "dc2",
        "status": {
            "error_code": null,
            "error_description": null,
            "value": "provisioning"
        },
        "updated_at": "2024-08-16T14:37:47Z"
    }
}

Step 4: Wait for Status Transition

The expected time for status.value to transition to provisioned is approximately 15 minutes. You can poll the PGW to check for status.

GET /v2/private_wireless_gateways/2280aa63-b9b8-4d8a-867a-ff153e5ec422 HTTP/1.1
Host: api.telnyx.com
Authorization: Bearer XXX

Step 5: Attach a SIM Group

The PGW is of little use when there is no SIMs are attached to it. Individual SIM must be added to a SIM group which then can be attached to the PGW. This is easily accomplished on the Mission Control Portal. PGW will show the SIM group after a successful attachment.

{
    "data": {
        "assigned_resources": [
            {
                "count": 1,
                "record_type": "sim_card_group"
            }
        ],
        "created_at": "2024-08-16T14:37:47Z",
        "id": "2280aa63-b9b8-4d8a-867a-ff153e5ec422",
        "ip_range": "100.64.199.0/24",
        "name": "pgw-08160937",
        "network_id": "f09e6854-fdef-4581-b3bc-63c2008fc4b5",
        "record_type": "private_wireless_gateway",
        "region_code": "dc2",
        "status": {
            "error_code": null,
            "error_description": null,
            "value": "provisioned"
        },
        "updated_at": "2024-08-16T15:08:15Z"
    }
}

Use Cases

In the following examples, abbreviations are consistently used for brevity.

PGW = Private Wireless Gateway
VXC = Virtual Cross Connect

Use Case 1: PGW + WireGuard Interface

We will construct this architecture which is useful when

Traffic to and from SIMs needs to be segmented and private, and
They do not need high bandwidth connection back to the user’s internal services.

In the following example

The connected device is an iPhone.
It only has access to the peers attached to the WireGuard Interface; there exists no default route for them.
Internal Service Peer is a Droplet on DigitalOcean that runs an toy Apache web server.
Admin Peer is a local host.

Detailed WireGuard Interface and Peer setup guide can be found here. On both peers, ensure that both the WireGuard Interface subnet and the PGW subnet are on the AllowedIPs of the [Peer] config.

[Peer]
PublicKey = XXX
AllowedIPs = 172.27.0.0/24, 100.64.199.0/24
Endpoint = XXX
PersistentKeepalive = XXX

From the internal service peer, we can see there is a route to the iPhone.

root@ubuntu-s-1vcpu-512mb-10gb-nyc1-01:~# traceroute 100.64.199.1
traceroute to 100.64.199.1 (100.64.199.1), 64 hops max
 172.27.0.1  21.591ms  21.000ms  20.677ms 
 *  *  * 
 *  *  * 
 *  *  * 
 100.64.199.1  885.269ms  179.245ms  171.923ms 

From the iPhone, it has access to the internal service peer.

Costs

The monthly recurring cost (MRC) for each PGW is $100.
Additional costs on SIM and data are applicable as well. Consult this guide for more detail.

Configuration

Roaming Control

Monitoring & Troubleshooting

Device Guides

For AI Agents

Private Wireless Gateway (PGW)

Introduction

Creating a PGW

Step 1: Create a Network

Step 2: Check for Coverage

Step 3: Create a PGW

Step 4: Wait for Status Transition

Step 5: Attach a SIM Group

Use Cases

Use Case 1: PGW + WireGuard Interface

Costs

API References

​Introduction

​Creating a PGW

​Step 1: Create a Network

​Step 2: Check for Coverage

​Step 3: Create a PGW

​Step 4: Wait for Status Transition

​Step 5: Attach a SIM Group

​Use Cases

​Use Case 1: PGW + WireGuard Interface

​Costs

​API References

Introduction

Creating a PGW

Step 1: Create a Network

Step 2: Check for Coverage

Step 3: Create a PGW

Step 4: Wait for Status Transition

Step 5: Attach a SIM Group

Use Cases

Use Case 1: PGW + WireGuard Interface

Costs

API References