SIM Cards

Get SIM card

Changed on

Returns the details regarding a specific SIM card.

get/sim_cards/{id}

Request

  • Base URL: https://api.telnyx.com/v2
  • URL: https://api.telnyx.com/v2/sim_cards/{id}
  • Auth: HTTP bearer

Path parameters

idstring uuid required
Example:6a09cdc3-8948-47f0-aa62-74ac943d6c58

Identifies the SIM.

Query parameters

include_sim_card_groupboolean
Example:true

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

include_pin_puk_codesboolean

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.

Response

Successful response

Example response

{
  "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",
    "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": []
  }
}

Changes

  • 19db5ee4ec59Revision changes
    • breaking

      the // response's property type changed from integer to string, and format from int32 to no format for status

    • info

      added the optional property // to the response with the status

  • a6a61a29ecddRevision changes
    • breaking

      the // response's property type changed from string to integer, and format from no format to int32 for status