​

Telnyx Wireless: SIMs & eSIMs — Documentation Index

SIMs & eSIMs documentation within the Wireless section of the Telnyx developer docs (https://developers.telnyx.com). Root index: https://developers.telnyx.com/llms.txt · Wireless index: https://developers.telnyx.com/development/llms/wireless-llms-txt.md · Full content for this subsection: https://developers.telnyx.com/development/llms/wireless-sims-esims-llms-full-txt.md

​

Overview

• 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

• 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

• 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

• 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.

​

API Reference (SIMs & eSIMs)

​

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.

​

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.