Get Thing ICCID using IMSI

This guide will show you how you can view Thing ICCID number using API command to search using IMSI number.

Get Thing ICCID using IMSI

GET https://console.monogoto.io/mobilesubscriber/{IMSI_NUMBER}/

Path Parameters

Name	Type	Description
IMSI_NUMBER	String	The IMSI of your SIM

Headers

Name	Type	Description
TOKEN_HERE	String	Your authentication token

Example using cURL:

curl -X GET \
    --url "https://console.monogoto.io/mobilesubscriber/{IMSI_NUMBER}/" \
    -H "accept: application/json" \
    -H "Authorization: Bearer {TOKEN_HERE}"

Add your IMSI_NUMBER and Token in the GET request to successfully obtain the Thing info.

Example of request:

curl -X GET \
    --url "https://console.monogoto.io/mobilesubscriber/123456789101112/" \
    -H "accept: application/json" \
    -H "Authorization: Bearer eyJhb6IkpXVCJ9.eyJSb2xlIjoiVXN4lclByb2ZpbGVJZF9kZGM2MThhNC0wNTI1LTQ2MmUtYWN3NzhhMGQxYmbSI6Im4zgFkbWluIiwiQ3VzdG9tsbCwiVXNlcklkIjoiVklkXzg5Yj5Y2OGEyUtNDQThhLTEzZjA0MzJhZDE3YyINTAzgZmUtZGI51My00ZjRiLTktN2U5Yjc0ZWU1ZThlIiwiaWNzM3MjI5L2MDY3NTE2Mjl9.99aSLzP7kTgK6TZGW-xalrMu0GkW6viunt3XxbNng"

Example of received result showing ICCID number:

{
  "BatchId": "Tutorial SIM",
  "BillingState": "NEVER",
  "BillingStateLastUpdatedMonth": 1649770113950,
  "Block": {
    "Data": false,
    "LTEData": false,
    "Voice_MO": false,
    "Voice_MT": false,
    "SMS_MO": false,
    "SMS_MT": false,
    "Voice_International": false,
    "Voice_International_Exc_Home": false,
    "Supplementary_Services": false,
    "SMS_MO_except_home_country": false,
    "Voice_Premium": false
  },
  "CreatedBy": "UserId_9sd6f07-22k9-4z9c-v6g1-c9d999hz44",
  "CurrentCountry": null,
  "CustomerId": "cid_c256463da-742-491b-911b-8850177ef5121",
  "DateAssignedToCustomer": null,
  "DateCreated": 1581239454231,
  "DateModified": 1649763719363,
  "ExternalBatchId": "Tutorial SIM",
  "IMSI": "123456789101112",
  "LastActivationDate": 1649661968873,
  "LastLocationUpdateTime": null,
  "Latitude": null,
  "LocationICCID": "ThingId_ICCID_8912372646888991",
  "Longitude": null,
  "MSC": null,
  "MobileSubscriberType": "Regular",
  "NetworkProviderId": "NetworkProviderId_09ba9s6f-afga-499d-afsd-6bd5161sd56g2",
  "OrganizationId": "OrganizationId_23156asfd-d1651as9-4699-accc-1eas5f16asb01a",
  "OtaRequestId": null,
  "PIN1": "1234",
  "PIN2": "1234",
  "PUK1": "12345678",
  "PUK2": "12345678",
  "PlmnList": [],
  "PricePlanInnerId": "InnerId_a264asfc5d-fc52-4ab9-8995-34516asf6a6",
  "RoamingPolicyId": null,
  "RoamingRestrictions": [],
  "SetPLMNByOTAState": "INHERITS",
  "ShouldOverrideCallForward": false,
  "State": "ACTIVE",
  "Status": "Serving",
  "SubProfId": "SubProfId_546sf6hf-c99c-459a-a92a-551569fasfa",
  "ThingId": "ThingId_ICCID_8912372646888991",
  "Type": "MobileSubscriber",
  "VcsAccountId": null,
  "WelcomeSMSState": "INHERITS",
  "CellId": 123,
  "Lac": 456,
  "cas": "164975648941393888",
  "UsedPricePlanInnerId": "InnerId_a2564asf5d-f6a-4949-8995-389twwgs921fa6",
  "ActualUsage": {
    "MO_SMS_CDR_": 0,
    "Data_": 127021140,
    "Voice_": 0,
    "Alarm": 0
  }
}

Returns a single mobile identity

GEThttps://console.monogoto.io/mobilesubscriber/{IMSI}/

Path parameters

IMSI*string

Mobile Identity

Response

200401404500

Mobile identity object identified by the IMSI parameters

Body

application/json

Typestring

Type

IMSI*string

Mobile Identity

CustomerIdstring

Customer ID

ThingIdstring

Parent Thing Id

PricePlanInnerIdstring

Price Plan Inner ID

ExternalBatchId*string

External Batch ID

BatchId*string

Batch ID

SubProfId*string

Subscription Profile ID

NetworkProviderIdstring

Network Provider ID

RoamingPolicyIdstring

Roaming Policy Id

Latitudenumber (float)

Thing GEO Location

Longitudenumber (float)

Thing GEO Location

Statestring

State of the mobile identity

SetPLMNByOTAStatestring

Allowed three states : Inherits - take from next hierarchy level (Thing, Things Group, Customer) , Enable - will create OTA Campaign with OPLMN , PLMN Sel operations if the subscriber connected to network in different country, Disable - will NOT create OTA Campaign

WelcomeSMSStatestring

Allowed three states : Inherits - take from next hierarchy level (Thing, Things Group, Customer) , Enable - will send welcome SMS if the subscriber connected to network in different country, Disable - will NOT send welcome SMS

BillingStatestring

Billing State of the thing

DateCreatednumber

Document Created Date

DateModifiednumber

Document Modified Date

VcsAccountIdstring

VCS Account ID

RoamingRestrictionsarray of RoamingRestrictions (object)

Roaming Restrictions

BlockBlockForThing (object)

ActualUsageActualUsage (object)

Creditstring

Credit in bytes

CreditExpirationDatestring (date-time)

Credit expiration date (UTC). Expected date format: YYYY-MM-DDTHH:mm:ssZ

CreditWebhookstring

Credit Webhook URL

casstring

indicator of version

Request

JavaScriptCurlPython

const response = await fetch('https://console.monogoto.io/mobilesubscriber/{IMSI}/', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200401404500

{
  "Type": "text",
  "IMSI": "text",
  "CustomerId": "text",
  "ThingId": "text",
  "PricePlanInnerId": "text",
  "ExternalBatchId": "text",
  "BatchId": "text",
  "SubProfId": "text",
  "NetworkProviderId": "text",
  "RoamingPolicyId": "text",
  "Latitude": 0,
  "Longitude": 0,
  "State": "text",
  "SetPLMNByOTAState": "text",
  "WelcomeSMSState": "text",
  "BillingState": "text",
  "DateCreated": 0,
  "DateModified": 0,
  "VcsAccountId": "text",
  "RoamingRestrictions": [
    {
      "BlockRoaming": false,
      "BlockSMS": false,
      "BlockMOVoiceFlag": false,
      "BlockMTVoiceFlag": false,
      "DataRestrictionByterateLimit": "text",
      "MNOId": "text",
      "Preferred": false,
      "RoamingPartnerId": 0,
      "RoamingPlanId": "text",
      "ByterateFlag": false,
      "BlockMOSMSFlag": false
    }
  ],
  "Block": {
    "Data2G": false,
    "Data": false,
    "LTEData": false,
    "Data5G": false,
    "SMS_MO": false,
    "SMS_MT": false,
    "Supplementary_Services": false,
    "Voice_International": false,
    "Voice_International_Exc_Home": false,
    "Voice_MO": false,
    "Voice_MT": false,
    "Voice_Premium": false
  },
  "ActualUsage": {
    "MO_SMS_CDR_": 0,
    "Data_": 0,
    "Voice_": 0,
    "Alarm": 0
  },
  "Credit": "text",
  "CreditExpirationDate": "2024-12-21T16:14:28.639Z",
  "CreditWebhook": "text",
  "cas": "text"
}