react-native-sim-data

React Native plugin to get the device's SIM data (carrier name, mcc mnc, country code, phone number, etc)

Downloads in past

Stats

StarsIssuesVersionUpdatedCreatedSize
react-native-sim-data
61153.0.05 years ago7 years agoMinified + gzip package size for react-native-sim-data in KB

Readme

Build Status npm version
react-native-sim-data
React Native plugin to get the device's SIM data (carrier name, mcc mnc, country code, phone number, etc)

Installation

$ npm i react-native-sim-data
$ react-native link react-native-sim-data

Supported Platforms

  • Android

Usage

import RNSimData from 'react-native-sim-data'

RNSimData.getSimInfo().deviceId0
/**
  the object has the following info (change 0 to access more than 1 SIM):

  carrierName0: string;
  displayName0: string;
  countryCode0: string;
  mcc0: string;
  mnc0: string;
  isNetworkRoaming0: string;
  isDataRoaming0: string;
  simSlotIndex0: string;
  phoneNumber0: string;
  deviceId0: string;
  simSerialNumber0: string;
  subscriptionId0: string;
*/

//shortcut for RNSimData.getSimInfo().phoneNumber0
RNSimData.getTelephoneNumber()
//shortcut for RNSimData.getSimInfo().carrierName0
RNSimData.getCarrierName()
//shortcut for RNSimData.getSimInfo().countryCode0
RNSimData.getCountryCode()

NOTE: React Native "Modules", when having only constants, work with getters, and the result of getSimInfo() is undefined, you need to access the properties to get any info

Caveats

Might crash if tries to use in a phone without any SIM cards.

Permissions

WARNING: Minimum API Level is 22
This plugin uses two different Android APIs to receive SIM data:
  • TelephonyManager (since API level 1)
  • SubscriptionManager (since API level 22)

Since Android 6 (API level 23) a few methods of TelephonyManager require permission READ_PHONE_STATE.
All methods of SubscriptionManager require permission READ_PHONE_STATE.
SubscriptionManager is able to access multiple SIM data.
You'll also need to include implementation 'com.google.android.gms:play-services-gcm:+' in your android/app/build.gradle (or any version that suits you)