Deletes a SIM card - Telnyx

The SIM card will be decommissioned, removed from your account and you will stop being charged.
The SIM card won't be able to connect to the network after the deletion is completed, thus making it impossible to consume data.

Transitioning to the disabled state may take a period of time.
Until the transition is completed, the SIM card status will be disabling disabling.
In order to re-enable the SIM card, you will need to re-register it.

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

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Path Params

string <uuid>

required

Identifies the SIM.

Example:

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

Query Params

report_lost

boolean

optional

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

Default:

false

Responses

🟢200OK

application/json

Successful response

Body

data

object (SIMCard)

optional

actions_in_progress

boolean

read-onlyoptional

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

Default:

false

Example:

true

authorized_imeis

array[string <int64>]

optional

List of IMEIs authorized to use a given SIM card.

Example:

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

created_at

string

read-onlyoptional

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

Example:

2018-02-02T22:25:27.521Z

current_billing_period_consumed_data

object

read-onlyoptional

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

current_device_location

object

read-onlyoptional

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

current_imei

string <int64>

read-onlyoptional

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

Example:

457032284023794

current_mcc

string

read-onlyoptional

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

current_mnc

string

read-onlyoptional

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_limit

object

optional

The SIM card individual data limit configuration.

iccid

string

read-onlyoptional

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

string <uuid>

read-onlyoptional

Identifies the resource.

Example:

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

imsi

string

read-onlyoptional

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:

81932214823362980

ipv4

string

read-onlyoptional

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

ipv6

string

read-onlyoptional

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

live_data_session

enum<string>

read-onlyoptional

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

Allowed values:

connecteddisconnectedunknown

Example:

connected

msisdn

string

read-onlyoptional

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

record_type

string

read-onlyoptional

Example:

sim_card

sim_card_group_id

string <uuid>

optional

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

Example:

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

status

object (SIMCardStatus)

optional