Telnyx Wireless: Data — Full Documentation

Complete page content for Data (Wireless section) of the Telnyx developer docs (https://developers.telnyx.com). This file: https://developers.telnyx.com/development/llms/wireless-data-llms-full-txt.md · Root index: https://developers.telnyx.com/llms.txt

Configuration

Public IPs

Source: https://developers.telnyx.com/docs/iot-sim/public-ips.md

By default, SIMs get dynamic private IPs — reachable outbound only. A public static IP makes the SIM reachable from the internet ($3/mo per SIM).

Actions

Action	Endpoint
Get Public IP	`GET /sim_cards/{id}/public_ip`
Set Public IP	`POST /sim_cards/{id}/actions/set_public_ip`
Remove Public IP	`POST /sim_cards/{id}/actions/remove_public_ip`
Bulk Set Public IPs	`POST /sim_cards/actions/bulk_set_public_ips`

When to Use

Inbound access — connect to your SIM from anywhere (SSH, remote management, server-initiated requests)
Firewall allowlists — stable IP for access control rules
Device-as-server — run services on the device that external systems call into

Private Wireless Gateways

Source: https://developers.telnyx.com/docs/iot-sim/private-wireless-gateways.md

A Private Wireless Gateway (PWG) routes all SIM traffic through your own private network. SIMs connected via a PWG sit inside your private IP space — not on the public internet.

Why PWG

Security — SIMs are not directly exposed to the internet
Control — route traffic through your own firewall or DLP platform
Direct access — devices are addressable on your corporate network like any other host

Architecture

PWGs connect to a VRF-defined network on Telnyx’s MPLS backbone. Virtual Cross Connects (VXC) or WireGuard interfaces (Cloud VPNs) bridge this to your corporate network. All interfaces on the same VRF can see each other.

API

Action	Endpoint
List PWGs	`GET /private_wireless_gateways`
Create PWG	`POST /private_wireless_gateways`
Get PWG	`GET /private_wireless_gateways/{id}`
Delete PWG	`DELETE /private_wireless_gateways/{id}`

Assign a PWG to a SIM Card Group via group actions. All SIMs in the group route through the PWG.

APN-based IP Assignment

APN	IP Assignment
`data.net`	Static — same IP across sessions
`data00.telnyx`	Dynamic — new IP each session

To use a static IP, your device must connect using the data.net APN. Devices on data00.telnyx get dynamic IPs.

Limitations

Region — PWGs are currently only available in Ashburn, VA. More regions coming.
IP range — Default 100.64.199.0/24 (254 concurrent SIMs). Custom ranges coming.
Internet access — PWGs have no internet access by default. Contact support to open your VRF to the internet.

Setup

See Private Gateway Setup for step-by-step instructions.

Private Gateway Setup

Source: https://developers.telnyx.com/docs/iot-sim/private-wireless-gateway-how-to.md

Step 1: Set up Cloud VPN

Navigate to the Network section in the portal. Select “Create Network”.
Set the network name and click “Create”.
Add a VPN Interface, create a name, click “Create”.
Wait for provisioning to complete, click “Next Step”.
Add a peer for the VPN — choose a name, click “Create Peer”.
Store the Private Key safely.
Skip “Buy global IP” if not needed.

Step 2: Create a Private Wireless Gateway

Select “Create PWG Interface” in the Wireless section of the portal.
Name it and select the network from Step 1. Region must match the VPN interface.
Accept the MRC charge.
Wait for status to transition from Provisioning to Provisioned.
Create a SIM Group, then edit it and click “Connect PWG” to assign the PWG.
Add SIM cards to the group — individually or via bulk action “Manage SIM Cards Setting”.

Step 3: Configure routing

The network default gateway must be set up by the Telnyx Network team manually. Contact support via the Mission Control Portal chat. Once configured, you can control which external destinations are reachable from devices connected through the PWG, and which are blocked.

Traffic Policies

Source: https://developers.telnyx.com/docs/iot-sim/traffic-policy-profiles.md

Traffic Policy Profiles define what network traffic your SIMs are allowed (or denied). Assign a profile to filter traffic at the network level before it reaches your devices.

Profile Types

Type	Behavior
whitelist	Only listed traffic is allowed. Everything else is blocked.
blacklist	Listed traffic is blocked. Everything else is allowed.
throttling	Traffic is allowed but bandwidth-limited to `limit_bw_kbps`.

Filter Criteria

Each profile can include one or more of:

services — PCEF service IDs (predefined traffic categories). Use GET /traffic/policy/profiles/services to list available services.
ip_ranges — CIDR notation (10.0.0.0/8, 203.0.113.0/24). Block or allow specific IP ranges.
domains — Domain names (example.com, *.internal.corp). DNS-level filtering.

At least one of services, ip_ranges, or domains is required when creating a profile.

Example: IoT Device Lockdown

Whitelist-only profile that restricts a fleet of sensors to your backend servers:

{
  "type": "whitelist",
  "ip_ranges": ["10.100.0.0/16"],
  "domains": ["api.yourcompany.com", "telemetry.yourcompany.com"]
}

Devices can only reach your internal network and two API endpoints. All other traffic is dropped.

Example: Bandwidth Throttling

Limit data-hungry devices to prevent runaway costs:

{
  "type": "throttling",
  "limit_bw_kbps": 256
}

Assigning Profiles

Profiles are assigned at the SIM Card Group level. Create the profile via POST /traffic/policy/profiles, then reference its ID when configuring the group.

Blocklists

Source: https://developers.telnyx.com/docs/iot-sim/wireless-blocklists.md

Wireless Blocklists let you restrict which networks your SIMs can attach to. Assign a blocklist to a SIM Card Group and every SIM in that group is blocked from the listed networks.

Blocklist Types

Type	Blocks By	Example Value	Use Case
country	ISO country code	`US`, `CN`, `RU`	Geo-fencing — keep devices in allowed regions
mcc	Mobile Country Code	`310` (US), `234` (UK)	Block all carriers in a country
plmn	MCC + MNC pair	`31026` (T-Mobile US)	Block a specific carrier

Use GET /wireless_blocklist_values to retrieve all valid values for a given type.

How It Works

Create a blocklist — POST /wireless_blocklists with a name, type, and values array.
Assign to a SIM Card Group — Set wireless_blocklist_id on the group via PATCH /sim_card_groups/{id}.
All SIMs in that group are now blocked from the listed networks.

One blocklist per group. Changing the blocklist on a group affects all SIMs in it immediately.

Common Patterns

Geo-fencing: Create a country blocklist with countries where your devices shouldn’t operate. Useful for compliance, cost control, or preventing stolen device use. Carrier avoidance: Create a plmn blocklist to steer SIMs away from expensive or unreliable carriers in a region. The SIM’s multi-IMSI applet will select the next best available network. Security lockdown: Block all networks except your target deployment region. Combined with Private Wireless Gateways, this creates a fully controlled connectivity path.

Usage Alerts

Source: https://developers.telnyx.com/docs/iot-sim/data-usage-notifications.md

Data Limits

Limits can be set at two levels:

Level	Set Via	Scope
Group	`PATCH /sim_card_groups/{id}`	All SIMs in the group share the limit. SIMs exceeding it enter `data_limit_exceeded`. Resets monthly.
SIM	`PATCH /sim_cards/{id}`	Per-SIM `data_limit` override.

Per-SIM Usage Notifications

Set a threshold on individual SIMs to get notified before they hit their limit.

Action	Endpoint
List Notifications	`GET /sim_card_data_usage_notifications`
Create Notification	`POST /sim_card_data_usage_notifications`
Get Notification	`GET /sim_card_data_usage_notifications/{id}`
Update Notification	`PATCH /sim_card_data_usage_notifications/{id}`
Delete Notification	`DELETE /sim_card_data_usage_notifications/{id}`

Monitoring Consumption

Per group — GET /sim_card_groups/{id} returns consumed_data.
Per SIM — visible in the SIM card detail response.
Portal — Settings page shows real-time consumption per group.

Monitoring & Troubleshooting

API errors

Source: https://developers.telnyx.com/docs/iot-sim/api-errors.md

Wireless endpoints can return the standard Telnyx errors envelope as well as legacy or status-only responses. When the response includes errors, branch on errors[].code and use errors[].detail and errors[].source for diagnostics. For responses whose API reference does not define an errors envelope—such as some 401 and 404 responses—branch on the HTTP status instead; the body may be absent or use a legacy single-error shape.

{
  "errors": [
    {
      "code": "70007",
      "title": "SIM card doesn't have a SIM card group",
      "detail": "A SIM card cannot be enabled unless it's associated with a SIM card group."
    }
  ]
}

Authentication, authorization, missing-resource, rate-limit, and other general request failures can use the general API error codes. Wireless validation failures can instead return product-specific codes such as 70002 and 70003; use the response shape documented for the operation together with the Wireless code guidance below.

Wireless error codes

Code	Title	Detail	Action
70000	Consumption reached data limit	The consumption reached the defined data limit. Please, update the SIM card group data limit.	Increase the SIM card group’s data limit before retrying the operation.
70001	There aren’t enough available SIM cards	Insufficient inventory to satisfy order request.	Reduce the requested quantity or retry when sufficient inventory is available.
70002	Invalid data format	The provided data attribute was invalid.	Compare the rejected attribute with the endpoint’s request schema, correct its format, and retry.
70003	Mobile operators’ preferences priorities are out of sequence	The mobile operators’ preferences priorities should be in an ascending order starting by 0.	Renumber the priorities as a contiguous sequence beginning with `0`, then retry.
70004	OTA update in progress	SIM card network preferences can’t be defined when a previous OTA update is still in progress.	Wait for the current OTA update to finish before changing network preferences.
70005	Could not delete SIM card group	The SIM card group associated with the provided ID can not be deleted because there are SIM cards associated with the SIM card group.	Move the associated SIM cards to another group before deleting this group.
70006	Could not delete default SIM card group	The SIM card group associated with the provided ID can not be deleted because it is the default SIM card group on your account.	Do not retry deletion of the default group; select a non-default group for deletion.
70007	SIM card doesn’t have a SIM card group	A SIM card cannot be enabled unless it’s associated with a SIM card group.	Assign the SIM card to a SIM card group, then retry the enable request.
70008	Public IPs are unavailable at this time	There aren’t any public IPs available at this time. Please contact Telnyx support for more information.	Contact Telnyx support before retrying public IP allocation.

Recovery pattern

Record the HTTP status, errors[].code, errors[].detail, and any errors[].source value.
Correct terminal request or resource-state errors before retrying. Repeating the same request does not resolve codes such as 70002, 70003, 70005, 70006, or 70007.
For in-progress state (70004), wait for the existing OTA update to finish, then retry.
For capacity errors (70001, 70008), change the request as described above or wait for availability; contact support when the error detail instructs you to do so.

See SIM lifecycle, SIM card groups, OTA updates, and public IPs for the related workflows.

Troubleshooting

Source: https://developers.telnyx.com/docs/iot-sim/connectivity-troubleshooting.md

Step 1: Check device configuration

Enable cellular data
Set network to 3G/LTE or 4G/LTE only (first registration requires at least 3G)
Enable roaming
Set APN: Name: Telnyx APN: data00.telnyx (leave all other fields blank)
Update firmware, then reboot

Android: Settings → Mobile Networks → Access Point Names → Add iOS: Settings → Cellular → Mobile Data → APN

Step 2: Check connectivity logs

View logs via portal (click SIM ICCID → Connectivity Logs) or API:

GET /sim_cards/{id}/wireless_connectivity_logs

The type column shows Registration or Data. MCC identifies the country, MNC identifies the carrier.

Step 3: Diagnose patterns

No connectivity logs at all

Connection isn’t reaching Telnyx. Device may be on a network Telnyx can’t access, misconfigured, or SIM is deactivated.
Fix: Scan networks and manually select one. Verify device config (Step 1). Check SIM status in portal — may be disabled due to data limit or billing.

Multiple registration attempts, no data

SIM isn’t authenticating.
Fix: Enable data roaming. Verify APN is data00.telnyx.

Registration succeeds but no data sessions

Data sessions not being created.
Fix: Enable data roaming. Verify APN is data00.telnyx.

If issues persist, contact support via the Mission Control Portal.

Detail Records

Source: https://developers.telnyx.com/docs/iot-sim/wireless-detail-records.md

Wireless Detail Records (WDRs) provide granular, per-session usage data for your SIM fleet. Each record captures a single data session — when it started, how long it lasted, bytes transferred, and which network was used.

Generating Reports

WDR reports are async. Request one, poll for completion, download when ready.

Create — POST /wireless/detail/records/reports with a time range:

{
  "start_time": "2026-04-01T00:00:00Z",
  "end_time": "2026-04-07T00:00:00Z"
}

Poll — GET /wireless/detail/records/reports/{id} until status is complete.
Download — The report_url field contains a pre-signed URL to the report file.

What’s in a Report

Each record includes:

Field	Description
`sim_card_id`	Which SIM
`start_time` / `stop_time`	Session duration
`radio_access_technology`	LTE, 3G, etc.
`mobile_country_code` + `mobile_network_code`	Which carrier
`apn`	Access Point Name used
`ipv4` / `ipv6`	IP assigned during session
`cell_id`	Cell tower

Connectivity Logs

For real-time session visibility (not batch reports), use connectivity logs: GET /sim_cards/{id}/wireless_connectivity_logs Returns recent sessions for a specific SIM, including IMSI, IMEI, radio technology, and connection state. Useful for debugging why a device can’t connect or which network it attached to.

Use Cases

Billing reconciliation — match data usage against your invoices
Anomaly detection — spot SIMs consuming unexpected data volumes
Coverage analysis — see which carriers your devices attach to by region
Troubleshooting — correlate connectivity issues with specific cells or networks

OTA Updates

Source: https://developers.telnyx.com/docs/iot-sim/ota-updates.md

OTA (Over-The-Air) updates let Telnyx push configuration changes to your SIMs remotely. No physical access needed — updates are delivered to the SIM’s on-card applet the next time the device connects.

What Gets Updated

OTA updates handle SIM-level configuration: IMSI profile switches, network preference changes, and applet settings. These are not firmware updates for the device itself — they modify the SIM card’s internal state. The type field on each update indicates the operation source and what changed.

Tracking Updates

List updates for your fleet:

GET /ota_updates

Or check a specific update:

GET /ota_updates/{id}

Each update includes:

Field	Description
`sim_card_id`	Target SIM
`type`	Operation type — relates to the source of the request
`status`	Current state of the update
`settings`	JSON object with the specific changes applied
`created_at`	When the update was initiated

How It Works

Telnyx queues the update for the target SIM.
The next time the device attaches to the network, the SIM’s applet receives the update.
The update applies automatically. Status transitions from pending to complete (or failed).

There’s no way to force immediate delivery — it depends on when the device next connects. For always-on devices this is near-instant. For devices that sleep or power cycle, it happens on next wake.

Multi-IMSI Context

The most common OTA operation is IMSI profile switching. Telnyx SIMs carry multiple IMSIs, and the on-card applet auto-selects the best one per location. OTA updates can override this selection or push updated IMSI profiles when Telnyx adds new carrier partnerships.

Device Guides

AT Commands

Source: https://developers.telnyx.com/docs/iot-sim/at-commands.md

Original location: Wireless > IoT > at-commands This document contains some useful AT commands to interact with Raspberry Pi HAT cellular modules.

Prerequisites to complete before running AT commands:

Make sure the raspberry Pi is up-to-date and the serial port is enabled. To enable the serial port run this command and then follow the prompts as shown:

sudo raspi-config
Choose Interfacing Options (5):
Choose P6 Serial:
Press No to the prompt below then Reboot.

The package, screen, should be installed by default on your Linux distro. If not, you can install it via, sudo apt or sudo yum install screen. You may also use minicom if you want additional customization. screen defaults to ttyS0 unless otherwise specified.

Sample Command: screen ttyUSB3 or screen ttyS0
To see which port your device is connected to, you can run ls -l /dev.
Debian Repository for accessing specific versions:
- https://packages.debian.org/bullseye/screen
- https://launchpad.net/ubuntu/+source/minicom

Now that you know how to run AT commands on your device, here are some common commands that you can use. Commands What does it do? Sample Reponses AT Same thing as “Hey!” in real life. This is used to check if you are able to communicate with the device. OK AT+COPS=? To see all available carriers. This command will also filter out carriers that are not compatible with the SIM card. 0, 1, “T-Mobile” or 0, 4, “AT&T” AT+COPS = (#, #) Check the current network. Obtain two #‘s from the above command. For example, if you want to connect to T-Mobile, you would do AT+COPS=(0,1). “T-Mobile” or “AT&T” AT+CCID Check the SIM ID IMEI NUMBER OK AT+CREG? Network Registration Status. You can run the AT+CREG=? for available flags.(#, “Current Network Name”, PLMN #) OK AT+COPS=? List of available networks. This response is valuable to switch carriers. (4, “Network Name”, PLMN #), (2, “Network Name 2”, PLMN #2) … AT+COPS = 1, 0 “Carrier Name” Manually connect to a network. This is also known as PLMN selection. If all went well, you should get an OK response. If there is an error, it will reply back with CME ERROR. The error usually occurs if your provider’s SIM does not support the carrier you are connecting to. Please check with your wireless provider on the list of providers that is supported in your area. AT+BANDS Manually select a cellular band. This shouldn’t be used often unless you are having issues with network congestion. The numbers seen in the sample result is different for every device. OK 0100004000 B12 045000000 B5

Troubleshooting issues with AT commands

Raspberry Pi 4 has intermittent issues recognizing which USB port to use for serial communication. Even if you specify ttyUSB3 or ttyS0, the Pi often thinks that there is a separate serial port located on the device. In order to fix this issue, we recommend using a bluetooth keyboard and mouse - this will mitigate the confusion the Pi goes through.

Raspberry Pi 4G Hat (SIM7600-A)

Source: https://developers.telnyx.com/docs/iot-sim/sim7600-a-rasp-pui-hat.md

Original location: Wireless > IoT > sim7600-a-rasp-pui-hat The SIM7600A 4G HAT is a 4G communication and GNSS positioning module, which supports LTE CAT4 up to 150Mbps for downlink data transfer. It is pretty low power consumption and can be attached to a Raspberry Pi to empower connectivity for IoT applications. You can also connect this 4G module with a computer to surf the Internet. It has functionality for sending SMS, global positioning, and high speed internet connections via 4G.

Prerequisites to complete the SIM7600 4G HAT setup

Sign up for a free Telnyx Portal account and purchase an active Telnyx SIM card with data plan. Check out this Quickstart Guide to get set up.
Raspberry Pi 3 Model B or Raspberry Pi 4 (this guide will use 4 but the steps are the same).
Internet connection for initial setup and configuration.

Alright, let’s get started!

Preparation steps for the SIM7600 Raspberry Pi 4G HAT setup

First, we are going to start by updating the Raspberry Pi so let’s run these commands:

sudo apt update -y
sudo apt dist-upgrade -y
sudo rpi-update
You may see a prompt like this. Press Y and press enter:

Once all of the steps are complete, reboot your Pi using sudo reboot command. With the updates out of the way, let’s start on installing prerequisite software and libraries: libqmi-utils and udhcpc are first up. Install them by running this command: sudo apt install libqmi-utils && udhcpc libqmi-utils installs libraries that allow you to interact with Qualcomm-based modems. SIM7600 comes with a Qualcomm MDM9607 chipset. udhcpc is used for modem DHCP leasing. The cellular network gives a unique IP to the HAT and the Pi will have its own IP. This is used to solve IP addressing conflicts between the Pi and the HAT. Now we will enable UART to communicate with the device. To do that, run this command and then follow the prompts as shown:

sudo raspi-config
Choose Interfacing Options (5):
Choose P6 Serial:
Press No to the prompt below then Reboot.

Configuration of the SIM7600 module

Next, we’re going to configure the SIM7600A module. To turn on the module we will be using the qmicli commands which are used to control Qualcomm devices. This command will activate the device: sudo qmicli -d /dev/cdc-wdm0 --dms-set-operating-mode='online' Now let’s verify that the module is online. These are sample commands you can send to the device:

qmicli -d /dev/cdc-wdm0 --dms-get-operating-mode
- Response: Online or Offline
qmicli -d /dev/cdc-wdm0 --nas-get-signal-strength
- Response: Signal strength and signal quality values
qmicli -d /dev/cdc-wdm0 --nas-get-home-network
- Response: Carrier name or carrier PLMN

You should now see a WWAN0 interface in net-stats (ifconfig). Unless specified by user, WWAN0 is the default interface this device uses. We’re now going to configure the module to use raw-ip protocol with the following commands:

sudo ip link set wwan0 down
echo 'Y' | sudo tee /sys/class/net/wwan0/qmi/raw_ip
sudo ip link set wwan0 up

And connecting to a mobile network:

sudo qmicli --device=/dev/cdc-wdm0 --device-open-proxy --wds-start-network="ip-type=4,apn=data00.telnyx" --client-no-release-cid

After pasting the above content, Kindly check and remove any new line added Finally, let’s set the default route and IP using udhcpc: sudo udhcpc -i wwan0 And tell the udhcpc library to receive a DHCP lease from the network using WWAN0: ip a s wwan0

The Telnyx SIM has access to all network types and many different operators. As a result, it can take them a while to attach to a network for the first time. Once it connects to a network, that network will be added to the list of priority operators so as to ensure a fast connection going forward. Please note that the first attach can take up to 30 minutes.

You are connected to the Internet! Open up your web browser and browse away!

Make sure to sign up for a free Telnyx account to get started with SIM7600-A Raspberry Pi 4G!

Sixfab Raspberry Pi 3G/4G Hat

Source: https://developers.telnyx.com/docs/iot-sim/sixfab-rasp-pi-hat.md

Original location: Wireless > IoT > sixfab-rasp-pi-hat The Sixfab 3G/4G & LTE Base HAT grants your Raspberry Pi or 40-pin Pi compatible single-board-computer a super-simple interface bridge between mini PCIe cellular modems. If you’re looking for a Raspberry Pi LTE HAT for IoT applications like location tracking or global device deployments this is a great device. This add-on also board allows you to create a remote controllable LTE Wi-Fi Hotspot, high-speed GPS tracking and more. From low-power consumption LTE-M to ultra-high-speed LTE-Advanced mini PCIe cards supported by this HAT. Both UART and USB communication with modules are available on the shield. This guide assumes that you have a fresh installation of Raspbian OS. Some parts of this guide were obtained from Sixfab’s official tutorial website.

Instructions for setting up your Sixfab Raspberry Pi 3G/4G HAT

First, let’s make sure that the Raspberry Pi is up to date. You can do that by running the below commands:

After pasting the below content, Kindly check and remove any new line added

sudo apt update && sudo apt upgrade
sudo apt dist-upgrade
sudo apt install raspberrypi-kernel-headers
reboot

Next, we’re going to obtain the required repository from the Sixfab quickstart script: wget https://raw.githubusercontent.com/sixfab/Sixfab_RPi_3G-4G-LTE_Base_Shield/master/tutorials/QMI_tutorial/qmi_install.sh
Now let’s take ownership of the script and install it. In this step, you may be prompted to enter an APN. Enter data00.telnyx as the APN and you are good to go!

chmod +x qmi_install.sh
sudo ./qmi_install.sh

After pasting the above content, Kindly check and remove any new line added

Reboot your device and then let’s get connected.
To get connected to the internet, navigate to the following directory: cd /files/quectel-CM
Then mark the device as “online” with the below command. This tells the device to relay its initial “online” status message to the network. Once the network acknowledges the message, your device should obtain a valid IP address from the network; thus, have an internet connection.

sudo ./quectel-CM -s internet

After pasting the above content, Kindly check and remove any new line added

The Telnyx SIM has access to all network types and many different operators. As a result, it can take them a while to attach to a network for the first time. Once it connects to a network, that network will be added to the list of priority operators so as to ensure a fast connection going forward. Please note that the first attach can take up to 30 minutes.

Troubleshooting your Sixfab Raspberry Pi 3G/4G HAT

If the device doesn’t connect to the internet, this means that the device either doesn’t know which APN to use or the Raspberry Pi has trouble communicating with the device. In this case, we are going to let the device handle the disconnect/reconnect process automatically. To set up this auto-connect process follow this steps:

Make sure the sixfab hat is connected.
Obtain required repository: wget https://raw.githubusercontent.com/sixfab/Sixfab_RPi_3G-4G-LTE_Base_Shield/master/tutorials/QMI_tutorial/install_auto_connect.sh
Take ownership of the script and install.

chmod +x install_auto_connect.sh
sudo ./install_auto_connect.sh

After pasting the above content, Kindly check and remove any new line added

Now, it will ask for an APN. Please make sure to double check the APN as a misspelling in this step may cause connectivity issues.
Verify that the module is active and online: sudo systemctl status qmi_reconnect.service

Sixfab Cellular IoT HAT

Source: https://developers.telnyx.com/docs/iot-sim/sixfab-cellular-iot-hat.md

Original location: Wireless > IoT > sixfab-cellular-iot-hat Sixfab Raspberry Pi Cellular IoT HAT allows you to send or receive data over LTE-M cellular networks that the Telnyx SIM has access to without needing gateways. LTE-M (Cat M1) is a must-have for those looking to make the most of Low Power Wide Area Network (LPWAN) technology. Meanwhile, some countries already started to shut down 2G networks. The Quectel BG96, lies on the middle of the Raspberry Pi Cellular IoT HAT. It is an LTE Cat M1/Cat NB1/EGPRS module offering a maximum data rate of 375Kbps downlink and uplink with worldwide coverage. This LTE add-on for Raspberry Pi also supports GNSS and GPS for the need of building location, navigation, tracking, mapping and timing applications.

Prerequisites to complete the Sixfab Cellular IoT HAT setup

A Telnyx Portal account and active Telnyx SIM card with data plan. Check out this Quickstart Guide to get set up.
Raspberry Pi 3 Model B or Raspberry Pi 4 (this guide will use 4 but the steps are the same).
Make sure both the firmware and software are up-to-date on your Pi.
Install the Sixfab IoT HAT on the Pi using the 40-pin connector and connect the HAT to the Pi’s USB port as shown below.

Alright, let’s get started!

Instructions for setting up your Sixfab Cellular IoT HAT

First, we will enable UART. This will allow us to communicate directly with the device using AT commands. To do that, run this command and then follow the prompts as shown:

sudo raspi-config
Choose Interfacing Options (5):
Choose P6 Serial:
Press No to the prompt below then Reboot.

Now, let’s retreive necessary repository from Sixfab to begin the dependency installation: git clone https://github.com/sixfab/Sixfab_RPi_CellularIoT_Library.git
Navigate to the directory, take ownership of the script, and begin the installation:

cd Sixfab_RPi_CellularIoT_Library
sudo python3 setup.py install

After pasting the above content, Kindly check and remove any new line added

We will now work on activating the module and specifying the APN.

wget https://raw.githubusercontent.com/sixfab/Sixfab_PPP_Installer/master/ppp_install_standalone.sh
sudo chmod +x ppp_install_standalone.sh
sudo ./ppp_install_standalone.sh

After pasting the above content, Kindly check and remove any new line added

Once the installation begins, you will be prompted several options. Select the options as follows:

Choose your HAT —> Cellular IoT HAT
What is your carrier APN? —> data00.telnyx
Does your carrier need an username or password? —> n
What is your device communication PORT? —> ttyUSB3
Would you like to reconnect automatically on boot? —> This step is optional. We will select “n” for this guide.

Once the Pi reboots, use the following commands to connect/disconnect from the internet. If you have selected “y” to the reconnect prompt during configuration, your HAT will automatically connect to the network.

sudo pon to connect sudo poff to disconnect

The Telnyx SIM has access to all network types and many different operators. As a result, it can take them a while to attach to a network for the first time. Once it connects to a network, that network will be added to the list of priority operators so as to ensure a fast connection going forward. Please note that the first attach can take up to 30 minutes.

Troubleshooting your Sixfab Cellular IoT HAT

If you have issues with network connectivity, check ifconfig to see if interface PPP0 is visible (it should be located at the very bottom). If you do not see this entry, repeat step 3 above. Sixfab’s script is designed to skip items when there is an error or a part doesn’t run properly. If you see the PPP0 interface but there is no data connection please try the following steps.

Try pinging Google DNS at 8.8.8.8.
If this doesn’t work, reboot the Pi and reset the interface.

sudo reboot
sudo ifconfig ppp0 down
sudo ifconfig ppp0 up

After pasting the above content, Kindly check and remove any new line added

If this step fails, run step 3 and 4 from the original setup again with a blank APN, then run the script again with the correct APN (data00.telnyx).
Check the antenna connection - main & GPS. An improperly seated connection will cause the device to reboot.
Check if the antenna supports your HAT model.
Check the Pi’s power supply - the HAT itself uses 2 - 6 watts of power. Make sure you are using a sufficient power supply for your Pi. Raspberry Pi 3 requires at least 12W of power. Raspberry Pi 4 requires at least 15W of power.
Slow internet may cause issues in your setup too. The theoratical speed max for this HAT is about 350 Kbps range as this is the limitation of the CATM1 network. This is normal.

Particle Boron LTE Kit

Source: https://developers.telnyx.com/docs/iot-sim/particle-boron-lte-kit.md

Original location: Wireless > IoT > particle-boron-lte-kit The Boron is a powerful LTE Cat M1 or 2G/3G enabled development kit that supports cellular networks and Bluetooth LE (BLE). It is based on the Nordic nRF52840 and has built-in battery charging circuitry so it’s easy to connect a Li-Po and deploy your local network in minutes. This guide will walk you through how to pair a Particle Electron Boron LTE Kit with a Telnyx SIM Card.

Prerequisites to complete the Particle Boron LTE Kit setup:

A Telnyx Portal account and active Telnyx SIM card with data plan. Check out this Quickstart Guide to get set up.
An Android or iOS device with internet acccess.
The Particle Electron Boron device.
A computer with CLI.

Alright, let’s get started!

Instructions for setting up your Particle Boron LTE Kit:

First, connect the LTE antenna to the port located in the front of the Particle Electron Boron device and connect the device to power. The device will automatically go into pairing mode.
Download and install the mobile application on your Android or iOS device.
Open the Particle Mobile Application and follow the on-screen instructions:
- Click “Get Started”.
- Log into your Particle.io account or create an account.
- Press the + button located at the top right of the page and select the device name (i.e. boron-ij3).
Your device will now activate its eSIM and you’ll be able to see the device by logging into console.particle.io. Particle.io offers a 3-month free trial with limited free data.
Now, let’s enable third-party SIM capability on the device. To begin, insert the Telnyx SIM card into the device.
Set up CLI environment on your computer using this Particle guide.
Place your device in DFU mode. This mode allows you to interact with the device using a computer.
Press and hold the “Mode” button then press the “Reset” button once. Keep holding the “Mode” button until the device flashes yellow.
Connect your device to the computer via the provided micro-USB cable. Then run the following commands in your CLI environment:
- particle update
  - This command updates the device’s firmware (1.5.2 as of this guide).
- particle flash --usb tinker
  - The device, by default, receives commands from the Particle Cloud via a network connection.
  - This command allows your computer to control the device instead of the cloud.
Repeat Step 6 to place your device into DFU mode.
Download this file TelnyxSIM and navigate to the saved location. Then, run the following commands:
- particle compile boron
  - This command will compile the .cpp file into a binary file.
- particle compile boron TelnyxSIM.cpp --saveTo firmware.bin
  - This command will create a firmware.bin file that you will tell the device to use the Telnyx SIM card.
- particle flash --usb firmware.bin
  - This command will flash the firmware.bin on to the device. The device will start using the Telnyx SIM card next time it reboots.
Repeat Step 6 to place your device into DFU mode and run this command to give back your device its control:
- particle flash --usb tinker
Once you connect your device into a power adapter, you’ll connect to the Telnyx network. It may take up to 2 minutes to reflect network connectivity. You can also verify the connectivity by clicking on your device name in console.particle.io.

That’s it! Your Particle Electron Boron LTE device is all set up with a Telnyx SIM card.

Nordic nRF9160 DK

Source: https://developers.telnyx.com/docs/iot-sim/nordic-semiconductor.md

Original location: Wireless > IoT > nordic-semiconductor The nRF9160 DK is an affordable, pre-certified single-board development kit for evaluation and development on the nRF9160 SiP for LTE-M, NB-IoT and GPS. This guide will walk through the steps to take in order to connect a Telnyx SIM to the nRF9160 development kit.

Updating the firmware of the nRF9160:

Download the latest board and SIP modem firmware for this device here.
Once both firmwares are downloaded, open up your file manager and extract the board firmware. The zip file has the file name: nrf9160dk_fw_0000-00-00_xxxxxxx.zip. Do NOT extract the SIP modem firmware labeled mfw_nrf9160_x.x.x.zip.
Download and install the latest nRF Connect application for your operating system here.
Once installed, open up the application and install the following modules:

LTE Link Monitor
Programmer
Trace Collector

Install the following modules on your nRF9160

Look at the front of the device and make sure it’s in debug mode as shown below.

Ensure the nRF9160 device is in debug mode.

Connect the device to the computer via a microUSB cable and turn on the device using the power switch located at the bottom left corner of the device.
Open up the Programmer application and select the device denoted PCA10090.
Drag and drop the firmware file into the file memory layout box then select Erase & write to update the firmware. The left box will show patterns when the update is in progress. Once the update is complete, the left box will display a Device is connected message.

Now, we’ll update the modem firmware. Scroll the right toolbar to the bottom of the screen. Select Update modem under the Cellular Modem section and click on the SIP modem firmware that was downloaded in step 1. Then click Write.

The zip file has the following filename: mfw_nrf9160_x.x.x.zip.

Once the modem updates are complete, turn off the device by using the power switch located at the bottom left corner and disconnect the device from the computer.

Connecting the nRF9160 device to your Telnyx SIM:

Insert your Telnyx SIM card into the nRF9160 device (this device uses nano-sim). Make sure to insert in the correct orientation as notated on the development kit.

Insert the Telnyx SIM card into the nRF9160 device.

Connect the nRF9160 device to the computer and power on the device.
Open up the nRF Connect application and launch LTE Link Monitor.
In the Select Device dropdown menu, select PCA10090. The LTE Link Monitor display will update and run preselected AT commands. Allow 10-15 seconds for it to complete and the device will automatically connect to the network. Verify connectivity in the information tab located on the right side of your display.

Verify connectivity of your nRF9160 device.

That’s it! You’ve connected the Telnyx SIM to the nRF9160 development kit.

Cradlepoint IBR200

Source: https://developers.telnyx.com/docs/iot-sim/cradlepoint-ibr200-cellular.md

Original location: Wireless > IoT > cradlepoint-ibr200-cellular The compact, semi-ruggedized IBR200 LTE router is designed for secure, cloud-managed IoT networking. The IBR200 enables use of low-cost M2M/IoT data plans via the Telnyx Wireless SIM, and with NetCloud Perimeter, addresses the biggest gap in IoT: security. It comes with NetCloud Perimeter and advanced security for PCI-compliant networking of vulnerable IoT devices. This guide will walk you through how to set up the CradlePoint IBR200 cellular router with a Telnyx SIM Card.

Prerequisites to complete the Cradlepoint IBR200 Cellular Router setup

A Telnyx Portal account and active Telnyx SIM card with data plan. Check out this Quickstart Guide to get set up.
The Cradlepoint IBR200 device (as shown below).
A Netcloud Essentials Cloud subscription is required for full functionality of this Cradlepoint modem. Without this, many of its features will be disabled. This guide, however, will walk you through basic connectivity which does NOT require the subscription.

Alright, let’s get started!

Instructions for setting up your Cradlepoint IBR200 Cellular Router:

First, insert the Telnyx SIM card into your Cradlepoint device. The device only accepts the standard SIM card (the largest size from your Telnyx SIM card kit).
Power on the device by connecting the device to its charging adapter.
Open up your preferred web browser and navigate to 192.168.0.1. This is the router’s default gateway. You’ll be prompted to log into the device. The default credentials are:
- Username: admin
- Password: the serial number located on the label at the bottom of the device.
Click on “Connection Manager” tab.
Click “Add”.

Configuring your Cradlepoint IBR200 Cellular Router

In this step you’ll specify the WAN Interface Profile. Configure the profile as shown below:
- Profile name: Telnyx SIM
- Type: Modem
- Leave everything else unchecked
On the next page, click on “SIM/APN/Auth”. In this step, you’ll specify the APN to use with the Telnyx SIM Card. Configure the items as shown below:
- SIM Card Lock: No Pin Required
- Access Point Name (APN): Default Override
- data00.telnyx
Once you hit “Save” it’ll take a few minutes for your device to receive connection. You can verify connectivity by heading to “Connection Manager” tab.

CradlePoint IBR200 cellular router setup

The Telnyx SIM has access to all network types and many different operators. As a result, it can take them a while to attach to a network for the first time. Once it connects to a network, that network will be added to the list of priority operators so as to ensure a fast connection going forward. Please note that the first attach can take up to 30 minutes.

That’s it! Your CradlePoint IBR200 cellular router is all set up with a Telnyx SIM card.

Pepwave Max BR1 Mini LTE

Source: https://developers.telnyx.com/docs/iot-sim/pepwave-max-br1-mini-lte.md

Original location: Wireless > IoT > pepwave-max-br1-mini-lte The Pepwave MAX BR1 Mini is the latest industrial-grade, 4G LTE router from Peplink. This capable router is heavy on features while keeping a lightweight, small footprint, suitable for installation just about anywhere. Whether the BR1 Mini is installed in a vehicle, used in M2M deployments, or will provide cellular backup or Out of Band Management to a home or office, it has great performance and works seamlessly with Telnyx Wireless SIMs. This guide will walk you through how to set up the Pepwave Max BRI Mini LTE cellular router with a Telnyx SIM card. Note: this is a standalone setup guide; it does not utilize the InControl Cloud Controller.

Prerequisites to complete the Pepwave MAX BR1 Mini setup

A Telnyx Portal account and active Telnyx SIM card with data plan. Check out this Quickstart Guide to get set up.
The Pepwave Max BRI Mini LTE Device.
A computer.
The latest firmware, which can be obtained here.

Alright, let’s get started!

Instructions for setting up your Pepwave MAX BR1 Mini

To start, insert the Telnyx SIM card into either SIM A or SIM B slot on the device and power on the device.The device only accepts the standard size SIM card (the largest SIM card included in the kit).
Connect to the device either via the WiFi credentials listed on the unit below the device or via the WAN/LAN Ethernet port located on the back of the device.
Navigate to 192.168.50.1, this is the default gateway of the device. Now, log in, the default username and password are both admin.
Update the device firmware by navigating to System, then Firmware, and uploading the firmware file. This may take up to 8 minutes.
Once the update process is complete, you’ll be directed to the Dashboards tab. Click on Details under WAN Connection Status. Then, scroll down to Cellular Settings and make modifications as shown below:
- SIM Card: Specified in Step 1 of this guide
- LTE/3G: Auto
- Band Selection: Auto
- Data Roaming: Checked, Any Countries
- APN: Custom, data00.telnyx
- Username: Leave blank
- Password: Leave blank
Scroll down to the end of this page and press Save and Apply.
It’ll take about 2 minutes to connect and you can verify connectivity by checking the WAN Connection Status under the Dashboards tab. This will show that you’re connected to Telecom Italia Mobile.

Verify the connectivity of your Pepwave MAX BR1 Mini

That’s it! You’ve just set up your Pepwave Max BRI Mini LTE cellular router with a Telnyx SIM card.

GL-MiFi 4G Smart Router

Source: https://developers.telnyx.com/docs/iot-sim/glmifi-router.md

Original location: Wireless > IoT > glmifi-router This guide will walk you through how to pair a GL-MiFi 4G Smart Router with a Telnyx SIM Card.

Prerequisites to complete the GL-MiFi 4G Smart Router setup:

A Telnyx Portal account and active Telnyx SIM card with data plan. Check out this Quickstart Guide to get set up.
GL-MiFi device.
A computer with a browser.

Alright, let’s get started!

Instructions for setting up your GL-MiFi 4G device:

First, insert the SIM card into the device. Look at the picture below for the proper placement of the SIM card, the gold chip should be facing up.
Power on the device and connect either via the Ethernet port or WiFi connection.The default WiFi credentials are located on a label at the bottom of the device.
Navigate to the device’s default gateway at 192.168.8.1 and log into the device. You’ll be prompted to set an admin password but if you don’t see the prompt, the default password is admin.
Once you’ve logged in, click on manual setup located in the Cellular Modem Overview section. Enter the following details as shown below and click Apply.
- Device: /dev/cdc-wdm0
- APN: data00.telnyx
The device will now attach to the Telnyx network. You can verify the connectivity by checking the front page of the default gateway as shown below. You’ll notice that the device now shows a Disconnect button as well as IP address and data usage.
To check your connectivity, you can also check the fourth icon on the left of the overview diagram. It will indicate I TIM.

That’s it! Your GL-MiFi 4G Smart Router is all set up with a Telnyx SIM card.

Mikrotik wAP LTE Kit

Source: https://developers.telnyx.com/docs/iot-sim/mikrotik-wap-lte.md

Original location: Wireless > IoT > mikrotik-wap-lte This guide will walk you through configuring the Mikrotik LTE Kit US router using a Telnyx SIM.

Prerequisites to Set Up Mikrotik wAP LTE kit

An active Telnyx SIM card
Mikrotik LTE kit router
A computer
Latest routerOS firmware, which you can obtain here.

Setting Up Mikrotik wAP LTE kit

Note: Please insert the SIM card into router only when instructed to do so.

Part I: Firmware Update

We will begin by updating the routerOS firmware to the latest version (6.48 as of 2.4.21).
Remove the SIM card from the device.
Connect your computer to the device via either the WiFi or the Ethernet interface and log into the default gateway at 192.168.88.1. The default username and password are shown below.
- Username: admin
- Password: (blank)
Once you log in, you will see the admin console as shown below.

Click on Files → Browse and upload the .npk firmware file.

Reboot the device by clicking System → Reboot.
- The device will apply the latest firmware automatically during the booting procedure.

Part II (Router Configuration)

Navigate to Interface → LTE.

Click LTE APNs → Add New.
- Name: Telnyx
- APN: data00.telnyx
- IP Type: IPv4
- Use Peer DNS: Check
- Add Default Route: Check
- Leave all other settings as their default values.

Click Apply then OK.
Go back to the LTE tab under Interfaces and click on the LTE module. Apply the APN created above using the dropdown menu and enable roaming by checking the Allow Roaming box.

Press Apply then OK.
Insert the Telnyx SIM card. After roughly 45 seconds, the device will attach to the network. You can verify connectivity by going to Interfaces → LTE → Click on the LTE module then scroll down to registration status. It will display “roaming”.

Edge Device Deployment

Source: https://developers.telnyx.com/docs/iot-sim/edge-deployment.md

Original location: Wireless > IoT > edge-deployment In this tutorial, we are going to deploy a Cradlepoint IBR200 to the edge of our corporate network in Digital Ocean. We will then open the Cradlepoint device up for SSH access via a private IP address from within our network. For this tutorial, the SIM card in the Cradlepoint device will only have access to our corporate network in Digital Ocean and will not have access to the public internet directly. In a follow-up tutorial, we will showcase how to open the SIM up to the public internet. There are 5 main steps in the setup of this deployment:

SIM card setup
Cloud VPN setup
Cradlepoint IBR200 setup
Private Wireless Gateway setup
Cradlepoint SSH configuration

Before we jump into the steps, let’s explore the design of this system first. Below is a diagram of our final setup.

Edge Device Deployment with Private Wireless Gateways

To ensure that we have direct access to the Cradlepoint device via a private IP address in our corporate network, we are going to connect a Digital Ocean Droplet (a Linux server) to a VRF-defined network on the Telnyx MPLS backbone via a Wireguard client. We will then spin up a private packet gateway in the Telnyx mobile core just for this SIM card and add that packet gateway to the same VRF-defined network that the Wireguard client is connected to. We will finally configure the Cradlepoint device to accept SSH access and connect directly into our Cradlepoint CLI via the private IP address that the packet gateway gives the SIM on our VRF-defined network.

SIM Card Setup

Our first step is to order and register a Telnyx SIM card. SIM cards can be ordered in the mission Control portal and registered via the registration flow in the wireless section. You can learn more about registering a SIM card in our quickstart guide. When the SIM is inserted into the Cradlepoint device, the only custom configuration that is required to connect the SIM is to set the APN to data00.telnyx.

Cloud VPN Setup

Next, we will configure a Wireguard client in a Digital Ocean Droplet to connect into a Cloud VPN on the Telnyx MPLS backbone. Follow the steps in our Digital Ocean Ubuntu Server to Cloud VPN tutorial. When you can successfully ping the server endpoint on the Telnyx network, you can move to the next step.

Cradlepoint IBR200 Setup

Before we create and configure a Private Wireless Gateway we will connect our Telnyx SIM card to the internet in our Cradlepoint device. Follow the steps in our Cradlepoint IBR200 Cellular Router Setup Guide. When you can successfully access the public internet via a connected device to the Cradlepoint network, you can move to the next step.

Private Wireless Gateway Setup

A Private Wireless Gateway (PWG) must be associated with a Network resource in the portal. The PWG can be created in the Private Wireless Gateways subsection in the Wireless section of the portal. Click the Create PWG button, enter a name and select the Network resource that you used for your Cloud VPN from step 2.

Create a Private Wireless Gateway using an existing Network

The PWG may take up to 15 minutes to create. This is due to the number of automated network configurations that are required to deploy an entirely new Dockerized PGW instance into our wireless mobile core. When the PWG status changes to provisioned, we can associate our SIM Group. This can be done by navigating to the relevant SIM Group and setting the PWG to the one we just created. For the sake of this tutorial, it is best to associate a SIM group with just the SIM that you have inserted into your Cradlepoint device. By default, the SIMs in this SIM group will lose access to the public internet when added to the new PGW in our wireless mobile core. Now that you have your SIM card associated with a new packet gateway via the PWG resource that you created on the same network as your Cloud VPN we can ping the IP of our SIM card from the Digital Ocean Droplet. Log into your Digital Ocean Ubuntu Server and ping the IP that your SIM is showing in the portal. The SIM card IP address can be viewed in the drill-down view for that SIM. When you have a successful ping working between your Digital Ocean server and SIM card in your Cradlepoint device, you can move on to the next step.

Cradlepoint SSH Configuration

The final step is to enable SSH access on your Cradlepoint device. This is done via the Administration page in the Cradlepoint configuration console. Connect to your Cradlepoint WiFi network and enter the LAN IP address or hostname of the router (assuming you are connecting from the LAN side) into a web browser’s location field. By default, the LAN IP address is 192.168.0.1 and the router’s hostname is cp: Next, navigate to the System section on the left nav menu, and then select Administration. Select Local Management from the drop-down menu. Then check the Enable SSH Server entry box. To access the CLI from your corporate network, select Remote Admin from the Administration drop-down menu, and check Allow Remote SSH Access. Click Save (if using Local Management) or Submit ( if using Remote Admin). Allow Weak Cipher Support is off by default. You may need to enable this depending on the SSH version and encryption algorithm that you are using on your server. It can be enabled by navigating to System > Administration > Local Management > Allow Weak Cipher Support. Now that you have enabled SSH on the Cradlepoint device, you should be able to access the device from your Digital Ocean server. From your Linux server run:

ssh admin@[SIM_CARD_IP]

After pasting the above content, Kindly check and remove any new line added Enter the password that you used to access the Cradlepoint management console. You should now have access to the Cradlepoint CLI without any internet access.

API Reference (Data)

SIM Cards

Get SIM card public IP definition: It returns the public IP requested for a SIM card.
Request setting a SIM card public IP: This API makes a SIM card reachable on the public internet by mapping a random public IP to the SIM card. <br/><br/>
Request removing a SIM card public IP: This API removes an existing public IP from a SIM card. <br/><br/>
List SIM card data usage notifications: Lists a paginated collection of SIM card data usage notifications. It enables exploring the collection using specific filters.
Create a new SIM card data usage notification: Creates a new SIM card data usage notification.
Delete SIM card data usage notifications: Delete the SIM Card Data Usage Notification.
Get a single SIM card data usage notification: Get a single SIM Card Data Usage Notification.
Updates information for a SIM Card Data Usage Notification: Updates information for a SIM Card Data Usage Notification.
List wireless connectivity logs: This API allows listing a paginated collection of Wireless Connectivity Logs associated with a SIM Card, for troubleshooting purposes.

Private Wireless Gateways

Get all Private Wireless Gateways: Get all Private Wireless Gateways belonging to the user.
Create a Private Wireless Gateway: Asynchronously create a Private Wireless Gateway for SIM cards for a previously created network. This operation may take several minutes so you can check the P…
Delete a Private Wireless Gateway: Deletes the Private Wireless Gateway.
Get a Private Wireless Gateway: Retrieve information about a Private Wireless Gateway.

Wireless Blocklists

Get all Wireless Blocklists: Get all Wireless Blocklists belonging to the user.
Create a Wireless Blocklist: Create a Wireless Blocklist to prevent SIMs from connecting to certain networks.
Delete a Wireless Blocklist: Deletes the Wireless Blocklist.
Get a Wireless Blocklist: Retrieve information about a Wireless Blocklist.
Update a Wireless Blocklist: Update a Wireless Blocklist.
Get all possible wireless blocklist values: Retrieve all wireless blocklist values for a given blocklist type.

OTA updates

List OTA updates: Retrieve a paginated list of over-the-air (OTA) update operations for your SIM cards.
Get OTA update: This API returns the details of an Over the Air (OTA) update.

Traffic Policy Profiles

Get all traffic policy profiles: Get all traffic policy profiles belonging to the user that match the given filters.
Create a traffic policy profile: Create a new traffic policy profile. At least one of services, ip_ranges, or domains must be provided.
Delete a traffic policy profile: Deletes the traffic policy profile.
Get a traffic policy profile: Returns the details regarding a specific traffic policy profile.
Update a traffic policy profile: Updates a traffic policy profile.
Get all available traffic policy profile services: Get all available PCEF services that can be used in traffic policy profiles.

Reporting

Get all Wireless Detail Records (WDRs) Reports: Returns the WDR Reports that match the given parameters.
Create a Wireless Detail Records (WDRs) Report: Asynchronously create a report containing Wireless Detail Records (WDRs) for the SIM cards that consumed wireless data in the given time period.
Delete a Wireless Detail Record (WDR) Report: Deletes one specific WDR report.
Get a Wireless Detail Record (WDR) Report: Returns one specific WDR report

⌘I

​Telnyx Wireless: Data — Full Documentation

​Configuration

​Public IPs

​Actions

​When to Use

​Private Wireless Gateways

​Why PWG

​Architecture

​API

​APN-based IP Assignment

​Limitations

​Setup

​Private Gateway Setup

​Step 1: Set up Cloud VPN

​Step 2: Create a Private Wireless Gateway

​Step 3: Configure routing

​Traffic Policies

​Profile Types

​Filter Criteria

​Example: IoT Device Lockdown

​Example: Bandwidth Throttling

​Assigning Profiles

​Blocklists

​Blocklist Types

​How It Works

​Common Patterns

​Usage Alerts

​Data Limits

​Per-SIM Usage Notifications

​Monitoring Consumption

​Monitoring & Troubleshooting

​API errors

​Wireless error codes

​Recovery pattern

​Troubleshooting

​Step 1: Check device configuration

​Step 2: Check connectivity logs

​Step 3: Diagnose patterns

​No connectivity logs at all

​Multiple registration attempts, no data

​Registration succeeds but no data sessions

​Detail Records

​Generating Reports

​What’s in a Report

​Connectivity Logs

​Use Cases

​OTA Updates

​What Gets Updated

​Tracking Updates

​How It Works

​Multi-IMSI Context

​Device Guides

​AT Commands

​Prerequisites to complete before running AT commands:

​Troubleshooting issues with AT commands

​Raspberry Pi 4G Hat (SIM7600-A)

​Prerequisites to complete the SIM7600 4G HAT setup

​Preparation steps for the SIM7600 Raspberry Pi 4G HAT setup

​Configuration of the SIM7600 module

​Sixfab Raspberry Pi 3G/4G Hat

​Instructions for setting up your Sixfab Raspberry Pi 3G/4G HAT

​Troubleshooting your Sixfab Raspberry Pi 3G/4G HAT

​Sixfab Cellular IoT HAT

​Prerequisites to complete the Sixfab Cellular IoT HAT setup

​Instructions for setting up your Sixfab Cellular IoT HAT

​Troubleshooting your Sixfab Cellular IoT HAT

​Particle Boron LTE Kit

​Prerequisites to complete the Particle Boron LTE Kit setup:

​Instructions for setting up your Particle Boron LTE Kit:

​Nordic nRF9160 DK

​Updating the firmware of the nRF9160:

​Connecting the nRF9160 device to your Telnyx SIM:

​Cradlepoint IBR200

​Prerequisites to complete the Cradlepoint IBR200 Cellular Router setup

​Instructions for setting up your Cradlepoint IBR200 Cellular Router:

​Pepwave Max BR1 Mini LTE

​Prerequisites to complete the Pepwave MAX BR1 Mini setup

​Instructions for setting up your Pepwave MAX BR1 Mini

​GL-MiFi 4G Smart Router

​Prerequisites to complete the GL-MiFi 4G Smart Router setup:

Telnyx Wireless: Data — Full Documentation

Configuration

Public IPs

Actions

When to Use

Private Wireless Gateways

Why PWG

Architecture

API

APN-based IP Assignment

Limitations

Setup

Private Gateway Setup

Step 1: Set up Cloud VPN

Step 2: Create a Private Wireless Gateway

Step 3: Configure routing

Traffic Policies

Profile Types

Filter Criteria

Example: IoT Device Lockdown

Example: Bandwidth Throttling

Assigning Profiles

Blocklists

Blocklist Types

How It Works

Common Patterns

Usage Alerts

Data Limits

Per-SIM Usage Notifications

Monitoring Consumption

Monitoring & Troubleshooting

API errors

Wireless error codes

Recovery pattern

Troubleshooting

Step 1: Check device configuration

Step 2: Check connectivity logs

Step 3: Diagnose patterns

No connectivity logs at all

Multiple registration attempts, no data

Registration succeeds but no data sessions

Detail Records

Generating Reports

What’s in a Report

Connectivity Logs

Use Cases

OTA Updates

What Gets Updated

Tracking Updates

How It Works

Multi-IMSI Context

Device Guides

AT Commands

Prerequisites to complete before running AT commands:

Troubleshooting issues with AT commands

Raspberry Pi 4G Hat (SIM7600-A)

Prerequisites to complete the SIM7600 4G HAT setup

Preparation steps for the SIM7600 Raspberry Pi 4G HAT setup

Configuration of the SIM7600 module

Sixfab Raspberry Pi 3G/4G Hat

Instructions for setting up your Sixfab Raspberry Pi 3G/4G HAT

Troubleshooting your Sixfab Raspberry Pi 3G/4G HAT

Sixfab Cellular IoT HAT

Prerequisites to complete the Sixfab Cellular IoT HAT setup

Instructions for setting up your Sixfab Cellular IoT HAT

Troubleshooting your Sixfab Cellular IoT HAT

Particle Boron LTE Kit

Prerequisites to complete the Particle Boron LTE Kit setup:

Instructions for setting up your Particle Boron LTE Kit:

Nordic nRF9160 DK

Updating the firmware of the nRF9160:

Connecting the nRF9160 device to your Telnyx SIM:

Cradlepoint IBR200

Prerequisites to complete the Cradlepoint IBR200 Cellular Router setup

Instructions for setting up your Cradlepoint IBR200 Cellular Router:

Pepwave Max BR1 Mini LTE

Prerequisites to complete the Pepwave MAX BR1 Mini setup

Instructions for setting up your Pepwave MAX BR1 Mini

GL-MiFi 4G Smart Router

Prerequisites to complete the GL-MiFi 4G Smart Router setup: