Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Kin Lane

Chat with Kin

AI assistant · trained on my blog

Telnyx

Telnyx SIM Cards API

SIM Cards operations

Documentation Provider Profile APIs.io OpenAPI GitHub

Telnyx SIM Cards API is one of 168 APIs that Telnyx publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include SIM Cards. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 24 operations across 19 paths, and defines 20 schemas. It is described by OpenAPI 3.1.0, at version 2.0.0.

Requests are made against a single base URL, https://api.telnyx.com/v2.

24 operations 19 paths 20 schemas 2 DELETE8 GET2 PATCH12 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
2.0.0
Base URL
https://api.telnyx.com/v2
Authentication
HTTP Bearer, HTTP Bearer, OAuth 2.0, HTTP Bearer, HTTP Bearer, HTTP Bearer
Contact
support@telnyx.com
Resource Areas
1

Authentication & Security 6

Telnyx SIM Cards API declares 6 security schemes for authenticating requests. It accepts HTTP bearer tokens (bearerAuth). It accepts HTTP bearer tokens (branded-calling_bearerAuth). It supports OAuth 2.0 (oauthClientAuth) using the authorizationCode and clientCredentials flows, exposing 1 scope. It accepts HTTP bearer tokens (JWT) (outbound-voice-profiles_bearerAuth). It accepts HTTP bearer tokens (pronunciation-dicts_bearerAuth). It accepts HTTP bearer tokens (JWT) (stored-payment-transactions_bearerAuth). By default, every request must be authenticated.

  • branded-calling_bearerAuth — API key passed as a Bearer token in the Authorization header
  • oauthClientAuth — OAuth 2.0 authentication for Telnyx API and MCP integrations
  • pronunciation-dicts_bearerAuth — Telnyx API v2 key. Obtain from https://portal.telnyx.com

Paths & Operations 24

Across 19 paths, the API surfaces 24 operations — 2 DELETE, 8 GET, 2 PATCH, 12 POST. Each is listed below with its method, path, parameters, and response codes.

SIM Cards 24

SIM Cards operations

POST
/actions/purchase/esims
Purchase eSIMs
PurchaseESim body → 202401
POST
/actions/register/sim_cards
Register SIM cards
RegisterSimCards body → 202401
GET
/sim_card_data_usage_notifications
List SIM card data usage notifications
ListDataUsageNotifications 3 params → 200401default
POST
/sim_card_data_usage_notifications
Create a new SIM card data usage notification
PostSimCardDataUsageNotification body → 201401default
DELETE
/sim_card_data_usage_notifications/{id}
Delete SIM card data usage notifications
DeleteSimCardDataUsageNotifications 1 param → 200401default
GET
/sim_card_data_usage_notifications/{id}
Get a single SIM card data usage notification
GetSimCardDataUsageNotification 1 param → 200404default
PATCH
/sim_card_data_usage_notifications/{id}
Updates information for a SIM Card Data Usage Notification
PatchSimCardDataUsageNotification 1 param body → 200401default
GET
/sim_cards
Get all SIM cards
GetSimCards 5 params → 200401default
POST
/sim_cards/actions/bulk_disable_voice
Request bulk disabling voice on SIM cards.
DisableVoiceBulk body → 202422
POST
/sim_cards/actions/bulk_enable_voice
Request bulk enabling voice on SIM cards.
EnableVoiceBulk body → 202422
POST
/sim_cards/actions/bulk_set_public_ips
Request bulk setting SIM card public IPs.
SetPublicIPsBulk body → 202422
POST
/sim_cards/actions/validate_registration_codes
Validate SIM cards registration codes
ValidateRegistrationCodes body → 200401default
DELETE
/sim_cards/{id}
Deletes a SIM card
DeleteSimCard 2 params → 200401default
GET
/sim_cards/{id}
Get SIM card
GetSimCard 3 params → 200401default
PATCH
/sim_cards/{id}
Update a SIM card
UpdateSimCard 1 param body → 200401default
POST
/sim_cards/{id}/actions/disable
Request a SIM card disable
DisableSimCard 1 param → 202401default
POST
/sim_cards/{id}/actions/enable
Request a SIM card enable
EnableSimCard 1 param → 202422default
POST
/sim_cards/{id}/actions/remove_public_ip
Request removing a SIM card public IP
RemoveSimCardPublicIp 1 param → 202401default
POST
/sim_cards/{id}/actions/set_public_ip
Request setting a SIM card public IP
SetSimCardPublicIp 2 params → 202401default
POST
/sim_cards/{id}/actions/set_standby
Request setting a SIM card to standby
SetSimCardStandby 1 param → 202401default
GET
/sim_cards/{id}/activation_code
Get activation code for an eSIM
GetSimCardActivationCode 1 param → 200401default
GET
/sim_cards/{id}/device_details
Get SIM card device details
GetSimCardDeviceDetails 1 param → 200401default
GET
/sim_cards/{id}/public_ip
Get SIM card public IP definition
GetSimCardPublicIp 1 param → 200401default
GET
/sim_cards/{id}/wireless_connectivity_logs
List wireless connectivity logs
GetWirelessConnectivityLogs 3 params → 200401default

Schemas 20

The contract defines 20 schemas that model the data the API accepts and returns. The most detailed are SIMCard (28 properties), SimpleSIMCard (20 properties), WirelessConnectivityLog (18 properties), SIMCardAction (8 properties). Each schema is shown below with its type and property counts.

SIMCardRegistrationCodeValidations
object
1 property
ESimPurchase
object
6 properties 1 required
WirelessConnectivityLog
object
This object represents a wireless connectivity session log that happened through a SIM card. It aids in finding out potential problems when the SIM is not able…
18 properties
SIMCard
object
28 properties
SimCardDataUsageNotification
object
The SIM card individual data usage notification information.
6 properties
wireless_Id
string
Identifies the resource.
SIMCardActivationCode
object
2 properties
wireless_Errors
object
1 property
SimpleSIMCard
object
20 properties
wireless_Error
object
5 properties 2 required
SIMCardDeviceDetails
object
6 properties
SIMCardRegistrationCodeValidation
object
4 properties
wireless_CreatedAt
string
ISO 8601 formatted date-time indicating when the resource was created.
BulkSIMCardAction
object
This object represents a bulk SIM card action. It groups SIM card actions created through a bulk endpoint under a single resource for further lookup.
6 properties
SIMCardRegistration
object
4 properties 1 required
PaginationMeta
object
4 properties
SIMCardPublicIP
object
7 properties
SIMCardStatus
object
2 properties
SIMCardAction
object
This object represents a SIM card action. It allows tracking the current status of an operation that impacts the SIM card.
8 properties
wireless_UpdatedAt
string
ISO 8601 formatted date-time indicating when the resource was updated.

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

telnyx-sim-cards-api-openapi.yml Raw ↑

Other APIs Telnyx publishes across the network.

Telnyx Access Tokens API
AE Profile APIs.io
Telnyx Addresses API
AE Profile APIs.io
Telnyx Advanced Number Orders API
AE Profile APIs.io
Telnyx Assistants API
AE Profile APIs.io
Telnyx Audio API
AE Profile APIs.io
Telnyx Audit Logs API
AE Profile APIs.io
Telnyx Authentication Providers API
AE Profile APIs.io
Telnyx AutoRechargePreferences API
AE Profile APIs.io
Telnyx Billing API
AE Profile APIs.io
Telnyx Billing Groups API
AE Profile APIs.io
Telnyx Brands API
AE Profile APIs.io
Telnyx Bucket SSL Certificate API
AE Profile APIs.io
#SIM Cards
← Back to T APIs
API Details
ID
telnyx:telnyx-sim-cards-api
Base URL
https://api.telnyx.com/v2
Docs
https://developers.telnyx.com/api
Provider
Telnyx
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network