POST /Japi/Tigrillo/getSIMs

Returns a list of SIM records containing data about each SIM. You can set search parameters to restrict your search.

Authentication

  • User required to login

Headers

For information about headers, see Configuring headers.

Request Body application/json

Schema

Use null without quotes as the input if you do not wish to use these objects. The value will remain as previously set. If you want to change the object value to a new value, replace null with "<value>" within quotes, where <value> is the required value. To remove an existing value, type an empty string. For example: "friendlyName" : "" ,

JSON key Description Required?
searchCriteria

You can set searchCriteria on state, group, or tariff, or search for an exact string.

If null is entered as input for all parameters, all SIM records are returned, in ascending order of ICCID.

  
state

The SIM or IMSI state. You can request the following:

  • null (default) – this request will return all records, regardless of state
  • available
  • pendingProvision
  • provisioned
  • suspended
  • pendingDeprovision
  • unprovisioned

For more information, see Understanding the SIM lifecycle.

  
group

The SIM group name. Set the group names for SIM collections when you activate them using the activateSIMs function, or through the Infinity Classic portal. The default is null.

  
tariff The SIM tariff (returns PackageID). The tariff is usually four numerical digits in length, for example: 2356. The default is null.  
matchString An exact search string that you want to find. Requires matchType and matchFields to define where to search within a specified field. The default is null.  
matchType

Used in conjunction with matchString. Where to search for an exact string within a field, using the following search types:

  • "S" – starts with...
  • "E" – ends with...
  • "C" – contains
  • "M" – matches

The default is null.

  
matchFields

Used in conjunction with matchString. The field you want to search for an exact string. You can use either the field name or indicator:

Field name Indicator
"FriendlyName" "F"
"ICCID" "I"
"IMEI" "E"
"IMSI" "S"
"IP Address" "A"
"MSISDN" "M"

The default is null.

  
sortOrder

The field used for sorting the returned results. The default is null, which returns results in an undefined order.

Use either the field name or indicator:

Field name Indicator
"FriendlyName" "F"
"ICCID" "I"
"IMEI" "E"
"IMSI" "S"
"IP Address" "A"
MSISDN "M"

Type A (ascending) or D (descending) immediately after the indicator to arrange the results using the selected field.

For example, "FA" sorts the results by friendlyName, in ascending (0-9, A to Z) order. "FD" sorts the results by friendlyName, in descending order (Z to A, 9-0).

  
startRec

The start record for returned results. The default is null (alternatively, use "0"), which returns all the results listed from the first record (record 0). Use "1" to return all the results from record 1 onwards, "2" to return the results from record 2 onwards, and so on.

  
numRecs

The number of records to return. The default is null, which returns ten records. Use "1" to return one result, "2" to return two results, and so on.

  

Example

Copy
Body raw JSON
{
    "searchCriteria" : {
        "state" : null ,
        "group" : null ,
        "tariff" : null ,
        "matchString" : null ,
        "matchType" : null ,
        "matchFields" : null
    } ,
"sortOrder" : null ,
"startRec" : 0 ,
"numRecs" : 23
}

Responses application/json

Schema

JSON key Description
status

The array, containing details about the request status.
status

"OK" – the request processed successfully

"ERR" – the request failed
errorCode

"" – the request processed successfully

"<ErrorCodeNumber>" – the request failed because of this specific error.

For more information, see Troubleshooting errors: Tigrillo API.
errorMessage

"" – the request processed successfully

"<ErrorCodeMessage>" – displays an explanation of the error if the request failed.

For more information, see Troubleshooting errors: Tigrillo API.
totRecs

The total number of returned records.

sims

The array, containing details about each SIM.

 
MSISDN The unique SIM phone number (Mobile Station International ISDN Number).
simID The SIM number.

friendlyName

 A unique user-friendly name, to help identify the SIM. Change this value using setSIMDetail. For more information, see POST /Japi/Tigrillo/setSIMDetail.
MEID The Mobile Equipment Identifier. The unique 14 digit number that identifies CDMA system devices using Verizon, US Cellular, or Sprint carriers.
ICCID The unique Integrated Circuit Card Identification Number.
IMSI The International Mobile Subscriber Identity.
DataUsage The total amount of data used in the current month, in bytes.
DataDate The date and time stamp of the last data usage update.
ipAddress The unique SIM internet protocol address.
group The name identifying a group of SIMs. Change this value in the Infinity Classic portal.
LastMCC The last recorded Mobile Country Code – the country the device was in when the event occurred, in three-digit numeric format. For more information, see http://en.wikipedia.org/wiki/Mobile_country_code.
LastMNC Last recorded Mobile Network Code – the network operator the device was using when the event occurred, in one or two digit numeric format. For more information, see http://en.wikipedia.org/wiki/Mobile_country_code.
LastRadiusStart

The last recorded date and time that the device opened a data session and optained an IP address.
LastRadiusStop

The last recorded date and time that the device ended a data session.

If LastRadiusStop occurs before the LastRadiusStart, the current session is in progress.

If LastRadiusStop occurs after LastRadiusStart, the session has ended.

If the data session abnormally terminates without a close request from the device, the event and date and time stamp may be absent.
PackageID The package reference number (tariffID), usually four digits.
Activated The date and time stamp indicating when the SIM was activated.
OutOfService The date and time stamp indicating when the SIM was terminated.
status

The current SIM state: "available", "pendingProvision", "provisioned", "suspended", "pendingDeprovision", or "unprovisioned".

For more information, see Understanding the SIM lifecycle.
statusReason

For suspended or terminated (unprovisioned) SIMs or IMSIs (for a multi-IMSI SIM) only, a reason for the status. Either:

  • "customer" – the customer requested the suspension or termination
  • "profile" – the alerting profile rules have triggered a suspension. For more information, see 8295 Infinity Classic User Guide (PDF).
alert Currently unused
controls

The type of control message you can send to the SIM:

  • S – SMS
  • U – USSD
  • US– both USSD and SMS
  • "" – neither USSD nor SMS are permitted
dataMSISDN Not normally supported for IoT devices without prior arrangement. One or more phone numbers that are associated with the SIM for sending and receiving data only.
localMSISDN The primary phone number associated with the SIM.
mappedMSISDN

One or more country-specific phone numbers that are associated with the SIM.

Example

Copy
JSON
{
    "totRecs": 15,
    "sims": [
        {
            "MSISDN": 19282885999,
            "simID": "8944555523012560998",
            "friendlyName": "null",
            "MEID": null,
            "ICCID": "8944555523012560998",
            "IMSI": 234588550763077,
            "DataUsage": 0,
            "DataDate": null,
            "ipAddress": "10.246.121.56",
            "group": null,
            "LastMCC": "310",
            "LastMNC": "260",
            "LastRadiusStart": "2018-01-09 17:46:43",
            "LastRadiusStop": "2018-01-09 17:47:14",
            "PackageID": 9337,
            "Activated": "2020-09-18 12:57:02",
            "OutOfService": null,
            "status": "active",
            "alert": "",
            "controls": "SU",
            "dataMSISDN": null,
            "localMSISDN": 44745256365313,
            "mappedMSISDN": 19282885056
        },

Where to next?

Related resources