Telnyx

import Telnyx from 'telnyx'; const client = new Telnyx({ apiKey: 'My API Key', }); const simCard = await client.simCards.delete('6a09cdc3-8948-47f0-aa62-74ac943d6c58'); console.log(simCard.data);

{ "data": { "id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58", "record_type": "sim_card", "status": { "value": "enabled", "reason": "The SIM card is active, ready to connect to networks and consume data." }, "type": "physical", "iccid": "89310410106543789301", "imsi": "081932214823362973", "msisdn": "+13109976224", "sim_card_group_id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58", "tags": [ "personal", "customers", "active-customers" ], "authorized_imeis": [ "106516771852751", "534051870479563", "508821468377961" ], "current_imei": "457032284023794", "data_limit": { "amount": "2048.1", "unit": "MB" }, "current_billing_period_consumed_data": { "amount": "2049.0", "unit": "MB" }, "actions_in_progress": true, "created_at": "2018-02-02T22:25:27.521Z", "updated_at": "2018-02-02T22:25:27.521Z", "ipv4": "192.168.0.0", "ipv6": "2001:cdba:0000:0000:0000:0000:3257:9652", "current_device_location": { "latitude": "41.143", "longitude": "-8.605", "accuracy": 1250, "accuracy_unit": "m" }, "current_mnc": "260", "current_mcc": "410", "live_data_session": "connected", "pin_puk_codes": { "pin1": "1234", "pin2": "5678", "puk1": "12345678", "puk2": "87654321" }, "esim_installation_status": "released", "version": "4.3", "resources_with_in_progress_actions": [], "eid": null } }

import Telnyx from 'telnyx'; const client = new Telnyx({ apiKey: 'My API Key', }); const simCard = await client.simCards.delete('6a09cdc3-8948-47f0-aa62-74ac943d6c58'); console.log(simCard.data);

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

string<uuid>

required

Identifies the SIM.

Example:

"6a09cdc3-8948-47f0-aa62-74ac943d6c58"

Query Parameters

report_lost

boolean

default:false

Enables deletion of disabled eSIMs that can't be uninstalled from a device. This is irreversible and the eSIM cannot be re-registered.

Response

Successful response

data

SIMCard · object

Show child attributes

data.id

string<uuid>

Identifies the resource.

Example:

"6a09cdc3-8948-47f0-aa62-74ac943d6c58"

data.record_type

string

Example:

"sim_card"

data.status

object

Show child attributes

data.status.value

enum<string>

The current status of the SIM card. It will be one of the following:

<ul> <li><code>registering</code> - the card is being registered</li> <li><code>enabling</code> - the card is being enabled</li> <li><code>enabled</code> - the card is enabled and ready for use</li> <li><code>disabling</code> - the card is being disabled</li> <li><code>disabled</code> - the card has been disabled and cannot be used</li> <li><code>data_limit_exceeded</code> - the card has exceeded its data consumption limit</li> <li><code>setting_standby</code> - the process to set the card in stand by is in progress</li> <li><code>standby</code> - the card is in stand by</li> </ul> Transitioning between the enabled and disabled states may take a period of time.

Available options:

registering,

enabling,

enabled,

disabling,

disabled,

data_limit_exceeded,

setting_standby,

standby

Example:

"enabled"

data.status.reason

string

It describes why the SIM card is in the current status.

Example:

"The SIM card is active, ready to connect to networks and consume data."

data.type

enum<string>

The type of SIM card

Available options:

physical,

esim

Example:

"physical"

data.iccid

string

The ICCID is the identifier of the specific SIM card/chip. Each SIM is internationally identified by its integrated circuit card identifier (ICCID). ICCIDs are stored in the SIM card's memory and are also engraved or printed on the SIM card body during a process called personalization.

Example:

"89310410106543789301"

data.imsi

string

SIM cards are identified on their individual network operators by a unique International Mobile Subscriber Identity (IMSI). Mobile network operators connect mobile phone calls and communicate with their market SIM cards using their IMSIs. The IMSI is stored in the Subscriber Identity Module (SIM) inside the device and is sent by the device to the appropriate network. It is used to acquire the details of the device in the Home Location Register (HLR) or the Visitor Location Register (VLR).

Example:

"081932214823362973"

data.msisdn

string

Mobile Station International Subscriber Directory Number (MSISDN) is a number used to identify a mobile phone number internationally. MSISDN is defined by the E.164 numbering plan. It includes a country code and a National Destination Code which identifies the subscriber's operator.

Example:

"+13109976224"

data.sim_card_group_id

string<uuid>

The group SIMCardGroup identification. This attribute can be <code>null</code> when it's present in an associated resource.

Example:

"6a09cdc3-8948-47f0-aa62-74ac943d6c58"

data.tags

string[]

Searchable tags associated with the SIM card

Example:

["personal", "customers", "active-customers"]

data.authorized_imeis

string[] | null

List of IMEIs authorized to use a given SIM card.

Example:

[
  "106516771852751",
  "534051870479563",
  "508821468377961"
]

data.current_imei

string

IMEI of the device where a given SIM card is currently being used.

Example:

"457032284023794"

data.data_limit

object

The SIM card individual data limit configuration.

Show child attributes

data.data_limit.amount

string

Example:

"2048.1"

data.data_limit.unit

enum<string>

Available options:

MB,

GB

Example:

"MB"

data.current_billing_period_consumed_data

object

The SIM card consumption so far in the current billing cycle.

Show child attributes

data.current_billing_period_consumed_data.amount

string

Example:

"2049.0"

data.current_billing_period_consumed_data.unit

string

default:MB

Example:

"MB"

data.actions_in_progress

boolean

default:false

Indicate whether the SIM card has any pending (in-progress) actions.

Example:

true

data.created_at

string

ISO 8601 formatted date-time indicating when the resource was created.

Example:

"2018-02-02T22:25:27.521Z"

data.updated_at

string

ISO 8601 formatted date-time indicating when the resource was updated.

Example:

"2018-02-02T22:25:27.521Z"

data.ipv4

string

The SIM's address in the currently connected network. This IPv4 address is usually obtained dynamically, so it may vary according to the location or new connections.

Example:

"192.168.0.0"

data.ipv6

string

The SIM's address in the currently connected network. This IPv6 address is usually obtained dynamically, so it may vary according to the location or new connections.

Example:

"2001:cdba:0000:0000:0000:0000:3257:9652"

data.current_device_location

object

Current physical location data of a given SIM card. Accuracy is given in meters.

Show child attributes

data.current_device_location.latitude

string

Example:

"41.143"

data.current_device_location.longitude

string

Example:

"-8.605"

data.current_device_location.accuracy

integer

Example:

1250

data.current_device_location.accuracy_unit

string

default:m

Example:

"m"

data.current_mnc

string

Mobile Network Code of the current network to which the SIM card is connected. It's a two to three decimal digits that identify a network. This code is commonly seen joined with a Mobile Country Code (MCC) in a tuple that allows identifying a carrier known as PLMN (Public Land Mobile Network) code.

Example:

"260"

data.current_mcc

string

Mobile Country Code of the current network to which the SIM card is connected. It's a three decimal digit that identifies a country. This code is commonly seen joined with a Mobile Network Code (MNC) in a tuple that allows identifying a carrier known as PLMN (Public Land Mobile Network) code.

Example:

"410"

data.live_data_session

enum<string>

Indicates whether the device is actively connected to a network and able to run data.

Available options:

connected,

disconnected,

unknown

Example:

"connected"

data.pin_puk_codes

object

PIN and PUK codes for the SIM card. Only available when include_pin_puk_codes=true is set in the request.

Show child attributes

data.pin_puk_codes.pin1

string

The primary Personal Identification Number (PIN) for the SIM card. This is a 4-digit code used to protect the SIM card from unauthorized use.

Example:

"1234"

data.pin_puk_codes.pin2

string

The secondary Personal Identification Number (PIN2) for the SIM card. This is a 4-digit code used for additional security features.

Example:

"5678"

data.pin_puk_codes.puk1

string

The primary Personal Unblocking Key (PUK1) for the SIM card. This is an 8-digit code used to unlock the SIM card if PIN1 is entered incorrectly multiple times.

Example:

"12345678"

data.pin_puk_codes.puk2

string

The secondary Personal Unblocking Key (PUK2) for the SIM card. This is an 8-digit code used to unlock the SIM card if PIN2 is entered incorrectly multiple times.

Example:

"87654321"

data.esim_installation_status

enum<string> | null

The installation status of the eSIM. Only applicable for eSIM cards.

Available options:

released,

disabled

Example:

"released"

data.version

string

The version of the SIM card.

Example:

"4.3"

data.resources_with_in_progress_actions

object[]

List of resources with actions in progress.

Example:

[]

data.eid

string | null

The Embedded Identity Document (eID) for eSIM cards.

Example:

null

OAuth Discovery

IP Addresses

IP Ranges

SIM Cards

Addresses

Advanced Number Orders

Assistants

Audio

Chat

Clusters

Conversations

Embeddings

Fine Tuning

Integrations

MCP Servers

Audit Logs

Authentication Providers

Phone Number Search

Billing

Billing Groups

Brands

SIM Card Actions

Bundles

User Bundles

Call Control Applications

Debugging

Call Commands

Call Information

Campaign

Voice Channels

API Reference

Phone Number Orders

Conference Commands

Connections

Country Coverage

Credential Connections

Call Recordings

Customer Service Record

Detail Records

Dialogflow Integration

Documents

Dynamic Emergency Addresses

Dynamic Emergency Endpoints

Enum

External Connections

Programmable Fax Applications

Programmable Fax Commands

FQDN Connections

FQDNs

Global IPs

Inexplicit Number Orders

Integration Secrets

Inventory Level

IP Connections

IPs

Reports

MDR Detailed Reports

Speech to Text Batch Reports

CDR Reports

MDR Usage Reports

Telco Data Usage Reports

Speech to text Usage Reports

CDR Usage Reports

Managed Accounts

Media Storage API

Messages

RCS messaging

Messaging Hosted Number

Number Configurations

Advanced OptIn/OptOut

Messaging Profiles

Messaging Tollfree Verification

Messaging URL Domains

Mobile Network Operators

Push Credentials

Coverage

Networks

Notifications

Phone Number Block Orders

Number Lookup