@ohos.telephony.call (Call)

The call module provides call management functions, including making calls, redirecting to the dial screen, obtaining the call status, and formatting phone numbers.

To subscribe to the call status, use observer.on('callStateChange').

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 call from '@ohos.telephony.call';

call.dialCall⁹⁺

dialCall(phoneNumber: string, callback: AsyncCallback<void>): void

Initiates a call. This API uses an asynchronous callback to return the result.

System API: This is a system API.

Required Permissions: ohos.permission.PLACE_CALL

System capability: SystemCapability.Telephony.CallManager

Parameters

Error codes

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

Example

call.dialCall("138xxxxxxxx", (err) => {
    console.log(`callback: err->${JSON.stringify(err)}`);
});

call.dialCall⁹⁺

dialCall(phoneNumber: string, options: DialCallOptions, callback: AsyncCallback<void>): void

Initiates a call. You can set call options as needed. This API uses an asynchronous callback to return the result.

System API: This is a system API.

Required Permissions: ohos.permission.PLACE_CALL

System capability: SystemCapability.Telephony.CallManager

Parameters

Error codes

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

Example

call.dialCall("138xxxxxxxx", {
    accountId: 0,
    videoState: 0,
    dialScene: 0,
    dialType: 0,
}, (err) => {
    console.log(`callback: err->${JSON.stringify(err)}`);
});

call.dialCall⁹⁺

dialCall(phoneNumber: string, options?: DialCallOptions): Promise<void>

Initiates a call. You can set call options as needed. This API uses a promise to return the result.

System API: This is a system API.

Required Permissions: ohos.permission.PLACE_CALL

System capability: SystemCapability.Telephony.CallManager

Parameters

Return value

Error codes

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

Example

let promise = call.dialCall("138xxxxxxxx", {
    accountId: 0,
    videoState: 0,
    dialScene: 0,
    dialType: 0,
});
promise.then(() => {
    console.log(`dialCall success.`);
}).catch((err) => {
    console.error(`dialCall fail, promise: err->${JSON.stringify(err)}`);
});

call.dial^(deprecated)

dial(phoneNumber: string, callback: AsyncCallback<boolean>): void

Initiates a call. This API uses an asynchronous callback to return the result.

NOTE

This API is supported since API version 6 and deprecated since API version 9. You are advised to use dialCall. The substitute API is available only for system applications.

Required Permissions: ohos.permission.PLACE_CALL

System capability: SystemCapability.Telephony.CallManager

Parameters

Example

call.dial("138xxxxxxxx", (err, data) => {
    console.log(`callback: err->${JSON.stringify(err)}, data->${JSON.stringify(data)}`);
});

call.dial^(deprecated)

dial(phoneNumber: string, options: DialOptions, callback: AsyncCallback<boolean>): void

Initiates a call. You can set call options as needed. This API uses an asynchronous callback to return the result.

NOTE

This API is supported since API version 6 and deprecated since API version 9. You are advised to use dialCall. The substitute API is available only for system applications.

Required Permissions: ohos.permission.PLACE_CALL

System capability: SystemCapability.Telephony.CallManager

Parameters

Example

call.dial("138xxxxxxxx", {
    extras: false
}, (err, data) => {
    console.log(`callback: err->${JSON.stringify(err)}, data->${JSON.stringify(data)}`);
});

call.dial^(deprecated)

dial(phoneNumber: string, options?: DialOptions): Promise<boolean>

Initiates a call. You can set call options as needed. This API uses a promise to return the result.

NOTE

This API is supported since API version 6 and deprecated since API version 9. You are advised to use dialCall. The substitute API is available only for system applications.

Required Permissions: ohos.permission.PLACE_CALL

System capability: SystemCapability.Telephony.CallManager

Parameters

Return value

Example

let promise = call.dial("138xxxxxxxx", {
    extras: false
});
promise.then(data => {
    console.log(`dial success, promise: data->${JSON.stringify(data)}`);
}).catch(err => {
    console.error(`dial fail, promise: err->${JSON.stringify(err)}`);
});

call.makeCall⁷⁺

makeCall(phoneNumber: string, callback: AsyncCallback<void>): void

Launches the call screen and displays the dialed number. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.Applications.Contacts

Parameters

Error codes

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

Example

call.makeCall("138xxxxxxxx", err => {
    console.log(`makeCall callback: err->${JSON.stringify(err)}`);
});

call.makeCall⁷⁺

makeCall(phoneNumber: string): Promise<void>

Launches the call screen and displays the dialed number. This API uses a promise to return the result.

System capability: SystemCapability.Applications.Contacts

Parameters

Return value

Error codes

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

Example

let promise = call.makeCall("138xxxxxxxx");
promise.then(() => {
    console.log(`makeCall success`);
}).catch(err => {
    console.error(`makeCall fail, promise: err->${JSON.stringify(err)}`);
});

call.hasCall

hasCall(callback: AsyncCallback<boolean>): void

Checks whether a call is in progress. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.Telephony.CallManager

Parameters

Example

call.hasCall((err, data) => {
    console.log(`callback: err->${JSON.stringify(err)}, data->${JSON.stringify(data)}`);
});

call.hasCall

hasCall(): Promise<boolean>

Checks whether a call is in progress. This API uses a promise to return the result.

System capability: SystemCapability.Telephony.CallManager

Return value

Example

let promise = call.hasCall();
promise.then(data => {
    console.log(`hasCall success, promise: data->${JSON.stringify(data)}`);
}).catch(err => {
    console.error(`hasCall fail, promise: err->${JSON.stringify(err)}`);
});

call.getCallState

getCallState(callback: AsyncCallback<CallState>): void

Obtains the call status. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.Telephony.CallManager

Parameters

Example

call.getCallState((err, data) => {
    console.log(`callback: err->${JSON.stringify(err)}, data->${JSON.stringify(data)}`);
});

call.getCallState

getCallState(): Promise<CallState>

Obtains the call status. This API uses a promise to return the result.

System capability: SystemCapability.Telephony.CallManager

Return value

Example

let promise = call.getCallState();
promise.then(data => {
    console.log(`getCallState success, promise: data->${JSON.stringify(data)}`);
}).catch(err => {
    console.error(`getCallState fail, promise: err->${JSON.stringify(err)}`);
});

call.hasVoiceCapability⁷⁺

hasVoiceCapability(): boolean

Checks whether a device supports voice calls.

System capability: SystemCapability.Telephony.CallManager

Return value

let result = call.hasVoiceCapability(); 
console.log(`hasVoiceCapability: ${JSON.stringify(result)}`);

call.isEmergencyPhoneNumber⁷⁺

isEmergencyPhoneNumber(phoneNumber: string, callback: AsyncCallback<boolean>): void

Checks whether the called number is an emergency number. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.Telephony.CallManager

Parameters

Error codes

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

Example

call.isEmergencyPhoneNumber("138xxxxxxxx", (err, data) => {
    console.log(`callback: err->${JSON.stringify(err)}, data->${JSON.stringify(data)}`);
});

call.isEmergencyPhoneNumber⁷⁺

isEmergencyPhoneNumber(phoneNumber: string, options: EmergencyNumberOptions, callback: AsyncCallback<boolean>): void

Checks whether the called number is an emergency number based on the phone number. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.Telephony.CallManager

Parameters

Error codes

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

Example

call.isEmergencyPhoneNumber("112", {slotId: 1}, (err, data) => {
    console.log(`callback: err->${JSON.stringify(err)}, data->${JSON.stringify(data)}`);
});

call.isEmergencyPhoneNumber⁷⁺

isEmergencyPhoneNumber(phoneNumber: string, options?: EmergencyNumberOptions): Promise<boolean>

Checks whether the called number is an emergency number based on the phone number. This API uses a promise to return the result.

System capability: SystemCapability.Telephony.CallManager

Parameters

Return value

Error codes

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

Example

let promise = call.isEmergencyPhoneNumber("138xxxxxxxx", {slotId: 1});
promise.then(data => {
    console.log(`isEmergencyPhoneNumber success, promise: data->${JSON.stringify(data)}`);
}).catch(err => {
    console.error(`isEmergencyPhoneNumber fail, promise: err->${JSON.stringify(err)}`);
});

call.formatPhoneNumber⁷⁺

formatPhoneNumber(phoneNumber: string, callback: AsyncCallback<string>): void

Formats a phone number. This API uses an asynchronous callback to return the result.

A formatted phone number is a standard numeric string, for example, 555 0100.

System capability: SystemCapability.Telephony.CallManager

Parameters

Error codes

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

Example

call.formatPhoneNumber("138xxxxxxxx", (err, data) => {
    console.log(`callback: err->${JSON.stringify(err)}, data->${JSON.stringify(data)}`);
});

call.formatPhoneNumber⁷⁺

formatPhoneNumber(phoneNumber: string, options: NumberFormatOptions, callback: AsyncCallback<string>): void

Formats a phone number based on specified formatting options. This API uses an asynchronous callback to return the result.

A formatted phone number is a standard numeric string, for example, 555 0100.

System capability: SystemCapability.Telephony.CallManager

Parameters

Error codes

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

Example

call.formatPhoneNumber("138xxxxxxxx", {
    countryCode: "CN"
}, (err, data) => {
    console.log(`callback: err->${JSON.stringify(err)}, data->${JSON.stringify(data)}`);
});

call.formatPhoneNumber⁷⁺

formatPhoneNumber(phoneNumber: string, options?: NumberFormatOptions): Promise<string>

Formats a phone number based on specified formatting options. This API uses a promise to return the result.

A formatted phone number is a standard numeric string, for example, 555 0100.

System capability: SystemCapability.Telephony.CallManager

Parameters

Return value

Error codes

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

Example

let promise = call.formatPhoneNumber("138xxxxxxxx", {
    countryCode: "CN"
});
promise.then(data => {
    console.log(`formatPhoneNumber success, promise: data->${JSON.stringify(data)}`);
}).catch(err => {
    console.error(`formatPhoneNumber fail, promise: err->${JSON.stringify(err)}`);
});

call.formatPhoneNumberToE164⁷⁺

formatPhoneNumberToE164(phoneNumber: string, countryCode: string, callback: AsyncCallback<string>): void

Converts a phone number into the E.164 format. This API uses an asynchronous callback to return the result.

The phone number must match the specified country code. For example, for a China phone number, the country code must be CN. Otherwise, null will be returned.

System capability: SystemCapability.Telephony.CallManager

Parameters

Error codes

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

Example

call.formatPhoneNumberToE164("138xxxxxxxx", "CN", (err, data) => {
    console.log(`callback: err->${JSON.stringify(err)}, data->${JSON.stringify(data)}`);
});

call.formatPhoneNumberToE164⁷⁺

formatPhoneNumberToE164(phoneNumber: string, countryCode: string): Promise<string>

Converts a phone number into the E.164 format. This API uses a promise to return the result.

The phone number must match the specified country code. For example, for a China phone number, the country code must be CN. Otherwise, null will be returned.

All country codes are supported.

System capability: SystemCapability.Telephony.CallManager

Parameters

Return value

Error codes

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

Example

let promise = call.formatPhoneNumberToE164("138xxxxxxxx", "CN");
promise.then(data => {
    console.log(`formatPhoneNumberToE164 success, promise: data->${JSON.stringify(data)}`);
}).catch(err => {
    console.error(`formatPhoneNumberToE164 fail, promise: err->${JSON.stringify(err)}`);
});

call.muteRinger⁸⁺

muteRinger(callback: AsyncCallback<void>): void

Mutes the ringtone while it is playing. It does not work if the ringtone has been muted. This API uses an asynchronous callback to return the result.

System API: This is a system API.

Required permission: ohos.permission.SET_TELEPHONY_STATE

System capability: SystemCapability.Telephony.CallManager

Parameters

Error codes

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

Example

call.muteRinger((err) => {
    console.log(`callback: err->${JSON.stringify(err)}`);
});

call.muteRinger⁸⁺

muteRinger(): Promise<void>

Mutes the ringtone while it is playing. It does not work if the ringtone has been muted. This API uses a promise to return the result.

System API: This is a system API.

Required permission: ohos.permission.SET_TELEPHONY_STATE

System capability: SystemCapability.Telephony.CallManager

Return value

Error codes

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

Example

call.muteRinger().then(() => {
    console.log(`muteRinger success.`);
}).catch((err) => {
    console.error(`muteRinger fail, promise: err->${JSON.stringify(err)}`);
});

call.answerCall⁹⁺

answerCall(callId: number, callback: AsyncCallback<void>): void

Answers a call. This API uses an asynchronous callback to return the result.

System API: This is a system API.

Required permission: ohos.permission.ANSWER_CALL

System capability: SystemCapability.Telephony.CallManager

Parameters

Error codes

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

Example

call.answerCall(1, (err) => {
    console.log(`callback: err->${JSON.stringify(err)}`);
});

call.answerCall⁹⁺

answerCall(callId?: number): Promise<void>

Answers a call. This API uses a promise to return the result.

System API: This is a system API.

Required permission: ohos.permission.ANSWER_CALL

System capability: SystemCapability.Telephony.CallManager

Parameters

Return value

Error codes

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

Example

call.answerCall(1).then(() => {
    console.log(`answerCall success.`);
}).catch((err) => {
    console.error(`answerCall fail, promise: err->${JSON.stringify(err)}`);
});

call.answerCall⁹⁺

answerCall(callback: AsyncCallback<void>): void

Answers a call. This API uses an asynchronous callback to return the result.

System API: This is a system API.

Required permission: ohos.permission.ANSWER_CALL

System capability: SystemCapability.Telephony.CallManager

Parameters

Error codes

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

Example

call.answerCall((err) => {
    console.log(`callback: err->${JSON.stringify(err)}`);
});

call.hangUpCall⁹⁺

hangUpCall(callId: number, callback: AsyncCallback<void>): void

Ends a call. This API uses an asynchronous callback to return the result.

System API: This is a system API.

Required permission: ohos.permission.ANSWER_CALL

System capability: SystemCapability.Telephony.CallManager

Parameters

Error codes

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

Example

call.hangUpCall(1, (err) => {
    console.log(`callback: err->${JSON.stringify(err)}`);
});

call.hangUpCall⁹⁺

hangUpCall(callId?: number): Promise<void>

Ends a call. This API uses a promise to return the result.

System API: This is a system API.

Required permission: ohos.permission.ANSWER_CALL

System capability: SystemCapability.Telephony.CallManager

Parameters

Return value

Error codes

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

Example

call.hangUpCall(1).then(() => {
    console.log(`hangUpCall success.`);
}).catch((err) => {
    console.error(`hangUpCall fail, promise: err->${JSON.stringify(err)}`);
});

call.hangUpCall⁹⁺

hangUpCall(callback: AsyncCallback<void>): void

Ends a call. This API uses an asynchronous callback to return the result.

System API: This is a system API.

Required permission: ohos.permission.ANSWER_CALL

System capability: SystemCapability.Telephony.CallManager

Parameters

Error codes

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

Example

call.hangUpCall((err) => {
    console.log(`callback: err->${JSON.stringify(err)}`);
});

call.rejectCall⁹⁺

rejectCall(callId: number, callback: AsyncCallback<void>): void

Rejects a call. This API uses an asynchronous callback to return the result.

System API: This is a system API.

Required permission: ohos.permission.ANSWER_CALL

System capability: SystemCapability.Telephony.CallManager

Parameters

Error codes

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

Example

call.rejectCall(1, (err) => {
    console.log(`callback: err->${JSON.stringify(err)}`);
});

call.rejectCall⁹⁺

rejectCall(callId: number, options: RejectMessageOptions, callback: AsyncCallback<void>): void

Rejects a call. This API uses an asynchronous callback to return the result.

System API: This is a system API.

Required permission: ohos.permission.ANSWER_CALL

System capability: SystemCapability.Telephony.CallManager

Parameters

Error codes

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

Example

let rejectMessageOptions={
    messageContent: "Unknown number blocked"
}
call.rejectCall(1, rejectMessageOptions, (err) => {
    console.log(`callback: err->${JSON.stringify(err)}`);
});

call.rejectCall⁹⁺

rejectCall(callId?: number, options?: RejectMessageOptions): Promise<void>

Rejects a call. This API uses a promise to return the result.

System API: This is a system API.

Required permission: ohos.permission.ANSWER_CALL

System capability: SystemCapability.Telephony.CallManager

Parameters

Return value

Error codes

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

Example

let rejectMessageOptions={
    messageContent: "Unknown number blocked"
}
call.reject(1, rejectMessageOptions).then(() => {
    console.log(`reject success.`);
}).catch((err) => {
    console.error(`reject fail, promise: err->${JSON.stringify(err)}`);
});

call.rejectCall⁹⁺

rejectCall(callback: AsyncCallback<void>): void

Rejects a call. This API uses an asynchronous callback to return the result.

System API: This is a system API.

Required permission: ohos.permission.ANSWER_CALL

System capability: SystemCapability.Telephony.CallManager

Parameters

Error codes

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

Example

call.rejectCall((err) => {
    console.log(`callback: err->${JSON.stringify(err)}`);
});

call.rejectCall⁹⁺

rejectCall(options: RejectMessageOptions, callback: AsyncCallback<void>): void

Rejects a call. This API uses an asynchronous callback to return the result.

System API: This is a system API.

Required permission: ohos.permission.ANSWER_CALL

System capability: SystemCapability.Telephony.CallManager

Parameters

Error codes

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

Example

let rejectMessageOptions={
    messageContent: "Unknown number blocked"
}
call.rejectCall(rejectMessageOptions, (err) => {
    console.log(`callback: err->${JSON.stringify(err)}`);
});

call.holdCall⁷⁺

holdCall(callId: number, callback: AsyncCallback<void>): void

Holds a call based on the specified call ID. This API uses an asynchronous callback to return the result.

System API: This is a system API.

Required permission: ohos.permission.ANSWER_CALL

System capability: SystemCapability.Telephony.CallManager

Parameters

Error codes

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

Example

call.holdCall(1, (err) => {
    console.log(`callback: err->${JSON.stringify(err)}`);
});

call.holdCall⁷⁺

holdCall(callId: number): Promise<void>

Holds a call based on the specified call ID. This API uses a promise to return the result.

System API: This is a system API.

Required permission: ohos.permission.ANSWER_CALL

System capability: SystemCapability.Telephony.CallManager

Parameters

Return value

Error codes

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

Example

call.holdCall(1).then(() => {
    console.log(`holdCall success.`);
}).catch((err) => {
    console.error(`holdCall fail, promise: err->${JSON.stringify(err)}`);
});

call.unHoldCall⁷⁺

unHoldCall(callId: number, callback: AsyncCallback<void>): void

Unholds a call based on the specified call ID. This API uses an asynchronous callback to return the result.

System API: This is a system API.

Required permission: ohos.permission.ANSWER_CALL

System capability: SystemCapability.Telephony.CallManager

Parameters

Error codes

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

Example

call.unHoldCall(1, (err) => {
    console.log(`callback: err->${JSON.stringify(err)}`);
});

call.unHoldCall⁷⁺

unHoldCall(callId: number): Promise<void>

Unholds a call based on the specified call ID. This API uses a promise to return the result.

System API: This is a system API.

Required permission: ohos.permission.ANSWER_CALL

System capability: SystemCapability.Telephony.CallManager

Parameters

Return value

Error codes

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

Example

call.unHoldCall(1).then(() => {
    console.log(`unHoldCall success.`);
}).catch((err) => {
    console.error(`unHoldCall fail, promise: err->${JSON.stringify(err)}`);
});

call.switchCall⁷⁺

switchCall(callId: number, callback: AsyncCallback<void>): void

Switches a call. This API uses an asynchronous callback to return the result.

System API: This is a system API.

Required permission: ohos.permission.ANSWER_CALL

System capability: SystemCapability.Telephony.CallManager

Parameters

Error codes

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

Example

call.switchCall(1, (err) => {
    console.log(`callback: err->${JSON.stringify(err)}`);
});

call.switchCall⁷⁺

switchCall(callId: number): Promise<void>

Switches a call. This API uses a promise to return the result.

System API: This is a system API.

Required permission: ohos.permission.ANSWER_CALL

System capability: SystemCapability.Telephony.CallManager

Parameters

Return value

Error codes

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

Example

call.switchCall(1).then(() => {
    console.log(`switchCall success.`);
}).catch((err) => {
    console.error(`switchCall fail, promise: err->${JSON.stringify(err)}`);
});

call.combineConference⁷⁺

combineConference(callId: number, callback: AsyncCallback<void>): void

Combines two calls into a conference call. This API uses an asynchronous callback to return the result.

System API: This is a system API.

System capability: SystemCapability.Telephony.CallManager

Parameters

Error codes

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

Example

call.combineConference(1, (err) => {
    console.log(`callback: err->${JSON.stringify(err)}`);
});

call.combineConference⁷⁺

combineConference(callId: number): Promise<void>

Combines two calls into a conference call. This API uses a promise to return the result.

System API: This is a system API.

System capability: SystemCapability.Telephony.CallManager

Parameters

Return value

Error codes

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

Example

call.combineConference(1).then(() => {
    console.log(`combineConference success.`);
}).catch((err) => {
    console.error(`combineConference fail, promise: err->${JSON.stringify(err)}`);
});

call.getMainCallId⁷⁺

getMainCallId(callId: number, callback: AsyncCallback<number>): void

Obtains the main call ID. This API uses an asynchronous callback to return the result.

System API: This is a system API.

System capability: SystemCapability.Telephony.CallManager

Parameters

Error codes

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

Example

call.getMainCallId(1, (err, data) => {
    console.log(`callback: err->${JSON.stringify(err)}, data->${JSON.stringify(data)}`);
});

call.getMainCallId⁷⁺

getMainCallId(callId: number): Promise<number>

Obtains the main call ID. This API uses a promise to return the result.

System API: This is a system API.

System capability: SystemCapability.Telephony.CallManager

Parameters

Return value

Error codes

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

Example

let promise = call.getMainCallId(1);
promise.then(data => {
    console.log(`getMainCallId success, promise: data->${JSON.stringify(data)}`);
}).catch(err => {
    console.error(`getMainCallId fail, promise: err->${JSON.stringify(err)}`);
});

call.getSubCallIdList⁷⁺

getSubCallIdList(callId: number, callback: AsyncCallback<Array<string>>): void

Obtains the list of subcall IDs. This API uses an asynchronous callback to return the result.

System API: This is a system API.

System capability: SystemCapability.Telephony.CallManager

Parameters

Error codes

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

Example

call.getSubCallIdList(1, (err, data) => {
    console.log(`callback: err->${JSON.stringify(err)}, data->${JSON.stringify(data)}`);
});

call.getSubCallIdList⁷⁺

getSubCallIdList(callId: number): Promise<Array<string>>

Obtains the list of subcall IDs. This API uses a promise to return the result.

System API: This is a system API.

System capability: SystemCapability.Telephony.CallManager

Parameters

Return value

Error codes

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

Example

let promise = call.getSubCallIdList(1);
promise.then(data => {
    console.log(`getSubCallIdList success, promise: data->${JSON.stringify(data)}`);
}).catch(err => {
    console.error(`getSubCallIdList fail, promise: err->${JSON.stringify(err)}`);
});

call.getCallIdListForConference⁷⁺

getCallIdListForConference(callId: number, callback: AsyncCallback<Array<string>>): void

Obtains the list of call IDs in a conference. This API uses an asynchronous callback to return the result.

System API: This is a system API.

System capability: SystemCapability.Telephony.CallManager

Parameters

Error codes

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

Example

call.getCallIdListForConference(1, (err, data) => {
    console.log(`callback: err->${JSON.stringify(err)}, data->${JSON.stringify(data)}`);
});

call.getCallIdListForConference⁷⁺

getCallIdListForConference(callId: number): Promise<Array<string>>

Obtains the list of call IDs in a conference. This API uses a promise to return the result.

System API: This is a system API.

System capability: SystemCapability.Telephony.CallManager

Parameters

Return value

Error codes

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

Example

let promise = call.getCallIdListForConference(1);
promise.then(data => {
    console.log(`getCallIdListForConference success, promise: data->${JSON.stringify(data)}`);
}).catch(err => {
    console.error(`getCallIdListForConference fail, promise: err->${JSON.stringify(err)}`);
});

call.getCallWaitingStatus⁷⁺

getCallWaitingStatus(slotId: number, callback: AsyncCallback<CallWaitingStatus>): void

Obtains the call waiting status. This API uses an asynchronous callback to return the result.

System API: This is a system API.

Required permission: ohos.permission.GET_TELEPHONY_STATE

System capability: SystemCapability.Telephony.CallManager

Parameters

Error codes

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

Example

call.getCallWaitingStatus(0, (err, data) => {
    console.log(`callback: err->${JSON.stringify(err)}, data->${JSON.stringify(data)}`);
});

call.getCallWaitingStatus⁷⁺

getCallWaitingStatus(slotId: number): Promise<CallWaitingStatus>

Obtains the call waiting status. This API uses a promise to return the result.

System API: This is a system API.

Required permission: ohos.permission.GET_TELEPHONY_STATE

System capability: SystemCapability.Telephony.CallManager

Parameters

Return value

Error codes

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

Example

let promise = call.getCallWaitingStatus(0);
promise.then(data => {
    console.log(`getCallWaitingStatus success, promise: data->${JSON.stringify(data)}`);
}).catch(err => {
    console.error(`getCallWaitingStatus fail, promise: err->${JSON.stringify(err)}`);
});

call.setCallWaiting⁷⁺

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

Sets the call waiting switch. This API uses an asynchronous callback to return the result.

System API: This is a system API.

Required permission: ohos.permission.SET_TELEPHONY_STATE

System capability: SystemCapability.Telephony.CallManager

Parameters

Error codes

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

Example

call.setCallWaiting(0, true, (err) => {
    console.log(`callback: err->${JSON.stringify(err)}`);
});

call.setCallWaiting⁷⁺

setCallWaiting(slotId: number, activate: boolean): Promise<void>

Sets the call waiting switch. This API uses a promise to return the result.

System API: This is a system API.

Required permission: ohos.permission.SET_TELEPHONY_STATE

System capability: SystemCapability.Telephony.CallManager

Parameters

Return value

Error codes

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

Example

call.setCallWaiting(0, true).then(() => {
    console.log(`setCallWaiting success.`);
}).catch((err) => {
    console.error(`setCallWaiting fail, promise: err->${JSON.stringify(err)}`);
});

call.startDTMF⁷⁺

startDTMF(callId: number, character: string, callback: AsyncCallback<void>): void

Enables DTMF. This API uses an asynchronous callback to return the result.

System API: This is a system API.

System capability: SystemCapability.Telephony.CallManager

Parameters

Error codes

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

Example

call.startDTMF(1, "0", (err) => {
    console.log(`callback: err->${JSON.stringify(err)}`);
});

call.startDTMF⁷⁺

startDTMF(callId: number, character: string): Promise<void>

Enables DTMF. This API uses a promise to return the result.

System API: This is a system API.

System capability: SystemCapability.Telephony.CallManager

Parameters

Return value

Error codes

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

Example

call.startDTMF(1, "0").then(() => {
    console.log(`startDTMF success.`);
}).catch((err) => {
    console.error(`startDTMF fail, promise: err->${JSON.stringify(err)}`);
});

call.stopDTMF⁷⁺

stopDTMF(callId: number, callback: AsyncCallback<void>): void

Stops DTMF. This API uses an asynchronous callback to return the result.

System API: This is a system API.

System capability: SystemCapability.Telephony.CallManager

Parameters

Error codes

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

Example

call.stopDTMF(1, (err) => {
    console.log(`callback: err->${JSON.stringify(err)}`);
});

call.stopDTMF⁷⁺

stopDTMF(callId: number): Promise<void>

Stops DTMF. This API uses a promise to return the result.

System API: This is a system API.

System capability: SystemCapability.Telephony.CallManager

Parameters

Return value

Error codes

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

Example

call.stopDTMF(1).then(() => {
    console.log(`stopDTMF success.`);
}).catch((err) => {
    console.error(`stopDTMF fail, promise: err->${JSON.stringify(err)}`);
});

call.isInEmergencyCall⁷⁺

isInEmergencyCall(callback: AsyncCallback<boolean>): void

Checks whether a call is an emergency call. This API uses an asynchronous callback to return the result.

System API: This is a system API.

Required permission: ohos.permission.SET_TELEPHONY_STATE

System capability: SystemCapability.Telephony.CallManager

Parameters

Error codes

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

Example

call.isInEmergencyCall((err, data) => {
    console.log(`callback: err->${JSON.stringify(err)}, data->${JSON.stringify(data)}`);
});

call.isInEmergencyCall⁷⁺

isInEmergencyCall(): Promise<boolean>

Checks whether a call is an emergency call. This API uses a promise to return the result.

System API: This is a system API.

Required permission: ohos.permission.SET_TELEPHONY_STATE

System capability: SystemCapability.Telephony.CallManager

Return value

Error codes

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

Example

let promise = call.isInEmergencyCall();
promise.then(data => {
    console.log(`isInEmergencyCall success, promise: data->${JSON.stringify(data)}`);
}).catch(err => {
    console.error(`isInEmergencyCall fail, promise: err->${JSON.stringify(err)}`);
});

call.on('callDetailsChange')⁷⁺

on(type: 'callDetailsChange', callback: Callback<CallAttributeOptions>): void

Subscribes to callDetailsChange events. This API uses an asynchronous callback to return the result.

System API: This is a system API.

Required permission: ohos.permission.SET_TELEPHONY_STATE

System capability: SystemCapability.Telephony.CallManager

Parameters

Error codes

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

Example

call.on('callDetailsChange', data => {
    console.log(`callback: data->${JSON.stringify(data)}`);
});

call.on('callEventChange')⁸⁺

on(type: 'callEventChange', callback: Callback<CallEventOptions>): void

Subscribes to callEventChange events. This API uses an asynchronous callback to return the result.

System API: This is a system API.

Required permission: ohos.permission.SET_TELEPHONY_STATE

System capability: SystemCapability.Telephony.CallManager

Parameters

Error codes

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

Example

call.on('callEventChange', data => {
    console.log(`callback: data->${JSON.stringify(data)}`);
});

call.on('callDisconnectedCause')⁸⁺

on(type: 'callDisconnectedCause', callback: Callback<DisconnectedDetails>): void

Subscribes to callDisconnectedCause events. This API uses an asynchronous callback to return the result.

System API: This is a system API.

Required permission: ohos.permission.SET_TELEPHONY_STATE

System capability: SystemCapability.Telephony.CallManager

Parameters

Error codes

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

Example

call.on('callDisconnectedCause', data => {
    console.log(`callback: data->${JSON.stringify(data)}`);
});

call.on('mmiCodeResult')⁹⁺

on(type: 'mmiCodeResult', callback: Callback<MmiCodeResults>): void

Subscribes to mmiCodeResult events. This API uses an asynchronous callback to return the result.

System API: This is a system API.

Required permission: ohos.permission.SET_TELEPHONY_STATE

System capability: SystemCapability.Telephony.CallManager

Parameters

Error codes

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

Example

call.on('mmiCodeResult', data => {
    console.log(`callback: data->${JSON.stringify(data)}`);
});

call.off('callDetailsChange')⁷⁺

off(type: 'callDetailsChange', callback?: Callback<CallAttributeOptions>): void

Unsubscribes from callDetailsChange events. This API uses an asynchronous callback to return the result.

System API: This is a system API.

Required permission: ohos.permission.SET_TELEPHONY_STATE

System capability: SystemCapability.Telephony.CallManager

Parameters

Error codes

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

Example

call.off('callDetailsChange', data => {
    console.log(`callback: data->${JSON.stringify(data)}`);
});

call.off('callEventChange')⁸⁺

off(type: 'callEventChange', callback?: Callback<CallEventOptions>): void

Unsubscribes from callEventChange events. This API uses an asynchronous callback to return the result.

System API: This is a system API.

Required permission: ohos.permission.SET_TELEPHONY_STATE

System capability: SystemCapability.Telephony.CallManager

Parameters

Error codes

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

Example

call.off('callEventChange', data => {
    console.log(`callback: data->${JSON.stringify(data)}`);
});

call.off('callDisconnectedCause')⁸⁺

off(type: 'callDisconnectedCause', callback?: Callback<DisconnectedDetails>): void

Unsubscribes from callDisconnectedCause events. This API uses an asynchronous callback to return the result.

System API: This is a system API.

Required permission: ohos.permission.SET_TELEPHONY_STATE

System capability: SystemCapability.Telephony.CallManager

Parameters

Error codes

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

Example

call.off('callDisconnectedCause', data => {
    console.log(`callback: data->${JSON.stringify(data)}`);
});

call.off('mmiCodeResult')⁹⁺

off(type: 'mmiCodeResult', callback?: Callback<MmiCodeResults>): void

Unsubscribes from mmiCodeResult events. This API uses an asynchronous callback to return the result.

System API: This is a system API.

Required permission: ohos.permission.SET_TELEPHONY_STATE

System capability: SystemCapability.Telephony.CallManager

Parameters

Error codes

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

Example

call.off('mmiCodeResult', data => {
    console.log(`callback: data->${JSON.stringify(data)}`);
});

call.isNewCallAllowed⁸⁺

isNewCallAllowed(callback: AsyncCallback<boolean>): void

Checks whether a new call is allowed. This API uses an asynchronous callback to return the result.

System API: This is a system API.

System capability: SystemCapability.Telephony.CallManager

Parameters

Error codes

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

Example

call.isNewCallAllowed((err, data) => {
    console.log(`callback: err->${JSON.stringify(err)}, data->${JSON.stringify(data)}`);
});

call.isNewCallAllowed⁸⁺

isNewCallAllowed(): Promise<boolean>

Checks whether a new call is allowed. This API uses a promise to return the result.

System API: This is a system API.

System capability: SystemCapability.Telephony.CallManager

Return value

Error codes

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

Example

let promise = call.isNewCallAllowed();
promise.then(data => {
    console.log(`isNewCallAllowed success, promise: data->${JSON.stringify(data)}`);
}).catch(err => {
    console.error(`isNewCallAllowed fail, promise: err->${JSON.stringify(err)}`);
});

call.separateConference⁸⁺

separateConference(callId: number, callback: AsyncCallback<void>): void

Separates calls from a conference call. This API uses an asynchronous callback to return the result.

System API: This is a system API.

System capability: SystemCapability.Telephony.CallManager

Parameters

Error codes

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

Example

call.separateConference(1, (err) => {
    console.log(`callback: err->${JSON.stringify(err)}`);
});

call.separateConference⁸⁺

separateConference(callId: number): Promise<void>

Separates calls from a conference call. This API uses a promise to return the result.

System API: This is a system API.

System capability: SystemCapability.Telephony.CallManager

Parameters

Return value

Error codes

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

Example

call.separateConference(1).then(() => {
    console.log(`separateConference success.`);
}).catch((err) => {
    console.error(`separateConference fail, promise: err->${JSON.stringify(err)}`);
});

call.getCallRestrictionStatus⁸⁺

getCallRestrictionStatus(slotId: number, type: CallRestrictionType, callback: AsyncCallback<RestrictionStatus>): void

Obtains the call restriction status. This API uses an asynchronous callback to return the result.

System API: This is a system API.

Required permission: ohos.permission.GET_TELEPHONY_STATE

System capability: SystemCapability.Telephony.CallManager

Parameters

Error codes

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

Example

call.getCallRestrictionStatus(0, 1, (err, data) => {
    console.log(`callback: err->${JSON.stringify(err)}, data->${JSON.stringify(data)}`);
});

call.getCallRestrictionStatus⁸⁺

getCallRestrictionStatus(slotId: number, type: CallRestrictionType): Promise<RestrictionStatus>

Obtains the call restriction status. This API uses a promise to return the result.

System API: This is a system API.

Required permission: ohos.permission.GET_TELEPHONY_STATE

System capability: SystemCapability.Telephony.CallManager

Parameters

Return value

Error codes

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

Example

let promise = call.getCallRestrictionStatus(0, 1);
promise.then(data => {
    console.log(`getCallRestrictionStatus success, promise: data->${JSON.stringify(data)}`);
}).catch(err => {
    console.error(`getCallRestrictionStatus fail, promise: err->${JSON.stringify(err)}`);
});

call.setCallRestriction⁸⁺

setCallRestriction(slotId: number, info: CallRestrictionInfo, callback: AsyncCallback<void>): void

Sets the call restriction status. This API uses an asynchronous callback to return the result.

System API: This is a system API.

Required permission: ohos.permission.SET_TELEPHONY_STATE

System capability: SystemCapability.Telephony.CallManager

Parameters

Error codes

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

Example

let callRestrictionInfo={
    type: 1,
    password: "123456",
    mode: 1
}
call.setCallRestriction(0, callRestrictionInfo, (err) => {
    console.log(`callback: err->${JSON.stringify(err)}`);
});

call.setCallRestriction⁸⁺

setCallRestriction(slotId: number, info: CallRestrictionInfo): Promise<void>

Sets the call restriction status. This API uses a promise to return the result.

System API: This is a system API.

Required permission: ohos.permission.SET_TELEPHONY_STATE

System capability: SystemCapability.Telephony.CallManager

Parameters

Return value

Error codes

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

Example

let callRestrictionInfo={
    type: 1,
    password: "123456",
    mode: 1
}
call.setCallRestriction(0, callRestrictionInfo).then(() => {
    console.log(`setCallRestriction success.`);
}).catch((err) => {
    console.error(`setCallRestriction fail, promise: err->${JSON.stringify(err)}`);
});

call.getCallTransferInfo⁸⁺

getCallTransferInfo(slotId: number, type: CallTransferType, callback: AsyncCallback<CallTransferResult>): void

Obtains call transfer information. This API uses an asynchronous callback to return the result.

System API: This is a system API.

Required permission: ohos.permission.GET_TELEPHONY_STATE

System capability: SystemCapability.Telephony.CallManager

Parameters

Error codes

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

Example

call.getCallTransferInfo(0, call.CallTransferType.TRANSFER_TYPE_BUSY, (err, data) => {
    console.log(`callback: err->${JSON.stringify(err)}, data->${JSON.stringify(data)}`);
});

call.getCallTransferInfo⁸⁺

getCallTransferInfo(slotId: number, type: CallTransferType): Promise<CallTransferResult>

Obtains call transfer information. This API uses a promise to return the result.

System API: This is a system API.

Required permission: ohos.permission.GET_TELEPHONY_STATE

System capability: SystemCapability.Telephony.CallManager

Parameters

Return value

Error codes

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

Example

let promise = call.getCallTransferInfo(0, call.CallTransferType.TRANSFER_TYPE_BUSY);
promise.then(data => {
    console.log(`getCallTransferInfo success, promise: data->${JSON.stringify(data)}`);
}).catch(err => {
    console.error(`getCallTransferInfo fail, promise: err->${JSON.stringify(err)}`);
});

call.setCallTransfer⁸⁺

setCallTransfer(slotId: number, info: CallTransferInfo, callback: AsyncCallback<void>): void

Sets call transfer information. This API uses an asynchronous callback to return the result.

System API: This is a system API.

Required permission: ohos.permission.SET_TELEPHONY_STATE

System capability: SystemCapability.Telephony.CallManager

Parameters

Error codes

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

Example

let callTransferInfo={
    transferNum: "111",
    type: 1,
    settingType: 1
}
call.setCallTransfer(0, callTransferInfo, (err) => {
    console.log(`callback: err->${JSON.stringify(err)}`);
});

call.setCallTransfer⁸⁺

setCallTransfer(slotId: number, info: CallTransferInfo): Promise<void>

Sets call transfer information. This API uses a promise to return the result.

System API: This is a system API.

Required permission: ohos.permission.SET_TELEPHONY_STATE

System capability: SystemCapability.Telephony.CallManager

Parameters

Return value

Error codes

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

Example

let callTransferInfo={
    transferNum: "111",
    type: 1,
    settingType: 1
}
call.setCallTransfer(0, callTransferInfo).then(() => {
    console.log(`setCallTransfer success.`);
}).catch((err) => {
    console.error(`setCallTransfer fail, promise: err->${JSON.stringify(err)}`);
});

call.isRinging⁸⁺

isRinging(callback: AsyncCallback<boolean>): void

Checks whether the ringtone is playing. This API uses an asynchronous callback to return the result.

System API: This is a system API.

Required permission: ohos.permission.SET_TELEPHONY_STATE

System capability: SystemCapability.Telephony.CallManager

Parameters

Error codes

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

Example

call.isRinging((err, data) => {
    console.log(`callback: err->${JSON.stringify(err)}, data->${JSON.stringify(data)}`);
});

call.isRinging⁸⁺

isRinging(): Promise<boolean>

Checks whether the ringtone is playing. This API uses a promise to return the result.

System API: This is a system API.

Required permission: ohos.permission.SET_TELEPHONY_STATE

System capability: SystemCapability.Telephony.CallManager

Return value

Error codes

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

Example

let promise = call.isRinging();
promise.then(data => {
    console.log(`isRinging success, promise: data->${JSON.stringify(data)}`);
}).catch(err => {
    console.error(`isRinging fail, promise: err->${JSON.stringify(err)}`);
});

call.setMuted⁸⁺

setMuted(callback: AsyncCallback<void>): void

Sets call muting. This API uses an asynchronous callback to return the result.

System API: This is a system API.

System capability: SystemCapability.Telephony.CallManager

Parameters

Error codes

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

Example

call.setMuted((err) => {
    console.log(`callback: err->${JSON.stringify(err)}`);
});

call.setMuted⁸⁺

setMuted(): Promise<void>

Sets call muting. This API uses a promise to return the result.

System API: This is a system API.

System capability: SystemCapability.Telephony.CallManager

Return value

Error codes

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

Example

call.setMuted().then(() => {
    console.log(`setMuted success.`);
}).catch((err) => {
    console.error(`setMuted fail, promise: err->${JSON.stringify(err)}`);
});

call.cancelMuted⁸⁺

cancelMuted(callback: AsyncCallback<void>): void

Cancels call muting. This API uses an asynchronous callback to return the result.

System API: This is a system API.

System capability: SystemCapability.Telephony.CallManager

Parameters

Error codes

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

Example

call.cancelMuted((err) => {
    console.log(`callback: err->${JSON.stringify(err)}`);
});

call.cancelMuted⁸⁺

cancelMuted(): Promise<void>

Cancels call muting. This API uses a promise to return the result.

System API: This is a system API.

System capability: SystemCapability.Telephony.CallManager

Return value

Error codes

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

Example

call.cancelMuted().then(() => {
    console.log(`cancelMuted success.`);
}).catch((err) => {
    console.error(`cancelMuted fail, promise: err->${JSON.stringify(err)}`);
});

call.setAudioDevice⁸⁺

setAudioDevice(device: AudioDevice, callback: AsyncCallback<void>): void

Sets the audio device for a call. This API uses an asynchronous callback to return the result.

System API: This is a system API.

System capability: SystemCapability.Telephony.CallManager

Parameters

Error codes

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

Example

call.setAudioDevice(1, (err) => {
    console.log(`callback: err->${JSON.stringify(err)}`);
});

call.setAudioDevice⁹⁺

setAudioDevice(device: AudioDevice, options: AudioDeviceOptions, callback: AsyncCallback<void>): void

Sets the audio device for a call based on the specified options. This API uses an asynchronous callback to return the result.

System API: This is a system API.

System capability: SystemCapability.Telephony.CallManager

Parameters

Error codes

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

Example

let audioDeviceOptions={
    bluetoothAddress: "IEEE 802-2014"
}
call.setAudioDevice(1, audioDeviceOptions, (err) => {
    console.log(`callback: err->${JSON.stringify(err)}`);
});

call.setAudioDevice⁹⁺

setAudioDevice(device: AudioDevice, options?: AudioDeviceOptions): Promise<void>

Sets the audio device for a call based on the specified options. This API uses a promise to return the result.

System API: This is a system API.

System capability: SystemCapability.Telephony.CallManager

Parameters

Return value

Error codes

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

Example

let audioDeviceOptions={
    bluetoothAddress: "IEEE 802-2014"
}
call.setAudioDevice(1, audioDeviceOptions).then(() => {
    console.log(`setAudioDevice success.`);
}).catch((err) => {
    console.error(`setAudioDevice fail, promise: err->${JSON.stringify(err)}`);
});

call.joinConference⁸⁺

joinConference(mainCallId: number, callNumberList: Array<string>, callback: AsyncCallback<void>): void

Joins a conference call. This API uses an asynchronous callback to return the result.

System API: This is a system API.

System capability: SystemCapability.Telephony.CallManager

Parameters

Error codes

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

Example

let callNumberList: Array<string> = [
    "138XXXXXXXX"
];
call.joinConference(1, callNumberList, (err) => {
    console.log(`callback: err->${JSON.stringify(err)}`);
});

call.joinConference⁸⁺

joinConference(mainCallId: number, callNumberList: Array<string>): Promise<void>

Joins a conference call. This API uses a promise to return the result.

System API: This is a system API.

System capability: SystemCapability.Telephony.CallManager

Parameters

Return value

Error codes

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

Example

let callNumberList: Array<string> = [
    "138XXXXXXXX"
];
call.joinConference(1, callNumberList).then(() => {
    console.log(`joinConference success.`);
}).catch((err) => {
    console.error(`joinConference fail, promise: err->${JSON.stringify(err)}`);
});

call.updateImsCallMode⁸⁺

updateImsCallMode(callId: number, mode: ImsCallMode, callback: AsyncCallback<void>): void

Updates the IMS call mode. This API uses an asynchronous callback to return the result.

System API: This is a system API.

System capability: SystemCapability.Telephony.CallManager

Parameters

Error codes

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

Example

call.updateImsCallMode(1, 1, (err) => {
    console.log(`callback: err->${JSON.stringify(err)}`);
});

call.updateImsCallMode⁸⁺

updateImsCallMode(callId: number, mode: ImsCallMode): Promise<void>

Updates the IMS call mode. This API uses a promise to return the result.

System API: This is a system API.

System capability: SystemCapability.Telephony.CallManager

Parameters

Return value

Error codes

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

Example

call.updateImsCallMode(1, 1).then(() => {
    console.log(`updateImsCallMode success.`);
}).catch((err) => {
    console.error(`updateImsCallMode fail, promise: err->${JSON.stringify(err)}`);
});

call.enableImsSwitch⁸⁺

enableImsSwitch(slotId: number, callback: AsyncCallback<void>): void

Enables the IMS switch. This API uses an asynchronous callback to return the result.

System API: This is a system API.

Required permission: ohos.permission.SET_TELEPHONY_STATE

System capability: SystemCapability.Telephony.CallManager

Parameters

Error codes

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

Example

call.enableImsSwitch(0, (err) => {
    console.log(`callback: err->${JSON.stringify(err)}`);
});

call.enableImsSwitch⁸⁺

enableImsSwitch(slotId: number): Promise<void>

Enables the IMS switch. This API uses a promise to return the result.

System API: This is a system API.

Required permission: ohos.permission.SET_TELEPHONY_STATE

System capability: SystemCapability.Telephony.CallManager

Parameters

Return value

Error codes

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

Example

call.enableImsSwitch(0).then(() => {
    console.log(`enableImsSwitch success.`);
}).catch((err) => {
    console.error(`enableImsSwitch fail, promise: err->${JSON.stringify(err)}`);
});

call.disableImsSwitch⁸⁺

disableImsSwitch(slotId: number, callback: AsyncCallback<void>): void

Disables the IMS switch. This API uses an asynchronous callback to return the result.

System API: This is a system API.

Required permission: ohos.permission.SET_TELEPHONY_STATE

System capability: SystemCapability.Telephony.CallManager

Parameters

Error codes

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

Example

call.disableImsSwitch(0, (err) => {
    console.log(`callback: err->${JSON.stringify(err)}`);
});

call.disableImsSwitch⁸⁺

disableImsSwitch(slotId: number): Promise<void>

Disables the IMS switch. This API uses a promise to return the result.

System API: This is a system API.

Required permission: ohos.permission.SET_TELEPHONY_STATE

System capability: SystemCapability.Telephony.CallManager

Parameters

Return value

Error codes

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

Example

call.disableImsSwitch(0).then(() => {
    console.log(`disableImsSwitch success.`);
}).catch((err) => {
    console.error(`disableImsSwitch fail, promise: err->${JSON.stringify(err)}`);
});

call.isImsSwitchEnabled⁸⁺

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

Checks whether the IMS switch is enabled. This API uses an asynchronous callback to return the result.

System API: This is a system API.

System capability: SystemCapability.Telephony.CallManager

Parameters

Error codes

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

Example

call.isImsSwitchEnabled(0, (err, data) => {
    console.log(`callback: err->${JSON.stringify(err)}, data->${JSON.stringify(data)}`);
});

call.isImsSwitchEnabled⁸⁺

isImsSwitchEnabled(slotId: number): Promise<boolean>

Checks whether the IMS switch is enabled. This API uses a promise to return the result.

System API: This is a system API.

System capability: SystemCapability.Telephony.CallManager

Parameters

Return value

Error codes

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

Example

let promise = call.isImsSwitchEnabled(0);
promise.then(data => {
    console.log(`isImsSwitchEnabled success, promise: data->${JSON.stringify(data)}`);
}).catch(err => {
    console.error(`isImsSwitchEnabled fail, promise: err->${JSON.stringify(err)}`);
});

DialOptions

Provides an option for determining whether a call is a video call.

System capability: SystemCapability.Telephony.CallManager

DialCallOptions⁹⁺

Defines options for initiating a call.

System capability: SystemCapability.Telephony.CallManager

CallState

Enumerates call states.

System capability: SystemCapability.Telephony.CallManager

EmergencyNumberOptions⁷⁺

Provides an option for determining whether a number is an emergency number for the SIM card in the specified slot.

System capability: SystemCapability.Telephony.CallManager

NumberFormatOptions⁷⁺

Provides an option for number formatting.

System capability: SystemCapability.Telephony.CallManager

ImsCallMode⁸⁺

Enumerates IMS call modes.

System API: This is a system API.

System capability: SystemCapability.Telephony.CallManager

AudioDevice⁸⁺

Enumerates audio devices.

System API: This is a system API.

System capability: SystemCapability.Telephony.CallManager

CallRestrictionType⁸⁺

Enumerates call restriction types.

System API: This is a system API.

System capability: SystemCapability.Telephony.CallManager

CallTransferInfo⁸⁺

Defines the call transfer information.

System API: This is a system API.

System capability: SystemCapability.Telephony.CallManager

CallTransferType⁸⁺

Enumerates call transfer types.

System API: This is a system API.

System capability: SystemCapability.Telephony.CallManager

CallTransferSettingType⁸⁺

Enumerates call transfer setting types.

System API: This is a system API.

System capability: SystemCapability.Telephony.CallManager

CallAttributeOptions⁷⁺

Defines the call attribute options.

System API: This is a system API.

System capability: SystemCapability.Telephony.CallManager

ConferenceState⁷⁺

Enumerates conference states.

System API: This is a system API.

System capability: SystemCapability.Telephony.CallManager

CallType⁷⁺

Enumerates call types.

System API: This is a system API.

System capability: SystemCapability.Telephony.CallManager

VideoStateType⁷⁺

Video state type.

System API: This is a system API.

System capability: SystemCapability.Telephony.CallManager

DetailedCallState⁷⁺

Enumerates detailed call states.

System API: This is a system API.

System capability: SystemCapability.Telephony.CallManager

CallRestrictionInfo⁸⁺

Defines the call restriction information.

System API: This is a system API.

System capability: SystemCapability.Telephony.CallManager

CallRestrictionMode⁸⁺

Enumerates call restriction modes.

System API: This is a system API.

System capability: SystemCapability.Telephony.CallManager

CallEventOptions⁸⁺

Defines the call event options.

System API: This is a system API.

System capability: SystemCapability.Telephony.CallManager

CallAbilityEventId⁸⁺

Enumerates call ability event IDs.

System API: This is a system API.

System capability: SystemCapability.Telephony.CallManager

DialScene⁸⁺

Enumerates dialup scenarios.

System API: This is a system API.

System capability: SystemCapability.Telephony.CallManager

DialType⁸⁺

Enumerates dialup types.

System API: This is a system API.

System capability: SystemCapability.Telephony.CallManager

RejectMessageOptions⁷⁺

Defines options for the call rejection message.

System API: This is a system API.

System capability: SystemCapability.Telephony.CallManager