SIM card API#

This is the API for SIM card management. We currently expose the following actions:

  • Get SIM cards
  • Get single SIM card
  • Get status of single SIM card
  • Perform action on single SIM card

Endpoint: Get SIM cards#

Description

Get SIM cards on account, with pagination, and with multiple optional filters. To retrieve the remaining pages simply change the page parameter of the query to the next page.

Endpoint: GET /simcards

Request Query Parameters

Field Type Description Required
page Integer Page number for pagination No
size Integer Page size No
iccFilter String Filter for ICC No
msisdnFilter String Filter for MSISDN No
imsiFilter String Filter for the IMSI No

Info

The page query parameters is 0-indexed. Such that the initial query will be /simcards?page=0

Response Payload

Page(Simcard)

Endpoint: Get single sim card#

Description

Queries the system for one SIM card, by ICC.

Endpoint: GET /simcards/{icc}

Response Payload

Field Type Description
icc String The ICC of the SIM card
msisdn String E164 MSISDN, e.g. +4593709603
state ImsiStates The current state of the SIM card
pin1 String Primary pin code for the sim card
pin2 String Secondary pin code for the sim card
puk1 String Primary puk code for the sim card
puk2 String Secondary puk code for the sim card
networkSpeed NetworkSpeed Network speed property of the sim card

Endpoint: Get status of single SIM card#

Description

Provides some additional details about a single SIM card.

Endpoint: GET /simcards/{icc}/status

Response Payload

Field Type Description
icc String The ICC of the SIM card
msisdn String E164 MSISDN, e.g. +4593709603
state ImsiStates The current state of the SIM card
pendingState ImsiStates The state the SIM card is about to change to
operatorProfileName String Name of the operator profile assigned to the SIM card
dataSessionState DataSessionStates Information on the current data state of the SIM card

Endpoint: Apply action to sim card#

Description

Apply an action to the specified SIM card, for example "activate SIM card" or "suspend SIM card".

Endpoint: POST /simcards/{icc}/action

Request Payload

Field Type Description
simCardAction SimCardActions The action to apply to the SIM card
networkSpeed NetworkSpeed The network speed to apply to the sim card

Example

{
    "simCardAction": "ACTIVATE"
}

{
    "simCardAction": "THROTTLE",
    "networkSpeed": "MBIT_1"
}

{
    "simCardAction": "ACTIVATE",
    "networkSpeed": "MBIT_5"
}

{
    "simCardAction": "SUSPEND"
}

{
    "simCardAction": "UNTHROTTLE"
}

Endpoint: Update operator profile for sim card#

Description

Update the operator profile for a single sim card

Endpoint: PUT /simcards/{icc}/operatorprofiles

Request Payload

Field Type Description
operatorProfileId Long The operator profile to apply

Endpoint: Remove sim card from its sim card group if present#

Description

Remove the sim card group relation for the sim card

Endpoint: DELETE /simcards/{icc}/simcardgroup