SIM Cards

Get all SIM cards

Changed on

Get all SIM cards belonging to the user that match the given filters.

get/sim_cards

Request

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

Query parameters

iccidstring

A search string to partially match for the SIM card's ICCID.

msisdnstring

A search string to match for the SIM card's MSISDN.

statusstring[]

Filter by a SIM card's status.

tagsstring[]

A list of SIM card tags to filter on.<br/><br/> If the SIM card contains <b><i>all</i></b> of the given <code>tags</code> they will be found.<br/><br/> For example, if the SIM cards have the following tags: <ul>

<li><code>['customers', 'staff', 'test']</code> <li><code>['test']</code></li> <li><code>['customers']</code></li> </ul> Searching for <code>['customers', 'test']</code> returns only the first because it's the only one with both tags.<br/> Searching for <code>test</code> returns the first two SIMs, because both of them have such tag.<br/> Searching for <code>customers</code> returns the first and last SIMs.<br/>

Consolidated filter parameter for SIM cards (deepObject style). Originally: filter[iccid], filter[msisdn], filter[status], filter[tags]

{
  "iccid": "89310410106543789301",
  "msisdn": "+13109976224",
  "tags": [
    "personal",
    "customers",
    "active-customers"
  ]
}
numberinteger

The page number to load.

sizeinteger

The size of the page.

Consolidated pagination parameter (deepObject style). Originally: page[number], page[size]

include_sim_card_groupboolean
Example:true

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

filter[sim_card_group_id]string uuid
Example:47a1c2b0-cc7b-4ab1-bb98-b33fb0fc61b9

A valid SIM card group ID.

sort'current_billing_period_consumed_data.amount' | '-current_billing_period_consumed_data.amount'

Sorts SIM cards by the given field. Defaults to ascending order unless field is prefixed with a minus sign.

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"
      ],
      "data_limit": {
        "amount": "2048.0",
        "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",
      "esim_installation_status": "released",
      "version": "4.3",
      "resources_with_in_progress_actions": [],
      "authorized_imeis": [
        "106516771852751",
        "534051870479563",
        "508821468377961"
      ]
    }
  ],
  "meta": {
    "total_pages": 3,
    "total_results": 55,
    "page_number": 2,
    "page_size": 25
  }
}

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