SubscriptionManager

ACTION_DEFAULT_SMS_SUBSCRIPTION_CHANGED

public static final String ACTION_DEFAULT_SMS_SUBSCRIPTION_CHANGED

Broadcast Action: The default sms subscription has changed. This has the following extra values:

Constant Value: "android.telephony.action.DEFAULT_SMS_SUBSCRIPTION_CHANGED"

ACTION_DEFAULT_SUBSCRIPTION_CHANGED

public static final String ACTION_DEFAULT_SUBSCRIPTION_CHANGED

Broadcast Action: The default subscription has changed. This has the following extra values:

Constant Value: "android.telephony.action.DEFAULT_SUBSCRIPTION_CHANGED"

ACTION_MANAGE_SUBSCRIPTION_PLANS

public static final String ACTION_MANAGE_SUBSCRIPTION_PLANS

Activity Action: Display UI for managing the billing relationship plans between a carrier and a specific subscriber.

Carrier apps are encouraged to implement this activity, and the OS will provide an affordance to quickly enter this activity, typically via Settings. This affordance will only be shown when the carrier app is actively providing subscription plan information via setSubscriptionPlans(int, java.util.List).

Contains EXTRA_SUBSCRIPTION_INDEX to indicate which subscription the user is interested in.

Constant Value: "android.telephony.action.MANAGE_SUBSCRIPTION_PLANS"

ACTION_REFRESH_SUBSCRIPTION_PLANS

public static final String ACTION_REFRESH_SUBSCRIPTION_PLANS

Broadcast Action: Request a refresh of the billing relationship plans between a carrier and a specific subscriber.

Carrier apps are encouraged to implement this receiver, and the OS will provide an affordance to request a refresh. This affordance will only be shown when the carrier app is actively providing subscription plan information via setSubscriptionPlans(int, java.util.List).

Contains EXTRA_SUBSCRIPTION_INDEX to indicate which subscription the user is interested in.

Receivers should protect themselves by checking that the sender holds the android.permission.MANAGE_SUBSCRIPTION_PLANS permission.

Constant Value: "android.telephony.action.REFRESH_SUBSCRIPTION_PLANS"

DATA_ROAMING_DISABLE

public static final int DATA_ROAMING_DISABLE

Indicates that data roaming is disabled for a subscription

Constant Value: 0 (0x00000000)

DATA_ROAMING_ENABLE

public static final int DATA_ROAMING_ENABLE

Indicates that data roaming is enabled for a subscription

Constant Value: 1 (0x00000001)

DEFAULT_SUBSCRIPTION_ID

public static final int DEFAULT_SUBSCRIPTION_ID

Indicates the default subscription ID in Telephony.

Constant Value: 2147483647 (0x7fffffff)

EXTRA_SUBSCRIPTION_INDEX

public static final String EXTRA_SUBSCRIPTION_INDEX

Integer extra used with ACTION_DEFAULT_SUBSCRIPTION_CHANGED and ACTION_DEFAULT_SMS_SUBSCRIPTION_CHANGED to indicate the subscription which has changed.

Constant Value: "android.telephony.extra.SUBSCRIPTION_INDEX"

INVALID_SIM_SLOT_INDEX

public static final int INVALID_SIM_SLOT_INDEX

Indicates invalid sim slot. This can be returned by getSlotIndex(int).

Constant Value: -1 (0xffffffff)

INVALID_SUBSCRIPTION_ID

public static final int INVALID_SUBSCRIPTION_ID

An invalid subscription identifier

Constant Value: -1 (0xffffffff)

SUBSCRIPTION_TYPE_LOCAL_SIM

public static final int SUBSCRIPTION_TYPE_LOCAL_SIM

This constant is to designate a subscription as a Local-SIM Subscription.

A Local-SIM can be a physical SIM inserted into a sim-slot in the device, or eSIM on the device.

Constant Value: 0 (0x00000000)

SUBSCRIPTION_TYPE_REMOTE_SIM

public static final int SUBSCRIPTION_TYPE_REMOTE_SIM

This constant is to designate a subscription as a Remote-SIM Subscription.

A Remote-SIM subscription is for a SIM on a phone connected to this device via some connectivity mechanism, for example bluetooth. Similar to Local SIM, this subscription can be used for SMS, Voice and data by proxying data through the connected device. Certain data of the SIM, such as IMEI, are not accessible for Remote SIMs.

A Remote-SIM is available only as long the phone stays connected to this device. When the phone disconnects, Remote-SIM subscription is removed from this device and is no longer known. All data associated with the subscription, such as stored SMS, call logs, contacts etc, are removed from this device.

If the phone re-connects to this device, a new Remote-SIM subscription is created for the phone. The Subscription Id associated with the new subscription is different from the Subscription Id of the previous Remote-SIM subscription created (and removed) for the phone; i.e., new Remote-SIM subscription treats the reconnected phone as a Remote-SIM that was never seen before.

Constant Value: 1 (0x00000001)

addOnOpportunisticSubscriptionsChangedListener

public void addOnOpportunisticSubscriptionsChangedListener (Executor executor, 
                SubscriptionManager.OnOpportunisticSubscriptionsChangedListener listener)

Register for changes to the list of opportunistic subscription records or to the individual records themselves. When a change occurs the onOpportunisticSubscriptionsChanged method of the listener will be invoked immediately if there has been a notification.

addOnSubscriptionsChangedListener

public void addOnSubscriptionsChangedListener (SubscriptionManager.OnSubscriptionsChangedListener listener)

Register for changes to the list of active SubscriptionInfo records or to the individual records themselves. When a change occurs the onSubscriptionsChanged method of the listener will be invoked immediately if there has been a notification. The onSubscriptionChanged method will also be triggered once initially when calling this function.

canManageSubscription

public boolean canManageSubscription (SubscriptionInfo info)

Checks whether the app with the given context is authorized to manage the given subscription according to its metadata. Only supported for embedded subscriptions (if SubscriptionInfo#isEmbedded returns true).

from

public static SubscriptionManager from (Context context)

This method was deprecated in API level 28.
developers should always obtain references directly from Context#getSystemService(Class).

getAccessibleSubscriptionInfoList

public List<SubscriptionInfo> getAccessibleSubscriptionInfoList ()

Gets the SubscriptionInfo(s) of all embedded subscriptions accessible to the calling app, if any.

Only those subscriptions for which the calling app has carrier privileges per the subscription metadata, if any, will be included in the returned list.

The records will be sorted by SubscriptionInfo#getSimSlotIndex then by SubscriptionInfo#getSubscriptionId.

getActiveSubscriptionInfo

public SubscriptionInfo getActiveSubscriptionInfo (int subId)

Get the active SubscriptionInfo with the input subId.

Requires Permission: READ_PHONE_STATE or that the calling app has carrier privileges (see TelephonyManager#hasCarrierPrivileges).
Requires Manifest.permission.READ_PHONE_STATE

getActiveSubscriptionInfoCount

public int getActiveSubscriptionInfoCount ()

Requires Permission: READ_PHONE_STATE or that the calling app has carrier privileges (see TelephonyManager#hasCarrierPrivileges). In the latter case, the count will include only those subscriptions accessible to the caller.
Requires Manifest.permission.READ_PHONE_STATE

getActiveSubscriptionInfoCountMax

public int getActiveSubscriptionInfoCountMax ()

getActiveSubscriptionInfoForSimSlotIndex

public SubscriptionInfo getActiveSubscriptionInfoForSimSlotIndex (int slotIndex)

Get the active SubscriptionInfo associated with the slotIndex

Requires Permission: READ_PHONE_STATE or that the calling app has carrier privileges (see TelephonyManager#hasCarrierPrivileges).
Requires Manifest.permission.READ_PHONE_STATE

getActiveSubscriptionInfoList

public List<SubscriptionInfo> getActiveSubscriptionInfoList ()

Get the SubscriptionInfo(s) of the currently active SIM(s). The records will be sorted by SubscriptionInfo#getSimSlotIndex then by SubscriptionInfo#getSubscriptionId.

Requires Permission: READ_PHONE_STATE or that the calling app has carrier privileges (see TelephonyManager#hasCarrierPrivileges). In the latter case, only records accessible to the calling app are returned.
Requires Manifest.permission.READ_PHONE_STATE

getDefaultDataSubscriptionId

public static int getDefaultDataSubscriptionId ()

Returns the system's default data subscription id. On a voice only device or on error, will return INVALID_SUBSCRIPTION_ID.

getDefaultSmsSubscriptionId

public static int getDefaultSmsSubscriptionId ()

Returns the system's default SMS subscription id. On a data only device or on error, will return INVALID_SUBSCRIPTION_ID.

getDefaultSubscriptionId

public static int getDefaultSubscriptionId ()

Returns the system's default subscription id. For a voice capable device, it will return getDefaultVoiceSubscriptionId. For a data only device, it will return the getDefaultDataSubscriptionId. May return an INVALID_SUBSCRIPTION_ID on error.

getDefaultVoiceSubscriptionId

public static int getDefaultVoiceSubscriptionId ()

Returns the system's default voice subscription id. On a data only device or on error, will return INVALID_SUBSCRIPTION_ID.

getOpportunisticSubscriptions

public List<SubscriptionInfo> getOpportunisticSubscriptions ()

Return opportunistic subscriptions that can be visible to the caller. Opportunistic subscriptions are for opportunistic networks, which are cellular networks with limited capabilities and coverage, for example, CBRS.

Requires Permission: READ_PHONE_STATE or that the calling app has carrier privileges (see TelephonyManager#hasCarrierPrivileges).
Requires Manifest.permission.READ_PHONE_STATE

getSlotIndex

public static int getSlotIndex (int subscriptionId)

Get slotIndex associated with the subscription.

getSubscriptionIds

public int[] getSubscriptionIds (int slotIndex)

Get an array of Subscription Ids for specified slot Index.

getSubscriptionPlans

public List<SubscriptionPlan> getSubscriptionPlans (int subId)

Get the description of the billing relationship plan between a carrier and a specific subscriber.

This method is only accessible to the following narrow set of apps:

• The carrier app for this subscriberId, as determined by TelephonyManager#hasCarrierPrivileges().
• The carrier app explicitly delegated access through CarrierConfigManager#KEY_CONFIG_PLANS_PACKAGE_OVERRIDE_STRING.

getSubscriptionsInGroup

public List<SubscriptionInfo> getSubscriptionsInGroup (int subId)

Get subscriptionInfo list of subscriptions that are in the same group of given subId. See setSubscriptionGroup(int[]) for more details. Caller will either have Manifest.permission.READ_PHONE_STATE permission or had carrier privilege permission on the subscription. TelephonyManager#hasCarrierPrivileges()
Requires Manifest.permission.READ_PHONE_STATE

isActiveSubscriptionId

public boolean isActiveSubscriptionId (int subscriptionId)

Checks if the supplied subscription ID corresponds to an active subscription.
Requires Manifest.permission.READ_PHONE_STATE

isNetworkRoaming

public boolean isNetworkRoaming (int subId)

Returns true if the device is considered roaming on the current network for a subscription.

Availability: Only when user registered to a network.

isUsableSubscriptionId

public static boolean isUsableSubscriptionId (int subscriptionId)

Check if the subscription ID is usable. A usable subscription ID has a valid value except some special values such as DEFAULT_SUBSCRIPTION_ID. It can be used for subscription functions.

isValidSubscriptionId

public static boolean isValidSubscriptionId (int subscriptionId)

Checks if the supplied subscription ID is valid. Note: a valid subscription ID does not necessarily correspond to an active subscription.

removeOnOpportunisticSubscriptionsChangedListener

public void removeOnOpportunisticSubscriptionsChangedListener (SubscriptionManager.OnOpportunisticSubscriptionsChangedListener listener)

Unregister the OnOpportunisticSubscriptionsChangedListener that is currently listening opportunistic subscriptions change. This is not strictly necessary as the listener will automatically be unregistered if an attempt to invoke the listener fails.

removeOnSubscriptionsChangedListener

public void removeOnSubscriptionsChangedListener (SubscriptionManager.OnSubscriptionsChangedListener listener)

Unregister the OnSubscriptionsChangedListener. This is not strictly necessary as the listener will automatically be unregistered if an attempt to invoke the listener fails.

removeSubscriptionsFromGroup

public boolean removeSubscriptionsFromGroup (int[] subIdList)

Remove a list of subscriptions from their subscription group. See setSubscriptionGroup(int[]) for more details. Caller will either have Manifest.permission.MODIFY_PHONE_STATE permission or had carrier privilege permission on the subscriptions: TelephonyManager#hasCarrierPrivileges() or canManageSubscription(android.telephony.SubscriptionInfo)
Requires Manifest.permission.MODIFY_PHONE_STATE

setMetered

public boolean setMetered (boolean isMetered, 
                int subId)

Set if a subscription is metered or not. Similar to Wi-Fi, metered means user may be charged more if more data is used. By default all Cellular networks are considered metered. System or carrier privileged apps can set a subscription un-metered which will be considered when system switches data between primary subscription and opportunistic subscription. Caller will either have Manifest.permission.MODIFY_PHONE_STATE or carrier privilege permission of the subscription.
Requires Manifest.permission.MODIFY_PHONE_STATE

setOpportunistic

public boolean setOpportunistic (boolean opportunistic, 
                int subId)

Set whether a subscription is opportunistic, that is, whether the network it connects to has limited coverage. For example, CBRS. Setting a subscription opportunistic has following impacts: 1) Even if it's active, it will be dormant most of the time. The modem will not try to scan or camp until it knows an available network is nearby to save power. 2) Telephony relies on system app or carrier input to notify nearby available networks. See TelephonyManager#updateAvailableNetworks(List) for more information. 3) In multi-SIM devices, when the network is nearby and camped, system may automatically switch internet data between it and default data subscription, based on carrier recommendation and its signal strength and metered-ness, etc. Caller will either have Manifest.permission.MODIFY_PHONE_STATE or carrier privilege permission of the subscription.
Requires Manifest.permission.MODIFY_PHONE_STATE

setSubscriptionGroup

public String setSubscriptionGroup (int[] subIdList)

Inform SubscriptionManager that subscriptions in the list are bundled as a group. Typically it's a primary subscription and an opportunistic subscription. It should only affect multi-SIM scenarios where primary and opportunistic subscriptions can be activated together. Being in the same group means they might be activated or deactivated together, some of them may be invisible to the users, etc. Caller will either have Manifest.permission.MODIFY_PHONE_STATE permission or had carrier privilege permission on the subscriptions: TelephonyManager#hasCarrierPrivileges() or canManageSubscription(android.telephony.SubscriptionInfo)
Requires Manifest.permission.MODIFY_PHONE_STATE

setSubscriptionOverrideCongested

public void setSubscriptionOverrideCongested (int subId, 
                boolean overrideCongested, 
                long timeoutMillis)

Temporarily override the billing relationship plan between a carrier and a specific subscriber to be considered congested. This will cause the device to delay certain network requests when possible, such as developer jobs that are willing to run in a flexible time window.

This method is only accessible to the following narrow set of apps:

• The carrier app for this subscriberId, as determined by TelephonyManager#hasCarrierPrivileges().
• The carrier app explicitly delegated access through CarrierConfigManager#KEY_CONFIG_PLANS_PACKAGE_OVERRIDE_STRING.

setSubscriptionOverrideUnmetered

public void setSubscriptionOverrideUnmetered (int subId, 
                boolean overrideUnmetered, 
                long timeoutMillis)

Temporarily override the billing relationship plan between a carrier and a specific subscriber to be considered unmetered. This will be reflected to apps via NetworkCapabilities#NET_CAPABILITY_NOT_METERED.

This method is only accessible to the following narrow set of apps:

• The carrier app for this subscriberId, as determined by TelephonyManager#hasCarrierPrivileges().
• The carrier app explicitly delegated access through CarrierConfigManager#KEY_CONFIG_PLANS_PACKAGE_OVERRIDE_STRING.

setSubscriptionPlans

public void setSubscriptionPlans (int subId, 
                List<SubscriptionPlan> plans)

Set the description of the billing relationship plan between a carrier and a specific subscriber.

This method is only accessible to the following narrow set of apps:

• The carrier app for this subscriberId, as determined by TelephonyManager#hasCarrierPrivileges().
• The carrier app explicitly delegated access through CarrierConfigManager#KEY_CONFIG_PLANS_PACKAGE_OVERRIDE_STRING.

switchToSubscription

public void switchToSubscription (int subId, 
                PendingIntent callbackIntent)

Switch to a certain subscription
Requires android.Manifest.permission.WRITE_EMBEDDED_SUBSCRIPTIONS