Skip to main content

Get SIM card

GET 
/sim_cards/:id

Returns the details regarding a specific SIM card.

Request ​

Path Parameters

    id uuidrequired

    Identifies the SIM.

Query Parameters

    include_sim_card_group boolean

    It includes the associated SIM card group object in the response when present.

    include_pin_puk_codes boolean

    When set to true, includes the PIN and PUK codes in the response. These codes are used for SIM card security and unlocking purposes. Available for both physical SIM cards and eSIMs.

Responses ​

200: Successful response

Schema

    data

    object

    id uuid

    Identifies the resource.

    record_type string

    status

    object

    value string

    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:

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

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

    type string

    Possible values: [physical, esim]

    The type of SIM card

    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.

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

    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.

    sim_card_group_id uuid

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

    tags string[]

    Searchable tags associated with the SIM card

    authorized_imeis int64[]

    List of IMEIs authorized to use a given SIM card.

    current_imei int64

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

    data_limit

    object

    The SIM card individual data limit configuration.

    amount decimal
    unit string

    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.

    amount decimal
    unit string

    Default value: MB

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

    actions_in_progress boolean

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

    created_at string

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

    updated_at string

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

    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.

    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.

    current_device_location

    object

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

    latitude float
    longitude float
    accuracy integer
    accuracy_unit string

    Default value: m

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

    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.

    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.

    live_data_session string

    Possible values: [connected, disconnected, unknown]

    Indicates whether the device is actively connected to a network and able to run 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.

    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.

    pin2 string

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

    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.

    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.

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

401: Unauthorized

default: Unexpected error

Schema

    errors

    Error[]

  • Array [

    • code intrequired
    title stringrequired
    detail string

    source

    object

    pointer json-pointer

    JSON pointer (RFC6901) to the offending entity.

    parameter string

    Indicates which query parameter caused the error.

    meta object

  • ]

Request samples

curl -L 'https://api.telnyx.com/v2/sim_cards/:id' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'

Response samples

{
  "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"
    }
  }
}