Modify Subscriber SIM Settings

Modify Subscriber SIM Settings API is used to amend in-use SIM related attributes. Requested changes in SIM are executed via OTA commands sent by a binary SMS.

Request should contain only elements which require modification. Empty elements denote overridden of the existing value with a NULL value.

HTTP URL  
PATCH api/v2/subscriber/{type}/{value}/sim

NOTE: All {type} and {value} pairs, define the search criteria. Valid {type} ENUMs are: ‘imsi’, ‘iccid’, ‘msisdn’, ‘imei’.

Eligibility

The Requestor is eligible to request his own subscribers' SIM settings information regardless of their actual existence (which level they reside in).

API Request

Parameter Type M/O/CM Description
appletMode String O Set the SIM applet mode. Determines whether the active IMSI can be set manually, or the applet determines which IMSI to use.ENUM valid values: MANUAL, AUTOMATIC
activeImsi String O Set active IMSI. Must be from the subscriber identifiers list.Note: The system does not block an attempt to modify active IMSI even if the ‘appletMode’ is set to AUTOMATIC.
sim Object O Array of SIMs object – In-Use IMSIs only

SIM

Parameter Type M/O/CM Description
imsi String M IMSI number registered on current SIM instance
allowedCountries String O

Set an array of IMSI related Mobile Country Codes (MCC). The device is allowed to make a connection while in this country/continent.

Send ‘MCC’ Comma separated values. Max 16 items in the array are allowed.

Set the following values when allowing a whole mainland using a single item: 2FF,3FF,4FF,5FF,6FF,7FF

  • 2FF: Europe

  • 3FF: North America and the Caribbean

  • 4FF: Asia and the Middle East

  • 5FF: Australia and Oceania

  • 6FF: Africa 7FF

  • South and Central America

preferredOperatorNetworks String O Set the list of operator networks (array of comma separated strings) that get precedence on unlisted networks in current SIM instance (given IMSI) while roaming. >Send MCCMNC value.Note: Passed value(s) will override existing value(s). Empty string will reset the existing array list.
forbiddenNetworks String O Set the list of networks (array of comma separated strings) that current SIM instance (given IMSI) cannot connect to while roaming. Send MCCMNC value. Note: Passed value(s) will override existing value(s). Empty string will reset the existing array list.

API Response

Response Structure

Parameter Type M/O/CM Description
errorCode String O Failure code. See list below, under ‘Error Codes’ section
errorMessage String O Failure detailed description. See list below, under ‘Error Codes’ section
content Object O Array of main response body object. Displayed when an API call was successful. For a failure it will be empty.
pageable Object O Paging information object. Displayed when an API call was successful. For a failure it will be empty.

Content

Parameter Type M/O/CM Description
requestId UUID M Request instance ID. To be used by external systems to query the call (operation) status, whether in progress, successful or failed.

Pageable data objects

Element

Type

M/O/CM

Description
page Numeric M Page number
size Numeric M Page size. Number of requested elements per page
totalPages Numeric M Total amount of available pages per requested page size
totalElements Numeric M Total amount of retrieved elements

Error Codes

In addition to the general success and failure codes, the following error codes are possible.

Code Message
GLOBAL_1001 Service unavailable. Please try again
SUBSCRIBER_1002

Subscriber does not exist.

Examples

Request Body

Copy 
{
  "appletMode": "MANUAL",
  "activeImsi": "222013090961859",
  "sim": [
    {
      "imsi": "222013090961859",
      "allowedCountries": "001",
      "preferredOperatorNetworks": [
        "302220",
        "302500"
      ],
      "forbiddenNetworks": [
        "23430",
        "23415",
        "90146"
      ]
    },
    {
      "imsi": "310380501118337",
      "allowedCountries": "320",
      "preferredOperatorNetworks": [],
      "forbiddenNetworks": []
    }
  ]
}

Response Body: Success ACK

Copy 
{
  "errorCode": "",
  "errorMessage": "",
  "content": [
    {
      "requestId": "ff74dca6-8e7f-4b85-a42b-13860913b370"
    }
  ],
  "pageable": null
}

Response Body: Failure NAK

Copy 

  "errorCode": "GLOBAL_1001",
  "errorMessage": "Service unavailable. Please try again",