@ohos.telephony.sim (SIM Management)

The sim module provides basic SIM card management functions. With the APIs provided by this module, you can obtain the ISO country code, home PLMN ID, service provider name, SIM card status, type, installation status, and activation status of the SIM card in the specified slot.

NOTE

The initial APIs of this module are supported since API version 6. Newly added APIs will be marked with a superscript to indicate their earliest API version.

Modules to Import

import { sim } from '@kit.TelephonyKit';

sim.isSimActive⁷⁺

isSimActive(slotId: number, callback: AsyncCallback<boolean>): void

Checks whether the SIM card in the specified slot is activated. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.Telephony.CoreService

Parameters

Name	Type	Mandatory	Description
slotId	number	Yes	Card slot ID. - 0: card slot 1. - 1: card slot 2
callback	AsyncCallback<boolean>	Yes	Callback used to return the result, which indicates whether the SIM card in the specified slot is activated. true: activated. false: not activated.

Example

import { BusinessError } from '@kit.BasicServicesKit';
import { sim } from '@kit.TelephonyKit';

sim.isSimActive(0, (err: BusinessError, data: boolean) => {
    console.log(`callback: err->${JSON.stringify(err)}, data->${JSON.stringify(data)}`);
});

sim.isSimActive⁷⁺

isSimActive(slotId: number): Promise<boolean>

Checks whether the SIM card in the specified slot is activated. This API uses a promise to return the result.

System capability: SystemCapability.Telephony.CoreService

Parameters

Name	Type	Mandatory	Description
slotId	number	Yes	Card slot ID. - 0: card slot 1. - 1: card slot 2

Return value

Type	Description
Promise<boolean>	Promise used to return the result. true: activated. false: not activated.

Example

import { BusinessError } from '@kit.BasicServicesKit';
import { sim } from '@kit.TelephonyKit';

sim.isSimActive(0).then((data: boolean) => {
    console.log(`isSimActive success, promise: data->${JSON.stringify(data)}`);
}).catch((err: BusinessError) => {
    console.error(`isSimActive failed, promise: err->${JSON.stringify(err)}`);
});

sim.isSimActiveSync¹⁰⁺

isSimActiveSync(slotId: number): boolean

Checks whether the SIM card in the specified slot is activated.

System capability: SystemCapability.Telephony.CoreService

Parameters

Name	Type	Mandatory	Description
slotId	number	Yes	Card slot ID. - 0: card slot 1. - 1: card slot 2

Return value

Type	Description
boolean	which indicates whether the SIM card in the specified slot is activated. true: activated. false: not activated.

Example

import { sim } from '@kit.TelephonyKit';

let isSimActive: boolean = sim.isSimActiveSync(0);
console.log(`the sim is active:` + isSimActive);

sim.getDefaultVoiceSlotId⁷⁺

getDefaultVoiceSlotId(callback: AsyncCallback<number>): void

Obtains the default slot ID of the SIM card that provides voice services. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.Telephony.CoreService

Parameters

Name	Type	Mandatory	Description
callback	AsyncCallback<number>	Yes	Callback used to return the result. - 0: card slot 1. - 1: card slot 2. - -1: card slot not set or service not unavailable

Example

import { BusinessError } from '@kit.BasicServicesKit';
import { sim } from '@kit.TelephonyKit';

sim.getDefaultVoiceSlotId((err: BusinessError, data: number) => {
    console.log(`callback: err->${JSON.stringify(err)}, data->${JSON.stringify(data)}`);
});

sim.getDefaultVoiceSlotId⁷⁺

getDefaultVoiceSlotId(): Promise<number>

Obtains the default slot ID of the SIM card that provides voice services. This API uses a promise to return the result.

System capability: SystemCapability.Telephony.CoreService

Return value

Type	Description
Promise<number>	Promise used to return the result. - 0: card slot 1. - 1: card slot 2. - -1: card slot not set or service not unavailable

Example

import { BusinessError } from '@kit.BasicServicesKit';
import { sim } from '@kit.TelephonyKit';

sim.getDefaultVoiceSlotId().then((data: number) => {
    console.log(`getDefaultVoiceSlotId success, promise: data->${JSON.stringify(data)}`);
}).catch((err: BusinessError) => {
    console.error(`getDefaultVoiceSlotId failed, promise: err->${JSON.stringify(err)}`);
});

sim.hasOperatorPrivileges⁷⁺

hasOperatorPrivileges(slotId: number, callback: AsyncCallback<boolean>): void

Checks whether the application (caller) has been granted the operator permission. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.Telephony.CoreService

Parameters

Name	Type	Mandatory	Description
slotId	number	Yes	Card slot ID. - 0: card slot 1. - 1: card slot 2
callback	AsyncCallback<boolean>	Yes	Callback used to return the result, which indicates whether the application (caller) has been granted the operator permission.

Error codes

For details about the error codes, see Universal Error Codes and Telephony Error Codes.

ID	Error Message
401	Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. 2. Incorrect parameter types.
8300001	Invalid parameter value.
8300002	Service connection failed.
8300003	System internal error.
8300999	Unknown error.

Example

import { BusinessError } from '@kit.BasicServicesKit';
import { sim } from '@kit.TelephonyKit';

sim.hasOperatorPrivileges(0, (err: BusinessError, data: boolean) => {
    console.log(`callback: err->${JSON.stringify(err)}, data->${JSON.stringify(data)}`);
});

sim.hasOperatorPrivileges⁷⁺

hasOperatorPrivileges(slotId: number): Promise<boolean>

Checks whether the application (caller) has been granted the operator permission. This API uses a promise to return the result.

System capability: SystemCapability.Telephony.CoreService

Parameters

Name	Type	Mandatory	Description
slotId	number	Yes	Card slot ID. - 0: card slot 1. - 1: card slot 2

Return value

Type	Description
Promise<boolean>	Promise used to return the result. The value true indicates that the application (caller) has been granted the carrier permission, and the value false indicates the opposite.

Error codes

For details about the error codes, see Universal Error Codes and Telephony Error Codes.

ID	Error Message
401	Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. 2. Incorrect parameter types.
8300001	Invalid parameter value.
8300002	Service connection failed.
8300003	System internal error.
8300999	Unknown error.

Example

import { BusinessError } from '@kit.BasicServicesKit';
import { sim } from '@kit.TelephonyKit';

sim.hasOperatorPrivileges(0).then((data: boolean) => {
    console.log(`hasOperatorPrivileges success, promise: data->${JSON.stringify(data)}`);
}).catch((err: BusinessError) => {
    console.error(`hasOperatorPrivileges failed, promise: err->${JSON.stringify(err)}`);
});

sim.getISOCountryCodeForSim

getISOCountryCodeForSim(slotId: number, callback: AsyncCallback<string>): void

Obtains the ISO country code of the SIM card in the specified slot. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.Telephony.CoreService

Parameters

Name	Type	Mandatory	Description
slotId	number	Yes	Card slot ID. - 0: card slot 1. - 1: card slot 2
callback	AsyncCallback<string>	Yes	Callback used to return the result, which is a country code, for example, CN (China).

Error codes

For details about the error codes, see Universal Error Codes and Telephony Error Codes.

ID	Error Message
401	Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. 2. Incorrect parameter types.
8300001	Invalid parameter value.
8300002	Service connection failed.
8300003	System internal error.
8300004	No SIM card found.
8300999	Unknown error.

Example

import { BusinessError } from '@kit.BasicServicesKit';
import { sim } from '@kit.TelephonyKit';

sim.getISOCountryCodeForSim(0, (err: BusinessError, data: string) => {
    console.log(`callback: err->${JSON.stringify(err)}, data->${JSON.stringify(data)}`);
});

sim.getISOCountryCodeForSim

getISOCountryCodeForSim(slotId: number): Promise<string>

Obtains the ISO country code of the SIM card in the specified slot. This API uses a promise to return the result.

System capability: SystemCapability.Telephony.CoreService

Parameters

Name	Type	Mandatory	Description
slotId	number	Yes	Card slot ID. - 0: card slot 1. - 1: card slot 2

Return value

Type	Description
Promise<string>	Promise used to return the result, which is the ISO country code of the SIM card in the specified slot, for example, CN (China).

Error codes

For details about the error codes, see Universal Error Codes and Telephony Error Codes.

ID	Error Message
401	Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. 2. Incorrect parameter types.
8300001	Invalid parameter value.
8300002	Service connection failed.
8300003	System internal error.
8300004	No SIM card found.
8300999	Unknown error.

Example

import { BusinessError } from '@kit.BasicServicesKit';
import { sim } from '@kit.TelephonyKit';

sim.getISOCountryCodeForSim(0).then((data: string) => {
    console.log(`getISOCountryCodeForSim success, promise: data->${JSON.stringify(data)}`);
}).catch((err: BusinessError) => {
    console.error(`getISOCountryCodeForSim failed, promise: err->${JSON.stringify(err)}`);
});

sim.getISOCountryCodeForSimSync¹⁰⁺

getISOCountryCodeForSimSync(slotId: number): string

Obtains the ISO country code of the SIM card in the specified slot.

System capability: SystemCapability.Telephony.CoreService

Parameters

Name	Type	Mandatory	Description
slotId	number	Yes	Card slot ID. - 0: card slot 1. - 1: card slot 2

Return value

Type	Description
string	ISO country code of the SIM card in the specified slot, for example, CN (China).

Example

import { sim } from '@kit.TelephonyKit';

let countryCode: string = sim.getISOCountryCodeForSimSync(0);
console.log(`the country ISO is:` + countryCode);

sim.getSimOperatorNumeric

getSimOperatorNumeric(slotId: number, callback: AsyncCallback<string>): void

Obtains the home public land mobile network (PLMN) ID of the SIM card in the specified slot. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.Telephony.CoreService

Parameters

Name	Type	Mandatory	Description
slotId	number	Yes	Card slot ID. - 0: card slot 1. - 1: card slot 2
callback	AsyncCallback<string>	Yes	Callback used to return the result, which is the home PLMN number of the SIM card in the specified slot.

Error codes

For details about the error codes, see Universal Error Codes and Telephony Error Codes.

ID	Error Message
401	Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. 2. Incorrect parameter types.
8300001	Invalid parameter value.
8300002	Service connection failed.
8300003	System internal error.
8300004	No SIM card found.
8300999	Unknown error.

Example

import { BusinessError } from '@kit.BasicServicesKit';
import { sim } from '@kit.TelephonyKit';

sim.getSimOperatorNumeric(0, (err: BusinessError, data: string) => {
    console.log(`callback: err->${JSON.stringify(err)}, data->${JSON.stringify(data)}`);
});

sim.getSimOperatorNumeric

getSimOperatorNumeric(slotId: number): Promise<string>

Obtains the home PLMN ID of the SIM card in the specified slot. This API uses a promise to return the result.

System capability: SystemCapability.Telephony.CoreService

Parameters

Name	Type	Mandatory	Description
slotId	number	Yes	Card slot ID. - 0: card slot 1. - 1: card slot 2

Return value

Type	Description
Promise<string>	Promise used to return the result.

Error codes

For details about the error codes, see Universal Error Codes and Telephony Error Codes.

ID	Error Message
401	Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. 2. Incorrect parameter types.
8300001	Invalid parameter value.
8300002	Service connection failed.
8300003	System internal error.
8300004	No SIM card found.
8300999	Unknown error.

Example

import { BusinessError } from '@kit.BasicServicesKit';
import { sim } from '@kit.TelephonyKit';

sim.getSimOperatorNumeric(0).then((data: string) => {
    console.log(`getSimOperatorNumeric success, promise: data->${JSON.stringify(data)}`);
}).catch((err: BusinessError) => {
    console.error(`getSimOperatorNumeric failed, promise: err->${JSON.stringify(err)}`);
});

sim.getSimOperatorNumericSync¹⁰⁺

getSimOperatorNumericSync(slotId: number): string

Obtains the home PLMN ID of the SIM card in the specified slot.

System capability: SystemCapability.Telephony.CoreService

Parameters

Name	Type	Mandatory	Description
slotId	number	Yes	Card slot ID. - 0: card slot 1. - 1: card slot 2

Return value

Type	Description
string	Home PLMN number of the SIM card in the specified slot.

Example

import { sim } from '@kit.TelephonyKit';

let numeric: string = sim.getSimOperatorNumericSync(0);
console.log(`the sim operator numeric is:` + numeric);

sim.getSimSpn

getSimSpn(slotId: number, callback: AsyncCallback<string>): void

Obtains the service provider name (SPN) of the SIM card in the specified slot. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.Telephony.CoreService

Parameters

Name	Type	Mandatory	Description
slotId	number	Yes	Card slot ID. - 0: card slot 1. - 1: card slot 2
callback	AsyncCallback<string>	Yes	Callback used to return the result, which is the SPN of the SIM card in the specified slot.

Error codes

For details about the error codes, see Universal Error Codes and Telephony Error Codes.

ID	Error Message
401	Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. 2. Incorrect parameter types.
8300001	Invalid parameter value.
8300002	Service connection failed.
8300003	System internal error.
8300004	No SIM card found.
8300999	Unknown error.

Example

import { BusinessError } from '@kit.BasicServicesKit';
import { sim } from '@kit.TelephonyKit';

sim.getSimSpn(0, (err: BusinessError, data: string) => {
    console.log(`callback: err->${JSON.stringify(err)}, data->${JSON.stringify(data)}`);
});

sim.getSimSpn

getSimSpn(slotId: number): Promise<string>

Obtains the SPN of the SIM card in the specified slot. This API uses a promise to return the result.

System capability: SystemCapability.Telephony.CoreService

Parameters

Name	Type	Mandatory	Description
slotId	number	Yes	Card slot ID. - 0: card slot 1. - 1: card slot 2

Return value

Type	Description
Promise<string>	Promise used to return the result.

Error codes

For details about the error codes, see Universal Error Codes and Telephony Error Codes.

ID	Error Message
401	Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. 2. Incorrect parameter types.
8300001	Invalid parameter value.
8300002	Service connection failed.
8300003	System internal error.
8300004	No SIM card found.
8300999	Unknown error.

Example

import { BusinessError } from '@kit.BasicServicesKit';
import { sim } from '@kit.TelephonyKit';

sim.getSimSpn(0).then((data: string) => {
    console.log(`getSimSpn success, promise: data->${JSON.stringify(data)}`);
}).catch((err: BusinessError) => {
    console.error(`getSimSpn failed, promise: err->${JSON.stringify(err)}`);
});

sim.getSimSpnSync¹⁰⁺

getSimSpnSync(slotId: number): string

Obtains the SPN of the SIM card in the specified slot.

System capability: SystemCapability.Telephony.CoreService

Parameters

Name	Type	Mandatory	Description
slotId	number	Yes	Card slot ID. - 0: card slot 1. - 1: card slot 2

Return value

Type	Description
string	SPN of the SIM card in the specified slot.

Example

import { sim } from '@kit.TelephonyKit';

let spn: string = sim.getSimSpnSync(0);
console.log(`the sim card spn is:` + spn);

sim.getSimState

getSimState(slotId: number, callback: AsyncCallback<SimState>): void

Obtains the state of the SIM card in the specified slot. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.Telephony.CoreService

Parameters

Name	Type	Mandatory	Description
slotId	number	Yes	Card slot ID. - 0: card slot 1. - 1: card slot 2
callback	AsyncCallback<SimState>	Yes	Callback used to return the result, which is the state of the SIM card in the specified slot. For details, see SimState.

Error codes

For details about the error codes, see Universal Error Codes and Telephony Error Codes.

ID	Error Message
401	Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. 2. Incorrect parameter types.
8300001	Invalid parameter value.
8300002	Service connection failed.
8300003	System internal error.
8300999	Unknown error.

Example

import { BusinessError } from '@kit.BasicServicesKit';
import { sim } from '@kit.TelephonyKit';

sim.getSimState(0, (err: BusinessError, data: sim.SimState) => {
    console.log(`callback: err->${JSON.stringify(err)}, data->${JSON.stringify(data)}`);
});

sim.getSimState

getSimState(slotId: number): Promise<SimState>

Obtains the state of the SIM card in the specified slot. This API uses a promise to return the result.

System capability: SystemCapability.Telephony.CoreService

Parameters

Name	Type	Mandatory	Description
slotId	number	Yes	Card slot ID. - 0: card slot 1. - 1: card slot 2

Return value

Type	Description
Promise<SimState>	Promise used to return the result.

Error codes

For details about the error codes, see Universal Error Codes and Telephony Error Codes.

ID	Error Message
401	Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. 2. Incorrect parameter types.
8300001	Invalid parameter value.
8300002	Service connection failed.
8300003	System internal error.
8300999	Unknown error.

Example

import { BusinessError } from '@kit.BasicServicesKit';
import { sim } from '@kit.TelephonyKit';

sim.getSimState(0).then((data: sim.SimState) => {
    console.log(`getSimState success, promise: data->${JSON.stringify(data)}`);
}).catch((err: BusinessError) => {
    console.error(`getSimState failed, promise: err->${JSON.stringify(err)}`);
});

sim.getSimStateSync¹⁰⁺

getSimStateSync(slotId: number): SimState

Obtains the state of the SIM card in the specified slot.

System capability: SystemCapability.Telephony.CoreService

Parameters

Name	Type	Mandatory	Description
slotId	number	Yes	Card slot ID. - 0: card slot 1. - 1: card slot 2

Return value

Type	Description
SimState	State of the SIM card in the specified slot.

Example

import { sim } from '@kit.TelephonyKit';

let simState: sim.SimState = sim.getSimStateSync(0);
console.log(`The sim state is:` + simState);

sim.getCardType⁷⁺

getCardType(slotId: number, callback: AsyncCallback<CardType>): void

Obtains the type of the SIM card in the specified slot. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.Telephony.CoreService

Parameters

Name	Type	Mandatory	Description
slotId	number	Yes	Card slot ID. - 0: card slot 1. - 1: card slot 2
callback	AsyncCallback<CardType>	Yes	Callback used to return the result.

Error codes

For details about the error codes, see Universal Error Codes and Telephony Error Codes.

ID	Error Message
401	Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. 2. Incorrect parameter types.
8300001	Invalid parameter value.
8300002	Service connection failed.
8300003	System internal error.
8300004	No SIM card found.
8300999	Unknown error.

Example

import { BusinessError } from '@kit.BasicServicesKit';
import { sim } from '@kit.TelephonyKit';

sim.getCardType(0, (err: BusinessError, data: sim.CardType) => {
    console.log(`callback: err->${JSON.stringify(err)}, data->${JSON.stringify(data)}`);
});

sim.getCardType⁷⁺

getCardType(slotId: number): Promise<CardType>

Obtains the type of the SIM card in the specified slot. This API uses a promise to return the result.

System capability: SystemCapability.Telephony.CoreService

Parameters

Name	Type	Mandatory	Description
slotId	number	Yes	Card slot ID. - 0: card slot 1. - 1: card slot 2

Return value

Type	Description
Promise<CardType>	Promise used to return the result.

Error codes

For details about the error codes, see Universal Error Codes and Telephony Error Codes.

ID	Error Message
401	Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. 2. Incorrect parameter types.
8300001	Invalid parameter value.
8300002	Service connection failed.
8300003	System internal error.
8300004	No SIM card found.
8300999	Unknown error.

Example

import { BusinessError } from '@kit.BasicServicesKit';
import { sim } from '@kit.TelephonyKit';

sim.getCardType(0).then((data: sim.CardType) => {
    console.log(`getCardType success, promise: data->${JSON.stringify(data)}`);
}).catch((err: BusinessError) => {
    console.error(`getCardType failed, promise: err->${JSON.stringify(err)}`);
});

sim.getCardTypeSync¹⁰⁺

getCardTypeSync(slotId: number): CardType

Obtains the type of the SIM card in the specified slot.

System capability: SystemCapability.Telephony.CoreService

Parameters

Name	Type	Mandatory	Description
slotId	number	Yes	Card slot ID. - 0: card slot 1. - 1: card slot 2

Return value

Type	Description
CardType	Type of the SIM card in the specified slot.

Example

import { sim } from '@kit.TelephonyKit';

let cardType: sim.CardType = sim.getCardTypeSync(0);
console.log(`the card type is:` + cardType);

sim.hasSimCard⁷⁺

hasSimCard(slotId: number, callback: AsyncCallback<boolean>): void

Checks whether the SIM card in the specified slot is installed. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.Telephony.CoreService

Parameters

Name	Type	Mandatory	Description
slotId	number	Yes	Card slot ID. - 0: card slot 1. - 1: card slot 2
callback	AsyncCallback<boolean>	Yes	Callback used to return the result. - true: installed. - false: not installed.

Error codes

For details about the error codes, see Universal Error Codes and Telephony Error Codes.

ID	Error Message
401	Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. 2. Incorrect parameter types.
8300001	Invalid parameter value.
8300002	Service connection failed.
8300003	System internal error.
8300999	Unknown error.

Example

import { BusinessError } from '@kit.BasicServicesKit';
import { sim } from '@kit.TelephonyKit';

sim.hasSimCard(0, (err: BusinessError, data: boolean) => {
    console.log(`callback: err->${JSON.stringify(err)}, data->${JSON.stringify(data)}`);
});

sim.hasSimCard⁷⁺

hasSimCard(slotId: number): Promise<boolean>

Checks whether the SIM card in the specified slot is installed. This API uses a promise to return the result.

System capability: SystemCapability.Telephony.CoreService

Parameters

Name	Type	Mandatory	Description
slotId	number	Yes	Card slot ID. - 0: card slot 1. - 1: card slot 2

Return value

Type	Description
Promise<boolean>	Promise used to return the result. - true: installed. - false: not installed.

Error codes

For details about the error codes, see Universal Error Codes and Telephony Error Codes.

ID	Error Message
401	Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. 2. Incorrect parameter types.
8300001	Invalid parameter value.
8300002	Service connection failed.
8300003	System internal error.
8300999	Unknown error.

Example

import { BusinessError } from '@kit.BasicServicesKit';
import { sim } from '@kit.TelephonyKit';

sim.hasSimCard(0).then((data: boolean) => {
    console.log(`hasSimCard success, promise: data->${JSON.stringify(data)}`);
}).catch((err: BusinessError) => {
    console.error(`hasSimCard failed, promise: err->${JSON.stringify(err)}`);
});

sim.hasSimCardSync¹⁰⁺

hasSimCardSync(slotId: number): boolean

Checks whether the SIM card in the specified slot is installed.

System capability: SystemCapability.Telephony.CoreService

Parameters

Name	Type	Mandatory	Description
slotId	number	Yes	Card slot ID. - 0: card slot 1. - 1: card slot 2

Return value

Type	Description
boolean	Whether the SIM card in the specified slot is installed. - true: installed. - false: not installed.

Example

import { sim } from '@kit.TelephonyKit';

let hasSimCard: boolean = sim.hasSimCardSync(0);
console.log(`has sim card: ` + hasSimCard);

sim.getSimAccountInfo¹⁰⁺

getSimAccountInfo(slotId: number, callback: AsyncCallback<IccAccountInfo>): void

Obtains account information of the SIM card in the specified slot. This API uses an asynchronous callback to return the result.

Required permission: ohos.permission.GET_TELEPHONY_STATE

NOTE

The GET_TELEPHONY_STATE permission is required to obtain the ICCID and phone number. Such information is sensitive and not open to third-party applications. When this API is called, the returned ICCID and phone number are empty.

System capability: SystemCapability.Telephony.CoreService

Parameters

Name	Type	Mandatory	Description
slotId	number	Yes	Card slot ID. - 0: card slot 1. - 1: card slot 2
callback	AsyncCallback<IccAccountInfo>	Yes	Callback used to return the result, which is the account information of the SIM card in the specified slot.

Error codes

For details about the error codes, see Universal Error Codes and Telephony Error Codes.

ID	Error Message
401	Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. 2. Incorrect parameter types.
8300001	Invalid parameter value.
8300002	Service connection failed.
8300003	System internal error.
8300004	No SIM card found.
8300999	Unknown error.
8301002	The SIM card failed to read or update data.

Example

import { BusinessError } from '@kit.BasicServicesKit';
import { sim } from '@kit.TelephonyKit';

sim.getSimAccountInfo(0, (err:BusinessError , data: sim.IccAccountInfo) => {
    console.log(`callback: err->${JSON.stringify(err)}, data->${JSON.stringify(data)}`);
});

sim.getSimAccountInfo¹⁰⁺

getSimAccountInfo(slotId: number): Promise<IccAccountInfo>

Obtains account information of the SIM card in the specified slot. This API uses a promise to return the result.

Required permission: ohos.permission.GET_TELEPHONY_STATE

NOTE

The GET_TELEPHONY_STATE permission is required to obtain the ICCID and phone number. Such information is sensitive and not open to third-party applications. When this API is called, the returned ICCID and phone number are empty.

System capability: SystemCapability.Telephony.CoreService

Parameters

Name	Type	Mandatory	Description
slotId	number	Yes	Card slot ID. - 0: card slot 1. - 1: card slot 2

Return value

Type	Description
Promise<IccAccountInfo>	Promise used to return the result.

Error codes

For details about the error codes, see Universal Error Codes and Telephony Error Codes.

ID	Error Message
401	Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. 2. Incorrect parameter types.
8300001	Invalid parameter value.
8300002	Service connection failed.
8300003	System internal error.
8300004	No SIM card found.
8300999	Unknown error.
8301002	The SIM card failed to read or update data.

Example

import { BusinessError } from '@kit.BasicServicesKit';
import { sim } from '@kit.TelephonyKit';

sim.getSimAccountInfo(0).then((data: sim.IccAccountInfo) => {
    console.log(`getSimAccountInfo success, promise: data->${JSON.stringify(data)}`);
}).catch((err: BusinessError) => {
    console.error(`getSimAccountInfo failed, promise: err->${JSON.stringify(err)}`);
});

sim.getActiveSimAccountInfoList¹⁰⁺

getActiveSimAccountInfoList(callback: AsyncCallback<Array<IccAccountInfo>>): void

Obtains the list of activated SIM card accounts. This API uses an asynchronous callback to return the result.

Required permission: ohos.permission.GET_TELEPHONY_STATE

NOTE

The GET_TELEPHONY_STATE permission is required to obtain the ICCID and phone number. Such information is sensitive and not open to third-party applications. When this API is called, the returned ICCID and phone number are empty.

System capability: SystemCapability.Telephony.CoreService

Parameters

Name	Type	Mandatory	Description
callback	AsyncCallback<Array<IccAccountInfo>>	Yes	Callback used to return the result, which is a list of activated SIM card accounts.

Error codes

For details about the error codes, see Universal Error Codes and Telephony Error Codes.

ID	Error Message
401	Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. 2. Incorrect parameter types.
8300001	Invalid parameter value.
8300002	Service connection failed.
8300003	System internal error.
8300004	No SIM card found.
8300999	Unknown error.

Example

import { BusinessError } from '@kit.BasicServicesKit';
import { sim } from '@kit.TelephonyKit';

sim.getActiveSimAccountInfoList((err: BusinessError, data: Array<sim.IccAccountInfo>) => {
    console.log(`callback: err->${JSON.stringify(err)}, data->${JSON.stringify(data)}`);
});

sim.getMaxSimCount⁷⁺

getMaxSimCount(): number

Obtains the number of card slots.

System capability: SystemCapability.Telephony.CoreService

Return value

Type	Description
number	Number of card slots.

Example

import { sim } from '@kit.TelephonyKit';

console.log("Result: "+ sim.getMaxSimCount());

sim.getActiveSimAccountInfoList¹⁰⁺

getActiveSimAccountInfoList(): Promise<Array<IccAccountInfo>>

Obtains the list of activated SIM card accounts. This API uses a promise to return the result.

Required permission: ohos.permission.GET_TELEPHONY_STATE

NOTE

The GET_TELEPHONY_STATE permission is required to obtain the ICCID and phone number. Such information is sensitive and not open to third-party applications. When this API is called, the returned ICCID and phone number are empty.

System capability: SystemCapability.Telephony.CoreService

Return value

Type	Description
Promise<Array<IccAccountInfo>>	Promise used to return the result.

Error codes

For details about the error codes, seeohos.telephony (Telephony) Error Codes.

ID	Error Message
8300002	Service connection failed.
8300003	System internal error.
8300004	No SIM card found.
8300999	Unknown error.

Example

import { BusinessError } from '@kit.BasicServicesKit';
import { sim } from '@kit.TelephonyKit';

sim.getActiveSimAccountInfoList().then((data: Array<sim.IccAccountInfo>) => {
    console.log(`getActiveSimAccountInfoList success, promise: data->${JSON.stringify(data)}`);
}).catch((err: BusinessError) => {
    console.error(`getActiveSimAccountInfoList failed, promise: err->${JSON.stringify(err)}`);
});

sim.getOpKey⁹⁺

getOpKey(slotId: number, callback: AsyncCallback<string>): void

Obtains the opkey of the SIM card in the specified slot. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.Telephony.CoreService

Parameters

Name	Type	Mandatory	Description
slotId	number	Yes	Card slot ID. - 0: card slot 1. - 1: card slot 2
callback	AsyncCallback<string>	Yes	Callback used to return the result.

Error codes

For details about the error codes, see Universal Error Codes and Telephony Error Codes.

ID	Error Message
401	Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. 2. Incorrect parameter types.
801	Capability not supported.
8300001	Invalid parameter value.
8300002	Service connection failed.
8300003	System internal error.
8300999	Unknown error.

Example

import { BusinessError } from '@kit.BasicServicesKit';
import { sim } from '@kit.TelephonyKit';

try {
    sim.getOpKey(0, (err: BusinessError, data: string) => {
    if (err) {
      console.error("getOpKey failed, err: " + JSON.stringify(err));
    } else {
      console.log('getOpKey successfully, data: ' + JSON.stringify(data));
    }
  });
} catch (err) {
  console.error("getOpKey err: " + JSON.stringify(err));
}

sim.getOpKey⁹⁺

getOpKey(slotId: number): Promise<string>

Obtains the opkey of the SIM card in the specified slot. This API uses a promise to return the result.

System capability: SystemCapability.Telephony.CoreService

Parameters

Name	Type	Mandatory	Description
slotId	number	Yes	Card slot ID. - 0: card slot 1. - 1: card slot 2

Return value

Type	Description
Promise<string>	Promise used to return the result.

Error codes

For details about the error codes, see Universal Error Codes and Telephony Error Codes.

ID	Error Message
401	Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. 2. Incorrect parameter types.
801	Capability not supported.
8300001	Invalid parameter value.
8300002	Service connection failed.
8300003	System internal error.
8300999	Unknown error.

Example

import { BusinessError } from '@kit.BasicServicesKit';
import { sim } from '@kit.TelephonyKit';

sim.getOpKey(0).then((data: string) => {
    console.log(`getOpKey success, promise: data->${JSON.stringify(data)}`);
}).catch((err: BusinessError) => {
    console.error(`getOpKey failed, promise: err->${JSON.stringify(err)}`);
});

sim.getOpKeySync¹⁰⁺

getOpKeySync(slotId: number): string

Obtains the opkey of the SIM card in the specified slot.

System capability: SystemCapability.Telephony.CoreService

Parameters

Name	Type	Mandatory	Description
slotId	number	Yes	Card slot ID. - 0: card slot 1. - 1: card slot 2

Return value

Type	Description
string	opkey of the SIM card in the specified slot.

Example

import { sim } from '@kit.TelephonyKit';

let data: string = sim.getOpKeySync(0);
console.log(`getOpKey success, promise: data->${JSON.stringify(data)}`);

sim.getOpName⁹⁺

getOpName(slotId: number, callback: AsyncCallback<string>): void

Obtains the OpName of the SIM card in the specified slot. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.Telephony.CoreService

Parameters

Name	Type	Mandatory	Description
slotId	number	Yes	Card slot ID. - 0: card slot 1. - 1: card slot 2
callback	AsyncCallback<string>	Yes	Callback used to return the result.

Error codes

For details about the error codes, see Universal Error Codes and Telephony Error Codes.

ID	Error Message
401	Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. 2. Incorrect parameter types.
801	Capability not supported.
8300001	Invalid parameter value.
8300002	Service connection failed.
8300003	System internal error.
8300999	Unknown error.

Example

import { BusinessError } from '@kit.BasicServicesKit';
import { sim } from '@kit.TelephonyKit';

try {
    sim.getOpName(0, (err: BusinessError, data: string) => {
    if (err) {
      console.error("getOpName failed, err: " + JSON.stringify(err));
    } else {
      console.log('getOpName successfully, data: ' + JSON.stringify(data));
    }
  });
} catch (err) {
  console.error("getOpName err: " + JSON.stringify(err));
}

sim.getOpName⁹⁺

getOpName(slotId: number): Promise<string>

Obtains the OpName of the SIM card in the specified slot. This API uses a promise to return the result.

System capability: SystemCapability.Telephony.CoreService

Parameters

Name	Type	Mandatory	Description
slotId	number	Yes	Card slot ID. - 0: card slot 1. - 1: card slot 2

Return value

Type	Description
Promise<string>	Promise used to return the result.

Error codes

For details about the error codes, see Universal Error Codes and Telephony Error Codes.

ID	Error Message
401	Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. 2. Incorrect parameter types.
801	Capability not supported.
8300001	Invalid parameter value.
8300002	Service connection failed.
8300003	System internal error.
8300999	Unknown error.

Example

import { BusinessError } from '@kit.BasicServicesKit';
import { sim } from '@kit.TelephonyKit';

sim.getOpName(0).then((data: string) => {
    console.log(`getOpName success, promise: data->${JSON.stringify(data)}`);
}).catch((err: BusinessError) => {
    console.error(`getOpName failed, promise: err->${JSON.stringify(err)}`);
});

sim.getOpNameSync¹⁰⁺

getOpNameSync(slotId: number): string

Obtains the OpName of the SIM card in the specified slot.

System capability: SystemCapability.Telephony.CoreService

Parameters

Name	Type	Mandatory	Description
slotId	number	Yes	Card slot ID. - 0: card slot 1. - 1: card slot 2

Return value

Type	Description
string	OpName of the SIM card in the specified slot.

Example

import { sim } from '@kit.TelephonyKit';

let data: string = sim.getOpNameSync(0);
console.log(`getOpName success, promise: data->${JSON.stringify(data)}`);

sim.getDefaultVoiceSimId¹⁰⁺

getDefaultVoiceSimId(callback: AsyncCallback<number>): void

Obtains the default slot ID of the SIM card that provides voice services. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.Telephony.CoreService

Parameters

Name	Type	Mandatory	Description
callback	AsyncCallback<number>	Yes	Callback used to return the result. The return value is bound to the SIM card and increases from 1.

Error codes

For details about the error codes, see Universal Error Codes and Telephony Error Codes.

ID	Error Message
401	Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. 2. Incorrect parameter types.
8300001	Invalid parameter value.
8300002	Service connection failed.
8300003	System internal error.
8300004	No SIM card found.
8300999	Unknown error.
8301001	SIM card is not activated.

Example

import { BusinessError } from '@kit.BasicServicesKit';
import { sim } from '@kit.TelephonyKit';

sim.getDefaultVoiceSimId((err: BusinessError, data: number) => {
    console.log(`callback: err->${JSON.stringify(err)}, data->${JSON.stringify(data)}`);
});

sim.getDefaultVoiceSimId¹⁰⁺

getDefaultVoiceSimId(): Promise<number>

Obtains the default slot ID of the SIM card that provides voice services. This API uses a promise to return the result.

System capability: SystemCapability.Telephony.CoreService

Return value

Type	Description
Promise<number>	Promise used to return the result. The return value is bound to the SIM card and increases from 1.

Error codes

For details about the error codes, seeohos.telephony (Telephony) Error Codes.

ID	Error Message
8300001	Invalid parameter value.
8300002	Service connection failed.
8300003	System internal error.
8300004	No SIM card found.
8300999	Unknown error.
8301001	SIM card is not activated.

Example

import { BusinessError } from '@kit.BasicServicesKit';
import { sim } from '@kit.TelephonyKit';

let promise = sim.getDefaultVoiceSimId();
promise.then((data: number) => {
    console.log(`getDefaultVoiceSimId success, promise: data->${JSON.stringify(data)}`);
}).catch((err: BusinessError) => {
    console.error(`getDefaultVoiceSimId failed, promise: err->${JSON.stringify(err)}`);
});

SimState

Enumerates SIM card states.

System capability: SystemCapability.Telephony.CoreService

Name	Value	Description
SIM_STATE_UNKNOWN	0	The SIM card is in unknown state; that is, the SIM card status cannot be obtained.
SIM_STATE_NOT_PRESENT	1	The SIM card is in not present state; that is, no SIM card is inserted into the card slot.
SIM_STATE_LOCKED	2	The SIM card is in locked state; that is, the SIM card is locked by the personal identification number (PIN), PIN unblocking key (PUK), or network.
SIM_STATE_NOT_READY	3	The SIM card is in not ready state; that is, the SIM card has been installed but cannot work properly.
SIM_STATE_READY	4	The SIM card is in ready state; that is, the SIM card has been installed and is working properly.
SIM_STATE_LOADED	5	The SIM card is in loaded state; that is, the SIM card is present and all its files have been loaded.

CardType⁷⁺

Enumerates SIM card types.

System capability: SystemCapability.Telephony.CoreService

Name	Value	Description
UNKNOWN_CARD	-1	Unknown type.
SINGLE_MODE_SIM_CARD	10	Single-card (SIM).
SINGLE_MODE_USIM_CARD	20	Single-card (USIM).
SINGLE_MODE_RUIM_CARD	30	Single-card (RUIM).
DUAL_MODE_CG_CARD	40	Dual-card (CDMA+GSM).
CT_NATIONAL_ROAMING_CARD	41	China Telecom internal roaming card.
CU_DUAL_MODE_CARD	42	China Unicom dual-mode card.
DUAL_MODE_TELECOM_LTE_CARD	43	China Telecom dual-mode LTE card.
DUAL_MODE_UG_CARD	50	Dual-mode card (UMTS+GSM).
SINGLE_MODE_ISIM_CARD⁸⁺	60	Single-card (ISIM).

IccAccountInfo¹⁰⁺

ICC account information.

System capability: SystemCapability.Telephony.CoreService

Name	Type	Mandatory	Description
simId	number	Yes	SIM card ID.
slotIndex	number	Yes	Card slot ID.
isEsim	boolean	Yes	Whether the SIM card is an eSim card.
isActive	boolean	Yes	Whether the card is activated.
iccId	string	Yes	ICCID number.
showName	string	Yes	SIM card display name.
showNumber	string	Yes	SIM card display number.

你可能感兴趣的鸿蒙文章

harmony 鸿蒙Telephony Kit

harmony 鸿蒙Telephony_NetworkState

harmony 鸿蒙Telephony Error Codes

harmony 鸿蒙js-apis-call-sys

harmony 鸿蒙@ohos.telephony.call (Call)

harmony 鸿蒙@ohos.telephony.esim (eSIM Management) (System API)

harmony 鸿蒙@ohos.telephony.esim (eSIM Management)

harmony 鸿蒙@ohos.telephony.observer (Observer) (System API)

harmony 鸿蒙@ohos.telephony.observer (Observer)

harmony 鸿蒙@ohos.telephony.radio (Radio) (System API)

标签云

@ohos.telephony.sim (SIM Management)

Modules to Import

sim.isSimActive7+

sim.isSimActive7+

sim.isSimActiveSync10+

sim.getDefaultVoiceSlotId7+

sim.getDefaultVoiceSlotId7+

sim.hasOperatorPrivileges7+

sim.hasOperatorPrivileges7+

sim.getISOCountryCodeForSim

sim.getISOCountryCodeForSim

sim.getISOCountryCodeForSimSync10+

sim.getSimOperatorNumeric

sim.getSimOperatorNumeric

sim.getSimOperatorNumericSync10+

sim.getSimSpn

sim.getSimSpn

sim.getSimSpnSync10+

sim.getSimState

sim.getSimState

sim.getSimStateSync10+

sim.getCardType7+

sim.getCardType7+

sim.getCardTypeSync10+

sim.hasSimCard7+

sim.hasSimCard7+

sim.hasSimCardSync10+

sim.getSimAccountInfo10+

sim.getSimAccountInfo10+

sim.getActiveSimAccountInfoList10+

sim.getMaxSimCount7+

sim.getActiveSimAccountInfoList10+

sim.getOpKey9+

sim.getOpKey9+

sim.getOpKeySync10+

sim.getOpName9+

sim.getOpName9+

sim.getOpNameSync10+

sim.getDefaultVoiceSimId10+

sim.getDefaultVoiceSimId10+

SimState

CardType7+

IccAccountInfo10+

你可能感兴趣的鸿蒙文章

最新博客

最热博客

sim.isSimActive⁷⁺

sim.isSimActive⁷⁺

sim.isSimActiveSync¹⁰⁺

sim.getDefaultVoiceSlotId⁷⁺

sim.getDefaultVoiceSlotId⁷⁺

sim.hasOperatorPrivileges⁷⁺

sim.hasOperatorPrivileges⁷⁺

sim.getISOCountryCodeForSimSync¹⁰⁺

sim.getSimOperatorNumericSync¹⁰⁺

sim.getSimSpnSync¹⁰⁺

sim.getSimStateSync¹⁰⁺

sim.getCardType⁷⁺

sim.getCardType⁷⁺

sim.getCardTypeSync¹⁰⁺

sim.hasSimCard⁷⁺

sim.hasSimCard⁷⁺

sim.hasSimCardSync¹⁰⁺

sim.getSimAccountInfo¹⁰⁺

sim.getSimAccountInfo¹⁰⁺

sim.getActiveSimAccountInfoList¹⁰⁺

sim.getMaxSimCount⁷⁺

sim.getActiveSimAccountInfoList¹⁰⁺

sim.getOpKey⁹⁺

sim.getOpKey⁹⁺

sim.getOpKeySync¹⁰⁺

sim.getOpName⁹⁺

sim.getOpName⁹⁺

sim.getOpNameSync¹⁰⁺

sim.getDefaultVoiceSimId¹⁰⁺

sim.getDefaultVoiceSimId¹⁰⁺

CardType⁷⁺

IccAccountInfo¹⁰⁺