cordova-plugin-sim

This is a cordova plugin to get data from the SIM card like the carrier name, mcc, mnc and country code and other system dependent additional info.

Installation

cordova plugin add cordova-plugin-sim

Supported Platforms

• Android
• iOS
• Windows Phone 7 and 8

Usage

document.addEventListener("deviceready", onDeviceReady, false);

function onDeviceReady() {
  window.plugins.sim.getSimInfo(successCallback, errorCallback);
}

function successCallback(result) {
  console.log(result);
}

function errorCallback(error) {
  console.log(error);
}

The plugin returns a JSON object. Return values:

• carrierName: String - the Service Provider Name (SPN)
• countryCode: String - the ISO country code equivalent for the SIM provider's country code
• mcc: String - the MCC (mobile country code) of the provider of the SIM
• mnc: String - the MNC (mobile network code) of the provider of the SIM

Field carrierName may remain empty, dependent on the mobile provider.

On Windows Phone access to countryCode, MCC and MNC is not made provided (returns empty string).

You can extract country and carrier data from MCC and MNC codes, read further on Wikipedia and ITU-T.

Android Quirks

Additional return values:

• phoneNumber: String - phone number string for line 1, for example, the MSISDN for a GSM phone ¹
• deviceId: String - the unique device ID, for example, the IMEI for GSM and the MEID or ESN for CDMA phones
• deviceSoftwareVersion: String - the software version number for the device, for example, the IMEI/SV for GSM phones
• simSerialNumber: String - the serial number of the SIM, if applicable
• subscriberId: String - the unique subscriber ID, for example, the IMSI for a GSM phone
• callState: Number - the call state (cellular) on the device
• dataActivity: Number - the type of activity on a data connection (cellular)
• networkType: Number - the NETWORK_TYPE_xxxx for current data connection
• phoneType: Number - the device phone type. This indicates the type of radio used to transmit voice calls
• simState: Number - the state of the device SIM card
• isNetworkRoaming: Boolean - true if the device is considered roaming on the current network, for GSM purposes

¹⁾ Notice: the content of phoneNumber is unreliable (see this and this article). Sometimes phoneNumber is only an empty string.

Android Emulator results

{
  "carrierName": "Android",
  "countryCode": "us",
  "mcc": "310",
  "mnc": "260",
  "phoneNumber": "15555215554",
  "deviceId": "0000000000000000",
  "simSerialNumber": "89014103211118510720",
  "subscriberId": "310260000000000",
  "callState": 0,
  "dataActivity": 0,
  "networkType": 3,
  "phoneType": 1,
  "simState": 5,
  "isNetworkRoaming": false
}

List of Call State Codes and Meanings

List of Data Activity Codes and Meanings

List of Network Type Codes and Meanings

List of Phone Type Codes and Meanings

List of SIM State Codes and Meanings

Android 6.0 Permissions

Beginning in Android 6.0 (API level 23), users grant permissions to apps while the app is running, not when they install the app.

If the device is running Android 6.0 or higher, and your app's target SDK is 23 or higher: The app has to list the permissions in the manifest, and it must request each dangerous permission it needs while the app is running. The user can grant or deny each permission, and the app can continue to run with limited capabilities even if the user denies a permission request.

Note: Beginning with Android 6.0 (API level 23), users can revoke permissions from any app at any time, even if the app targets a lower API level. You should test your app to verify that it behaves properly when it's missing a needed permission, regardless of what API level your app targets.

// check permission
function hasReadPermission() {
  window.plugins.sim.hasReadPermission(successCallback, errorCallback);
}

// request permission
function requestReadPermission() {
  // no callbacks required as this opens a popup which returns async
  window.plugins.sim.requestReadPermission();
}

This plugin needs READ_PHONE_STATE permission for getting the following values:

• phoneNumber
• deviceId
• deviceSoftwareVersion
• simSerialNumber
• subscriberId

iOS Quirks

Additional return value:

• allowsVOIP: Boolean - indicates if the carrier allows VoIP calls to be made on its network

iOS Emulator results

{
  "carrierName": "",
  "countryCode": "",
  "mcc": "",
  "mnc": "",
  "allowsVOIP": false
}

Windows Phone Quirks

Additional return values:

• isCellularDataEnabled: Boolean - indicates whether the network is cellular data enabled
• isCellularDataRoamingEnabled: Boolean - indicates whether the network allows data roaming
• IsNetworkAvailable: Boolean - indicates whether the network is available
• isWiFiEnabled: Boolean - indicates whether the network is Wi-Fi enabled

Author

Peter Bakondy

• https://github.com/pbakondy

LICENSE

cordova-plugin-sim is licensed under the MIT Open Source license. For more information, see the LICENSE file in this repository.