Telnyx Wireless — Documentation Index
SIMs, eSIMs, IoT data plans, VoLTE, and wireless messaging. One section of the Telnyx developer docs (https://developers.telnyx.com). Root index: https://developers.telnyx.com/llms.txt · Full content for this section: https://developers.telnyx.com/development/llms/wireless-llms-full-txt.md
Subsections
Focused per-subsection files (index + full content):Overview
- Overview: Programmable cellular connectivity — data, voice, and messaging for any device.
SIMs & eSIMs
- Overview: Overview of Telnyx IoT SIMs and eSIMs, including SIM types, lifecycle states, the resource model for the API, and multi-IMSI roaming networking.
- SIM Cards: How to order physical Telnyx IoT SIMs and eSIMs through the dashboard or API, what to expect after the order, and how SIMs are shipped and activated.
- Lifecycle: State machine, transitions, and what to know about managing SIM status.
- SIM Card Groups: Apply group-level configuration and policy to Telnyx IoT SIM cards, including data limits, allowed networks, and security settings managed in bulk.
- Bulk Operations: Run one-time batch operations on an explicit list of Telnyx IoT SIM cards, including activation, deactivation, and policy updates applied in bulk.
Data
- Public IPs: Assign public static IPs to Telnyx IoT SIM cards to enable inbound connectivity from the internet, making cellular devices reachable like cloud servers.
- Private Wireless Gateways: Route SIM traffic through your private network instead of the public internet.
- Private Gateway Setup: Set up a Telnyx Private Wireless Gateway (PWG) to route IoT SIM traffic over a private network. Includes APN configuration, IP allocation, and routing.
- Traffic Policies: Control what traffic your SIMs can send and receive — by service, IP range, or domain.
- Blocklists: Prevent SIMs from connecting to specific networks by country, MCC, or PLMN.
- Usage Alerts: Set per-SIM usage thresholds and get notified when SIMs approach their limits.
- Troubleshooting: Troubleshoot Telnyx IoT SIM connectivity issues — diagnose registration failures, APN settings, signal problems, and data session errors on cellular networks.
- Detail Records: Export per-session data usage records for billing, auditing, and troubleshooting.
- OTA Updates: Over-the-air SIM profile updates — IMSI changes, network settings, and configuration pushes.
- AT Commands: Reference of AT commands for cellular modems used with Telnyx IoT SIMs. Configure APN, network selection, signal queries, and SMS via your device terminal.
- Raspberry Pi 4G Hat (SIM7600-A): This DevDocs page provides a comprehensive tutorial on how to use
- Sixfab Raspberry Pi 3G/4G Hat: Configure the Sixfab Raspberry Pi cellular HAT with a Telnyx IoT SIM. Add LTE connectivity to your Pi project with step-by-step APN setup instructions.
- Sixfab Cellular IoT HAT: Use the Sixfab Cellular IoT HAT with a Telnyx IoT SIM. Connect a Raspberry Pi over 2G/3G/4G with UART, SPI, I2C, and GPIO interfaces for IoT projects.
- Particle Boron LTE Kit: Set up the Particle Boron LTE development kit with a Telnyx IoT SIM. Step-by-step instructions to register, configure APN, and connect to the network.
- Nordic nRF9160 DK: Get started with the Nordic Semiconductor nRF9160 LTE-M/NB-IoT SoC and a Telnyx IoT SIM. APN configuration, AT command tests, and first connection steps.
- Cradlepoint IBR200: Configure a Cradlepoint IBR200 cellular router with a Telnyx IoT SIM. Step-by-step setup for APN, signal verification, and basic troubleshooting.
- Pepwave Max BR1 Mini LTE: Configure a Pepwave MAX BR1 Mini LTE router with a Telnyx IoT SIM. Step-by-step APN, WAN, and SIM setup to bring the device online quickly.
- GL-MiFi 4G Smart Router: Set up a GL.iNet Mifi router with a Telnyx IoT SIM for LTE internet access. Step-by-step APN configuration, signal checks, and basic troubleshooting.
- Mikrotik wAP LTE Kit: Configure a MikroTik wAP LTE router with a Telnyx IoT SIM. Step-by-step APN setup, RouterOS configuration examples, and signal verification.
- Edge Device Deployment: Deploy a Telnyx Private Wireless Gateway at the edge to route IoT SIM traffic onto your private network. Setup, configuration, and operational tips.
VoLTE
- Overview: Programmable cellular voice — from a simple second line to enabling native AI assistant on the call.
- Phone Numbers: Assign real phone numbers to SIMs for voice calling and messaging.
- Forwarding, Recording & Screening: Route unanswered calls, record conversations, and screen spam on cellular numbers.
Messaging
- Overview: Send and receive SMS, MMS, and RCS messages directly to and from cellular phone numbers attached to Telnyx IoT SIM cards (coming soon).
API Reference (Wireless)
SIM Cards
- Get all SIM cards: Get all SIM cards belonging to the user that match the given filters.
- Get SIM card: Returns the details regarding a specific SIM card.
- Update a SIM card: Updates SIM card data
- Deletes a SIM card: The SIM card will be decommissioned, removed from your account and you will stop being charged.<br />The SIM card won’t be able to connect to the network after…
- Register SIM cards: Register the SIM cards associated with the provided registration codes to the current user’s account.<br/><br/>
- Purchase eSIMs: Purchases and registers the specified amount of eSIMs to the current user’s account.<br/><br/>
- Request a SIM card enable: This API enables a SIM card, connecting it to the network and making it possible to consume data.<br/>
- Request a SIM card disable: This API disables a SIM card, disconnecting it from the network and making it impossible to consume data.<br/>
- Request setting a SIM card to standby: The SIM card will be able to connect to the network once the process to set it to standby has been completed, thus making it possible to consume data.<br/>
- Request bulk disabling voice on SIM cards.: This API triggers an asynchronous operation to disable voice on SIM cards belonging to a specified SIM Card Group.<br/>
- Request bulk enabling voice on SIM cards.: This API triggers an asynchronous operation to enable voice on SIM cards belonging to a specified SIM Card Group.<br/>
- Request bulk setting SIM card public IPs.: This API triggers an asynchronous operation to set a public IP for each of the specified SIM cards.<br/>
- Validate SIM cards registration codes: It validates whether SIM card registration codes are valid or not.
- 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.
- 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.
- Delete SIM card data usage notifications: Delete the 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.
SIM Card Orders
- Get all SIM card orders: Get all SIM card orders according to filters.
- Create a SIM card order: Creates a new order for SIM cards.
- Get a single SIM card order: Get a single SIM card order by its ID.
- Preview SIM card orders: Preview SIM card order purchases.
SIM Card Actions
- List SIM card actions: This API lists a paginated collection of SIM card actions. It enables exploring a collection of existing asynchronous operations using specific filters.
- Get SIM card action details: This API fetches detailed information about a SIM card action to follow-up on an existing asynchronous operation.
- List bulk SIM card actions: This API lists a paginated collection of bulk SIM card actions. A bulk SIM card action contains details about a collection of individual SIM card actions.
- Get bulk SIM card action details: This API fetches information about a bulk SIM card action. A bulk SIM card action contains details about a collection of individual SIM card actions.
SIM Card Groups
- Get all SIM card groups: Get all SIM card groups belonging to the user that match the given filters.
- Create a SIM card group: Creates a new SIM card group object
- Get SIM card group: Returns the details regarding a specific SIM card group
- Update a SIM card group: Updates a SIM card group
- Delete a SIM card group: Permanently deletes a SIM card group
- Request Private Wireless Gateway removal from SIM card group: This action will asynchronously remove an existing Private Wireless Gateway definition from a SIM card group. Completing this operation defines that all SIM ca…
- Request Wireless Blocklist removal from SIM card group: This action will asynchronously remove an existing Wireless Blocklist to all the SIMs in the SIM card group.
- Request Private Wireless Gateway assignment for SIM card group: This action will asynchronously assign a provisioned Private Wireless Gateway to the SIM card group. Completing this operation defines that all SIM cards in th…
- Request Wireless Blocklist assignment for SIM card group: This action will asynchronously assign a Wireless Blocklist to all the SIMs in the SIM card group.
SIM Card Group Actions
- List SIM card group actions: This API allows listing a paginated collection a SIM card group actions. It allows to explore a collection of existing asynchronous operation using specific fi…
- Get SIM card group action details: This API allows fetching detailed information about a SIM card group action resource to make follow-ups in an existing asynchronous operation.
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…
- Get a Private Wireless Gateway: Retrieve information about a Private Wireless Gateway.
- Delete a Private Wireless Gateway: Deletes the 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.
- Get a Wireless Blocklist: Retrieve information about a Wireless Blocklist.
- Update a Wireless Blocklist: Update a Wireless Blocklist.
- Delete a Wireless Blocklist: Deletes the Wireless Blocklist.
- Get all possible wireless blocklist values: Retrieve all wireless blocklist values for a given blocklist type.
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, ordomainsmust be provided. - Get a traffic policy profile: Returns the details regarding a specific traffic policy profile.
- Update a traffic policy profile: Updates a traffic policy profile.
- Delete a traffic policy profile: Deletes the 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.
- Get a Wireless Detail Record (WDR) Report: Returns one specific WDR report
- Delete a Wireless Detail Record (WDR) Report: Deletes one specific WDR report.
OTA updates
- List OTA updates
- Get OTA update: This API returns the details of an Over the Air (OTA) update.