Deletes a SIM card
DELETE/sim_cards/:id
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.
Request
Path Parameters
Identifies the resource.
Responses
200: Successful response
- application/json
- Schema
- Example (from schema)
Schema
registering
- the card is being registeredenabling
- the card is being enabledenabled
- the card is enabled and ready for usedisabling
- the card is being disableddisabled
- the card has been disabled and cannot be useddata_limit_exceeded
- the card has exceeded its data consumption limitsetting_standby
- the process to set the card in stand by is in progressstandby
- the card is in stand by
data
object
Identifies the resource.
status
object
Possible values: [registering
, enabling
, enabled
, disabling
, disabled
, data_limit_exceeded
, setting_standby
, standby
]
The current status of the SIM card. It will be one of the following:
It describes why the SIM card is in the current status.
Possible values: [physical
, esim
]
The type of SIM card
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.
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).
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.
The group SIMCardGroup identification. This attribute can be null
when it's present in an associated resource.
Searchable tags associated with the SIM card
List of IMEIs authorized to use a given SIM card.
IMEI of the device where a given SIM card is currently being used.
data_limit
object
The SIM card individual data limit configuration.
Possible values: [MB
, GB
]
The SIM card individual data limit configuration.
current_billing_period_consumed_data
object
The SIM card consumption so far in the current billing cycle.
Default value: MB
The SIM card consumption so far in the current billing cycle.
Indicate whether the SIM card has any pending (in-progress) actions.
ISO 8601 formatted date-time indicating when the resource was created.
ISO 8601 formatted date-time indicating when the resource was updated.
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.
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.
current_device_location
object
Current physical location data of a given SIM card. Accuracy is given in meters.
Default value: m
Current physical location data of a given SIM card. Accuracy is given in meters.
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.
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.
Possible values: [connected
, disconnected
, unknown
]
Indicates whether the device is actively connected to a network and able to run 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"
}
}
default: Unexpected error
- application/json
- Schema
- Example (from schema)
Schema
Array [
]
errors
Error[]
source
object
JSON pointer (RFC6901) to the offending entity.
Indicates which query parameter caused the error.
{
"errors": [
{
"code": "string",
"title": "string",
"detail": "string",
"source": {
"pointer": "string",
"parameter": "string"
},
"meta": {}
}
]
}