Smarthub Api En
  1. SIM Card Management
  • Overview
    • Global Description
  • SIM Card Management
    • Retrieve SIM detail information
      GET
    • Retrieve list of SIMs detail information
      GET
    • Retrieve state change history of SIMs
      GET
    • Retreive custom field of SIM
      GET
    • Edit custom field of SIM
      PUT
    • Activate SIM
      POST
    • Suspend SIM
      POST
    • Retire SIM
      POST
    • SIM subscribe to supplimentary rate plan
      POST
    • Change SIM basic rate plan
      PUT
    • Change SIM apn status
      PUT
  • SIM Card Batch Operation
    • Batch SIM activate
      POST
    • Batch SIM suspend
      POST
    • Batch SIM retire
      POST
    • Batch change SIM basic rate plan
      POST
    • Retrieve batch job information
      GET
  • Sms Service
    • Send SMS to terminal
      POST
    • Query SMS delivery status
      GET
    • MO SMS Push
      POST
    • Push MT SMS Status Report
      POST
  • Subscription Notification
    • Push Cycle Usage Tracking Event Notification
      POST
    • Push Imei Change Event Notification
      POST
    • Push No Session Connection Event Notification
      POST
    • Push Prepaid Service Package Expired Event Notification
      POST
    • Push Prepaid Service Package Traffic Tracking Event Notification
      POST
    • Push Sim Status Change Event Notification
      POST
    • Push Sim Apn Status Change Event Notification
      POST
  • Share Pool
    • Get share pool information
  • Enterprise Information
    • Get enterprise information
    • Get account information
    • Get servicePackages information
  • SIM Card Statistics
    • Get the country code traffic and number of cards for SIM card statistics
  1. SIM Card Management

Retrieve list of SIMs detail information

GET
/global-sims
Retrieve list of SIMs detail information including activated time, billing cycle usage and rate plan information etc.
Status description:
statusDescription
TEST_READYReady to test
ACTIVATE_READYReady to activate
INVENTORYIn inventory
ACTIVATEDActivated
DEACTIVATEDDeactivated
RETIREDRetired, cannot activate anymore

Request

Query Params

Header Params

Request Code Samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET '/global-sims?status&po=8723164786&customerName=example_customer&accountName=example_account&basicServicePackageName&giccids=giccid01,giccid02&page&size=10' \
--header 'X-API-Key;'

Responses

🟢200OK
application/json
List of SIMs detail information
Body

Example
{
    "data": [
        {
            "giccid": "8986011805021000040",
            "deviceInfo": [
                {
                    "imei": "460013050000000",
                    "imsi": "460013050000000",
                    "msisdn": "8613856541093"
                }
            ],
            "status": "TEST_READY",
            "sellTime": "2018-10-10T10:32:50+0000",
            "activatedTime": "2018-10-10T10:32:50+0000",
            "currentCycleUsages": {
                "dataUsage": 23.323,
                "smsUsage": 30,
                "voiceUsage": 10
            },
            "currentCycleAPNUsagesList": [
                {
                    "apn": "apn1",
                    "dataUsage": 23.323
                }
            ],
            "currentBasicServicePackage": {
                "name": "Prepaid-Basic-10M",
                "startTime": "2018-10-10T10:32:50+0000",
                "endTime": "2018-10-10T10:32:50+0000"
            },
            "apnList": [
                {
                    "apnName": "apn1",
                    "apnStatus": "CLOSED"
                },
                {
                    "apnName": "apn2",
                    "apnStatus": "OPEN"
                }
            ]
        }
    ],
    "page": 0,
    "size": 10,
    "total": 100
}
Modified at 2025-08-13 06:36:31
Previous
Retrieve SIM detail information
Next
Retrieve state change history of SIMs
Built with