Skip to main content
Back to plugins
@capgo/capacitor-sim
Tutorial
@capgo/capacitor-sim

SIM

Retrieve SIM card information including carrier name, country code, and phone number

Guide

Tutorial on SIM

Using @capgo/capacitor-sim

Capacitor SIM Plugin for retrieving information from device SIM cards.

Install

bun add @capgo/capacitor-sim
bunx cap sync

What This Plugin Exposes

  • getSimCards - Get information from the device's SIM cards.
  • checkPermissions - Check permission to access SIM card information.
  • requestPermissions - Request permission to access SIM card information.

Example Usage

getSimCards

Get information from the device's SIM cards.

import { Sim } from '@capgo/capacitor-sim';

const { simCards } = await SimPlugin.getSimCards();
simCards.forEach((sim, index) => {
  console.log(`SIM ${index + 1}:`);
  console.log(`  Carrier: ${sim.carrierName}`);
  console.log(`  Country: ${sim.isoCountryCode}`);
  console.log(`  MCC: ${sim.mobileCountryCode}`);
  console.log(`  MNC: ${sim.mobileNetworkCode}`);
});

checkPermissions

Check permission to access SIM card information.

import { Sim } from '@capgo/capacitor-sim';

const status = await SimPlugin.checkPermissions();
if (status.readSimCard === 'granted') {
  console.log('Permission granted');
} else {
  console.log('Permission not granted');
}

requestPermissions

Request permission to access SIM card information.

import { Sim } from '@capgo/capacitor-sim';

const status = await SimPlugin.requestPermissions();
if (status.readSimCard === 'granted') {
  // Now you can call getSimCards()
  const simCards = await SimPlugin.getSimCards();
}

Full Reference

Keep going from Using @capgo/capacitor-sim

If you are using Using @capgo/capacitor-sim to plan dashboard and API operations, connect it with @capgo/capacitor-sim for the implementation detail in @capgo/capacitor-sim, Getting Started for the implementation detail in Getting Started, API Overview for the implementation detail in API Overview, Introduction for the implementation detail in Introduction, and API Keys for the implementation detail in API Keys.