diff --git a/en/application-dev/reference/apis/js-apis-call.md b/en/application-dev/reference/apis/js-apis-call.md index b19c71404a0273c7813f764a1ef3ef9392ce8891..f7c52787326fe5429c6911e1e9500b48b0e0f615 100644 --- a/en/application-dev/reference/apis/js-apis-call.md +++ b/en/application-dev/reference/apis/js-apis-call.md @@ -1,5146 +1,5420 @@ -# +# @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')`](js-apis-observer.md#observeroncallstatechange). -> +>**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 - - +```js +import call from '@ohos.telephony.call'; ``` -## +## call.dialCall9+ - +dialCall\(phoneNumber: string, callback: AsyncCallback\\): 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** -| | | | | +| Name | Type | Mandatory| Description | | ----------- | ---------------------------- | ---- | -------------------------------------- | -| | | | | -| | | | | +| phoneNumber | string | Yes | Phone number. | +| callback | AsyncCallback<void> | Yes | Callback used to return the result. | - +**Error codes** - +For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md). -| | | +| ID| Error Message | | -------- | -------------------------------------------- | -| | | -| | | -| | | -| | | -| | | -| | | -| | | -| | | -| | | - - - - - - - +| 201 | Permission denied. | +| 202 | Non-system applications use system APIs. | +| 401 | Parameter error. | +| 8300001 | Invalid parameter value. | +| 8300002 | Operation failed. Cannot connect to service. | +| 8300003 | System internal error. | +| 8300005 | Airplane mode is on. | +| 8300006 | Network not in service. | +| 8300999 | Unknown error code. | + +**Example** + +```js +call.dialCall("138xxxxxxxx", (err) => { + console.log(`callback: err->${JSON.stringify(err)}`); +}); ``` -## +## call.dialCall9+ - +dialCall\(phoneNumber: string, options: DialCallOptions, callback: AsyncCallback\\): 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** -| | | | | +| Name | Type | Mandatory| Description | | ----------- | ----------------------------------- | ---- | ----------------------------------- | -| | | | | -| | | | | -| | | | | +| phoneNumber | string | Yes | Phone number. | +| options | [DialCallOptions](#dialcalloptions9)| Yes | Call options, which carry other configuration information of the call. | +| callback | AsyncCallback<void> | Yes | Callback used to return the result.| - +**Error codes** - +For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md). -| | | +| ID| Error Message | | -------- | -------------------------------------------- | -| | | -| | | -| | | -| | | -| | | -| | | -| | | -| | | -| | | - - - - - - - - - - - - +| 201 | Permission denied. | +| 202 | Non-system applications use system APIs. | +| 401 | Parameter error. | +| 8300001 | Invalid parameter value. | +| 8300002 | Operation failed. Cannot connect to service. | +| 8300003 | System internal error. | +| 8300005 | Airplane mode is on. | +| 8300006 | Network not in service. | +| 8300999 | Unknown error code. | + +**Example** + +```js +call.dialCall("138xxxxxxxx", { + accountId: 0, + videoState: 0, + dialScene: 0, + dialType: 0, +}, (err) => { + console.log(`callback: err->${JSON.stringify(err)}`); +}); ``` -## +## call.dialCall9+ - +dialCall\(phoneNumber: string, options?: DialCallOptions\): Promise\ - +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** -| | | | | +| Name | Type | Mandatory| Description | | ----------- | ----------------------------------- | ---- | -------------------------------------- | -| | | | | -| | | |




| +| phoneNumber | string | Yes | Phone number. | +| options | [DialCallOptions](#dialcalloptions9)| No | Call options, which carry other configuration information of the call.
If this parameter is not set, the following configuration is used by default. For details, see [DialCallOptions](#dialcalloptions9).
- **accountId**: 0 (card slot 1)
- **videoState**: voice call
- **dialScene**: common call
- **dialType**: carrier call | - +**Return value** -| | | +| Type | Description | | ---------------------- | ---------------------------- | -| | | +| Promise<void> | Promise used to return the result.| - +**Error codes** - +For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md). -| | | +| ID| Error Message | | -------- | -------------------------------------------- | -| | | -| | | -| | | -| | | -| | | -| | | -| | | -| | | -| | | - - - - - - - - - - - - - - - +| 201 | Permission denied. | +| 202 | Non-system applications use system APIs. | +| 401 | Parameter error. | +| 8300001 | Invalid parameter value. | +| 8300002 | Operation failed. Cannot connect to service. | +| 8300003 | System internal error. | +| 8300005 | Airplane mode is on. | +| 8300006 | Network not in service. | +| 8300999 | Unknown error code. | + +**Example** + +```js +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\\): 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](#calldialcall9). The substitute API is available only for system applications. - +**Required Permissions**: ohos.permission.PLACE_CALL - +**System capability**: SystemCapability.Telephony.CallManager - +**Parameters** -| | | | | +| Name | Type | Mandatory| Description | | ----------- | ---------------------------- | ---- | --------------------------------------- | -| | | | | -| | | | | +| phoneNumber | string | Yes | Phone number. | +| callback | AsyncCallback<boolean> | Yes | Callback used to return the result.
- **true**: success
- **false**: failure| - +**Example** - - - - +```js +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\\): 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](#calldialcall9). The substitute API is available only for system applications. - +**Required Permissions**: ohos.permission.PLACE_CALL - +**System capability**: SystemCapability.Telephony.CallManager - +**Parameters** -| | | | | +| Name | Type | Mandatory| Description | | ----------- | ---------------------------- | ---- | --------------------------------------- | -| | | | | -| | | | | -| | | | | - - - - - - - - - +| phoneNumber | string | Yes | Phone number. | +| options | [DialOptions](#dialoptions) | Yes | Call option, which indicates whether the call is a voice call or video call. | +| callback | AsyncCallback<boolean> | Yes | Callback used to return the result.
- **true**: success
- **false**: failure| + +**Example** + +```js +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\ - +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](#calldialcall9). The substitute API is available only for system applications. - +**Required Permissions**: ohos.permission.PLACE_CALL - +**System capability**: SystemCapability.Telephony.CallManager - +**Parameters** -| | | | | +| Name | Type | Mandatory| Description | | ----------- | --------------------------- | ---- | -------------------------------------- | -| | | | | -| | | | | +| phoneNumber | string | Yes | Phone number. | +| options | [DialOptions](#dialoptions) | No | Call option, which indicates whether the call is a voice call or video call.| - +**Return value** -| | | +| Type | Description | | ---------------------- | ------------------------------------------------------------ | -| | | - - - - - - - - - - - - +| Promise<boolean> | Promise used to return the result.
- **true**: success
- **false**: failure| + +**Example** + +```js +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.makeCall7+ - +makeCall\(phoneNumber: string, callback: AsyncCallback\\): 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** -| | | | | +| Name | Type | Mandatory| Description | | ----------- | ------------------------- | ---- | ------------------------------------------ | -| | | | | -| | | | | +| phoneNumber | string | Yes | Phone number. | +| callback | AsyncCallback<void> | Yes | Callback used to return the result.| - +**Error codes** - +For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md). -| | | +| ID| Error Message | | -------- | -------------------------------------------- | -| | | -| | | -| | | -| | | -| | | - - - - - - - +| 401 | Parameter error. | +| 8300001 | Invalid parameter value. | +| 8300002 | Operation failed. Cannot connect to service. | +| 8300003 | System internal error. | +| 8300999 | Unknown error code. | + +**Example** + +```js +call.makeCall("138xxxxxxxx", err => { + console.log(`makeCall callback: err->${JSON.stringify(err)}`); +}); ``` -## +## call.makeCall7+ - +makeCall\(phoneNumber: string\): Promise\ - +Launches the call screen and displays the dialed number. This API uses a promise to return the result. - +**System capability**: SystemCapability.Applications.Contacts - +**Parameters** -| | | | | +| Name | Type | Mandatory| Description | | ----------- | ------ | ---- | ---------- | -| | | | | +| phoneNumber | string | Yes | Phone number.| - +**Return value** -| | | +| Type | Description | | ------------------- | --------------------------------- | -| | | +| Promise<void> | Promise used to return the result.| - +**Error codes** - +For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md). -| | | +| ID| Error Message | | -------- | -------------------------------------------- | -| | | -| | | -| | | -| | | -| | | - - - - - - - - - - +| 401 | Parameter error. | +| 8300001 | Invalid parameter value. | +| 8300002 | Operation failed. Cannot connect to service. | +| 8300003 | System internal error. | +| 8300999 | Unknown error code. | + +**Example** + +```js +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\\): void - +Checks whether a call is in progress. This API uses an asynchronous callback to return the result. - +**System capability**: SystemCapability.Telephony.CallManager - +**Parameters** -| | | | | +| Name | Type | Mandatory| Description | | -------- | ---------------------------- | ---- | ------------------------------------------------------------ | -| | | | | +| callback | AsyncCallback<boolean> | Yes | Callback used to return the result. Callback used to return the result.
- **true**: A call is in progress.
- **false**: No call is in progress.| - +**Example** - - - - +```js +call.hasCall((err, data) => { + console.log(`callback: err->${JSON.stringify(err)}, data->${JSON.stringify(data)}`); +}); ``` -## +## call.hasCall - +hasCall\(\): Promise\ - +Checks whether a call is in progress. This API uses a promise to return the result. - +**System capability**: SystemCapability.Telephony.CallManager - +**Return value** -| | | +| Type | Description | | ---------------------- | --------------------------------------- | -| | | +| Promise<boolean> | Promise used to return the result.| - +**Example** - - - - - - - +```js +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\\): void - +Obtains the call status. This API uses an asynchronous callback to return the result. - +**System capability**: SystemCapability.Telephony.CallManager - +**Parameters** -| | | | | +| Name | Type | Mandatory| Description | | -------- | -------------------------------------------- | ---- | ------------------------------------ | -| | | | | +| callback | AsyncCallback<[CallState](#callstate)> | Yes | Callback used to return the result.| - +**Example** - - - - +```js +call.getCallState((err, data) => { + console.log(`callback: err->${JSON.stringify(err)}, data->${JSON.stringify(data)}`); +}); ``` -## +## call.getCallState - +getCallState\(\): Promise\ - +Obtains the call status. This API uses a promise to return the result. - +**System capability**: SystemCapability.Telephony.CallManager - +**Return value** -| | | +| Type | Description | | -------------------------------------- | --------------------------------------- | -| | | +| Promise<[CallState](#callstate)> | Promise used to return the result.| - +**Example** - - - - - - - +```js +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.hasVoiceCapability7+ - +hasVoiceCapability\(\): boolean - +Checks whether a device supports voice calls. - +**System capability**: SystemCapability.Telephony.CallManager - +**Return value** -| | | +| Type | Description | | ------- | ------------------------------------------------------------ | -| | | +| boolean | - **true**: The device supports voice calls.
- **false**: The device does not support voice calls.| - - - +```js +let result = call.hasVoiceCapability(); +console.log(`hasVoiceCapability: ${JSON.stringify(result)}`); ``` -## +## call.isEmergencyPhoneNumber7+ - +isEmergencyPhoneNumber\(phoneNumber: string, callback: AsyncCallback\\): 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** -| | | | | +| Name | Type | Mandatory| Description | | ----------- | ---------------------------- | ---- | ------------------------------------------------------------ | -| | | | | -| | | | | +| phoneNumber | string | Yes | Phone number. | +| callback | AsyncCallback<boolean> | Yes | Callback used to return the result. - **true**: The called number is an emergency number.
- **false**: The called number is not an emergency number.| - +**Error codes** - +For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md). -| | | +| ID| Error Message | | -------- | -------------------------------------------- | -| | | -| | | -| | | -| | | -| | | - - - - - - - +| 401 | Parameter error. | +| 8300001 | Invalid parameter value. | +| 8300002 | Operation failed. Cannot connect to service. | +| 8300003 | System internal error. | +| 8300999 | Unknown error code. | + +**Example** + +```js +call.isEmergencyPhoneNumber("138xxxxxxxx", (err, data) => { + console.log(`callback: err->${JSON.stringify(err)}, data->${JSON.stringify(data)}`); +}); ``` -## +## call.isEmergencyPhoneNumber7+ - +isEmergencyPhoneNumber\(phoneNumber: string, options: EmergencyNumberOptions, callback: AsyncCallback\\): 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** -| | | | | +| Name | Type | Mandatory| Description | | ----------- | -------------------------------------------------- | ---- | ------------------------------------------------------------ | -| | | | | -| | | | | -| | | | | +| phoneNumber | string | Yes | Phone number. | +| options | [EmergencyNumberOptions](#emergencynumberoptions7) | Yes | Phone number. | +| callback | AsyncCallback<boolean> | Yes | Callback used to return the result. - **true**: The called number is an emergency number.
- **false**: The called number is not an emergency number.| - +**Error codes** - +For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md). -| | | +| ID| Error Message | | -------- | -------------------------------------------- | -| | | -| | | -| | | -| | | -| | | - - - - - - - +| 401 | Parameter error. | +| 8300001 | Invalid parameter value. | +| 8300002 | Operation failed. Cannot connect to service. | +| 8300003 | System internal error. | +| 8300999 | Unknown error code. | + +**Example** + +```js +call.isEmergencyPhoneNumber("112", {slotId: 1}, (err, data) => { + console.log(`callback: err->${JSON.stringify(err)}, data->${JSON.stringify(data)}`); +}); ``` -## +## call.isEmergencyPhoneNumber7+ - +isEmergencyPhoneNumber\(phoneNumber: string, options?: EmergencyNumberOptions\): Promise\ - +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** -| | | | | +| Name | Type | Mandatory| Description | | ----------- | -------------------------------------------------- | ---- | -------------- | -| | | | | -| | | | | +| phoneNumber | string | Yes | Phone number. | +| options | [EmergencyNumberOptions](#emergencynumberoptions7) | No | Phone number.| - +**Return value** -| | | +| Type | Description | | ---------------------- | --------------------------------------------------- | -| | | +| Promise<boolean> | Promise used to return the result.| - +**Error codes** - +For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md). -| | | +| ID| Error Message | | -------- | -------------------------------------------- | -| | | -| | | -| | | -| | | -| | | - - - - - - - - - - +| 401 | Parameter error. | +| 8300001 | Invalid parameter value. | +| 8300002 | Operation failed. Cannot connect to service. | +| 8300003 | System internal error. | +| 8300999 | Unknown error code. | + +**Example** + +```js +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.formatPhoneNumber7+ - +formatPhoneNumber\(phoneNumber: string, callback: AsyncCallback\\): 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** -| | | | | +| Name | Type | Mandatory| Description | | ----------- | --------------------------- | ---- | ------------------------------------ | -| | | | | -| | | | | +| phoneNumber | string | Yes | Phone number. | +| callback | AsyncCallback<string> | Yes | Callback used to return the result.| - +**Error codes** - +For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md). -| | | +| ID| Error Message | | -------- | -------------------------------------------- | -| | | -| | | -| | | -| | | -| | | - - - - - - - +| 401 | Parameter error. | +| 8300001 | Invalid parameter value. | +| 8300002 | Operation failed. Cannot connect to service. | +| 8300003 | System internal error. | +| 8300999 | Unknown error code. | + +**Example** + +```js +call.formatPhoneNumber("138xxxxxxxx", (err, data) => { + console.log(`callback: err->${JSON.stringify(err)}, data->${JSON.stringify(data)}`); +}); ``` -## +## call.formatPhoneNumber7+ - +formatPhoneNumber\(phoneNumber: string, options: NumberFormatOptions, callback: AsyncCallback\\): 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** -| | | | | +| Name | Type | Mandatory| Description | | ----------- | -------------------------------------------- | ---- | ------------------------------------ | -| | | | | -| | | | | -| | | | | +| phoneNumber | string | Yes | Phone number. | +| options | [NumberFormatOptions](#numberformatoptions7) | Yes | Number formatting options, for example, country code. | +| callback | AsyncCallback<string> | Yes | Callback used to return the result.| - +**Error codes** - +For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md). -| | | +| ID| Error Message | | -------- | -------------------------------------------- | -| | | -| | | -| | | -| | | -| | | - - - - - - - - - +| 401 | Parameter error. | +| 8300001 | Invalid parameter value. | +| 8300002 | Operation failed. Cannot connect to service. | +| 8300003 | System internal error. | +| 8300999 | Unknown error code. | + +**Example** + +```js +call.formatPhoneNumber("138xxxxxxxx", { + countryCode: "CN" +}, (err, data) => { + console.log(`callback: err->${JSON.stringify(err)}, data->${JSON.stringify(data)}`); +}); ``` -## +## call.formatPhoneNumber7+ - +formatPhoneNumber\(phoneNumber: string, options?: NumberFormatOptions\): Promise\ - +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** -| | | | | +| Name | Type | Mandatory| Description | | ----------- | -------------------------------------------- | ---- | ---------------------- | -| | | | | -| | | | | +| phoneNumber | string | Yes | Phone number. | +| options | [NumberFormatOptions](#numberformatoptions7) | No | Number formatting options, for example, country code.| - +**Return value** -| | | +| Type | Description | | --------------------- | ------------------------------------------- | -| | | +| Promise<string> | Promise used to return the result.| - +**Error codes** - +For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md). -| | | +| ID| Error Message | | -------- | -------------------------------------------- | -| | | -| | | -| | | -| | | -| | | - - - - - - - - - - - - +| 401 | Parameter error. | +| 8300001 | Invalid parameter value. | +| 8300002 | Operation failed. Cannot connect to service. | +| 8300003 | System internal error. | +| 8300999 | Unknown error code. | + +**Example** + +```js +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.formatPhoneNumberToE1647+ - +formatPhoneNumberToE164\(phoneNumber: string, countryCode: string, callback: AsyncCallback\\): 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** -| | | | | +| Name | Type | Mandatory| Description | | ----------- | --------------------------- | ---- | ----------------------------------------------------- | -| | | | | -| | | | | -| | | | | +| phoneNumber | string | Yes | Phone number. | +| countryCode | string | Yes | Country code, for example, **CN** (China). All country codes are supported. | +| callback | AsyncCallback<string> | Yes | Callback used to return the result.| - +**Error codes** - +For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md). -| | | +| ID| Error Message | | -------- | -------------------------------------------- | -| | | -| | | -| | | -| | | -| | | - - - - - - - +| 401 | Parameter error. | +| 8300001 | Invalid parameter value. | +| 8300002 | Operation failed. Cannot connect to service. | +| 8300003 | System internal error. | +| 8300999 | Unknown error code. | + +**Example** + +```js +call.formatPhoneNumberToE164("138xxxxxxxx", "CN", (err, data) => { + console.log(`callback: err->${JSON.stringify(err)}, data->${JSON.stringify(data)}`); +}); ``` -## +## call.formatPhoneNumberToE1647+ - +formatPhoneNumberToE164\(phoneNumber: string, countryCode: string\): Promise\ - +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** -| | | | | +| Name | Type | Mandatory| Description | | ----------- | ------ | ---- | ---------------------------------------- | -| | | | | -| | | | | +| phoneNumber | string | Yes | Phone number. | +| countryCode | string | Yes | Country code, for example, **CN** (China). All country codes are supported.| - +**Return value** -| | | +| Type | Description | | --------------------- | ------------------------------------------------------------ | -| | | +| Promise<string> | Promise used to return the result.| - +**Error codes** - +For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md). -| | | +| ID| Error Message | | -------- | -------------------------------------------- | -| | | -| | | -| | | -| | | -| | | - - - - - - - - - - +| 401 | Parameter error. | +| 8300001 | Invalid parameter value. | +| 8300002 | Operation failed. Cannot connect to service. | +| 8300003 | System internal error. | +| 8300999 | Unknown error code. | + +**Example** + +```js +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.muteRinger8+ - +muteRinger\(callback: AsyncCallback\\): 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** -| | | | | +| Name | Type | Mandatory| Description | | ----------- | ------------------------- | ---- | ---------- | -| | | | | +| callback | AsyncCallback<void> | Yes | Callback used to return the result.| - +**Error codes** - +For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md). -| | | +| ID| Error Message | | -------- | -------------------------------------------- | -| | | -| | | -| | | -| | | -| | | -| | | -| | | - - - - - - - +| 201 | Permission denied. | +| 202 | Non-system applications use system APIs. | +| 401 | Parameter error. | +| 8300001 | Invalid parameter value. | +| 8300002 | Operation failed. Cannot connect to service. | +| 8300003 | System internal error. | +| 8300999 | Unknown error code. | + +**Example** + +```js +call.muteRinger((err) => { + console.log(`callback: err->${JSON.stringify(err)}`); +}); ``` -## +## call.muteRinger8+ - +muteRinger\(\): Promise\ - +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** -| | | +| Type | Description | | ------------------- | --------------------------- | -| | | +| Promise<void> | Promise used to return the result.| - +**Error codes** - +For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md). -| | | +| ID| Error Message | | -------- | -------------------------------------------- | -| | | -| | | -| | | -| | | -| | | - - - - - - - - - +| 201 | Permission denied. | +| 202 | Non-system applications use system APIs. | +| 8300002 | Operation failed. Cannot connect to service. | +| 8300003 | System internal error. | +| 8300999 | Unknown error code. | + +**Example** + +```js +call.muteRinger().then(() => { + console.log(`muteRinger success.`); +}).catch((err) => { + console.error(`muteRinger fail, promise: err->${JSON.stringify(err)}`); +}); ``` -## +## call.answerCall9+ - +answerCall\(callId: number, callback: AsyncCallback\\): 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** -| | | | | +| Name | Type | Mandatory| Description | | -------- | ------------------------- | ---- | ----------------------------------------------- | -| | | | | -| | | | | +| callId | number | Yes | Call ID. You can obtain the value by subscribing to **callDetailsChange** events.| +| callback | AsyncCallback<void> | Yes | Callback used to return the result. | - +**Error codes** - +For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md). -| | | +| ID| Error Message | | -------- | -------------------------------------------- | -| | | -| | | -| | | -| | | -| | | -| | | -| | | - - - - - - - +| 201 | Permission denied. | +| 202 | Non-system applications use system APIs. | +| 401 | Parameter error. | +| 8300001 | Invalid parameter value. | +| 8300002 | Operation failed. Cannot connect to service. | +| 8300003 | System internal error. | +| 8300999 | Unknown error code. | + +**Example** + +```js +call.answerCall(1, (err) => { + console.log(`callback: err->${JSON.stringify(err)}`); +}); ``` -## +## call.answerCall9+ - +answerCall(callId?: number\): Promise\ - +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** -| | | | | +| Name| Type | Mandatory| Description | | ------ | ------ | ---- | ------------------------------------------------------------ | -| | | |
| +| callId | number | No | Call ID. You can obtain the value by subscribing to **callDetailsChange** events. This parameter is optional from API version 9.
If this parameter is not set, the latest ringing call will be connected.| - +**Return value** -| | | +| Type | Description | | ------------------- | --------------------------- | -| | | +| Promise<void> | Promise used to return the result.| - +**Error codes** - +For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md). -| | | +| ID| Error Message | | -------- | -------------------------------------------- | -| | | -| | | -| | | -| | | -| | | -| | | -| | | - - - - - - - - - +| 201 | Permission denied. | +| 202 | Non-system applications use system APIs. | +| 401 | Parameter error. | +| 8300001 | Invalid parameter value. | +| 8300002 | Operation failed. Cannot connect to service. | +| 8300003 | System internal error. | +| 8300999 | Unknown error code. | + +**Example** + +```js +call.answerCall(1).then(() => { + console.log(`answerCall success.`); +}).catch((err) => { + console.error(`answerCall fail, promise: err->${JSON.stringify(err)}`); +}); ``` -## +## call.answerCall9+ - +answerCall\(callback: AsyncCallback\\): 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** -| | | | | +| Name | Type | Mandatory| Description | | -------- | ------------------------- | ---- | ---------- | -| | | | | +| callback | AsyncCallback<void> | Yes | Callback used to return the result.| - +**Error codes** - +For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md). -| | | +| ID| Error Message | | -------- | -------------------------------------------- | -| | | -| | | -| | | -| | | -| | | -| | | -| | | - - - - - - - +| 201 | Permission denied. | +| 202 | Non-system applications use system APIs. | +| 401 | Parameter error. | +| 8300001 | Invalid parameter value. | +| 8300002 | Operation failed. Cannot connect to service. | +| 8300003 | System internal error. | +| 8300999 | Unknown error code. | + +**Example** + +```js +call.answerCall((err) => { + console.log(`callback: err->${JSON.stringify(err)}`); +}); ``` -## +## call.hangUpCall9+ - +hangUpCall\(callId: number, callback: AsyncCallback\\): 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** -| | | | | +| Name | Type | Mandatory| Description | | -------- | ------------------------- | ---- | ----------------------------------------------- | -| | | | | -| | | | | +| callId | number | Yes | Call ID. You can obtain the value by subscribing to **callDetailsChange** events.| +| callback | AsyncCallback<void> | Yes | Callback used to return the result. | - +**Error codes** - +For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md). -| | | +| ID| Error Message | | -------- | -------------------------------------------- | -| | | -| | | -| | | -| | | -| | | -| | | -| | | - - - - - - - +| 201 | Permission denied. | +| 202 | Non-system applications use system APIs. | +| 401 | Parameter error. | +| 8300001 | Invalid parameter value. | +| 8300002 | Operation failed. Cannot connect to service. | +| 8300003 | System internal error. | +| 8300999 | Unknown error code. | + +**Example** + +```js +call.hangUpCall(1, (err) => { + console.log(`callback: err->${JSON.stringify(err)}`); +}); ``` -## +## call.hangUpCall9+ - +hangUpCall\(callId?: number\): Promise\ - +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** -| | | | | +| Name| Type | Mandatory| Description | | ------ | ------ | ---- | ------------------------------------------------------------ | -| | | |
| +| callId | number | No | Call ID. You can obtain the value by subscribing to **callDetailsChange** events. This parameter is optional from API version 9.
If this parameter is not set, the latest ongoing, dialed, or connected call will be ended.| - +**Return value** -| | | +| Type | Description | | ------------------- | --------------------------- | -| | | +| Promise<void> | Promise used to return the result.| - +**Error codes** - +For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md). -| | | +| ID| Error Message | | -------- | -------------------------------------------- | -| | | -| | | -| | | -| | | -| | | -| | | -| | | - - - - - - - - - +| 201 | Permission denied. | +| 202 | Non-system applications use system APIs. | +| 401 | Parameter error. | +| 8300001 | Invalid parameter value. | +| 8300002 | Operation failed. Cannot connect to service. | +| 8300003 | System internal error. | +| 8300999 | Unknown error code. | + +**Example** + +```js +call.hangUpCall(1).then(() => { + console.log(`hangUpCall success.`); +}).catch((err) => { + console.error(`hangUpCall fail, promise: err->${JSON.stringify(err)}`); +}); ``` -## +## call.hangUpCall9+ - +hangUpCall\(callback: AsyncCallback\\): 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** -| | | | | +| Name | Type | Mandatory| Description | | -------- | ------------------------- | ---- | ---------- | -| | | | | +| callback | AsyncCallback<void> | Yes | Callback used to return the result.| - +**Error codes** - +For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md). -| | | +| ID| Error Message | | -------- | -------------------------------------------- | -| | | -| | | -| | | -| | | -| | | -| | | -| | | +| 201 | Permission denied. | +| 202 | Non-system applications use system APIs. | +| 401 | Parameter error. | +| 8300001 | Invalid parameter value. | +| 8300002 | Operation failed. Cannot connect to service. | +| 8300003 | System internal error. | +| 8300999 | Unknown error code. | - +**Example** - - - - +```js +call.hangUpCall((err) => { + console.log(`callback: err->${JSON.stringify(err)}`); +}); ``` -## +## call.rejectCall9+ - +rejectCall\(callId: number, callback: AsyncCallback\\): 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** -| | | | | +| Name | Type | Mandatory| Description | | -------- | ------------------------- | ---- | ----------------------------------------------- | -| | | | | -| | | | | +| callId | number | Yes | Call ID. You can obtain the value by subscribing to **callDetailsChange** events.| +| callback | AsyncCallback<void> | Yes | Callback used to return the result. | - +**Error codes** - +For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md). -| | | +| ID| Error Message | | -------- | -------------------------------------------- | -| | | -| | | -| | | -| | | -| | | -| | | -| | | +| 201 | Permission denied. | +| 202 | Non-system applications use system APIs. | +| 401 | Parameter error. | +| 8300001 | Invalid parameter value. | +| 8300002 | Operation failed. Cannot connect to service. | +| 8300003 | System internal error. | +| 8300999 | Unknown error code. | - +**Example** - - - - +```js +call.rejectCall(1, (err) => { + console.log(`callback: err->${JSON.stringify(err)}`); +}); ``` -## +## call.rejectCall9+ - +rejectCall\(callId: number, options: RejectMessageOptions, callback: AsyncCallback\\): 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** -| | | | | +| Name | Type | Mandatory| Description | | -------- | ---------------------------------------------- | ---- | ----------------------------------------------- | -| | | | | -| | | | | -| | | | | +| callId | number | Yes | Call ID. You can obtain the value by subscribing to **callDetailsChange** events.| +| options | [RejectMessageOptions](#rejectmessageoptions7) | Yes | Options for the call rejection message. | +| callback | AsyncCallback<void> | Yes | Callback used to return the result. | - +**Error codes** - +For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md). -| | | +| ID| Error Message | | -------- | -------------------------------------------- | -| | | -| | | -| | | -| | | -| | | -| | | -| | | - - - - - - +| 201 | Permission denied. | +| 202 | Non-system applications use system APIs. | +| 401 | Parameter error. | +| 8300001 | Invalid parameter value. | +| 8300002 | Operation failed. Cannot connect to service. | +| 8300003 | System internal error. | +| 8300999 | Unknown error code. | + +**Example** + +```js +let rejectMessageOptions={ + messageContent: "Unknown number blocked" } - - - +call.rejectCall(1, rejectMessageOptions, (err) => { + console.log(`callback: err->${JSON.stringify(err)}`); +}); ``` -## +## call.rejectCall9+ - +rejectCall\(callId?: number, options?: RejectMessageOptions\): Promise\ - +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** -| | | | | +| Name | Type | Mandatory| Description | | ------- | ---------------------------------------------- | ---- | ------------------------------------------------------------ | -| | | |
| -| | | | | +| callId | number | No | Call ID. You can obtain the value by subscribing to **callDetailsChange** events. This parameter is optional from API version 9.
If this parameter is not set, the latest ringing call will be rejected.| +| options | [RejectMessageOptions](#rejectmessageoptions7) | No | Options for the call rejection message. If this parameter is not set, no call rejection message will be sent.| - +**Return value** -| | | +| Type | Description | | ------------------- | --------------------------- | -| | | +| Promise<void> | Promise used to return the result.| - +**Error codes** - +For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md). -| | | +| ID| Error Message | | -------- | -------------------------------------------- | -| | | -| | | -| | | -| | | -| | | -| | | -| | | - - - - - - +| 201 | Permission denied. | +| 202 | Non-system applications use system APIs. | +| 401 | Parameter error. | +| 8300001 | Invalid parameter value. | +| 8300002 | Operation failed. Cannot connect to service. | +| 8300003 | System internal error. | +| 8300999 | Unknown error code. | + +**Example** + +```js +let rejectMessageOptions={ + messageContent: "Unknown number blocked" } - - - - - +call.rejectCall(1, rejectMessageOptions).then(() => { + console.log(`rejectCall success.`); +}).catch((err) => { + console.error(`rejectCall fail, promise: err->${JSON.stringify(err)}`); +}); ``` -## +## call.rejectCall9+ - +rejectCall\(callback: AsyncCallback\\): 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** -| | | | | +| Name | Type | Mandatory| Description | | -------- | ------------------------- | ---- | ---------- | -| | | | | +| callback | AsyncCallback<void> | Yes | Callback used to return the result.| - +**Error codes** - +For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md). -| | | +| ID| Error Message | | -------- | -------------------------------------------- | -| | | -| | | -| | | -| | | -| | | -| | | -| | | - - - - - - - +| 201 | Permission denied. | +| 202 | Non-system applications use system APIs. | +| 401 | Parameter error. | +| 8300001 | Invalid parameter value. | +| 8300002 | Operation failed. Cannot connect to service. | +| 8300003 | System internal error. | +| 8300999 | Unknown error code. | + +**Example** + +```js +call.rejectCall((err) => { + console.log(`callback: err->${JSON.stringify(err)}`); +}); ``` -## +## call.rejectCall9+ - +rejectCall\(options: RejectMessageOptions, callback: AsyncCallback\\): 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** -| | | | | +| Name | Type | Mandatory| Description | | -------- | ---------------------------------------------- | ---- | -------------- | -| | | | | -| | | | | +| options | [RejectMessageOptions](#rejectmessageoptions7) | Yes | Options for the call rejection message.| +| callback | AsyncCallback<void> | Yes | Callback used to return the result. | - +**Error codes** - +For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md). -| | | +| ID| Error Message | | -------- | -------------------------------------------- | -| | | -| | | -| | | -| | | -| | | -| | | -| | | - - - - - - +| 201 | Permission denied. | +| 202 | Non-system applications use system APIs. | +| 401 | Parameter error. | +| 8300001 | Invalid parameter value. | +| 8300002 | Operation failed. Cannot connect to service. | +| 8300003 | System internal error. | +| 8300999 | Unknown error code. | + +**Example** + +```js +let rejectMessageOptions={ + messageContent: "Unknown number blocked" } - - - +call.rejectCall(rejectMessageOptions, (err) => { + console.log(`callback: err->${JSON.stringify(err)}`); +}); ``` -## +## call.holdCall7+ - +holdCall\(callId: number, callback: AsyncCallback\\): 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** -| | | | | +| Name | Type | Mandatory| Description | | -------- | ------------------------- | ---- | ---------- | -| | | | | -| | | | | +| callId | number | Yes | Call ID. | +| callback | AsyncCallback<void> | Yes | Callback used to return the result.| - +**Error codes** - +For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md). -| | | +| ID| Error Message | | -------- | -------------------------------------------- | -| | | -| | | -| | | -| | | -| | | -| | | -| | | - - - - - - - +| 201 | Permission denied. | +| 202 | Non-system applications use system APIs. | +| 401 | Parameter error. | +| 8300001 | Invalid parameter value. | +| 8300002 | Operation failed. Cannot connect to service. | +| 8300003 | System internal error. | +| 8300999 | Unknown error code. | + +**Example** + +```js +call.holdCall(1, (err) => { + console.log(`callback: err->${JSON.stringify(err)}`); +}); ``` -## +## call.holdCall7+ - +holdCall\(callId: number\): Promise\ - +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** -| | | | | +| Name| Type | Mandatory| Description | | ------ | ------ | ---- | -------- | -| | | | | +| callId | number | Yes | Call ID.| - +**Return value** -| | | +| Type | Description | | ------------------- | --------------------------- | -| | | +| Promise<void> | Promise used to return the result.| - +**Error codes** - +For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md). -| | | +| ID| Error Message | | -------- | -------------------------------------------- | -| | | -| | | -| | | -| | | -| | | -| | | -| | | - - - - - - - - - +| 201 | Permission denied. | +| 202 | Non-system applications use system APIs. | +| 401 | Parameter error. | +| 8300001 | Invalid parameter value. | +| 8300002 | Operation failed. Cannot connect to service. | +| 8300003 | System internal error. | +| 8300999 | Unknown error code. | + +**Example** + +```js +call.holdCall(1).then(() => { + console.log(`holdCall success.`); +}).catch((err) => { + console.error(`holdCall fail, promise: err->${JSON.stringify(err)}`); +}); ``` -## +## call.unHoldCall7+ - +unHoldCall\(callId: number, callback: AsyncCallback\\): 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** -| | | | | +| Name | Type | Mandatory| Description | | -------- | ------------------------- | ---- | ---------- | -| | | | | -| | | | | +| callId | number | Yes | Call ID. | +| callback | AsyncCallback<void> | Yes | Callback used to return the result.| - +**Error codes** - +For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md). -| | | +| ID| Error Message | | -------- | -------------------------------------------- | -| | | -| | | -| | | -| | | -| | | -| | | -| | | - - - - - - - +| 201 | Permission denied. | +| 202 | Non-system applications use system APIs. | +| 401 | Parameter error. | +| 8300001 | Invalid parameter value. | +| 8300002 | Operation failed. Cannot connect to service. | +| 8300003 | System internal error. | +| 8300999 | Unknown error code. | + +**Example** + +```js +call.unHoldCall(1, (err) => { + console.log(`callback: err->${JSON.stringify(err)}`); +}); ``` -## +## call.unHoldCall7+ - +unHoldCall\(callId: number\): Promise\ - +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** -| | | | | +| Name| Type | Mandatory| Description | | ------ | ------ | ---- | -------- | -| | | | | +| callId | number | Yes | Call ID.| - +**Return value** -| | | +| Type | Description | | ------------------- | --------------------------- | -| | | +| Promise<void> | Promise used to return the result.| - +**Error codes** - +For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md). -| | | +| ID| Error Message | | -------- | -------------------------------------------- | -| | | -| | | -| | | -| | | -| | | -| | | -| | | - - - - - - - - - +| 201 | Permission denied. | +| 202 | Non-system applications use system APIs. | +| 401 | Parameter error. | +| 8300001 | Invalid parameter value. | +| 8300002 | Operation failed. Cannot connect to service. | +| 8300003 | System internal error. | +| 8300999 | Unknown error code. | + +**Example** + +```js +call.unHoldCall(1).then(() => { + console.log(`unHoldCall success.`); +}).catch((err) => { + console.error(`unHoldCall fail, promise: err->${JSON.stringify(err)}`); +}); ``` -## +## call.switchCall7+ - +switchCall\(callId: number, callback: AsyncCallback\\): 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** -| | | | | +| Name | Type | Mandatory| Description | | -------- | ------------------------- | ---- | ---------- | -| | | | | -| | | | | +| callId | number | Yes | Call ID. | +| callback | AsyncCallback<void> | Yes | Callback used to return the result.| - +**Error codes** - +For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md). -| | | +| ID| Error Message | | -------- | -------------------------------------------- | -| | | -| | | -| | | -| | | -| | | -| | | -| | | - - - - - - - +| 201 | Permission denied. | +| 202 | Non-system applications use system APIs. | +| 401 | Parameter error. | +| 8300001 | Invalid parameter value. | +| 8300002 | Operation failed. Cannot connect to service. | +| 8300003 | System internal error. | +| 8300999 | Unknown error code. | + +**Example** + +```js +call.switchCall(1, (err) => { + console.log(`callback: err->${JSON.stringify(err)}`); +}); ``` -## +## call.switchCall7+ - +switchCall\(callId: number\): Promise\ - +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** -| | | | | +| Name| Type | Mandatory| Description | | ------ | ------ | ---- | -------- | -| | | | | +| callId | number | Yes | Call ID.| - +**Return value** -| | | +| Type | Description | | ------------------- | --------------------------- | -| | | +| Promise<void> | Promise used to return the result.| - +**Error codes** - +For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md). -| | | +| ID| Error Message | | -------- | -------------------------------------------- | -| | | -| | | -| | | -| | | -| | | -| | | -| | | - - - - - - - - - +| 201 | Permission denied. | +| 202 | Non-system applications use system APIs. | +| 401 | Parameter error. | +| 8300001 | Invalid parameter value. | +| 8300002 | Operation failed. Cannot connect to service. | +| 8300003 | System internal error. | +| 8300999 | Unknown error code. | + +**Example** + +```js +call.switchCall(1).then(() => { + console.log(`switchCall success.`); +}).catch((err) => { + console.error(`switchCall fail, promise: err->${JSON.stringify(err)}`); +}); ``` -## +## call.combineConference7+ - +combineConference\(callId: number, callback: AsyncCallback\\): 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** -| | | | | +| Name | Type | Mandatory| Description | | -------- | ------------------------- | ---- | ---------- | -| | | | | -| | | | | +| callId | number | Yes | Call ID. | +| callback | AsyncCallback<void> | Yes | Callback used to return the result.| - +**Error codes** - +For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md). -| | | +| ID| Error Message | | -------- | -------------------------------------------- | -| | | -| | | -| | | -| | | -| | | - - - - - - - +| 202 | Non-system applications use system APIs. | +| 401 | Parameter error. | +| 8300001 | Invalid parameter value. | +| 8300002 | Operation failed. Cannot connect to service. | +| 8300003 | System internal error. | + +**Example** + +```js +call.combineConference(1, (err) => { + console.log(`callback: err->${JSON.stringify(err)}`); +}); ``` -## +## call.combineConference7+ - +combineConference\(callId: number\): Promise\ - +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** -| | | | | +| Name| Type | Mandatory| Description | | ------ | ------ | ---- | -------- | -| | | | | +| callId | number | Yes | Call ID.| - +**Return value** -| | | +| Type | Description | | ------------------- | --------------------------- | -| | | +| Promise<void> | Promise used to return the result.| - +**Error codes** - +For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md). -| | | +| ID| Error Message | | -------- | -------------------------------------------- | -| | | -| | | -| | | -| | | -| | | - - - - - - - - - +| 202 | Non-system applications use system APIs. | +| 401 | Parameter error. | +| 8300001 | Invalid parameter value. | +| 8300002 | Operation failed. Cannot connect to service. | +| 8300003 | System internal error. | + +**Example** + +```js +call.combineConference(1).then(() => { + console.log(`combineConference success.`); +}).catch((err) => { + console.error(`combineConference fail, promise: err->${JSON.stringify(err)}`); +}); ``` -## +## call.kickOutFromConference10+ - +kickOutFromConference\(callId: number, callback: AsyncCallback\\): void - +Removes a specified call from a conference 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** + +| Name | Type | Mandatory| Description | +| -------- | ------------------------- | ---- | ---------- | +| callId | number | Yes | Call ID. | +| callback | AsyncCallback<void> | Yes | Callback used to return the result.| + +**Error codes** + +For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md). + +| ID| Error Message | +| -------- | -------------------------------------------- | +| 201 | Permission denied. | +| 202 | Non-system applications use system APIs. | +| 401 | Parameter error. | +| 8300001 | Invalid parameter value. | +| 8300002 | Operation failed. Cannot connect to service. | +| 8300003 | System internal error. | + +**Example** + +```js +call.kickOutFromConference(1, (err) => { + console.log(`callback: err->${JSON.stringify(err)}`); +}); +``` + +## call.kickOutFromConference10+ + +kickOutFromConference\(callId: number\): Promise\ + +Removes a specified call from a conference call. 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** + +| Name| Type | Mandatory| Description | +| ------ | ------ | ---- | -------- | +| callId | number | Yes | Call ID.| + +**Return value** + +| Type | Description | +| ------------------- | --------------------------- | +| Promise<void> | Promise used to return the result.| + +**Error codes** + +For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md). + +| ID| Error Message | +| -------- | -------------------------------------------- | +| 201 | Permission denied. | +| 202 | Non-system applications use system APIs. | +| 401 | Parameter error. | +| 8300001 | Invalid parameter value. | +| 8300002 | Operation failed. Cannot connect to service. | +| 8300003 | System internal error. | + +**Example** + +```js +call.kickOutFromConference(1).then(() => { + console.log(`kickOutFromConference success.`); +}).catch((err) => { + console.error(`kickOutFromConference fail, promise: err->${JSON.stringify(err)}`); +}); +``` + +## call.getMainCallId7+ + +getMainCallId\(callId: number, callback: AsyncCallback\\): 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** + +| Name | Type | Mandatory| Description | | -------- | --------------------------- | ---- | ------------------------ | -| | | | | -| | | | | +| callId | number | Yes | Call ID. | +| callback | AsyncCallback<number> | Yes | Callback used to return the result. | - +**Error codes** - +For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md). -| | | +| ID| Error Message | | -------- | -------------------------------------------- | -| | | -| | | -| | | -| | | -| | | +| 202 | Non-system applications use system APIs. | +| 401 | Parameter error. | +| 8300001 | Invalid parameter value. | +| 8300002 | Operation failed. Cannot connect to service. | +| 8300003 | System internal error. | - +**Example** - - - - +```js +call.getMainCallId(1, (err, data) => { + console.log(`callback: err->${JSON.stringify(err)}, data->${JSON.stringify(data)}`); +}); ``` -## +## call.getMainCallId7+ - +getMainCallId\(callId: number\): Promise\ - +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** -| | | | | +| Name| Type | Mandatory| Description | | ------ | ------ | ---- | -------- | -| | | | | +| callId | number | Yes | Call ID.| - +**Return value** -| | | +| Type | Description | | ------------------- | ------------------------------- | -| | | +| Promise<void> | Promise used to return the result.| - +**Error codes** - +For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md). -| | | +| ID| Error Message | | -------- | -------------------------------------------- | -| | | -| | | -| | | -| | | -| | | - - - - - - - - - - - +| 202 | Non-system applications use system APIs. | +| 401 | Parameter error. | +| 8300001 | Invalid parameter value. | +| 8300002 | Operation failed. Cannot connect to service. | +| 8300003 | System internal error. | + + +**Example** + +```js +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.getSubCallIdList7+ - +getSubCallIdList\(callId: number, callback: AsyncCallback\\>\): 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** -| | | | | +| Name | Type | Mandatory| Description | | -------- | ------------------------------ | ---- | ---------------------------- | -| | | | | -| | | | | +| callId | number | Yes | Call ID. | +| callback | AsyncCallback\> | Yes | Callback used to return the result. | - +**Error codes** - +For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md). -| | | +| ID| Error Message | | -------- | -------------------------------------------- | -| | | -| | | -| | | -| | | -| | | - - - - - - - +| 202 | Non-system applications use system APIs. | +| 401 | Parameter error. | +| 8300001 | Invalid parameter value. | +| 8300002 | Operation failed. Cannot connect to service. | +| 8300003 | System internal error. | + +**Example** + +```js +call.getSubCallIdList(1, (err, data) => { + console.log(`callback: err->${JSON.stringify(err)}, data->${JSON.stringify(data)}`); +}); ``` -## +## call.getSubCallIdList7+ - +getSubCallIdList\(callId: number\): Promise\\> - +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** -| | | | | +| Name| Type | Mandatory| Description | | ------ | ------ | ---- | -------- | -| | | | | +| callId | number | Yes | Call ID.| - +**Return value** -| | | +| Type | Description | | ----------------------------- | ----------------------------------- | -| | | +| Promise<Array> | Promise used to return the result.| - +**Error codes** - +For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md). -| | | +| ID| Error Message | | -------- | -------------------------------------------- | -| | | -| | | -| | | -| | | -| | | - - - - - - - - - - +| 202 | Non-system applications use system APIs. | +| 401 | Parameter error. | +| 8300001 | Invalid parameter value. | +| 8300002 | Operation failed. Cannot connect to service. | +| 8300003 | System internal error. | + +**Example** + +```js +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.getCallIdListForConference7+ - +getCallIdListForConference\(callId: number, callback: AsyncCallback\\>\): 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** -| | | | | +| Name | Type | Mandatory| Description | | -------- | ----------------------------------- | ---- | -------------------------------- | -| | | | | -| | | | | +| callId | number | Yes | Call ID. | +| callback | AsyncCallback<Array> | Yes | Callback used to return the result. | - +**Error codes** - +For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md). -| | | +| ID| Error Message | | -------- | -------------------------------------------- | -| | | -| | | -| | | -| | | -| | | - - - - - - - +| 202 | Non-system applications use system APIs. | +| 401 | Parameter error. | +| 8300001 | Invalid parameter value. | +| 8300002 | Operation failed. Cannot connect to service. | +| 8300003 | System internal error. | + +**Example** + +```js +call.getCallIdListForConference(1, (err, data) => { + console.log(`callback: err->${JSON.stringify(err)}, data->${JSON.stringify(data)}`); +}); ``` -## +## call.getCallIdListForConference7+ - +getCallIdListForConference\(callId: number\): Promise\\> - +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** -| | | | | +| Name| Type | Mandatory| Description | | ------ | ------ | ---- | -------- | -| | | | | +| callId | number | Yes | Call ID.| - +**Return value** -| | | +| Type | Description | | ----------------------------- | --------------------------------------- | -| | | +| Promise<Array> | Promise used to return the result.| - +**Error codes** - +For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md). -| | | +| ID| Error Message | | -------- | -------------------------------------------- | -| | | -| | | -| | | -| | | -| | | - - - - - - - - - - +| 202 | Non-system applications use system APIs. | +| 401 | Parameter error. | +| 8300001 | Invalid parameter value. | +| 8300002 | Operation failed. Cannot connect to service. | +| 8300003 | System internal error. | + +**Example** + +```js +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.getCallWaitingStatus7+ - +getCallWaitingStatus\(slotId: number, callback: AsyncCallback\\): 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** -| | | | | +| Name | Type | Mandatory| Description | | -------- | ----------------------------------------------------------- | ---- | ------------------------------------------------------------ | -| | | |

| -| | | |


| +| slotId | number | Yes | Card slot ID.
- **0**: card slot 1
- **1**: card slot 2 | +| callback | AsyncCallback<[CallWaitingStatus](#callwaitingstatus7)\> | Yes | Callback used to return the result.

- **0**: Call waiting is disabled.
- **1**: Call waiting is enabled.| - +**Error codes** - +For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md). -| | | +| ID| Error Message | | -------- | -------------------------------------------- | -| | | -| | | -| | | -| | | -| | | -| | | - - - - - - - +| 201 | Permission denied. | +| 202 | Non-system applications use system APIs. | +| 401 | Parameter error. | +| 801 | Capability not supported. | +| 8300001 | Invalid parameter value. | +| 8300002 | Operation failed. Cannot connect to service. | +| 8300003 | System internal error. | + +**Example** + +```js +call.getCallWaitingStatus(0, (err, data) => { + console.log(`callback: err->${JSON.stringify(err)}, data->${JSON.stringify(data)}`); +}); ``` -## +## call.getCallWaitingStatus7+ - +getCallWaitingStatus\(slotId: number\): Promise\ - +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** -| | | | | +| Name| Type | Mandatory| Description | | ------ | ------ | ---- | -------------------------------------- | -| | | |

| +| slotId | number | Yes | Card slot ID.
- **0**: card slot 1
- **1**: card slot 2| - +**Return value** -| | | +| Type | Description | | ------------------------------------------------------- | ------------------------------------------------------------ | -| |

| +| Promise<[CallWaitingStatus](#callwaitingstatus7)> | Promise used to return the result.
- **0**: Call waiting is disabled.
- **1**: Call waiting is enabled.| - +**Error codes** - +For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md). -| | | +| ID| Error Message | | -------- | -------------------------------------------- | -| | | -| | | -| | | -| | | -| | | -| | | - - - - - - - - - - +| 201 | Permission denied. | +| 202 | Non-system applications use system APIs. | +| 401 | Parameter error. | +| 801 | Capability not supported. | +| 8300001 | Invalid parameter value. | +| 8300002 | Operation failed. Cannot connect to service. | +| 8300003 | System internal error. | + +**Example** + +```js +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.setCallWaiting7+ - +setCallWaiting\(slotId: number, activate: boolean, callback: AsyncCallback\\): void - +Specifies whether to enable the call waiting service. 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** -| | | | | +| Name | Type | Mandatory| Description | | -------- | -------------------- | ---- | ------------------------------------------------------------ | -| | | |

| -| | | |

| -| | | | | +| slotId | number | Yes | Card slot ID.
- **0**: card slot 1
- **1**: card slot 2 | +| activate | boolean | Yes | Whether to enable call waiting.
- **false**: Disable call waiting.
- **true**: Enable call waiting.| +| callback | AsyncCallback | Yes | Callback used to return the result. | - +**Error codes** - +For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md). -| | | +| ID| Error Message | | -------- | -------------------------------------------- | -| | | -| | | -| | | -| | | -| | | -| | | - - - - - - - +| 201 | Permission denied. | +| 202 | Non-system applications use system APIs. | +| 401 | Parameter error. | +| 801 | Capability not supported. | +| 8300001 | Invalid parameter value. | +| 8300002 | Operation failed. Cannot connect to service. | +| 8300003 | System internal error. | + +**Example** + +```js +call.setCallWaiting(0, true, (err) => { + console.log(`callback: err->${JSON.stringify(err)}`); +}); ``` -## +## call.setCallWaiting7+ - +setCallWaiting\(slotId: number, activate: boolean\): Promise\ - +Specifies whether to enable the call waiting service. 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** -| | | | | +| Name | Type | Mandatory| Description | | -------- | ------- | ---- | ------------------------------------------------------------ | -| | | |

| -| | | |

| +| slotId | number | Yes | Card slot ID.
- **0**: card slot 1
- **1**: card slot 2 | +| activate | boolean | Yes | Whether to enable call waiting.
- **false**: Disable call waiting.
- **true**: Enable call waiting.| - +**Return value** -| | | +| Type | Description | | ------------------- | --------------------------- | -| | | +| Promise<void> | Promise used to return the result.| - +**Error codes** - +For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md). -| | | +| ID| Error Message | | -------- | -------------------------------------------- | -| | | -| | | -| | | -| | | -| | | -| | | - - - - - - - - - +| 201 | Permission denied. | +| 202 | Non-system applications use system APIs. | +| 401 | Parameter error. | +| 801 | Capability not supported. | +| 8300001 | Invalid parameter value. | +| 8300002 | Operation failed. Cannot connect to service. | +| 8300003 | System internal error. | + +**Example** + +```js +call.setCallWaiting(0, true).then(() => { + console.log(`setCallWaiting success.`); +}).catch((err) => { + console.error(`setCallWaiting fail, promise: err->${JSON.stringify(err)}`); +}); ``` -## +## call.startDTMF7+ - +startDTMF\(callId: number, character: string, callback: AsyncCallback\\): 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** -| | | | | +| Name | Type | Mandatory| Description | | --------- | -------------------- | ---- | ---------- | -| | | | | -| | | | | -| | | | | +| callId | number | Yes | Call ID. | +| character | string | Yes | DTMF code. | +| callback | AsyncCallback | Yes | Callback used to return the result.| - +**Error codes** - +For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md). -| | | +| ID| Error Message | | -------- | -------------------------------------------- | -| | | -| | | -| | | -| | | -| | | - - - - - - - +| 202 | Non-system applications use system APIs. | +| 401 | Parameter error. | +| 8300001 | Invalid parameter value. | +| 8300002 | Operation failed. Cannot connect to service. | +| 8300003 | System internal error. | + +**Example** + +```js +call.startDTMF(1, "0", (err) => { + console.log(`callback: err->${JSON.stringify(err)}`); +}); ``` -## +## call.startDTMF7+ - +startDTMF\(callId: number, character: string\): Promise\ - +Enables DTMF. This API uses a promise to return the result. - +**System API**: This is a system API. - +**System capability**: SystemCapability.Telephony.CallManager - +**Parameters** -| | | | | +| Name | Type | Mandatory| Description | | --------- | ------ | ---- | -------- | -| | | | | -| | | | | +| callId | number | Yes | Call ID.| +| character | string | Yes | DTMF code.| - +**Return value** -| | | +| Type | Description | | ------------------- | ----------------------- | -| | | +| Promise<void> | Promise used to return the result.| - +**Error codes** - +For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md). -| | | +| ID| Error Message | | -------- | -------------------------------------------- | -| | | -| | | -| | | -| | | -| | | - - - - - - - - - +| 202 | Non-system applications use system APIs. | +| 401 | Parameter error. | +| 8300001 | Invalid parameter value. | +| 8300002 | Operation failed. Cannot connect to service. | +| 8300003 | System internal error. | + +**Example** + +```js +call.startDTMF(1, "0").then(() => { + console.log(`startDTMF success.`); +}).catch((err) => { + console.error(`startDTMF fail, promise: err->${JSON.stringify(err)}`); +}); ``` -## +## call.stopDTMF7+ - +stopDTMF\(callId: number, callback: AsyncCallback\\): 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** -| | | | | +| Name | Type | Mandatory| Description | | -------- | ------------------------- | ---- | ---------- | -| | | | | -| | | | | +| callId | number | Yes | Call ID. | +| callback | AsyncCallback<void> | Yes | Callback used to return the result.| - +**Error codes** - +For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md). -| | | +| ID| Error Message | | -------- | -------------------------------------------- | -| | | -| | | -| | | -| | | -| | | - - - - - - - +| 202 | Non-system applications use system APIs. | +| 401 | Parameter error. | +| 8300001 | Invalid parameter value. | +| 8300002 | Operation failed. Cannot connect to service. | +| 8300003 | System internal error. | + +**Example** + +```js +call.stopDTMF(1, (err) => { + console.log(`callback: err->${JSON.stringify(err)}`); +}); ``` -## +## call.stopDTMF7+ - +stopDTMF\(callId: number\): Promise\ - +Stops DTMF. This API uses a promise to return the result. - +**System API**: This is a system API. - +**System capability**: SystemCapability.Telephony.CallManager - +**Parameters** -| | | | | +| Name| Type | Mandatory| Description | | ------ | ------ | ---- | -------- | -| | | | | +| callId | number | Yes | Call ID.| - +**Return value** -| | | +| Type | Description | | ------------------- | --------------------------- | -| | | +| Promise<void> | Promise used to return the result.| - +**Error codes** - +For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md). -| | | +| ID| Error Message | | -------- | -------------------------------------------- | -| | | -| | | -| | | -| | | -| | | - - - - - - - - - +| 202 | Non-system applications use system APIs. | +| 401 | Parameter error. | +| 8300001 | Invalid parameter value. | +| 8300002 | Operation failed. Cannot connect to service. | +| 8300003 | System internal error. | + +**Example** + +```js +call.stopDTMF(1).then(() => { + console.log(`stopDTMF success.`); +}).catch((err) => { + console.error(`stopDTMF fail, promise: err->${JSON.stringify(err)}`); +}); ``` -## +## call.isInEmergencyCall7+ - +isInEmergencyCall\(callback: AsyncCallback\\): 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** -| | | | | +| Name | Type | Mandatory| Description | | -------- | ---------------------------- | ---- | ---------- | -| | | | | +| callback | AsyncCallback<boolean> | Yes | Callback used to return the result.| - +**Error codes** - +For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md). -| | | +| ID| Error Message | | -------- | -------------------------------------------- | -| | | -| | | -| | | -| | | -| | | -| | | -| | | - - - - - - - +| 201 | Permission denied. | +| 202 | Non-system applications use system APIs. | +| 401 | Parameter error. | +| 8300001 | Invalid parameter value. | +| 8300002 | Operation failed. Cannot connect to service. | +| 8300003 | System internal error. | +| 8300999 | Unknown error code. | + +**Example** + +```js +call.isInEmergencyCall((err, data) => { + console.log(`callback: err->${JSON.stringify(err)}, data->${JSON.stringify(data)}`); +}); ``` -## +## call.isInEmergencyCall7+ - +isInEmergencyCall\(\): Promise\ - +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** -| | | +| Type | Description | | ---------------------- | --------------------------- | -| | | +| Promise<boolean> | Promise used to return the result.| - +**Error codes** - +For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md). -| | | +| ID| Error Message | | -------- | -------------------------------------------- | -| | | -| | | -| | | -| | | -| | | - - - - - - - - - - +| 201 | Permission denied. | +| 202 | Non-system applications use system APIs. | +| 8300002 | Operation failed. Cannot connect to service. | +| 8300003 | System internal error. | +| 8300999 | Unknown error code. | + +**Example** + +```js +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')7+ - +on\(type: 'callDetailsChange', callback: Callback\\): 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** -| | | | | +| Name | Type | Mandatory| Description | | -------- | ------------------------------------------------------- | ---- | -------------------------- | -| | | | | -| | | | | +| type | string | Yes | Call event change. This field has a fixed value of **callDetailsChange**.| +| callback | Callback<[CallAttributeOptions](#callattributeoptions7)> | Yes | Callback used to return the result. | - +**Error codes** - +For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md). -| | | +| ID| Error Message | | -------- | -------------------------------------------- | -| | | -| | | -| | | -| | | -| | | -| | | -| | | - - - - - - - +| 201 | Permission denied. | +| 202 | Non-system applications use system APIs. | +| 401 | Parameter error. | +| 8300001 | Invalid parameter value. | +| 8300002 | Operation failed. Cannot connect to service. | +| 8300003 | System internal error. | +| 8300999 | Unknown error code. | + +**Example** + +```js +call.on('callDetailsChange', data => { + console.log(`callback: data->${JSON.stringify(data)}`); +}); ``` -## +## call.on('callEventChange')8+ - +on\(type: 'callEventChange', callback: Callback\\): 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** -| | | | | +| Name | Type | Mandatory| Description | | -------- | ------------------------------------------------ | ---- | -------------------------- | -| | | | | -| | | | | +| type | string | Yes | Call event change. This field has a fixed value of **callEventChange**.| +| callback | Callback<[CallEventOptions](#calleventoptions8)> | Yes | Callback used to return the result. | - +**Error codes** - +For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md). -| | | +| ID| Error Message | | -------- | -------------------------------------------- | -| | | -| | | -| | | -| | | -| | | -| | | -| | | - - - - - - - +| 201 | Permission denied. | +| 202 | Non-system applications use system APIs. | +| 401 | Parameter error. | +| 8300001 | Invalid parameter value. | +| 8300002 | Operation failed. Cannot connect to service. | +| 8300003 | System internal error. | +| 8300999 | Unknown error code. | + +**Example** + +```js +call.on('callEventChange', data => { + console.log(`callback: data->${JSON.stringify(data)}`); +}); ``` -## +## call.on('callDisconnectedCause')8+ - +on\(type: 'callDisconnectedCause', callback: Callback\\): 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** -| | | | | +| Name | Type | Mandatory| Description | | -------- | ------------------------------------------------------ | ---- | -------------------------- | -| | | | | -| | | | | +| type | string | Yes | Call disconnection cause. This field has a fixed value of **callDisconnectedCause**.| +| callback | Callback<[DisconnectedDetails](#disconnecteddetails9)> | Yes | Callback used to return the result. | - +**Error codes** - +For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md). -| | | +| ID| Error Message | | -------- | -------------------------------------------- | -| | | -| | | -| | | -| | | -| | | -| | | -| | | - - - - - - - +| 201 | Permission denied. | +| 202 | Non-system applications use system APIs. | +| 401 | Parameter error. | +| 8300001 | Invalid parameter value. | +| 8300002 | Operation failed. Cannot connect to service. | +| 8300003 | System internal error. | +| 8300999 | Unknown error code. | + +**Example** + +```js +call.on('callDisconnectedCause', data => { + console.log(`callback: data->${JSON.stringify(data)}`); +}); ``` -## +## call.on('mmiCodeResult')9+ - +on\(type: 'mmiCodeResult', callback: Callback\\): 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** -| | | | | +| Name | Type | Mandatory| Description | | -------- | -------------------------------------------- | ---- | --------------------- | -| | | | | -| | | | | +| type | string | Yes | MMI code result. This field has a fixed value of **mmiCodeResult**.| +| callback | Callback<[MmiCodeResults](#mmicoderesults9)> | Yes | Callback used to return the result. | - +**Error codes** - +For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md). -| | | +| ID| Error Message | | -------- | -------------------------------------------- | -| | | -| | | -| | | -| | | -| | | -| | | -| | | - - - - - - - +| 201 | Permission denied. | +| 202 | Non-system applications use system APIs. | +| 401 | Parameter error. | +| 8300001 | Invalid parameter value. | +| 8300002 | Operation failed. Cannot connect to service. | +| 8300003 | System internal error. | +| 8300999 | Unknown error code. | + +**Example** + +```js +call.on('mmiCodeResult', data => { + console.log(`callback: data->${JSON.stringify(data)}`); +}); ``` -## +## call.off('callDetailsChange')7+ - +off\(type: 'callDetailsChange', callback?: Callback\\): 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** -| | | | | +| Name | Type | Mandatory| Description | | -------- | -------------------------------------------------------- | ---- | ---------------------------------- | -| | | | | -| | | | | +| type | string | Yes | Call details change. This field has a fixed value of **callDetailsChange**.| +| callback | Callback<[CallAttributeOptions](#callattributeoptions7)> | No | Callback used to return the result. If this parameter is not set, no subscription cancellation result will be received.| - +**Error codes** - +For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md). -| | | +| ID| Error Message | | -------- | -------------------------------------------- | -| | | -| | | -| | | -| | | -| | | -| | | -| | | - - - - - - - +| 201 | Permission denied. | +| 202 | Non-system applications use system APIs. | +| 401 | Parameter error. | +| 8300001 | Invalid parameter value. | +| 8300002 | Operation failed. Cannot connect to service. | +| 8300003 | System internal error. | +| 8300999 | Unknown error code. | + +**Example** + +```js +call.off('callDetailsChange', data => { + console.log(`callback: data->${JSON.stringify(data)}`); +}); ``` -## +## call.off('callEventChange')8+ - +off\(type: 'callEventChange', callback?: Callback\\): 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** -| | | | | +| Name | Type | Mandatory| Description | | -------- | ------------------------------------------------ | ---- | ---------------------------------- | -| | | | | -| | | | | +| type | string | Yes | Call event change. This field has a fixed value of **callEventChange**.| +| callback | Callback<[CallEventOptions](#calleventoptions8)> | No | Callback used to return the result. If this parameter is not set, no subscription cancellation result will be received.| - +**Error codes** - +For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md). -| | | +| ID| Error Message | | -------- | -------------------------------------------- | -| | | -| | | -| | | -| | | -| | | -| | | -| | | - - - - - - - +| 201 | Permission denied. | +| 202 | Non-system applications use system APIs. | +| 401 | Parameter error. | +| 8300001 | Invalid parameter value. | +| 8300002 | Operation failed. Cannot connect to service. | +| 8300003 | System internal error. | +| 8300999 | Unknown error code. | + +**Example** + +```js +call.off('callEventChange', data => { + console.log(`callback: data->${JSON.stringify(data)}`); +}); ``` -## +## call.off('callDisconnectedCause')8+ - +off\(type: 'callDisconnectedCause', callback?: Callback\\): 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** -| | | | | +| Name | Type | Mandatory| Description | | -------- | ---------------------------------------------------------- | ---- | ------------------- | -| | | | | -| | | | | +| type | string | Yes | Call disconnection cause. This field has a fixed value of **callDisconnectedCause**.| +| callback | Callback<[DisconnectedDetails](#disconnecteddetails9)> | No | Callback used to return the result. If this parameter is not set, no subscription cancellation result will be received.| - +**Error codes** - +For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md). -| | | +| ID| Error Message | | -------- | -------------------------------------------- | -| | | -| | | -| | | -| | | -| | | -| | | -| | | - - - - - - - +| 201 | Permission denied. | +| 202 | Non-system applications use system APIs. | +| 401 | Parameter error. | +| 8300001 | Invalid parameter value. | +| 8300002 | Operation failed. Cannot connect to service. | +| 8300003 | System internal error. | +| 8300999 | Unknown error code. | + +**Example** + +```js +call.off('callDisconnectedCause', data => { + console.log(`callback: data->${JSON.stringify(data)}`); +}); ``` -## +## call.off('mmiCodeResult')9+ - +off\(type: 'mmiCodeResult', callback?: Callback\\): 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** -| | | | | +| Name | Type | Mandatory| Description | | -------- | ------------------------------------------------ | ---- | ----------- | -| | | | | -| | | | | +| type | string | Yes | MMI code result. This field has a fixed value of **mmiCodeResult**.| +| callback | Callback<[MmiCodeResults](#mmicoderesults9)> | No | Callback used to return the result. If this parameter is not set, no subscription cancellation result will be received.| - +**Error codes** - +For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md). -| | | +| ID| Error Message | | -------- | -------------------------------------------- | -| | | -| | | -| | | -| | | -| | | -| | | -| | | - - - - - - - +| 201 | Permission denied. | +| 202 | Non-system applications use system APIs. | +| 401 | Parameter error. | +| 8300001 | Invalid parameter value. | +| 8300002 | Operation failed. Cannot connect to service. | +| 8300003 | System internal error. | +| 8300999 | Unknown error code. | + +**Example** + +```js +call.off('mmiCodeResult', data => { + console.log(`callback: data->${JSON.stringify(data)}`); +}); ``` -## +## call.on('audioDeviceChange')10+ - +on\(type: 'audioDeviceChange', callback: Callback\\): void - +Subscribes to audio device change 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** -| | | | | +| Name | Type | Mandatory| Description | | -------- | ----------------------------------------------- | ---- | --------------------------------------------------- | -| | | | | -| | | | | +| type | string | Yes | Audio device change. This field has a fixed value of **audioDeviceChange**.| +| callback | Callback<[AudioDeviceInfo](#audiodeviceinfo10)> | Yes | Callback used to return the result. | - +**Error codes** - +For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md). -| | | +| ID| Error Message | | -------- | -------------------------------------------- | -| | | -| | | -| | | -| | | -| | | -| | | -| | | - - - - - - - +| 201 | Permission denied. | +| 202 | Non-system applications use system APIs. | +| 401 | Parameter error. | +| 8300001 | Invalid parameter value. | +| 8300002 | Operation failed. Cannot connect to service. | +| 8300003 | System internal error. | +| 8300999 | Unknown error code. | + +**Example** + +```js +call.on('audioDeviceChange', data => { + console.log(`callback: data->${JSON.stringify(data)}`); +}); ``` -## +## call.off('audioDeviceChange')10+ - +off\(type: 'audioDeviceChange', callback?: Callback\\): void - +Unsubscribes from **audioDeviceChange** 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** -| | | | | +| Name | Type | Mandatory | Description | | -------- | ---------------------------------------------------------- | ---- | --------------------------------------------------- | -| | | | | -| | | | | +| type | string | Yes | Audio device change. This field has a fixed value of **audioDeviceChange**.| +| callback | Callback<[AudioDeviceInfo](#audiodeviceinfo10)> | No | Callback used to return the result. If this parameter is not set, no subscription cancellation result will be received. | - +**Error codes** - +For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md). -| | | +| ID| Error Message | | -------- | -------------------------------------------- | -| | | -| | | -| | | -| | | -| | | -| | | -| | | - - - - - - - +| 201 | Permission denied. | +| 202 | Non-system applications use system APIs. | +| 401 | Parameter error. | +| 8300001 | Invalid parameter value. | +| 8300002 | Operation failed. Cannot connect to service. | +| 8300003 | System internal error. | +| 8300999 | Unknown error code. | + +**Example** + +```js +call.off('audioDeviceChange', data => { + console.log(`callback: data->${JSON.stringify(data)}`); +}); ``` -## +## call.isNewCallAllowed8+ - +isNewCallAllowed\(callback: AsyncCallback\\): 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** -| | | | | +| Name | Type | Mandatory| Description | | -------- | ---------------------------- | ---- | ---------- | -| | | | | +| callback | AsyncCallback<boolean> | Yes | Callback used to return the result.| - +**Error codes** - +For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md). -| | | +| ID| Error Message | | -------- | -------------------------------------------- | -| | | -| | | -| | | -| | | -| | | -| | | - - - - - - - +| 202 | Non-system applications use system APIs. | +| 401 | Parameter error. | +| 8300001 | Invalid parameter value. | +| 8300002 | Operation failed. Cannot connect to service. | +| 8300003 | System internal error. | +| 8300999 | Unknown error code. | + +**Example** + +```js +call.isNewCallAllowed((err, data) => { + console.log(`callback: err->${JSON.stringify(err)}, data->${JSON.stringify(data)}`); +}); ``` -## +## call.isNewCallAllowed8+ - +isNewCallAllowed\(\): Promise\ - +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** -| | | +| Type | Description | | ---------------------- | --------------------------- | -| | | +| Promise<boolean> | Promise used to return the result.| - +**Error codes** - +For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md). -| | | +| ID| Error Message | | -------- | -------------------------------------------- | -| | | -| | | -| | | -| | | - - - - - - - - - - +| 202 | Non-system applications use system APIs. | +| 8300002 | Operation failed. Cannot connect to service. | +| 8300003 | System internal error. | +| 8300999 | Unknown error code. | + +**Example** + +```js +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.separateConference8+ - +separateConference\(callId: number, callback: AsyncCallback\\): 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** -| | | | | +| Name | Type | Mandatory| Description | | -------- | ------------------------- | ---- | ---------- | -| | | | | -| | | | | +| callId | number | Yes | Call ID. | +| callback | AsyncCallback<void> | Yes | Callback used to return the result.| - +**Error codes** - +For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md). -| | | +| ID| Error Message | | -------- | -------------------------------------------- | -| | | -| | | -| | | -| | | -| | | -| | | - - - - - - - +| 202 | Non-system applications use system APIs. | +| 401 | Parameter error. | +| 8300001 | Invalid parameter value. | +| 8300002 | Operation failed. Cannot connect to service. | +| 8300003 | System internal error. | +| 8300999 | Unknown error code. | + +**Example** + +```js +call.separateConference(1, (err) => { + console.log(`callback: err->${JSON.stringify(err)}`); +}); ``` -## +## call.separateConference8+ - +separateConference\(callId: number\): Promise\ - +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** -| | | | | +| Name| Type | Mandatory| Description | | ------ | ------ | ---- | -------- | -| | | | | +| callId | number | Yes | Call ID.| - +**Return value** -| | | +| Type | Description | | ------------------- | --------------------------- | -| | | +| Promise<void> | Promise used to return the result.| - +**Error codes** - +For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md). -| | | +| ID| Error Message | | -------- | -------------------------------------------- | -| | | -| | | -| | | -| | | -| | | -| | | - - - - - - - - - +| 202 | Non-system applications use system APIs. | +| 401 | Parameter error. | +| 8300001 | Invalid parameter value. | +| 8300002 | Operation failed. Cannot connect to service. | +| 8300003 | System internal error. | +| 8300999 | Unknown error code. | + +**Example** + +```js +call.separateConference(1).then(() => { + console.log(`separateConference success.`); +}).catch((err) => { + console.error(`separateConference fail, promise: err->${JSON.stringify(err)}`); +}); ``` -## +## call.getCallRestrictionStatus8+ - +getCallRestrictionStatus\(slotId: number, type: CallRestrictionType, callback: AsyncCallback\\): 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** -| | | | | +| Name | Type | Mandatory| Description | | -------- | ------------------------------------------------------------ | ---- | -------------------------------------- | -| | | |

| -| | | | | -| | | | | +| slotId | number | Yes | Card slot ID.
- **0**: card slot 1
- **1**: card slot 2| +| type | [CallRestrictionType](#callrestrictiontype8) | Yes | Call restriction type. | +| callback | AsyncCallback<[RestrictionStatus](#restrictionstatus8)> | Yes | Callback used to return the result. | - +**Error codes** - +For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md). -| | | +| ID| Error Message | | -------- | -------------------------------------------- | -| | | -| | | -| | | -| | | -| | | -| | | - - - - - - - +| 201 | Permission denied. | +| 202 | Non-system applications use system APIs. | +| 401 | Parameter error. | +| 801 | Capability not supported. | +| 8300001 | Invalid parameter value. | +| 8300002 | Operation failed. Cannot connect to service. | +| 8300003 | System internal error. | + +**Example** + +```js +call.getCallRestrictionStatus(0, 1, (err, data) => { + console.log(`callback: err->${JSON.stringify(err)}, data->${JSON.stringify(data)}`); +}); ``` -## +## call.getCallRestrictionStatus8+ - +getCallRestrictionStatus\(slotId: number, type: CallRestrictionType\): Promise\ - +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** -| | | | | +| Name| Type | Mandatory| Description | | ------ | -------------------------------------------- | ---- | -------------------------------------- | -| | | |

| -| | | | | +| slotId | number | Yes | Card slot ID.
- **0**: card slot 1
- **1**: card slot 2| +| type | [CallRestrictionType](#callrestrictiontype8) | Yes | Call restriction type. | - +**Return value** -| | | +| Type | Description | | ------------------------------------------------------- | --------------------------- | -| | | +| Promise<[RestrictionStatus](#restrictionstatus8)> | Promise used to return the result.| - +**Error codes** - +For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md). -| | | +| ID| Error Message | | -------- | -------------------------------------------- | -| | | -| | | -| | | -| | | -| | | -| | | - - - - - - - - - - +| 201 | Permission denied. | +| 202 | Non-system applications use system APIs. | +| 401 | Parameter error. | +| 801 | Capability not supported. | +| 8300001 | Invalid parameter value. | +| 8300002 | Operation failed. Cannot connect to service. | +| 8300003 | System internal error. | + +**Example** + +```js +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.setCallRestriction8+ - +setCallRestriction\(slotId: number, info: CallRestrictionInfo, callback: AsyncCallback\\): 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** -| | | | | +| Name | Type | Mandatory| Description | | -------- | ------------------------------------------- | ---- | -------------------------------------- | -| | | |

| -| | | | | -| | | | | +| slotId | number | Yes | Card slot ID.
- **0**: card slot 1
- **1**: card slot 2| +| info | [CallRestrictionInfo](#callrestrictioninfo8) | Yes | Call restriction information. | +| callback | AsyncCallback<void> | Yes | Callback used to return the result. | - +**Error codes** - +For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md). -| | | +| ID| Error Message | | -------- | -------------------------------------------- | -| | | -| | | -| | | -| | | -| | | -| | | - - - - - - - - +| 201 | Permission denied. | +| 202 | Non-system applications use system APIs. | +| 401 | Parameter error. | +| 801 | Capability not supported. | +| 8300001 | Invalid parameter value. | +| 8300002 | Operation failed. Cannot connect to service. | +| 8300003 | System internal error. | + +**Example** + +```js +let callRestrictionInfo={ + type: 1, + password: "123456", + mode: 1 } - - - +call.setCallRestriction(0, callRestrictionInfo, (err) => { + console.log(`callback: err->${JSON.stringify(err)}`); +}); ``` -## +## call.setCallRestriction8+ - +setCallRestriction\(slotId: number, info: CallRestrictionInfo\): Promise\ - +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** -| | | | | +| Name| Type | Mandatory| Description | | ------ | -------------------------------------------- | ---- | -------------------------------------- | -| | | |

| -| | | | | +| slotId | number | Yes | Card slot ID.
- **0**: card slot 1
- **1**: card slot 2| +| info | [CallRestrictionInfo](#callrestrictioninfo8) | Yes | Call restriction information. | - +**Return value** -| | | +| Type | Description | | ------------------- | --------------------------- | -| | | +| Promise<void> | Promise used to return the result.| - +**Error codes** - +For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md). -| | | +| ID| Error Message | | -------- | -------------------------------------------- | -| | | -| | | -| | | -| | | -| | | -| | | - - - - - - - - +| 201 | Permission denied. | +| 202 | Non-system applications use system APIs. | +| 401 | Parameter error. | +| 801 | Capability not supported. | +| 8300001 | Invalid parameter value. | +| 8300002 | Operation failed. Cannot connect to service. | +| 8300003 | System internal error. | + +**Example** + +```js +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.setCallRestrictionPassword10+ + +setCallRestrictionPassword\(slotId: number, oldPassword: string, newPassword: string, callback: AsyncCallback\\): void + +Changes the call barring password. 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** + +| Name | Type | Mandatory| Description | +| --------------- | ------------------------------------------- | ---- | ------------------------------------ | +| slotId | number | Yes | Card slot ID.
- **0**: card slot 1
- **1**: card slot 2| +| oldPassword | string | Yes | Old password for call barring. | +| newPassword | string | Yes | New password for call barring. | +| callback | AsyncCallback<void> | Yes | Callback used to return the result. | + +**Error codes** + +For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md). + +| ID| Error Message | +| -------- | -------------------------------------------- | +| 201 | Permission denied. | +| 202 | Non-system applications use system APIs. | +| 401 | Parameter error. | +| 801 | Capability not supported. | +| 8300001 | Invalid parameter value. | +| 8300002 | Operation failed. Cannot connect to service. | +| 8300003 | System internal error. | + +**Example** + +```js +call.setCallRestrictionPassword(0, "123456", "654321", (err) => { + console.log(`callback: err->${JSON.stringify(err)}`); +}); ``` -## +## call.setCallRestrictionPassword10+ + +setCallRestrictionPassword\(slotId: number, oldPassword: string, newPassword: string\): Promise\ - +Changes the call barring password. 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** - +| Name | Type | Mandatory| Description | +| --------------- | ------------------------------------------- | ---- | ------------------------------------ | +| slotId | number | Yes | Card slot ID.
- **0**: card slot 1
- **1**: card slot 2| +| oldPassword | string | Yes | Old password for call barring. | +| newPassword | string | Yes | New password for call barring. | -| | | | | +**Return value** + +| Type | Description | +| ------------------- | --------------------------- | +| Promise<void> | Promise used to return the result.| + +**Error codes** + +For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md). + +| ID| Error Message | +| -------- | -------------------------------------------- | +| 201 | Permission denied. | +| 202 | Non-system applications use system APIs. | +| 401 | Parameter error. | +| 801 | Capability not supported. | +| 8300001 | Invalid parameter value. | +| 8300002 | Operation failed. Cannot connect to service. | +| 8300003 | System internal error. | + +**Example** + +```js +call.setCallRestrictionPassword(0, "123456", "654321").then(() => { + console.log(`setCallRestrictionPassword success.`); +}).catch((err) => { + console.error(`setCallRestrictionPassword fail, promise: err->${JSON.stringify(err)}`); +}); +``` + +## call.getCallTransferInfo8+ + +getCallTransferInfo\(slotId: number, type: CallTransferType, callback: AsyncCallback\\): 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** + +| Name | Type | Mandatory| Description | | -------- | ------------------------------------------------------------ | ---- | -------------------------------------- | -| | | |

| -| | | | | -| | | | | +| slotId | number | Yes | Card slot ID.
- **0**: card slot 1
- **1**: card slot 2| +| type | [CallTransferType](#calltransfertype8) | Yes | Call transfer type. | +| callback | AsyncCallback<[CallTransferResult](#calltransferresult8)> | Yes | Callback used to return the result. | - +**Error codes** - +For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md). -| | | +| ID| Error Message | | -------- | -------------------------------------------- | -| | | -| | | -| | | -| | | -| | | -| | | - - - - - - - +| 201 | Permission denied. | +| 202 | Non-system applications use system APIs. | +| 401 | Parameter error. | +| 801 | Capability not supported. | +| 8300001 | Invalid parameter value. | +| 8300002 | Operation failed. Cannot connect to service. | +| 8300003 | System internal error. | + +**Example** + +```js +call.getCallTransferInfo(0, call.CallTransferType.TRANSFER_TYPE_BUSY, (err, data) => { + console.log(`callback: err->${JSON.stringify(err)}, data->${JSON.stringify(data)}`); +}); ``` -## +## call.getCallTransferInfo8+ - +getCallTransferInfo\(slotId: number, type: CallTransferType\): Promise\ - +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** -| | | | | +| Name| Type | Mandatory| Description | | ------ | -------------------------------------- | ---- | -------------------------------------- | -| | | |

| -| | | | | +| slotId | number | Yes | Card slot ID.
- **0**: card slot 1
- **1**: card slot 2| +| type | [CallTransferType](#calltransfertype8) | Yes | Call transfer type. | - +**Return value** -| | | +| Type | Description | | --------------------------------------------------------- | --------------------------- | -| | | +| Promise<[CallTransferResult](#calltransferresult8)> | Promise used to return the result.| - +**Error codes** - +For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md). -| | | +| ID| Error Message | | -------- | -------------------------------------------- | -| | | -| | | -| | | -| | | -| | | -| | | - - - - - - - - - - +| 201 | Permission denied. | +| 202 | Non-system applications use system APIs. | +| 401 | Parameter error. | +| 801 | Capability not supported. | +| 8300001 | Invalid parameter value. | +| 8300002 | Operation failed. Cannot connect to service. | +| 8300003 | System internal error. | + +**Example** + +```js +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.setCallTransfer8+ - +setCallTransfer\(slotId: number, info: CallTransferInfo, callback: AsyncCallback\\): 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** -| | | | | +| Name | Type | Mandatory| Description | | -------- | ------------------------------------- | ---- | -------------------------------------- | -| | | |

| -| | | | | -| | | | | +| slotId | number | Yes | Card slot ID.
- **0**: card slot 1
- **1**: card slot 2| +| info | [CallTransferInfo](#calltransferinfo8) | Yes | Call transfer information. | +| callback | AsyncCallback<void> | Yes | Callback used to return the result. | - +**Error codes** - +For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md). -| | | +| ID| Error Message | | -------- | -------------------------------------------- | -| | | -| | | -| | | -| | | -| | | -| | | - - - - - - - - +| 201 | Permission denied. | +| 202 | Non-system applications use system APIs. | +| 401 | Parameter error. | +| 801 | Capability not supported. | +| 8300001 | Invalid parameter value. | +| 8300002 | Operation failed. Cannot connect to service. | +| 8300003 | System internal error. | + +**Example** + +```js +let callTransferInfo={ + transferNum: "111", + type: 1, + settingType: 1 } - - - +call.setCallTransfer(0, callTransferInfo, (err) => { + console.log(`callback: err->${JSON.stringify(err)}`); +}); ``` -## +## call.setCallTransfer8+ - +setCallTransfer\(slotId: number, info: CallTransferInfo\): Promise\ - +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** -| | | | | +| Name| Type | Mandatory| Description | | ------ | ------------------------------------- | ---- | -------------------------------------- | -| | | |

| -| | | | | +| slotId | number | Yes | Card slot ID.
- **0**: card slot 1
- **1**: card slot 2| +| info | [CallTransferInfo](#calltransferinfo8) | Yes | Call transfer information. | - +**Return value** -| | | +| Type | Description | | ------------------- | --------------------------- | -| | | +| Promise<void> | Promise used to return the result.| - +**Error codes** - +For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md). -| | | +| ID| Error Message | | -------- | -------------------------------------------- | -| | | -| | | -| | | -| | | -| | | -| | | - - - - - - - - +| 201 | Permission denied. | +| 202 | Non-system applications use system APIs. | +| 401 | Parameter error. | +| 801 | Capability not supported. | +| 8300001 | Invalid parameter value. | +| 8300002 | Operation failed. Cannot connect to service. | +| 8300003 | System internal error. | + +**Example** + +```js +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.isRinging8+ - +isRinging\(callback: AsyncCallback\\): 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** -| | | | | +| Name | Type | Mandatory| Description | | -------- | ---------------------------- | ---- | ---------- | -| | | | | +| callback | AsyncCallback<boolean> | Yes | Callback used to return the result.| - +**Error codes** - +For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md). -| | | +| ID| Error Message | | -------- | -------------------------------------------- | -| | | -| | | -| | | -| | | -| | | -| | | -| | | - - - - - - - +| 201 | Permission denied. | +| 202 | Non-system applications use system APIs. | +| 401 | Parameter error. | +| 8300001 | Invalid parameter value. | +| 8300002 | Operation failed. Cannot connect to service. | +| 8300003 | System internal error. | +| 8300999 | Unknown error code. | + +**Example** + +```js +call.isRinging((err, data) => { + console.log(`callback: err->${JSON.stringify(err)}, data->${JSON.stringify(data)}`); +}); ``` -## +## call.isRinging8+ - +isRinging\(\): Promise\ - +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** -| | | +| Type | Description | | ---------------------- | --------------------------- | -| | | +| Promise<boolean> | Promise used to return the result.| - +**Error codes** - +For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md). -| | | +| ID| Error Message | | -------- | -------------------------------------------- | -| | | -| | | -| | | -| | | -| | | - - - - - - - - - - +| 201 | Permission denied. | +| 202 | Non-system applications use system APIs. | +| 8300002 | Operation failed. Cannot connect to service. | +| 8300003 | System internal error. | +| 8300999 | Unknown error code. | + +**Example** + +```js +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.setMuted8+ - +setMuted\(callback: AsyncCallback\\): 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** -| | | | | +| Name | Type | Mandatory| Description | | -------- | ------------------------- | ---- | ---------- | -| | | | | +| callback | AsyncCallback<void> | Yes | Callback used to return the result.| - +**Error codes** - +For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md). -| | | +| ID| Error Message | | -------- | -------------------------------------------- | -| | | -| | | -| | | -| | | -| | | -| | | - - - - - - - +| 202 | Non-system applications use system APIs. | +| 401 | Parameter error. | +| 8300001 | Invalid parameter value. | +| 8300002 | Operation failed. Cannot connect to service. | +| 8300003 | System internal error. | +| 8300999 | Unknown error code. | + +**Example** + +```js +call.setMuted((err) => { + console.log(`callback: err->${JSON.stringify(err)}`); +}); ``` -## +## call.setMuted8+ - +setMuted\(\): Promise\ - +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** -| | | +| Type | Description | | ------------------- | --------------------------- | -| | | +| Promise<void> | Promise used to return the result.| - +**Error codes** - +For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md). -| | | +| ID| Error Message | | -------- | -------------------------------------------- | -| | | -| | | -| | | -| | | - - - - - - - - - +| 202 | Non-system applications use system APIs. | +| 8300002 | Operation failed. Cannot connect to service. | +| 8300003 | System internal error. | +| 8300999 | Unknown error code. | + +**Example** + +```js +call.setMuted().then(() => { + console.log(`setMuted success.`); +}).catch((err) => { + console.error(`setMuted fail, promise: err->${JSON.stringify(err)}`); +}); ``` -## +## call.cancelMuted8+ - +cancelMuted\(callback: AsyncCallback\\): 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** -| | | | | +| Name | Type | Mandatory| Description | | -------- | ------------------------- | ---- | ---------- | -| | | | | +| callback | AsyncCallback<void> | Yes | Callback used to return the result.| - +**Error codes** - +For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md). -| | | +| ID| Error Message | | -------- | -------------------------------------------- | -| | | -| | | -| | | -| | | -| | | -| | | - - - - - - - +| 202 | Non-system applications use system APIs. | +| 401 | Parameter error. | +| 8300001 | Invalid parameter value. | +| 8300002 | Operation failed. Cannot connect to service. | +| 8300003 | System internal error. | +| 8300999 | Unknown error code. | + +**Example** + +```js +call.cancelMuted((err) => { + console.log(`callback: err->${JSON.stringify(err)}`); +}); ``` -## +## call.cancelMuted8+ - +cancelMuted\(\): Promise\ - +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** -| | | +| Type | Description | | ------------------- | --------------------------- | -| | | +| Promise<void> | Promise used to return the result.| - +**Error codes** - +For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md). -| | | +| ID| Error Message | | -------- | -------------------------------------------- | -| | | -| | | -| | | -| | | - - - - - - - - - +| 202 | Non-system applications use system APIs. | +| 8300002 | Operation failed. Cannot connect to service. | +| 8300003 | System internal error. | +| 8300999 | Unknown error code. | + +**Example** + +```js +call.cancelMuted().then(() => { + console.log(`cancelMuted success.`); +}).catch((err) => { + console.error(`cancelMuted fail, promise: err->${JSON.stringify(err)}`); +}); ``` -## +## call.setAudioDevice8+ - +setAudioDevice\(device: AudioDevice, callback: AsyncCallback\\): 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. - +**Required permission**: ohos.permission.SET_TELEPHONY_STATE - +**System capability**: SystemCapability.Telephony.CallManager - +**Parameters** -| | | | | +| Name | Type | Mandatory| Description | | -------- | ---------------------------- | ---- | ---------- | -| | | | | -| | | | | +| device | [AudioDevice](#audiodevice10)| Yes | Audio device.| +| callback | AsyncCallback<void> | Yes | Callback used to return the result.| - +**Error codes** - +For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md). -| | | +| ID| Error Message | | -------- | -------------------------------------------- | -| | | -| | | -| | | -| | | -| | | -| | | -| | | - - - - - - +| 201 | Permission denied. | +| 202 | Non-system applications use system APIs. | +| 401 | Parameter error. | +| 8300001 | Invalid parameter value. | +| 8300002 | Operation failed. Cannot connect to service. | +| 8300003 | System internal error. | +| 8300999 | Unknown error code. | + +**Example** + +```js +let audioDevice={ + deviceType: 1 } - - - +call.setAudioDevice(audioDevice, (err) => { + console.log(`callback: err->${JSON.stringify(err)}`); +}); ``` -## +## call.setAudioDevice10+ - +setAudioDevice\(device: AudioDevice): Promise\ - +Sets the audio device for a 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 - +**Parameters** -| | | | | +| Name | Type | Mandatory| Description | | -------- | ---------------------------- | ---- | ---------- | -| | | | | +| device | [AudioDevice](#audiodevice10)| Yes | Audio device.| - +**Return value** -| | | +| Type | Description | | ------------------- | --------------------------- | -| | | +| Promise<void> | Promise used to return the result.| - +**Error codes** - +For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md). -| | | +| ID| Error Message | | -------- | -------------------------------------------- | -| | | -| | | -| | | -| | | -| | | -| | | -| | | - - - - - - +| 201 | Permission denied. | +| 202 | Non-system applications use system APIs. | +| 401 | Parameter error. | +| 8300001 | Invalid parameter value. | +| 8300002 | Operation failed. Cannot connect to service. | +| 8300003 | System internal error. | +| 8300999 | Unknown error code. | + +**Example** + +```js +let audioDevice={ + deviceType: 1 } - - - - - +call.setAudioDevice(audioDevice).then(() => { + console.log(`setAudioDevice success.`); +}).catch((err) => { + console.error(`setAudioDevice fail, promise: err->${JSON.stringify(err)}`); +}); ``` -## +## call.joinConference8+ - +joinConference\(mainCallId: number, callNumberList: Array\, callback: AsyncCallback\\): 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** -| | | | | +| Name | Type | Mandatory| Description | | -------------- | ------------------------- | ---- | --------------- | -| | | | | -| | | | | -| | | | | +| mainCallId | number | Yes | Main call ID. | +| callNumberList | Array | Yes | List of call numbers.| +| callback | AsyncCallback<void> | Yes | Callback used to return the result. | - +**Error codes** - +For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md). -| | | +| ID| Error Message | | -------- | -------------------------------------------- | -| | | -| | | -| | | -| | | -| | | -| | | - - - - - - - - - - +| 202 | Non-system applications use system APIs. | +| 401 | Parameter error. | +| 8300001 | Invalid parameter value. | +| 8300002 | Operation failed. Cannot connect to service. | +| 8300003 | System internal error. | +| 8300999 | Unknown error code. | + +**Example** + +```js +let callNumberList: Array = [ + "138XXXXXXXX" +]; +call.joinConference(1, callNumberList, (err) => { + console.log(`callback: err->${JSON.stringify(err)}`); +}); ``` -## +## call.joinConference8+ - +joinConference\(mainCallId: number, callNumberList: Array\\): Promise\ - +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** -| | | | | +| Name | Type | Mandatory| Description | | -------------- | -------------- | ---- | --------------- | -| | | | | -| | | | | +| mainCallId | number | Yes | Main call ID. | +| callNumberList | Array | Yes | List of call numbers.| - +**Return value** -| | | +| Type | Description | | ------------------- | --------------------------- | -| | | +| Promise<void> | Promise used to return the result.| - +**Error codes** - +For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md). -| | | +| ID| Error Message | | -------- | -------------------------------------------- | -| | | -| | | -| | | -| | | -| | | -| | | - - - - - - - - - - - - +| 202 | Non-system applications use system APIs. | +| 401 | Parameter error. | +| 8300001 | Invalid parameter value. | +| 8300002 | Operation failed. Cannot connect to service. | +| 8300003 | System internal error. | +| 8300999 | Unknown error code. | + +**Example** + +```js +let callNumberList: Array = [ + "138XXXXXXXX" +]; +call.joinConference(1, callNumberList).then(() => { + console.log(`joinConference success.`); +}).catch((err) => { + console.error(`joinConference fail, promise: err->${JSON.stringify(err)}`); +}); ``` -## +## call.updateImsCallMode8+ - +updateImsCallMode\(callId: number, mode: ImsCallMode, callback: AsyncCallback\\): 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** -| | | | | +| Name | Type | Mandatory| Description | | -------- | ---------------------------- | ---- | -------------- | -| | | | | -| | | | | -| | | | | +| callId | number | Yes | Call ID. | +| mode | [ImsCallMode](#imscallmode8) | Yes | IMS call mode.| +| callback | AsyncCallback<void> | Yes | Callback used to return the result. | - +**Error codes** - +For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md). -| | | +| ID| Error Message | | -------- | -------------------------------------------- | -| | | -| | | -| | | -| | | -| | | -| | | - - - - - - - +| 202 | Non-system applications use system APIs. | +| 401 | Parameter error. | +| 8300001 | Invalid parameter value. | +| 8300002 | Operation failed. Cannot connect to service. | +| 8300003 | System internal error. | +| 8300999 | Unknown error code. | + +**Example** + +```js +call.updateImsCallMode(1, 1, (err) => { + console.log(`callback: err->${JSON.stringify(err)}`); +}); ``` -## +## call.updateImsCallMode8+ - +updateImsCallMode\(callId: number, mode: ImsCallMode\): Promise\ - +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** -| | | | | +| Name| Type | Mandatory| Description | | ------ | ---------------------------- | ---- | -------------- | -| | | | | -| | | | | +| callId | number | Yes | Call ID. | +| mode | [ImsCallMode](#imscallmode8) | Yes | IMS call mode.| - +**Return value** -| | | +| Type | Description | | ------------------- | --------------------------- | -| | | +| Promise<void> | Promise used to return the result.| - +**Error codes** - +For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md). -| | | +| ID| Error Message | | -------- | -------------------------------------------- | -| | | -| | | -| | | -| | | -| | | -| | | - - - - - - - - - +| 202 | Non-system applications use system APIs. | +| 401 | Parameter error. | +| 8300001 | Invalid parameter value. | +| 8300002 | Operation failed. Cannot connect to service. | +| 8300003 | System internal error. | +| 8300999 | Unknown error code. | + +**Example** + +```js +call.updateImsCallMode(1, 1).then(() => { + console.log(`updateImsCallMode success.`); +}).catch((err) => { + console.error(`updateImsCallMode fail, promise: err->${JSON.stringify(err)}`); +}); ``` -## +## call.enableImsSwitch8+ - +enableImsSwitch\(slotId: number, callback: AsyncCallback\\): void - +Enables the IMS service. 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** -| | | | | +| Name | Type | Mandatory| Description | | -------- | ------------------------- | ---- | -------------------------------------- | -| | | |

| -| | | | | +| slotId | number | Yes | Card slot ID.
- **0**: card slot 1
- **1**: card slot 2| +| callback | AsyncCallback<void> | Yes | Callback used to return the result. | - +**Error codes** - +For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md). -| | | +| ID| Error Message | | -------- | -------------------------------------------- | -| | | -| | | -| | | -| | | -| | | -| | | -| | | - - - - - - - +| 201 | Permission denied. | +| 202 | Non-system applications use system APIs. | +| 401 | Parameter error. | +| 8300001 | Invalid parameter value. | +| 8300002 | Operation failed. Cannot connect to service. | +| 8300003 | System internal error. | +| 8300999 | Unknown error code. | + +**Example** + +```js +call.enableImsSwitch(0, (err) => { + console.log(`callback: err->${JSON.stringify(err)}`); +}); ``` -## +## call.enableImsSwitch8+ - +enableImsSwitch\(slotId: number\): Promise\ - +Enables the IMS service. 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** -| | | | | +| Name| Type | Mandatory| Description | | ------ | ------ | ---- | -------------------------------------- | -| | | |

| +| slotId | number | Yes | Card slot ID.
- **0**: card slot 1
- **1**: card slot 2| - +**Return value** -| | | +| Type | Description | | ------------------- | --------------------------- | -| | | +| Promise<void> | Promise used to return the result.| - +**Error codes** - +For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md). -| | | +| ID| Error Message | | -------- | -------------------------------------------- | -| | | -| | | -| | | -| | | -| | | -| | | -| | | - - - - - - - - - +| 201 | Permission denied. | +| 202 | Non-system applications use system APIs. | +| 401 | Parameter error. | +| 8300001 | Invalid parameter value. | +| 8300002 | Operation failed. Cannot connect to service. | +| 8300003 | System internal error. | +| 8300999 | Unknown error code. | + +**Example** + +```js +call.enableImsSwitch(0).then(() => { + console.log(`enableImsSwitch success.`); +}).catch((err) => { + console.error(`enableImsSwitch fail, promise: err->${JSON.stringify(err)}`); +}); ``` -## +## call.disableImsSwitch8+ - +disableImsSwitch\(slotId: number, callback: AsyncCallback\\): void - +Disables the IMS service. 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** -| | | | | +| Name | Type | Mandatory| Description | | -------- | ------------------------- | ---- | -------------------------------------- | -| | | |

| -| | | | | +| slotId | number | Yes | Card slot ID.
- **0**: card slot 1
- **1**: card slot 2| +| callback | AsyncCallback<void> | Yes | Callback used to return the result. | - +**Error codes** - +For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md). -| | | +| ID| Error Message | | -------- | -------------------------------------------- | -| | | -| | | -| | | -| | | -| | | -| | | -| | | - - - - - - - +| 201 | Permission denied. | +| 202 | Non-system applications use system APIs. | +| 401 | Parameter error. | +| 8300001 | Invalid parameter value. | +| 8300002 | Operation failed. Cannot connect to service. | +| 8300003 | System internal error. | +| 8300999 | Unknown error code. | + +**Example** + +```js +call.disableImsSwitch(0, (err) => { + console.log(`callback: err->${JSON.stringify(err)}`); +}); ``` -## +## call.disableImsSwitch8+ - +disableImsSwitch\(slotId: number\): Promise\ - +Disables the IMS service. 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** -| | | | | +| Name| Type | Mandatory| Description | | ------ | ------ | ---- | -------------------------------------- | -| | | |

| +| slotId | number | Yes | Card slot ID.
- **0**: card slot 1
- **1**: card slot 2 | - +**Return value** -| | | +| Type | Description | | ------------------- | --------------------------- | -| | | +| Promise<void> | Promise used to return the result. | - +**Error codes** - +For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md). -| | | +| ID| Error Message | | -------- | -------------------------------------------- | -| | | -| | | -| | | -| | | -| | | -| | | -| | | - - - - - - - - - +| 201 | Permission denied. | +| 202 | Non-system applications use system APIs. | +| 401 | Parameter error. | +| 8300001 | Invalid parameter value. | +| 8300002 | Operation failed. Cannot connect to service. | +| 8300003 | System internal error. | +| 8300999 | Unknown error code. | + +**Example** + +```js +call.disableImsSwitch(0).then(() => { + console.log(`disableImsSwitch success.`); +}).catch((err) => { + console.error(`disableImsSwitch fail, promise: err->${JSON.stringify(err)}`); +}); ``` -## +## call.isImsSwitchEnabled8+ - +isImsSwitchEnabled\(slotId: number, callback: AsyncCallback\\): void - +Checks whether the IMS service 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** -| | | | | +| 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. | - +**Error codes** - +For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md). -| | | +| ID| Error Message | | -------- | -------------------------------------------- | -| | | -| | | -| | | -| | | -| | | -| | | - - - - - - - +| 202 | Non-system applications use system APIs. | +| 401 | Parameter error. | +| 8300001 | Invalid parameter value. | +| 8300002 | Operation failed. Cannot connect to service. | +| 8300003 | System internal error. | +| 8300999 | Unknown error code. | + +**Example** + +```js +call.isImsSwitchEnabled(0, (err, data) => { + console.log(`callback: err->${JSON.stringify(err)}, data->${JSON.stringify(data)}`); +}); ``` -## +## call.isImsSwitchEnabled8+ - +isImsSwitchEnabled\(slotId: number\): Promise\ - +Checks whether the IMS service is enabled. This API uses a promise to return the result. - +**System API**: This is a system API. - +**System capability**: SystemCapability.Telephony.CallManager - +**Parameters** -| | | | | +| Name| Type | Mandatory| Description | | ------ | ------ | ---- | -------------------------------------- | -| | | |

| +| slotId | number | Yes | Card slot ID.
- **0**: card slot 1
- **1**: card slot 2| - +**Return value** -| | | +| Type | Description | | ------------------- | --------------------------- | -| | | +| Promise<void> | Promise used to return the result.| - +**Error codes** - +For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md). -| | | +| ID| Error Message | | -------- | -------------------------------------------- | -| | | -| | | -| | | -| | | -| | | -| | | - - - - - - - - - - +| 202 | Non-system applications use system APIs. | +| 401 | Parameter error. | +| 8300001 | Invalid parameter value. | +| 8300002 | Operation failed. Cannot connect to service. | +| 8300003 | System internal error. | +| 8300999 | Unknown error code. | + +**Example** + +```js +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)}`); +}); ``` -## +## call.closeUnfinishedUssd10+ - +closeUnfinishedUssd\(slotId: number, callback: AsyncCallback\\): void - +Cancels the unfinished USSD services. 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** -| | | | | +| Name | Type | Mandatory| Description | | -------- | ------------------------- | ---- | -------------------------------------- | -| | | |

| -| | | | | +| slotId | number | Yes | Card slot ID.
- **0**: card slot 1
- **1**: card slot 2 | +| callback | AsyncCallback<void> | Yes | Callback used to return the result. | - +**Error codes** - +For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md). -| | | +| ID| Error Message | | -------- | -------------------------------------------- | -| | | -| | | -| | | -| | | -| | | -| | | -| | | - - - - - - - - +| 201 | Permission denied. | +| 202 | Non-system applications use system APIs. | +| 401 | Parameter error. | +| 8300001 | Invalid parameter value. | +| 8300002 | Operation failed. Cannot connect to service. | +| 8300003 | System internal error. | +| 8300999 | Unknown error code. | + +**Example** + +```js +let slotId = 0; +call.closeUnfinishedUssd(slotId, (err) => { + console.log(`callback: err->${JSON.stringify(err)}`); +}); ``` -## +## call.closeUnfinishedUssd10+ - +closeUnfinishedUssd\(slotId: number\): Promise\ - +Cancels the unfinished USSD services. 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** -| | | | | +| Name| Type | Mandatory| Description | | ------ | ------ | ---- | -------------------------------------- | -| | | |

| +| slotId | number | Yes | Card slot ID.
- **0**: card slot 1
- **1**: card slot 2 | - +**Return value** -| | | +| Type | Description | | ------------------- | --------------------------- | -| | | +| Promise<void> | Promise used to return the result. | - +**Error codes** - +For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md). -| | | +| ID| Error Message | | -------- | -------------------------------------------- | -| | | -| | | -| | | -| | | -| | | -| | | -| | | - - - - - - - - - - +| 201 | Permission denied. | +| 202 | Non-system applications use system APIs. | +| 401 | Parameter error. | +| 8300001 | Invalid parameter value. | +| 8300002 | Operation failed. Cannot connect to service. | +| 8300003 | System internal error. | +| 8300999 | Unknown error code. | + +**Example** + +```js +let slotId = 0; +call.closeUnfinishedUssd(slotId).then(() => { + console.log(`closeUnfinishedUssd success.`); +}).catch((err) => { + console.error(`closeUnfinishedUssd fail, promise: err->${JSON.stringify(err)}`); +}); ``` -## +## call.setVoNRState10+ - +setVoNRState\(slotId: number, state: VoNRState, callback: AsyncCallback\\): void - +Sets the status of the VoNR 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** -| | | | | +| Name | Type | Mandatory| Description | | ----------- | ----------------------------- | ---- | ---------------------------------------------------- | -| | | |

| -| | | | | -| | | | | +| slotId | number | Yes | Card slot ID.
- **0**: card slot 1
- **1**: card slot 2 | +| state | [VoNRState](#vonrstate10) | Yes | Status of the VoNR switch. | +| callback | AsyncCallback<void> | Yes | Callback used to return the result.| - +**Error codes** - +For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md). -| | | +| ID| Error Message | | -------- | -------------------------------------------- | -| | | -| | | -| | | -| | | -| | | -| | | -| | | - - - - - - - - - +| 201 | Permission denied. | +| 202 | Non-system applications use system APIs. | +| 401 | Parameter error. | +| 8300001 | Invalid parameter value. | +| 8300002 | Operation failed. Cannot connect to service. | +| 8300003 | System internal error. | +| 8300999 | Unknown error code. | + +**Example** + +```js +let slotId = 0; +let state = 1; +call.setVoNRState(slotId, state, (err, data) => { + console.log(`callback: err->${JSON.stringify(err)}, data->${JSON.stringify(data)}`); +}); ``` -## +## call.setVoNRState10+ - +setVoNRState\(slotId: number, state: VoNRState\): Promise\ - +Sets the status of the VoNR 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** -| | | | | +| Name | Type | Mandatory| Description | | ----------- | ----------------------------- | ---- | ------------------------------------------- | -| | | |

| -| | | | | +| slotId | number | Yes | Card slot ID.
- **0**: card slot 1
- **1**: card slot 2 | +| state | [VoNRState](#vonrstate10) | Yes | Status of the VoNR switch. | - +**Return value** -| | | +| Type | Description | | ---------------------- | --------------------------------------------- | -| | | +| Promise<void> | Promise used to return the result. | - +**Error codes** - +For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md). -| | | +| ID| Error Message | | -------- | -------------------------------------------- | -| | | -| | | -| | | -| | | -| | | -| | | -| | | - - - - - - - - - - - +| 201 | Permission denied. | +| 202 | Non-system applications use system APIs. | +| 401 | Parameter error. | +| 8300001 | Invalid parameter value. | +| 8300002 | Operation failed. Cannot connect to service. | +| 8300003 | System internal error. | +| 8300999 | Unknown error code. | + +**Example** + +```js +let slotId = 0; +let state = 1; +call.setVoNRState(slotId, state).then((data) => { + console.log(`setVoNRState success, promise: data->${JSON.stringify(data)}`); +}).catch((err) => { + console.error(`setVoNRState fail, promise: err->${JSON.stringify(err)}`); +}); ``` -## +## call.getVoNRState10+ - +getVoNRState\(slotId: number, callback: AsyncCallback\\): void - +Obtains the status of the VoNR switch. 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** -| | | | | +| Name | Type | Mandatory | Description | | ----------- | --------------------------------------------- | ---- | ------------------------------------------------------ | -| | | |

| -| | | | | +| slotId | number | Yes | Card slot ID.
- **0**: card slot 1
- **1**: card slot 2 | +| callback | AsyncCallback<[VoNRState](#vonrstate10)>| Yes | Callback used to return the result. | - +**Error codes** - +For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md). -| | | +| ID| Error Message | | -------- | -------------------------------------------- | -| | | -| | | -| | | -| | | -| | | -| | | -| | | - - - - - - - - +| 201 | Permission denied. | +| 202 | Non-system applications use system APIs. | +| 401 | Parameter error. | +| 8300001 | Invalid parameter value. | +| 8300002 | Operation failed. Cannot connect to service. | +| 8300003 | System internal error. | +| 8300999 | Unknown error code. | + +**Example** + +```js +let slotId = 0; +call.getVoNRState(slotId, (err, data) => { + console.log(`callback: err->${JSON.stringify(err)}, data->${JSON.stringify(data)}`); +}); ``` -## +## call.getVoNRState10+ - +getVoNRState\(slotId: number\): Promise\ - +Obtains the status of the VoNR switch. 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** -| | | | | +| Name | Type | Mandatory| Description | | ----------- | ----------------------------- | ---- | ------------------------------------------- | -| | | |

| +| slotId | number | Yes | Card slot ID.
- **0**: card slot 1
- **1**: card slot 2 | - +**Return value** -| | | +| Type | Description | | ---------------------------------------- | ------------------------------------------- | -| | | +| Promise<[VoNRState](#vonrstate10)> | Promise used to return the result. | - +**Error codes** - +For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md). -| | | +| ID| Error Message | | -------- | -------------------------------------------- | -| | | -| | | -| | | -| | | -| | | -| | | -| | | - - - - - - - - - - - +| 201 | Permission denied. | +| 202 | Non-system applications use system APIs. | +| 401 | Parameter error. | +| 8300001 | Invalid parameter value. | +| 8300002 | Operation failed. Cannot connect to service. | +| 8300003 | System internal error. | +| 8300999 | Unknown error code. | + +**Example** + +```js +let slotId = 0; +let promise = call.getVoNRState(slotId); +promise.then(data => { + console.log(`getVoNRState success, promise: data->${JSON.stringify(data)}`); +}).catch(err => { + console.error(`getVoNRState fail, promise: err->${JSON.stringify(err)}`); +}); ``` -## +## call.canSetCallTransferTime10+ - +canSetCallTransferTime\(slotId: number, callback: AsyncCallback\\): void - +Checks whether the call forwarding time can be set. 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** -| | | | | +| 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. Callback used to return the result. The value **true** indicates that the call forwarding time can be set, and the value **false** indicates the opposite.| - +**Error codes** - +For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md). -| | | +| ID| Error Message | | -------- | -------------------------------------------- | -| | | -| | | -| | | -| | | -| | | -| | | -| | | - - - - - - - - +| 201 | Permission denied. | +| 202 | Non-system applications use system APIs. | +| 401 | Parameter error. | +| 8300001 | Invalid parameter value. | +| 8300002 | Operation failed. Cannot connect to service. | +| 8300003 | System internal error. | +| 8300999 | Unknown error code. | + +**Example** + +```js +let slotId = 0; +call.canSetCallTransferTime(slotId, (err, data) => { + console.log(`callback: err->${JSON.stringify(err)}, data->${JSON.stringify(data)}`); +}); ``` -## +## call.canSetCallTransferTime10+ - +canSetCallTransferTime\(slotId: number\): Promise\ - +Checks whether the call forwarding time can be set. 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** -| | | | | +| 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.| - +**Error codes** - +For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md). -| | | +| ID| Error Message | | -------- | -------------------------------------------- | -| | | -| | | -| | | -| | | -| | | -| | | -| | | - - - - - - - - - - +| 201 | Permission denied. | +| 202 | Non-system applications use system APIs. | +| 401 | Parameter error. | +| 8300001 | Invalid parameter value. | +| 8300002 | Operation failed. Cannot connect to service. | +| 8300003 | System internal error. | +| 8300999 | Unknown error code. | + +**Example** + +```js +let slotId = 0; +call.canSetCallTransferTime(slotId).then((data) => { + console.log(`canSetCallTransferTime success, promise: data->${JSON.stringify(data)}`); +}).catch((err) => { + console.error(`canSetCallTransferTime fail, promise: err->${JSON.stringify(err)}`); +}); ``` -## +## call.inputDialerSpecialCode10+ - +inputDialerSpecialCode\(inputCode: string, callback: AsyncCallback\\): void - +Performs a secret code broadcast. 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** -| | | | | +| Name | Type | Mandatory| Description | | ----------- | ---------------------------- | ---- | ----------------------------------------- | -| | | | | -| | | | | +| inputCode | string | Yes | Secret code, for example, **2846579** (project menu).| +| callback | AsyncCallback<void> | Yes | Callback used to return the result. | - +**Error codes** - +For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md). -| | | +| ID| Error Message | | -------- | -------------------------------------------- | -| | | -| | | -| | | -| | | -| | | -| | | - - - - - - - +| 201 | Permission denied. | +| 202 | Non-system applications use system APIs. | +| 401 | Parameter error. | +| 8300001 | Invalid parameter value. | +| 8300002 | Operation failed. Cannot connect to service. | +| 8300003 | System internal error. | + +**Example** + +```js +call.inputDialerSpecialCode('2846579', (err) => { + console.log(`callback: err->${JSON.stringify(err)}`); +}); ``` -## +## call.inputDialerSpecialCode10+ - +inputDialerSpecialCode\(inputCode: string\): Promise\ - +Performs a secret code broadcast. 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** -| | | | | +| Name | Type | Mandatory| Description | | ----------- | ---------------------------- | ---- | ----------------------------------------- | -| | | | | +| inputCode | string | Yes | Secret code, for example, **2846579** (project menu).| - +**Return value** -| | | +| Type | Description | | ------------------- | --------------------------- | -| | | +| Promise<void> | Promise used to return the result.| - +**Error codes** - +For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md). -| | | +| ID| Error Message | | -------- | -------------------------------------------- | -| | | -| | | -| | | -| | | -| | | -| | | - - - - - - - - - +| 201 | Permission denied. | +| 202 | Non-system applications use system APIs. | +| 401 | Parameter error. | +| 8300001 | Invalid parameter value. | +| 8300002 | Operation failed. Cannot connect to service. | +| 8300003 | System internal error. | + +**Example** + +```js +try { + call.inputDialerSpecialCode('2846579'); + console.log(`inputDialerSpecialCode success`); +} catch (error) { + console.log(`inputDialerSpecialCode fail, promise: err->${JSON.stringify(error)}`); } ``` -## +## call.removeMissedIncomingCallNotification10+ + +removeMissedIncomingCallNotification\(callback: AsyncCallback\\): void + +Removes missed call notifications. This API uses an asynchronous callback to return the result. + +**System API**: This is a system API. + +**Required permissions**: ohos.permission.SET_TELEPHONY_STATE, ohos.permission.READ_CALL_LOG, and ohos.permission.WRITE_CALL_LOG + +**System capability**: SystemCapability.Telephony.CallManager + +**Parameters** + +| Name | Type | Mandatory| Description | +| ----------- | ---------------------------- | ---- | --------------------------------------- | +| callback | AsyncCallback<void> | Yes | Callback used to return the result. | + +**Error codes** + +For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md). + +| ID| Error Message | +| -------- | -------------------------------------------- | +| 201 | Permission denied. | +| 202 | Non-system applications use system APIs. | +| 401 | Parameter error. | +| 8300002 | Operation failed. Cannot connect to service. | +| 8300003 | System internal error. | +| 8300999 | Unknown error code. | + +**Example** + +```js +call.removeMissedIncomingCallNotification((err) => { + console.log(`callback: err->${JSON.stringify(err)}`); +}); +``` + + +## call.removeMissedIncomingCallNotification10+ + +removeMissedIncomingCallNotification\(\): Promise\ + +Removes missed call notifications. This API uses a promise to return the result. + +**System API**: This is a system API. + +**Required permissions**: ohos.permission.SET_TELEPHONY_STATE, ohos.permission.READ_CALL_LOG, and ohos.permission.WRITE_CALL_LOG + +**System capability**: SystemCapability.Telephony.CallManager + +**Return value** + +| Type | Description | +| ------------------- | --------------------------- | +| Promise<void> | Promise used to return the result.| + +**Error codes** + +For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md). + +| ID| Error Message | +| -------- | -------------------------------------------- | +| 201 | Permission denied. | +| 202 | Non-system applications use system APIs. | +| 8300002 | Operation failed. Cannot connect to service. | +| 8300003 | System internal error. | +| 8300999 | Unknown error code. | + +**Example** + +```js +let promise = call.removeMissedIncomingCallNotification(); +promise.then(data => { + console.log(`removeMissedIncomingCallNotification success, promise: data->${JSON.stringify(data)}`); +}).catch(err => { + console.log(`removeMissedIncomingCallNotification failed, promise: err->${JSON.stringify(err)}`); +}); +``` + + +## DialOptions - +Provides an option for determining whether a call is a video call. - +**System capability**: SystemCapability.Telephony.CallManager -| | | | | +| Name | Type | Mandatory| Description | | ------------------------ | ---------------------------------- | ---- | ----------------------------------------------------------------------------------------------- | -| | | |

| -| | | |


| -| | | | | -| | | | | -| | | | | +| extras | boolean | No | Indication of a video call.
- **true**: video call
- **false** (default): voice call | +| accountId 8+ | number | No | Account ID.
- **0**: card slot 1
- **1**: card slot 2
This is a system API. | +| videoState 8+ | [VideoStateType](#videostatetype7) | No | Video state type. This is a system API. | +| dialScene 8+ | [DialScene](#dialscene8) | No | Dialup scenario. This is a system API. | +| dialType 8+ | [DialType](#dialtype8) | No | Dialup type. This is a system API. | -## +## DialCallOptions9+ - +Provides an option for determining whether a call is a video call. - +**System API**: This is a system API. - +**System capability**: SystemCapability.Telephony.CallManager -| | | | | +| Name | Type | Mandatory| Description | | ------------------------ | ---------------------------------- | ---- | ------------------------------------------- | -| | | |


| -| | | | | -| | | | | -| | | | | +| accountId 9+ | number | No | Account ID.
- **0**: card slot 1
- **1**: card slot 2
| +| videoState 9+ | [VideoStateType](#videostatetype7) | No | Video state type. | +| dialScene 9+ | [DialScene](#dialscene8) | No | Dialup scenario. | +| dialType 9+ | [DialType](#dialtype8) | No | Dialup type. | -## +## CallState - +Enumerates call states. - +**System capability**: SystemCapability.Telephony.CallManager -| | | | +| Name | Value | Description | | ------------------ | ---- | ------------------------------------------------------------ | -| | | | -| | | | -| | | | -| | | | +| CALL_STATE_UNKNOWN | -1 | The call status fails to be obtained and is unknown. | +| CALL_STATE_IDLE | 0 | No call is in progress. | +| CALL_STATE_RINGING | 1 | The call is in the ringing or waiting state. | +| CALL_STATE_OFFHOOK | 2 | At least one call is in dialing, active, or on hold, and no new incoming call is ringing or waiting.| -## +## EmergencyNumberOptions7+ - +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 -| | | | | +| Name | Type | Mandatory| Description | | ------ | ------ | ---- | ---------------------------------------------- | -| | | |

| +| slotId | number | No | Card slot ID.
- **0**: card slot 1
- **1**: card slot 2| -## +## NumberFormatOptions7+ - +Provides an option for number formatting. - +**System capability**: SystemCapability.Telephony.CallManager -| | | | | +| Name | Type | Mandatory| Description | | ----------- | ------ | ---- | ---------------------------------------------------------- | -| | | | | +| countryCode | string | No | Country code, for example, **CN** (China). All country codes are supported. The default value is **CN**.| -## +## ImsCallMode8+ - +Enumerates IMS call modes. - +**System API**: This is a system API. - +**System capability**: SystemCapability.Telephony.CallManager -| | | | +| Name | Value | Description | | ---------------------- | ---- | ------------------ | -| | | | -| | | | -| | | | -| | | | -| | | | +| CALL_MODE_AUDIO_ONLY | 0 | Audio call only. | +| CALL_MODE_SEND_ONLY | 1 | Sending calls only. | +| CALL_MODE_RECEIVE_ONLY | 2 | Receiving calls only. | +| CALL_MODE_SEND_RECEIVE | 3 | Sending and receiving calls.| +| CALL_MODE_VIDEO_PAUSED | 4 | Pausing video calls. | -## +## VoNRState10+ - +Enumerates VoNR switch states. - +**System API**: This is a system API. - +**System capability**: SystemCapability.Telephony.CallManager -| | | | +| Name | Value | Description | | ---------------------- | ---- | ----------------- | -| | | | -| | | | +| VONR_STATE_OFF | 0 | Disabled. | +| VONR_STATE_ON | 1 | Enabled. | -## +## AudioDevice10+ - +Enumerates audio devices. - +**System API**: This is a system API. - +**System capability**: SystemCapability.Telephony.CallManager -| | | | | +| Name | Type | Mandatory | Description | | --------------------------------- | ------------------------------------- | ---- | ---------------- | -| | | | | -| | | | | +| deviceType 10+ | [AudioDeviceType](#audiodevicetype10) | Yes | Audio device type. | +| address 10+ | string | No | Audio device address. | -## +## AudioDeviceType10+ - +Enumerates audio device types. - +**System API**: This is a system API. - +**System capability**: SystemCapability.Telephony.CallManager -| | | | +| Name | Value | Description | | -------------------- | ---- | ----------- | -| | | | -| | | | -| | | | -| | | | +| DEVICE_EARPIECE | 0 | Headset device. | +| DEVICE_SPEAKER | 1 | Speaker device. | +| DEVICE_WIRED_HEADSET | 2 | Wired headset device.| +| DEVICE_BLUETOOTH_SCO | 3 | Bluetooth SCO device. | -## +## AudioDeviceInfo10+ - +Defines the audio device information. - +**System API**: This is a system API. - +**System capability**: SystemCapability.Telephony.CallManager -| | | | | +| Name | Type | Mandatory | Description | | --------------------------------- | ------------------------------------- | ---- | ---------------- | -| | | | | -| | | | | -| | | | | +| audioDeviceList 10+ | [Array\](#audiodevice10) | Yes | Audio device list. | +| currentAudioDevice 10+ | [AudioDevice](#audiodevice10) | Yes | Current audio device. | +| isMuted 10+ | boolean | Yes | Whether the audio device is muted. | -## +## CallRestrictionType8+ - +Enumerates call restriction types. - +**System API**: This is a system API. - +**System capability**: SystemCapability.Telephony.CallManager -| | | | +| Name | Value | Description | | --------------------------------------------- | ---- | -------------------------- | -| | | | -| | | | -| | | | -| | | | -| | | | -| | | | -| | | | -| | | | +| RESTRICTION_TYPE_ALL_INCOMING | 0 | Barring of all incoming calls. | +| RESTRICTION_TYPE_ALL_OUTGOING | 1 | Barring of all outgoing calls. | +| RESTRICTION_TYPE_INTERNATIONAL | 2 | Barring of international calls. | +| RESTRICTION_TYPE_INTERNATIONAL_EXCLUDING_HOME | 3 | Barring of international calls except those in the home country.| +| RESTRICTION_TYPE_ROAMING_INCOMING | 4 | Barring of incoming roaming calls. | +| RESTRICTION_TYPE_ALL_CALLS | 5 | Barring of all calls. | +| RESTRICTION_TYPE_OUTGOING_SERVICES | 6 | Barring of outgoing services. | +| RESTRICTION_TYPE_INCOMING_SERVICES | 7 | Barring of incoming services. | -## +## CallTransferInfo8+ - +Defines the call transfer information. - +**System API**: This is a system API. - +**System capability**: SystemCapability.Telephony.CallManager -| | | | | +| Name | Type | Mandatory| Description | | ------------------------ | ---------------------------------------------------- | ---- | ---------------- | -| | | | | -| | | | | -| | | | | -| | | | | -| | | | | -| | | | | -| | | | | +| transferNum | string | Yes | Call transfer number. | +| type | [CallTransferType](#calltransfertype8) | Yes | Call transfer type. | +| settingType | [CallTransferSettingType](#calltransfersettingtype8) | Yes | Call transfer setting type.| +| startHour9+ | number | No | Hour in the start time.| +| startMinute9+ | number | No | Minute in the start time.| +| endHour9+ | number | No | Minute in the end time.| +| endMinute9+ | number | No | Minute in the end time.| -## +## CallTransferType8+ - +Enumerates call transfer types. - +**System API**: This is a system API. - +**System capability**: SystemCapability.Telephony.CallManager -| | | | +| Name | Value | Description | | --------------------------- | ---- | ------------ | -| | | | -| | | | -| | | | -| | | | +| TRANSFER_TYPE_UNCONDITIONAL | 0 | Call forwarding unconditional. | +| TRANSFER_TYPE_BUSY | 1 | Call forwarding busy. | +| TRANSFER_TYPE_NO_REPLY | 2 | Call forwarding on no reply. | +| TRANSFER_TYPE_NOT_REACHABLE | 3 | Call forwarding on no user not reachable.| -## +## CallTransferSettingType8+ - +Enumerates call transfer setting types. - +**System API**: This is a system API. - +**System capability**: SystemCapability.Telephony.CallManager -| | | | +| Name | Value | Description | | -------------------------- | ---- | ------------ | -| | | | -| | | | -| | | | -| | | | +| CALL_TRANSFER_DISABLE | 0 | Disabling of call transfer.| +| CALL_TRANSFER_ENABLE | 1 | Enabling of call transfer.| +| CALL_TRANSFER_REGISTRATION | 3 | Registration of call transfer.| +| CALL_TRANSFER_ERASURE | 4 | Erasing of call transfer.| -## +## CallAttributeOptions7+ - +Defines the call attribute options. - +**System API**: This is a system API. - +**System capability**: SystemCapability.Telephony.CallManager -| | | | | +| Name | Type | Mandatory| Description | | --------------- | ---------------------------------------- | ---- | -------------- | -| | | | | -| | | | | -| | | | | -| | | | | -| | | | | -| | | | | -| | | | | -| | | | | -| | | | | -| | | | | +| accountNumber | string | Yes | Account number. | +| speakerphoneOn | boolean | Yes | Speakerphone on.| +| accountId | number | Yes | Account ID. | +| videoState | [VideoStateType](#videostatetype7) | Yes | Video state type. | +| startTime | number | Yes | Start time. | +| isEcc | boolean | Yes | Whether the call is an ECC. | +| callType | [CallType](#calltype7) | Yes | Call type. | +| callId | number | Yes | Call ID. | +| callState | [DetailedCallState](#detailedcallstate7) | Yes | Detailed call state. | +| conferenceState | [ConferenceState](#conferencestate7) | Yes | Conference state. | -## +## ConferenceState7+ - +Enumerates conference states. - +**System API**: This is a system API. - +**System capability**: SystemCapability.Telephony.CallManager -| | | | +| Name | Value | Description | | ---------------------------- | ---- | -------------- | -| | | | -| | | | -| | | | -| | | | +| TEL_CONFERENCE_IDLE | 0 | Idle state. | +| TEL_CONFERENCE_ACTIVE | 1 | Active state. | +| TEL_CONFERENCE_DISCONNECTING | 2 | Disconnecting state. | +| TEL_CONFERENCE_DISCONNECTED | 3 | Disconnected state.| -## +## CallType7+ - +Enumerates call types. - +**System API**: This is a system API. - +**System capability**: SystemCapability.Telephony.CallManager -| | | | +| Name | Value | Description | | ------------- | ---- | ------------ | -| | | | -| | | | -| | | | -| | | | +| TYPE_CS | 0 | CS call. | +| TYPE_IMS | 1 | IMS call. | +| TYPE_OTT | 2 | OTT call. | +| TYPE_ERR_CALL | 3 | Error call type.| -## +## VideoStateType7+ - +Video state type. - +**System API**: This is a system API. - +**System capability**: SystemCapability.Telephony.CallManager -| | | | +| Name | Value | Description | | ---------- | ---- | -------- | -| | | | -| | | | +| TYPE_VOICE | 0 | Voice state.| +| TYPE_VIDEO | 1 | Video state.| -## +## DetailedCallState7+ - +Enumerates detailed call states. - +**System API**: This is a system API. - +**System capability**: SystemCapability.Telephony.CallManager -| | | | +| Name | Value | Description | | ------------------------- | ---- | -------------- | -| | | | -| | | | -| | | | -| | | | -| | | | -| | | | -| | | | -| | | | -| | | | +| CALL_STATUS_ACTIVE | 0 | Active state. | +| CALL_STATUS_HOLDING | 1 | Hold state. | +| CALL_STATUS_DIALING | 2 | Dialing state. | +| CALL_STATUS_ALERTING | 3 | Alerting state. | +| CALL_STATUS_INCOMING | 4 | Incoming state. | +| CALL_STATUS_WAITING | 5 | Waiting state. | +| CALL_STATUS_DISCONNECTED | 6 | Disconnected state.| +| CALL_STATUS_DISCONNECTING | 7 | Disconnecting state. | +| CALL_STATUS_IDLE | 8 | Idle state. | -## +## CallRestrictionInfo8+ - +Defines the call restriction information. - +**System API**: This is a system API. - +**System capability**: SystemCapability.Telephony.CallManager -| | | | | +| Name | Type | Mandatory| Description | | -------- | -------------------------------------------- | ---- | ------------ | -| | | | | -| | | | | -| | | | | +| type | [CallRestrictionType](#callrestrictiontype8) | Yes | Call restriction type.| +| password | string | Yes | Password. | +| mode | [CallRestrictionMode](#callrestrictionmode8) | Yes | Call restriction mode.| -## +## CallRestrictionMode8+ - +Enumerates call restriction modes. - +**System API**: This is a system API. - +**System capability**: SystemCapability.Telephony.CallManager -| | | | +| Name | Value | Description | | ----------------------------- | ---- | ------------ | -| | | | -| | | | +| RESTRICTION_MODE_DEACTIVATION | 0 | Call restriction deactivated.| +| RESTRICTION_MODE_ACTIVATION | 1 | Call restriction activated.| -## +## CallEventOptions8+ - +Defines the call event options. - +**System API**: This is a system API. - +**System capability**: SystemCapability.Telephony.CallManager -| | | | | +| Name | Type | Mandatory| Description | | ------- | ------------------------------------------ | ---- | -------------- | -| | | | | +| eventId | [CallAbilityEventId](#callabilityeventid8) | Yes | Call ability event ID.| -## +## CallAbilityEventId8+ - +Enumerates call ability event IDs. - +**System API**: This is a system API. - +**System capability**: SystemCapability.Telephony.CallManager -| | | | +| Name | Value | Description | | ------------------------ | ---- | --------------- | -| | | | -| | | | +| EVENT_DIAL_NO_CARRIER | 1 | No available carrier during dialing. | +| EVENT_INVALID_FDN_NUMBER | 2 | Invalid FDN.| -## +## DialScene8+ - +Enumerates dialup scenarios. - +**System API**: This is a system API. - +**System capability**: SystemCapability.Telephony.CallManager -| | | | +| Name | Value | Description | | --------------- | ---- | ------------ | -| | | | -| | | | -| | | | +| CALL_NORMAL | 0 | Common call. | +| CALL_PRIVILEGED | 1 | Privileged call. | +| CALL_EMERGENCY | 2 | Emergency call.| -## +## DialType8+ - +Enumerates dialup types. - +**System API**: This is a system API. - +**System capability**: SystemCapability.Telephony.CallManager -| | | | +| Name | Value | Description | | -------------------- | ---- | ---------------- | -| | | | -| | | | -| | | | +| DIAL_CARRIER_TYPE | 0 | Carrier. | +| DIAL_VOICE_MAIL_TYPE | 1 | Voice mail.| +| DIAL_OTT_TYPE | 2 | OTT. | -## +## RejectMessageOptions7+ - +Defines options for the call rejection message. - +**System API**: This is a system API. - +**System capability**: SystemCapability.Telephony.CallManager -| | | | | +| Name | Type | Mandatory| Description | | -------------- | ------ | ---- | -------- | -| | | | | +| messageContent | string | Yes | Message content.| -## +## CallTransferResult8+ - +Defines the call transfer result. - +**System API**: This is a system API. - +**System capability**: SystemCapability.Telephony.CallManager -| | | | | +| Name | Type | Mandatory| Description | | ------------------------ | ---------------------------------- | ---- | ---------------- | -| | | | | -| | | | | -| | | | | -| | | | | -| | | | | -| | | | | +| status | [TransferStatus](#transferstatus8) | Yes | Call transfer status. | +| number | string | Yes | Call transfer number. | +| startHour9+ | number | Yes | Hour in the start time.| +| startMinute9+ | number | Yes | Minute in the start time.| +| endHour9+ | number | Yes | Minute in the end time.| +| endMinute9+ | number | Yes | Minute in the end time.| -## +## CallWaitingStatus7+ - +Enumerates call waiting states. - +**System API**: This is a system API. - +**System capability**: SystemCapability.Telephony.CallManager -| | | | +| Name | Value | Description | | -------------------- | ---- | ------------ | -| | | | -| | | | +| CALL_WAITING_DISABLE | 0 | Call waiting disabled.| +| CALL_WAITING_ENABLE | 1 | Call waiting enabled.| -## +## RestrictionStatus8+ - +Enumerates call restriction states. - +**System API**: This is a system API. - +**System capability**: SystemCapability.Telephony.CallManager -| | | | +| Name | Value | Description | | ------------------- | ---- | -------- | -| | | | -| | | | +| RESTRICTION_DISABLE | 0 | Call restriction disabled.| +| RESTRICTION_ENABLE | 1 | Call restriction enabled.| -## +## TransferStatus8+ - +Enumerates call transfer states. - +**System API**: This is a system API. - +**System capability**: SystemCapability.Telephony.CallManager -| | | | +| Name | Value | Description | | ---------------- | ---- | -------- | -| | | | -| | | | +| TRANSFER_DISABLE | 0 | Call transfer disabled.| +| TRANSFER_ENABLE | 1 | Call transfer enabled.| -## +## DisconnectedDetails9+ - +Defines the call disconnection cause. - +**System API**: This is a system API. - +**System capability**: SystemCapability.Telephony.CallManager -| | | | | +| Name | Type | Mandatory| Description | | ------- | ------------------------------------------ | ---- | --------------- | -| | | | | -| | | | | +| reason | [DisconnectedReason](#disconnectedreason8) | Yes | Call disconnection cause. | +| message | string | Yes | Call ending message.| -## +## DisconnectedReason8+ - +Enumerates call disconnection causes. - +**System API**: This is a system API. - +**System capability**: SystemCapability.Telephony.CallManager -| | | | +| Name | Value | Description | | ------------------------------------------------------------ | ---- | --------------------------------------- | -| | | | -| | | | -| | | | -| | | | -| | | | -| | | | -| | | | -| | | | -| | | | -| | | | -| | | | -| | | | -| | | | -| | | | -| | | | -| | | | -| | | | -| | | | -| | | | -| | | | -| | | | -| | | | -| | | | -| | | | -| | | | -| | | | -| | | | -| | | | -| | | | -| | | | -| | | | -| | | | -| | | | -| | | | -| | | | -| | | | -| | | | -| | | | -| | | | -| | | | -| | | | -| | | | -| | | | -| | | | -| | | | -| | | | -| | | | -| | | | -| | | | -| | | | -| | | | -| | | | -| | | | -| | | | -| | | | -| | | | -| | | | -| | | | -| | | | -| | | | -| | | | -| | | | -| | | | -| | | | -| | | | -| | | | -| | | | -| | | | -| | | | -| | | | -| | | | -| | | | -| | | | -| | | | -| | | | -| | | | -| | | | -| | | | -| | | | - -## - - - - - - - -| | | | | +| UNASSIGNED_NUMBER | 1 | Unallocated (unassigned) number. | +| NO_ROUTE_TO_DESTINATION | 3 | No route to destination. | +| CHANNEL_UNACCEPTABLE | 6 | Channel unacceptable. | +| OPERATOR_DETERMINED_BARRING | 8 | Operator determined barring (ODB). | +| CALL_COMPLETED_ELSEWHERE9+ | 13 | Call completed elsewhere. | +| NORMAL_CALL_CLEARING | 16 | Normal call clearing. | +| USER_BUSY | 17 | User busy. | +| NO_USER_RESPONDING | 18 | No user responding. | +| USER_ALERTING_NO_ANSWER | 19 | User alerting, no answer. | +| CALL_REJECTED | 21 | Call rejected. | +| NUMBER_CHANGED | 22 | Number changed. | +| CALL_REJECTED_DUE_TO_FEATURE_AT_THE_DESTINATION9+ | 24 | Call rejected due to feature at the destination.| +| FAILED_PRE_EMPTION9+ | 25 | Failed preemption. | +| NON_SELECTED_USER_CLEARING9+ | 26 | Non-selected user clearing. | +| DESTINATION_OUT_OF_ORDER | 27 | Destination out of order. | +| INVALID_NUMBER_FORMAT | 28 | Invalid number format (incomplete number). | +| FACILITY_REJECTED9+ | 29 | Facility rejected. | +| RESPONSE_TO_STATUS_ENQUIRY9+ | 30 | Response to status enquiry. | +| NORMAL_UNSPECIFIED9+ | 31 | Normal, unspecified. | +| NO_CIRCUIT_CHANNEL_AVAILABLE9+ | 34 | No circuit/channel available. | +| NETWORK_OUT_OF_ORDER | 38 | Network fault. | +| TEMPORARY_FAILURE | 41 | Temporary failure. | +| SWITCHING_EQUIPMENT_CONGESTION9+ | 42 | Switching equipment congestion. | +| ACCESS_INFORMATION_DISCARDED9+ | 43 | Access information discarded. | +| REQUEST_CIRCUIT_CHANNEL_NOT_AVAILABLE9+ | 44 | Requested circuit/channel unavailable | +| RESOURCES_UNAVAILABLE_UNSPECIFIED9+ | 47 | Resources unavailable, unspecified. | +| QUALITY_OF_SERVICE_UNAVAILABLE9+ | 49 | QoS unavailable. | +| REQUESTED_FACILITY_NOT_SUBSCRIBED9+ | 50 | Requested facility not subscribed. | +| INCOMING_CALLS_BARRED_WITHIN_THE_CUG9+ | 55 | Incoming calls barred within the CUG. | +| BEARER_CAPABILITY_NOT_AUTHORIZED9+ | 57 | Bearer capability not authorized. | +| BEARER_CAPABILITY_NOT_PRESENTLY_AVAILABLE9+ | 58 | Bearer capability presently available. | +| SERVICE_OR_OPTION_NOT_AVAILABLE_UNSPECIFIED9+ | 63 | Service or option not available, unspecified. | +| BEARER_SERVICE_NOT_IMPLEMENTED9+ | 65 | Bearer service not implemented. | +| ACM_EQUALTO_OR_GREATER_THAN_THE_MAXIMUM_VALUE9+ | 68 | ACM greater than or equal to the maximum value. | +| REQUESTED_FACILITY_NOT_IMPLEMENTED9+ | 69 | Requested facility not implemented. | +| ONLY_RESTRICTED_DIGITAL_INFO_BEARER_CAPABILITY_IS_AVAILABLE9+ | 70 | Only restricted digital information bearer capability available. | +| SERVICE_OR_OPTION_NOT_IMPLEMENTED_UNSPECIFIED9+ | 79 | Service or option not implemented, unspecified. | +| INVALID_TRANSACTION_IDENTIFIER_VALUE9+ | 81 | Invalid transaction identifier value. | +| USER_NOT_MEMBER_OF_CUG9+ | 87 | User not member of CUG. | +| INCOMPATIBLE_DESTINATION9+ | 88 | Incompatible destination. | +| INVALID_TRANSIT_NETWORK_SELECTION9+ | 91 | Invalid transit network selection. | +| SEMANTICALLY_INCORRECT_MESSAGE9+ | 95 | Semantically incorrect message. | +| INVALID_MANDATORY_INFORMATION9+ | 96 | Invalid mandatory information. | +| MESSAGE_TYPE_NON_EXISTENT_OR_NOT_IMPLEMENTED9+ | 97 | Message type non-existent or not implemented. | +| MESSAGE_TYPE_NOT_COMPATIBLE_WITH_PROTOCOL_STATE9+ | 98 | Message type not compatible with protocol state. | +| INFORMATION_ELEMENT_NON_EXISTENT_OR_NOT_IMPLEMENTED9+ | 99 | IE non-existent or not implemented. | +| CONDITIONAL_IE_ERROR9+ | 100 | Conditional IE error. | +| MESSAGE_NOT_COMPATIBLE_WITH_PROTOCOL_STATE9+ | 101 | Message not compatible with protocol state. | +| RECOVERY_ON_TIMER_EXPIRED9+ | 102 | Recovery on timer expiry. | +| PROTOCOL_ERROR_UNSPECIFIED9+ | 111 | Protocol error, unspecified. | +| INTERWORKING_UNSPECIFIED9+ | 127 | Interworking, unspecified. | +| CALL_BARRED9+ | 240 | Call barred. | +| FDN_BLOCKED9+ | 241 | FDN blocked. | +| IMSI_UNKNOWN_IN_VLR9+ | 242 | IMSI unknown in VLR. | +| IMEI_NOT_ACCEPTED9+ | 243 | IMEI not accepted. | +| DIAL_MODIFIED_TO_USSD9+ | 244 | Dial request modified to USSD request. | +| DIAL_MODIFIED_TO_SS9+ | 245 | Dial request modified to SS request. | +| DIAL_MODIFIED_TO_DIAL9+ | 246 | Dial request modified to dial with different number. | +| RADIO_OFF9+ | 247 | Radio off. | +| OUT_OF_SERVICE9+ | 248 | Out of service. | +| NO_VALID_SIM9+ | 249 | No valid SIM. | +| RADIO_INTERNAL_ERROR9+ | 250 | Radio internal error. | +| NETWORK_RESP_TIMEOUT9+ | 251 | Network response timeout. | +| NETWORK_REJECT9+ | 252 | Request rejected by network. | +| RADIO_ACCESS_FAILURE9+ | 253 | Radio access failure. | +| RADIO_LINK_FAILURE9+ | 254 | Radio link failure. | +| RADIO_LINK_LOST9+ | 255 | Radio link lost. | +| RADIO_UPLINK_FAILURE9+ | 256 | Radio uplink failure. | +| RADIO_SETUP_FAILURE9+ | 257 | Radio setup failure. | +| RADIO_RELEASE_NORMAL9+ | 258 | Radio release normal. | +| RADIO_RELEASE_ABNORMAL9+ | 259 | Radio release abnormal. | +| ACCESS_CLASS_BLOCKED9+ | 260 | Access class blocked. | +| NETWORK_DETACH9+ | 261 | Network detached. | +| INVALID_PARAMETER | 1025 | Invalid parameter. | +| SIM_NOT_EXIT | 1026 | SIM not exit. | +| SIM_PIN_NEED | 1027 | SIM PIN needed. | +| CALL_NOT_ALLOW | 1029 | Call not allowed. | +| SIM_INVALID | 1045 | No valid SIM. | +| UNKNOWN | 1279 | Unknown reason. | + +## MmiCodeResults9+ + +Defines the MMI code result. + +**System API**: This is a system API. + +**System capability**: SystemCapability.Telephony.CallManager + +| Name | Type | Mandatory| Description | | ------- | -------------------------------- | ---- | --------------- | -| | | | | -| | | | | +| result | [MmiCodeResult](#mmicoderesult9) | Yes | MMI code result.| +| message | string | Yes | MMI code message.| -## +## MmiCodeResult9+ - +Defines the MMI code result. - +**System API**: This is a system API. - +**System capability**: SystemCapability.Telephony.CallManager -| | | | +| Name | Value | Description | | ---------------- | ---- | ------------- | -| | | | -| | | | +| MMI_CODE_SUCCESS | 0 | Success.| +| MMI_CODE_FAILED | 1 | Failure.|