@ohos.telephony.call (Call) (System API)

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 call status changes, use observer.on('callStateChange').

NOTE

The initial APIs of this module are supported since API version 6. Newly added APIs will be marked with a superscript to indicate their earliest API version. This topic describes only system APIs provided by the module. For details about its public APIs, see @ohos.telephony.call (Call).

Modules to Import

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

call.dialCall⁹⁺

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

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

System API: This is a system API.

Required Permissions: ohos.permission.PLACE_CALL

System capability: SystemCapability.Telephony.CallManager

Parameters

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 error codes, see Telephony Error Codes and Universal Error Codes.

ID	Error Message
201	Permission denied.
202	Non-system applications use system APIs.
401	Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2. Incorrect parameters types;
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

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

call.dialCall("138xxxxxxxx", (err: BusinessError) => {
    if (err) {
        console.error(`dialCall fail, err->${JSON.stringify(err)}`);
    } else {
        console.info(`dialCall success.`);
    }
});

call.dialCall⁹⁺

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

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

System API: This is a system API.

Required Permissions: ohos.permission.PLACE_CALL

System capability: SystemCapability.Telephony.CallManager

Parameters

Name	Type	Mandatory	Description
phoneNumber	string	Yes	Phone number.
options	DialCallOptions	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 error codes, see Telephony Error Codes and Universal Error Codes.

ID	Error Message
201	Permission denied.
202	Non-system applications use system APIs.
401	Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2. Incorrect parameters types;
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

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

let dialCallOptions: call.DialCallOptions = {
    accountId: 0,
    videoState: 0,
    dialScene: 0,
    dialType: 0
}
call.dialCall("138xxxxxxxx", dialCallOptions, (err: BusinessError) => {
    if (err) {
        console.error(`dialCall fail, err->${JSON.stringify(err)}`);
    } else {
        console.info(`dialCall success.`);
    }
});

call.dialCall⁹⁺

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

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

System API: This is a system API.

Required Permissions: ohos.permission.PLACE_CALL

System capability: SystemCapability.Telephony.CallManager

Parameters

Name	Type	Mandatory	Description
phoneNumber	string	Yes	Phone number.
options	DialCallOptions	No	Call options, which carry other configuration information of the call. If this field is not set, the following configuration is used by default. For details, see DialCallOptions. - 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 error codes, see Telephony Error Codes and Universal Error Codes.

ID	Error Message
201	Permission denied.
202	Non-system applications use system APIs.
401	Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2. Incorrect parameters types;
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

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

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

call.muteRinger⁸⁺

muteRinger(callback: AsyncCallback<void>): void

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

System API: This is a system API.

Required permission: ohos.permission.SET_TELEPHONY_STATE

System capability: SystemCapability.Telephony.CallManager

Parameters

Name	Type	Mandatory	Description
callback	AsyncCallback<void>	Yes	Callback used to return the result.

Error codes

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

ID	Error Message
201	Permission denied.
202	Non-system applications use system APIs.
401	Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2. Incorrect parameters types;
8300001	Invalid parameter value.
8300002	Operation failed. Cannot connect to service.
8300003	System internal error.
8300999	Unknown error code.

Example

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

call.muteRinger((err: BusinessError) => {
    if (err) {
        console.error(`muteRinger fail, err->${JSON.stringify(err)}`);
    } else {
        console.info(`muteRinger success.`);
    }
});

call.muteRinger⁸⁺

muteRinger(): Promise<void>

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

System API: This is a system API.

Required permission: ohos.permission.SET_TELEPHONY_STATE

System capability: SystemCapability.Telephony.CallManager

Return value

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

Error codes

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

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

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

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

call.answerCall⁹⁺

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

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

System API: This is a system API.

Required permission: ohos.permission.ANSWER_CALL

System capability: SystemCapability.Telephony.CallManager

Parameters

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 error codes, see Telephony Error Codes and Universal Error Codes.

ID	Error Message
201	Permission denied.
202	Non-system applications use system APIs.
401	Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2. Incorrect parameters types;
8300001	Invalid parameter value.
8300002	Operation failed. Cannot connect to service.
8300003	System internal error.
8300999	Unknown error code.

Example

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

call.answerCall(1, (err: BusinessError) => {
    if (err) {
        console.error(`answerCall fail, err->${JSON.stringify(err)}`);
    } else {
        console.info(`answerCall success.`);
    }
});

call.answerCall⁹⁺

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

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

System API: This is a system API.

Required permission: ohos.permission.ANSWER_CALL

System capability: SystemCapability.Telephony.CallManager

Parameters

Name	Type	Mandatory	Description
callId	number	No	Call ID. You can obtain the value by subscribing to callDetailsChange events. This field is optional from API version 9. If this field 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 error codes, see Telephony Error Codes and Universal Error Codes.

ID	Error Message
201	Permission denied.
202	Non-system applications use system APIs.
401	Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2. Incorrect parameters types;
8300001	Invalid parameter value.
8300002	Operation failed. Cannot connect to service.
8300003	System internal error.
8300999	Unknown error code.

Example

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

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

call.hangUpCall⁹⁺

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

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

System API: This is a system API.

Required permissions: ohos.permission.ANSWER_CALL and ohos.permission.SET_TELEPHONY_STATE

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 error codes, see Telephony Error Codes and Universal Error Codes.

ID	Error Message
201	Permission denied.
202	Non-system applications use system APIs.
401	Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2. Incorrect parameters types;
8300001	Invalid parameter value.
8300002	Operation failed. Cannot connect to service.
8300003	System internal error.
8300999	Unknown error code.

Example

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

call.hangUpCall(1, (err: BusinessError) => {
    if (err) {
        console.error(`hangUpCall fail, err->${JSON.stringify(err)}`);
    } else {
        console.info(`hangUpCall success.`);
    }
});

call.hangUpCall⁹⁺

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

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

System API: This is a system API.

Required permission: ohos.permission.ANSWER_CALL

System capability: SystemCapability.Telephony.CallManager

Parameters

Name	Type	Mandatory	Description
callId	number	No	Call ID. You can obtain the value by subscribing to callDetailsChange events. This field is optional from API version 9. If this field 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 error codes, see Telephony Error Codes and Universal Error Codes.

ID	Error Message
201	Permission denied.
202	Non-system applications use system APIs.
401	Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2. Incorrect parameters types;
8300001	Invalid parameter value.
8300002	Operation failed. Cannot connect to service.
8300003	System internal error.
8300999	Unknown error code.

Example

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

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

call.rejectCall⁹⁺

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

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

System API: This is a system API.

Required permission: ohos.permission.ANSWER_CALL

System capability: SystemCapability.Telephony.CallManager

Parameters

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 error codes, see Telephony Error Codes and Universal Error Codes.

ID	Error Message
201	Permission denied.
202	Non-system applications use system APIs.
401	Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2. Incorrect parameters types;
8300001	Invalid parameter value.
8300002	Operation failed. Cannot connect to service.
8300003	System internal error.
8300999	Unknown error code.

Example

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

call.rejectCall(1, (err: BusinessError) => {
    if (err) {
        console.error(`rejectCall fail, err->${JSON.stringify(err)}`);
    } else {
        console.info(`rejectCall success.`);
    }
});

call.rejectCall⁹⁺

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

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

System API: This is a system API.

Required permission: ohos.permission.ANSWER_CALL

System capability: SystemCapability.Telephony.CallManager

Parameters

Name	Type	Mandatory	Description
callId	number	Yes	Call ID. You can obtain the value by subscribing to callDetailsChange events.
options	RejectMessageOptions	Yes	Options for the call rejection message.
callback	AsyncCallback<void>	Yes	Callback used to return the result.

Error codes

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

ID	Error Message
201	Permission denied.
202	Non-system applications use system APIs.
401	Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2. Incorrect parameters types;
8300001	Invalid parameter value.
8300002	Operation failed. Cannot connect to service.
8300003	System internal error.
8300999	Unknown error code.

Example

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

let rejectMessageOptions : call.RejectMessageOptions = {
    messageContent: "Unknown number blocked"
}
call.rejectCall(1, rejectMessageOptions, (err: BusinessError) => {
    if (err) {
        console.error(`rejectCall fail, err->${JSON.stringify(err)}`);
    } else {
        console.info(`rejectCall success.`);
    }
});

call.rejectCall⁹⁺

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

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

System API: This is a system API.

Required permission: ohos.permission.ANSWER_CALL

System capability: SystemCapability.Telephony.CallManager

Parameters

Name	Type	Mandatory	Description
callId	number	No	Call ID. You can obtain the value by subscribing to callDetailsChange events. This field is optional from API version 9. If this field is not set, the latest ringing call will be rejected.
options	RejectMessageOptions	No	Options for the call rejection message. If this field 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 error codes, see Telephony Error Codes and Universal Error Codes.

ID	Error Message
201	Permission denied.
202	Non-system applications use system APIs.
401	Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2. Incorrect parameters types;
8300001	Invalid parameter value.
8300002	Operation failed. Cannot connect to service.
8300003	System internal error.
8300999	Unknown error code.

Example

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

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

call.rejectCall⁹⁺

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

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

System API: This is a system API.

Required permission: ohos.permission.ANSWER_CALL

System capability: SystemCapability.Telephony.CallManager

Parameters

Name	Type	Mandatory	Description
options	RejectMessageOptions	Yes	Options for the call rejection message.
callback	AsyncCallback<void>	Yes	Callback used to return the result.

Error codes

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

ID	Error Message
201	Permission denied.
202	Non-system applications use system APIs.
401	Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2. Incorrect parameters types;
8300001	Invalid parameter value.
8300002	Operation failed. Cannot connect to service.
8300003	System internal error.
8300999	Unknown error code.

Example

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

let rejectMessageOptions: call.RejectMessageOptions = {
    messageContent: "Unknown number blocked"
}
call.rejectCall(rejectMessageOptions, (err: BusinessError) => {
    if (err) {
        console.error(`rejectCall fail, err->${JSON.stringify(err)}`);
    } else {
        console.info(`rejectCall success.`);
    }
});

call.holdCall⁷⁺

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

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

System API: This is a system API.

Required permission: ohos.permission.ANSWER_CALL

System capability: SystemCapability.Telephony.CallManager

Parameters

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 error codes, see Telephony Error Codes and Universal Error Codes.

ID	Error Message
201	Permission denied.
202	Non-system applications use system APIs.
401	Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2. Incorrect parameters types;
8300001	Invalid parameter value.
8300002	Operation failed. Cannot connect to service.
8300003	System internal error.
8300999	Unknown error code.

Example

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

call.holdCall(1, (err: BusinessError) => {
    if (err) {
        console.error(`holdCall fail, err->${JSON.stringify(err)}`);
    } else {
        console.info(`holdCall success.`);
    }
});

call.holdCall⁷⁺

holdCall(callId: number): Promise<void>

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

System API: This is a system API.

Required permission: ohos.permission.ANSWER_CALL

System capability: SystemCapability.Telephony.CallManager

Parameters

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 error codes, see Telephony Error Codes and Universal Error Codes.

ID	Error Message
201	Permission denied.
202	Non-system applications use system APIs.
401	Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2. Incorrect parameters types;
8300001	Invalid parameter value.
8300002	Operation failed. Cannot connect to service.
8300003	System internal error.
8300999	Unknown error code.

Example

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

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

call.unHoldCall⁷⁺

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

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

System API: This is a system API.

Required permission: ohos.permission.ANSWER_CALL

System capability: SystemCapability.Telephony.CallManager

Parameters

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 error codes, see Telephony Error Codes and Universal Error Codes.

ID	Error Message
201	Permission denied.
202	Non-system applications use system APIs.
401	Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2. Incorrect parameters types;
8300001	Invalid parameter value.
8300002	Operation failed. Cannot connect to service.
8300003	System internal error.
8300999	Unknown error code.

Example

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

call.unHoldCall(1, (err: BusinessError) => {
    if (err) {
        console.error(`unHoldCall fail, err->${JSON.stringify(err)}`);
    } else {
        console.info(`unHoldCall success.`);
    }
});

call.unHoldCall⁷⁺

unHoldCall(callId: number): Promise<void>

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

System API: This is a system API.

Required permission: ohos.permission.ANSWER_CALL

System capability: SystemCapability.Telephony.CallManager

Parameters

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 error codes, see Telephony Error Codes and Universal Error Codes.

ID	Error Message
201	Permission denied.
202	Non-system applications use system APIs.
401	Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2. Incorrect parameters types;
8300001	Invalid parameter value.
8300002	Operation failed. Cannot connect to service.
8300003	System internal error.
8300999	Unknown error code.

Example

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

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

call.switchCall⁷⁺

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

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

System API: This is a system API.

Required permission: ohos.permission.ANSWER_CALL

System capability: SystemCapability.Telephony.CallManager

Parameters

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 error codes, see Telephony Error Codes and Universal Error Codes.

ID	Error Message
201	Permission denied.
202	Non-system applications use system APIs.
401	Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2. Incorrect parameters types;
8300001	Invalid parameter value.
8300002	Operation failed. Cannot connect to service.
8300003	System internal error.
8300999	Unknown error code.

Example

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

call.switchCall(1, (err: BusinessError) => {
    if (err) {
        console.error(`switchCall fail, err->${JSON.stringify(err)}`);
    } else {
        console.info(`switchCall success.`);
    }
});

call.switchCall⁷⁺

switchCall(callId: number): Promise<void>

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

System API: This is a system API.

Required permission: ohos.permission.ANSWER_CALL

System capability: SystemCapability.Telephony.CallManager

Parameters

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 error codes, see Telephony Error Codes and Universal Error Codes.

ID	Error Message
201	Permission denied.
202	Non-system applications use system APIs.
401	Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2. Incorrect parameters types;
8300001	Invalid parameter value.
8300002	Operation failed. Cannot connect to service.
8300003	System internal error.
8300999	Unknown error code.

Example

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

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

call.combineConference¹¹⁺

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

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

System API: This is a system API.

System capability: SystemCapability.Telephony.CallManager

Parameters

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 error codes, see Telephony Error Codes and Universal Error Codes.

ID	Error Message
202	Non-system applications use system APIs.
401	Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2. Incorrect parameters types;
801	Capability not supported.
8300001	Invalid parameter value.
8300002	Operation failed. Cannot connect to service.
8300003	System internal error.
8300007	The number of conference calls exceeds the limit.

Example

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

call.combineConference(1, (err: BusinessError) => {
    if (err) {
        console.error(`combineConference fail, err->${JSON.stringify(err)}`);
    } else {
        console.info(`combineConference success.`);
    }
});

call.combineConference¹¹⁺

combineConference(callId: number): Promise<void>

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

System API: This is a system API.

System capability: SystemCapability.Telephony.CallManager

Parameters

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 error codes, see Telephony Error Codes and Universal Error Codes.

ID	Error Message
202	Non-system applications use system APIs.
401	Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2. Incorrect parameters types;
801	Capability not supported.
8300001	Invalid parameter value.
8300002	Operation failed. Cannot connect to service.
8300003	System internal error.
8300007	The number of conference calls exceeds the limit.

Example

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

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

call.kickOutFromConference¹⁰⁺

kickOutFromConference(callId: number, callback: AsyncCallback<void>): 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 error codes, see Telephony Error Codes and Universal Error Codes.

ID	Error Message
201	Permission denied.
202	Non-system applications use system APIs.
401	Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2. Incorrect parameters types;
8300001	Invalid parameter value.
8300002	Operation failed. Cannot connect to service.
8300003	System internal error.
8300999	Unknown error code.

Example

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

call.kickOutFromConference(1, (err: BusinessError) => {
    if (err) {
        console.error(`kickOutFromConference fail, err->${JSON.stringify(err)}`);
    } else {
        console.info(`kickOutFromConference success.`);
    }
});

call.kickOutFromConference¹⁰⁺

kickOutFromConference(callId: number): Promise<void>

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 error codes, see Telephony Error Codes and Universal Error Codes.

ID	Error Message
201	Permission denied.
202	Non-system applications use system APIs.
401	Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2. Incorrect parameters types;
8300001	Invalid parameter value.
8300002	Operation failed. Cannot connect to service.
8300003	System internal error.
8300999	Unknown error code.

Example

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

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

call.getMainCallId⁷⁺

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

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

System API: This is a system API.

System capability: SystemCapability.Telephony.CallManager

Parameters

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 error codes, see Telephony Error Codes and Universal Error Codes.

ID	Error Message
202	Non-system applications use system APIs.
401	Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2. Incorrect parameters types;
801	Capability not supported.
8300001	Invalid parameter value.
8300002	Operation failed. Cannot connect to service.
8300003	System internal error.

Example

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

call.getMainCallId(1, (err: BusinessError, data: number) => {
    if (err) {
        console.error(`getMainCallId fail, err->${JSON.stringify(err)}`);
    } else {
        console.info(`getMainCallId success, data->${JSON.stringify(data)}`);
    }
});

call.getMainCallId⁷⁺

getMainCallId(callId: number): Promise<number>

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

System API: This is a system API.

System capability: SystemCapability.Telephony.CallManager

Parameters

Name	Type	Mandatory	Description
callId	number	Yes	Call ID.

Return value

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

Error codes

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

ID	Error Message
202	Non-system applications use system APIs.
401	Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2. Incorrect parameters types;
801	Capability not supported.
8300001	Invalid parameter value.
8300002	Operation failed. Cannot connect to service.
8300003	System internal error.

Example

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

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

call.getSubCallIdList⁷⁺

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

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

System API: This is a system API.

System capability: SystemCapability.Telephony.CallManager

Parameters

Name	Type	Mandatory	Description
callId	number	Yes	Call ID.
callback	AsyncCallback<Array<string>>	Yes	Callback used to return the result.

Error codes

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

ID	Error Message
202	Non-system applications use system APIs.
401	Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2. Incorrect parameters types;
801	Capability not supported.
8300001	Invalid parameter value.
8300002	Operation failed. Cannot connect to service.
8300003	System internal error.

Example

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

call.getSubCallIdList(1, (err: BusinessError, data: Array<string>) => {
    if (err) {
        console.error(`getSubCallIdList fail, err->${JSON.stringify(err)}`);
    } else {
        console.info(`getSubCallIdList success, data->${JSON.stringify(data)}`);
    }
});

call.getSubCallIdList⁷⁺

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

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

System API: This is a system API.

System capability: SystemCapability.Telephony.CallManager

Parameters

Name	Type	Mandatory	Description
callId	number	Yes	Call ID.

Return value

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

Error codes

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

ID	Error Message
202	Non-system applications use system APIs.
401	Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2. Incorrect parameters types;
801	Capability not supported.
8300001	Invalid parameter value.
8300002	Operation failed. Cannot connect to service.
8300003	System internal error.

Example

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

call.getSubCallIdList(1).then((data: Array<string>) => {
    console.info(`getSubCallIdList success, promise: data->${JSON.stringify(data)}`);
}).catch((err: BusinessError) => {
    console.error(`getSubCallIdList fail, promise: err->${JSON.stringify(err)}`);
});

call.getCallIdListForConference⁷⁺

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

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

System API: This is a system API.

System capability: SystemCapability.Telephony.CallManager

Parameters

Name	Type	Mandatory	Description
callId	number	Yes	Call ID.
callback	AsyncCallback<Array<string>>	Yes	Callback used to return the result.

Error codes

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

ID	Error Message
202	Non-system applications use system APIs.
401	Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2. Incorrect parameters types;
801	Capability not supported.
8300001	Invalid parameter value.
8300002	Operation failed. Cannot connect to service.
8300003	System internal error.

Example

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

call.getCallIdListForConference(1, (err: BusinessError, data: Array<string>) => {
    if (err) {
        console.error(`getCallIdListForConference fail, err->${JSON.stringify(err)}`);
    } else {
        console.info(`getCallIdListForConference success, data->${JSON.stringify(data)}`);
    }
});

call.getCallIdListForConference⁷⁺

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

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

System API: This is a system API.

System capability: SystemCapability.Telephony.CallManager

Parameters

Name	Type	Mandatory	Description
callId	number	Yes	Call ID.

Return value

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

Error codes

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

ID	Error Message
202	Non-system applications use system APIs.
401	Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2. Incorrect parameters types;
801	Capability not supported.
8300001	Invalid parameter value.
8300002	Operation failed. Cannot connect to service.
8300003	System internal error.

Example

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

call.getCallIdListForConference(1).then((data: Array<string>) => {
    console.info(`getCallIdListForConference success, promise: data->${JSON.stringify(data)}`);
}).catch((err: BusinessError) => {
    console.error(`getCallIdListForConference fail, promise: err->${JSON.stringify(err)}`);
});

call.getCallWaitingStatus⁷⁺

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

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

System API: This is a system API.

Required permission: ohos.permission.GET_TELEPHONY_STATE

System capability: SystemCapability.Telephony.CallManager

Parameters

Name	Type	Mandatory	Description
slotId	number	Yes	Card slot ID. - 0: card slot 1. - 1: card slot 2.
callback	AsyncCallback<CallWaitingStatus>	Yes	Callback used to return the result. The value can be: - 0: Call waiting is disabled. - 1: Call waiting is enabled.

Error codes

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

ID	Error Message
201	Permission denied.
202	Non-system applications use system APIs.
401	Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2. Incorrect parameters types;
801	Capability not supported.
8300001	Invalid parameter value.
8300002	Operation failed. Cannot connect to service.
8300003	System internal error.

Example

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

call.getCallWaitingStatus(0, (err: BusinessError, data: call.CallWaitingStatus) => {
    if (err) {
        console.error(`getCallWaitingStatus fail, err->${JSON.stringify(err)}`);
    } else {
        console.info(`getCallWaitingStatus success, data->${JSON.stringify(data)}`);
    }
});

call.getCallWaitingStatus⁷⁺

getCallWaitingStatus(slotId: number): Promise<CallWaitingStatus>

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

System API: This is a system API.

Required permission: ohos.permission.GET_TELEPHONY_STATE

System capability: SystemCapability.Telephony.CallManager

Parameters

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

Return value

Type	Description
Promise<CallWaitingStatus>	Promise used to return the result. - 0: Call waiting is disabled. - 1: Call waiting is enabled.

Error codes

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

ID	Error Message
201	Permission denied.
202	Non-system applications use system APIs.
401	Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2. Incorrect parameters types;
801	Capability not supported.
8300001	Invalid parameter value.
8300002	Operation failed. Cannot connect to service.
8300003	System internal error.

Example

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

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

call.setCallWaiting⁷⁺

setCallWaiting(slotId: number, activate: boolean, callback: AsyncCallback<void>): 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<void>	Yes	Callback used to return the result.

Error codes

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

ID	Error Message
201	Permission denied.
202	Non-system applications use system APIs.
401	Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2. Incorrect parameters types;
801	Capability not supported.
8300001	Invalid parameter value.
8300002	Operation failed. Cannot connect to service.
8300003	System internal error.

Example

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

call.setCallWaiting(0, true, (err: BusinessError) => {
    if (err) {
        console.error(`setCallWaiting fail, err->${JSON.stringify(err)}`);
    } else {
        console.info(`setCallWaiting success.`);
    }
});

call.setCallWaiting⁷⁺

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

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 error codes, see Telephony Error Codes and Universal Error Codes.

ID	Error Message
201	Permission denied.
202	Non-system applications use system APIs.
401	Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2. Incorrect parameters types;
801	Capability not supported.
8300001	Invalid parameter value.
8300002	Operation failed. Cannot connect to service.
8300003	System internal error.

Example

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

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

call.startDTMF⁷⁺

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

Starts playing DTMF tones. 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
callId	number	Yes	Call ID.
character	string	Yes	DTMF string.
callback	AsyncCallback<void>	Yes	Callback used to return the result.

Error codes

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

ID	Error Message
202	Non-system applications use system APIs.
401	Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2. Incorrect parameters types;
801	Capability not supported.
8300001	Invalid parameter value.
8300002	Operation failed. Cannot connect to service.
8300003	System internal error.

Example

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

call.startDTMF(1, "0", (err: BusinessError) => {
    if (err) {
        console.error(`startDTMF fail, err->${JSON.stringify(err)}`);
    } else {
        console.info(`startDTMF success.`);
    }
});

call.startDTMF⁷⁺

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

Starts playing DTMF tones. 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 string.

Return value

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

Error codes

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

ID	Error Message
202	Non-system applications use system APIs.
401	Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2. Incorrect parameters types;
801	Capability not supported.
8300001	Invalid parameter value.
8300002	Operation failed. Cannot connect to service.
8300003	System internal error.

Example

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

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

call.stopDTMF⁷⁺

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

Stops playing DTMF tones. 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
callId	number	Yes	Call ID.
callback	AsyncCallback<void>	Yes	Callback used to return the result.

Error codes

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

ID	Error Message
202	Non-system applications use system APIs.
401	Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2. Incorrect parameters types;
801	Capability not supported.
8300001	Invalid parameter value.
8300002	Operation failed. Cannot connect to service.
8300003	System internal error.

Example

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

call.stopDTMF(1, (err: BusinessError) => {
    if (err) {
        console.error(`stopDTMF fail, err->${JSON.stringify(err)}`);
    } else {
        console.info(`stopDTMF success.`);
    }
});

call.stopDTMF⁷⁺

stopDTMF(callId: number): Promise<void>

Stops playing DTMF tones. 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 error codes, see Telephony Error Codes and Universal Error Codes.

ID	Error Message
202	Non-system applications use system APIs.
401	Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2. Incorrect parameters types;
801	Capability not supported.
8300001	Invalid parameter value.
8300002	Operation failed. Cannot connect to service.
8300003	System internal error.

Example

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

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

call.postDialProceed¹¹⁺

postDialProceed(callId: number, proceed: boolean, callback: AsyncCallback<void>): void

Continues a call by playing a post-dial DTMF string. This API uses an asynchronous callback to return the result.

If the called number is in the format of "common phone number + semicolon (😉 + DTMF string", for example, 400xxxxxxx;123, and the listening for postDialDelay events is enabled, the system reports a postDialDelay event when the call is connected. The application can then call this API to send DTMF tones.

System API: This is a system API.

Required permission: ohos.permission.SET_TELEPHONY_STATE

System capability: SystemCapability.Telephony.CallManager

Parameters

Name	Type	Mandatory	Description
callId	number	Yes	Call ID.
proceed	boolean	Yes	Whether to send DTMF tones. The default value is false. - true: yes - false: no
callback	AsyncCallback<void>	Yes	Callback used to return the result.

Error codes

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

ID	Error Message
201	Permission denied.
202	Non-system applications use system APIs.
401	Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2. Incorrect parameters types;
801	Capability not supported.
8300001	Invalid parameter value.
8300002	Operation failed. Cannot connect to service.
8300003	System internal error.

Example

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

call.postDialProceed(1, true, (err: BusinessError) => {
    console.info(`callback: err->${JSON.stringify(err)}`);
});

call.postDialProceed¹¹⁺

postDialProceed(callId: number, proceed: boolean): Promise<void>

Continues a call by playing a post-dial DTMF string. This API uses a promise to return the result.

If the called number is in the format of "common phone number + semicolon (😉 + DTMF string", for example, 400xxxxxxx;123, and the listening for postDialDelay events is enabled, the system reports a postDialDelay event when the call is connected. The application can then call this API to send DTMF tones.

System API: This is a system API.

Required permission: ohos.permission.SET_TELEPHONY_STATE

System capability: SystemCapability.Telephony.CallManager

Parameters

Name	Type	Mandatory	Description
callId	number	Yes	Call ID.
proceed	boolean	Yes	Whether to send DTMF tones. The default value is false. - true: yes - false: no

Return value

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

Error codes

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

ID	Error Message
201	Permission denied.
202	Non-system applications use system APIs.
401	Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2. Incorrect parameters types;
801	Capability not supported.
8300001	Invalid parameter value.
8300002	Operation failed. Cannot connect to service.
8300003	System internal error.

Example

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

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

call.isInEmergencyCall⁷⁺

isInEmergencyCall(callback: AsyncCallback<boolean>): void

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

System API: This is a system API.

Required permission: ohos.permission.SET_TELEPHONY_STATE

System capability: SystemCapability.Telephony.CallManager

Parameters

Name	Type	Mandatory	Description
callback	AsyncCallback<boolean>	Yes	Callback function used to return the result. The value true indicates an emergency call, and the value false indicates a non-emergency call.

Error codes

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

ID	Error Message
201	Permission denied.
202	Non-system applications use system APIs.
401	Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2. Incorrect parameters types;
8300001	Invalid parameter value.
8300002	Operation failed. Cannot connect to service.
8300003	System internal error.
8300999	Unknown error code.

Example

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

call.isInEmergencyCall((err: BusinessError, data: boolean) => {
    if (err) {
        console.error(`isInEmergencyCall fail, err->${JSON.stringify(err)}`);
    } else {
        console.info(`isInEmergencyCall success, data->${JSON.stringify(data)}`);
    }
});

call.isInEmergencyCall⁷⁺

isInEmergencyCall(): Promise<boolean>

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

System API: This is a system API.

Required permission: ohos.permission.SET_TELEPHONY_STATE

System capability: SystemCapability.Telephony.CallManager

Return value

Type	Description
Promise<boolean>	Promise used to return the result. The value true indicates an emergency call, and the value false indicates a non-emergency call.

Error codes

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

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

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

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

call.on('callDetailsChange')⁷⁺

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

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

System API: This is a system API.

Required permission: ohos.permission.SET_TELEPHONY_STATE

System capability: SystemCapability.Telephony.CallManager

Parameters

Name	Type	Mandatory	Description
type	string	Yes	Call event change. This field has a fixed value of callDetailsChange.
callback	Callback<CallAttributeOptions>	Yes	Callback used to return the result.

Error codes

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

ID	Error Message
201	Permission denied.
202	Non-system applications use system APIs.
401	Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2. Incorrect parameters types;
8300001	Invalid parameter value.
8300002	Operation failed. Cannot connect to service.
8300003	System internal error.
8300999	Unknown error code.

Example

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

call.on('callEventChange')⁸⁺

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

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

System API: This is a system API.

Required permission: ohos.permission.SET_TELEPHONY_STATE

System capability: SystemCapability.Telephony.CallManager

Parameters

Name	Type	Mandatory	Description
type	string	Yes	Call event change. This field has a fixed value of callEventChange.
callback	Callback<CallEventOptions>	Yes	Callback used to return the result.

Error codes

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

ID	Error Message
201	Permission denied.
202	Non-system applications use system APIs.
401	Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2. Incorrect parameters types;
8300001	Invalid parameter value.
8300002	Operation failed. Cannot connect to service.
8300003	System internal error.
8300999	Unknown error code.

Example

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

call.on('callDisconnectedCause')⁸⁺

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

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

System API: This is a system API.

Required permission: ohos.permission.SET_TELEPHONY_STATE

System capability: SystemCapability.Telephony.CallManager

Parameters

Name	Type	Mandatory	Description
type	string	Yes	Call disconnection cause. This field has a fixed value of callDisconnectedCause.
callback	Callback<DisconnectedDetails>	Yes	Callback used to return the result.

Error codes

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

ID	Error Message
201	Permission denied.
202	Non-system applications use system APIs.
401	Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2. Incorrect parameters types;
8300001	Invalid parameter value.
8300002	Operation failed. Cannot connect to service.
8300003	System internal error.
8300999	Unknown error code.

Example

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

call.on('mmiCodeResult')⁹⁺

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

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

System API: This is a system API.

Required permission: ohos.permission.SET_TELEPHONY_STATE

System capability: SystemCapability.Telephony.CallManager

Parameters

Name	Type	Mandatory	Description
type	string	Yes	MMI code result. This field has a fixed value of mmiCodeResult.
callback	Callback<MmiCodeResults>	Yes	Callback used to return the result.

Error codes

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

ID	Error Message
201	Permission denied.
202	Non-system applications use system APIs.
401	Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2. Incorrect parameters types;
8300001	Invalid parameter value.
8300002	Operation failed. Cannot connect to service.
8300003	System internal error.
8300999	Unknown error code.

Example

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

call.off('callDetailsChange')⁷⁺

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

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

System API: This is a system API.

Required permission: ohos.permission.SET_TELEPHONY_STATE

System capability: SystemCapability.Telephony.CallManager

Parameters

Name	Type	Mandatory	Description
type	string	Yes	Call details change. This field has a fixed value of callDetailsChange.
callback	Callback<CallAttributeOptions>	No	Callback used to return the result. If this field is not set, no subscription cancellation result will be received.

Error codes

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

ID	Error Message
201	Permission denied.
202	Non-system applications use system APIs.
401	Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2. Incorrect parameters types;
8300001	Invalid parameter value.
8300002	Operation failed. Cannot connect to service.
8300003	System internal error.
8300999	Unknown error code.

Example

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

call.off('callEventChange')⁸⁺

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

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

System API: This is a system API.

Required permission: ohos.permission.SET_TELEPHONY_STATE

System capability: SystemCapability.Telephony.CallManager

Parameters

Name	Type	Mandatory	Description
type	string	Yes	Call event change. This field has a fixed value of callEventChange.
callback	Callback<CallEventOptions>	No	Callback used to return the result. If this field is not set, no subscription cancellation result will be received.

Error codes

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

ID	Error Message
201	Permission denied.
202	Non-system applications use system APIs.
401	Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2. Incorrect parameters types;
8300001	Invalid parameter value.
8300002	Operation failed. Cannot connect to service.
8300003	System internal error.
8300999	Unknown error code.

Example

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

call.off('callDisconnectedCause')⁸⁺

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

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

System API: This is a system API.

Required permission: ohos.permission.SET_TELEPHONY_STATE

System capability: SystemCapability.Telephony.CallManager

Parameters

Name	Type	Mandatory	Description
type	string	Yes	Call disconnection cause. This field has a fixed value of callDisconnectedCause.
callback	Callback<DisconnectedDetails>	No	Callback used to return the result. If this field is not set, no subscription cancellation result will be received.

Error codes

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

ID	Error Message
201	Permission denied.
202	Non-system applications use system APIs.
401	Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2. Incorrect parameters types;
8300001	Invalid parameter value.
8300002	Operation failed. Cannot connect to service.
8300003	System internal error.
8300999	Unknown error code.

Example

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

call.off('mmiCodeResult')⁹⁺

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

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

System API: This is a system API.

Required permission: ohos.permission.SET_TELEPHONY_STATE

System capability: SystemCapability.Telephony.CallManager

Parameters

Name	Type	Mandatory	Description
type	string	Yes	MMI code result. This field has a fixed value of mmiCodeResult.
callback	Callback<MmiCodeResults>	No	Callback used to return the result. If this field is not set, no subscription cancellation result will be received.

Error codes

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

ID	Error Message
201	Permission denied.
202	Non-system applications use system APIs.
401	Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2. Incorrect parameters types;
8300001	Invalid parameter value.
8300002	Operation failed. Cannot connect to service.
8300003	System internal error.
8300999	Unknown error code.

Example

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

call.on('audioDeviceChange')¹⁰⁺

on(type: 'audioDeviceChange', callback: Callback<AudioDeviceCallbackInfo>): 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<AudioDeviceCallbackInfo>	Yes	Callback used to return the result.

Error codes

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

ID	Error Message
201	Permission denied.
202	Non-system applications use system APIs.
401	Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2. Incorrect parameters types;
8300001	Invalid parameter value.
8300002	Operation failed. Cannot connect to service.
8300003	System internal error.
8300999	Unknown error code.

Example

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

call.off('audioDeviceChange')¹⁰⁺

off(type: 'audioDeviceChange', callback?: Callback<AudioDeviceCallbackInfo>): 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<AudioDeviceCallbackInfo>	No	Callback used to return the result. If this field is not set, no subscription cancellation result will be received.

Error codes

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

ID	Error Message
201	Permission denied.
202	Non-system applications use system APIs.
401	Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2. Incorrect parameters types;
8300001	Invalid parameter value.
8300002	Operation failed. Cannot connect to service.
8300003	System internal error.
8300999	Unknown error code.

Example

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

call.on('postDialDelay')¹¹⁺

on(type: 'postDialDelay', callback: Callback<string>): void

Subscribes to postDialDelay 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	Post-dial delay. This field has a fixed value of postDialDelay.
callback	Callback<string>	Yes	Callback used to return the result.

Error codes

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

ID	Error Message
201	Permission denied.
202	Non-system applications use system APIs.
401	Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2. Incorrect parameters types;
8300001	Invalid parameter value.
8300002	Operation failed. Cannot connect to service.
8300003	System internal error.
8300999	Unknown error code.

Example

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

call.off('postDialDelay')¹¹⁺

off(type: 'postDialDelay', callback?: Callback<string>): void

Unsubscribes from postDialDelay 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	Post-dial delay. This field has a fixed value of postDialDelay.
callback	Callback<string>	No	Callback used to return the result. If this field is not set, no subscription cancellation result will be received.

Error codes

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

ID	Error Message
201	Permission denied.
202	Non-system applications use system APIs.
401	Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2. Incorrect parameters types;
8300001	Invalid parameter value.
8300002	Operation failed. Cannot connect to service.
8300003	System internal error.
8300999	Unknown error code.

Example

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

call.isNewCallAllowed⁸⁺

isNewCallAllowed(callback: AsyncCallback<boolean>): void

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

System API: This is a system API.

System capability: SystemCapability.Telephony.CallManager

Parameters

Name	Type	Mandatory	Description
callback	AsyncCallback<boolean>	Yes	Callback function used to return the result. The value true indicates that the call is allowed, and the value false indicates the opposite.

Error codes

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

ID	Error Message
202	Non-system applications use system APIs.
401	Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2. Incorrect parameters types;
8300001	Invalid parameter value.
8300002	Operation failed. Cannot connect to service.
8300003	System internal error.
8300999	Unknown error code.

Example

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

call.isNewCallAllowed((err: BusinessError, data: boolean) => {
    if (err) {
        console.error(`isNewCallAllowed fail, err->${JSON.stringify(err)}`);
    } else {
        console.info(`isNewCallAllowed success, data->${JSON.stringify(data)}`);
    }
});

call.isNewCallAllowed⁸⁺

isNewCallAllowed(): Promise<boolean>

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

System API: This is a system API.

System capability: SystemCapability.Telephony.CallManager

Return value

Type	Description
Promise<boolean>	Promise used to return the result. The value true indicates that the call is allowed, and the value false indicates the opposite.

Error codes

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

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

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

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

call.separateConference¹¹⁺

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

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

System API: This is a system API.

Required permission: ohos.permission.SET_TELEPHONY_STATE

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 error codes, see Telephony Error Codes and Universal Error Codes.

ID	Error Message
202	Non-system applications use system APIs.
401	Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2. Incorrect parameters types;
8300001	Invalid parameter value.
8300002	Operation failed. Cannot connect to service.
8300003	System internal error.
8300008	Conference call is not active.
8300999	Unknown error code.

Example

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

call.separateConference(1, (err: BusinessError) => {
    if (err) {
        console.error(`separateConference fail, err->${JSON.stringify(err)}`);
    } else {
        console.info(`separateConference success.`);
    }
});

call.separateConference¹¹⁺

separateConference(callId: number): Promise<void>

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

System API: This is a system API.

System capability: SystemCapability.Telephony.CallManager

Parameters

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 error codes, see Telephony Error Codes and Universal Error Codes.

ID	Error Message
202	Non-system applications use system APIs.
401	Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2. Incorrect parameters types;
8300001	Invalid parameter value.
8300002	Operation failed. Cannot connect to service.
8300003	System internal error.
8300008	Conference call is not active.
8300999	Unknown error code.

Example

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

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

call.getCallRestrictionStatus⁸⁺

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

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

System API: This is a system API.

Required permission: ohos.permission.GET_TELEPHONY_STATE

System capability: SystemCapability.Telephony.CallManager

Parameters

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

Error codes

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

ID	Error Message
201	Permission denied.
202	Non-system applications use system APIs.
401	Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2. Incorrect parameters types;
801	Capability not supported.
8300001	Invalid parameter value.
8300002	Operation failed. Cannot connect to service.
8300003	System internal error.

Example

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

call.getCallRestrictionStatus(0, 1, (err: BusinessError, data: call.RestrictionStatus) => {
    if (err) {
        console.error(`getCallRestrictionStatus fail, err->${JSON.stringify(err)}`);
    } else {
        console.info(`getCallRestrictionStatus success, data->${JSON.stringify(data)}`);
    }
});

call.getCallRestrictionStatus⁸⁺

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

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

System API: This is a system API.

Required permission: ohos.permission.GET_TELEPHONY_STATE

System capability: SystemCapability.Telephony.CallManager

Parameters

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

Return value

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

Error codes

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

ID	Error Message
201	Permission denied.
202	Non-system applications use system APIs.
401	Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2. Incorrect parameters types;
801	Capability not supported.
8300001	Invalid parameter value.
8300002	Operation failed. Cannot connect to service.
8300003	System internal error.

Example

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

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

call.setCallRestriction⁸⁺

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

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

System API: This is a system API.

Required permission: ohos.permission.SET_TELEPHONY_STATE

System capability: SystemCapability.Telephony.CallManager

Parameters

Name	Type	Mandatory	Description
slotId	number	Yes	Card slot ID. - 0: card slot 1. - 1: card slot 2.
info	CallRestrictionInfo	Yes	Call restriction information.
callback	AsyncCallback<void>	Yes	Callback used to return the result.

Error codes

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

ID	Error Message
201	Permission denied.
202	Non-system applications use system APIs.
401	Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2. Incorrect parameters types;
801	Capability not supported.
8300001	Invalid parameter value.
8300002	Operation failed. Cannot connect to service.
8300003	System internal error.

Example

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

let callRestrictionInfo: call.CallRestrictionInfo = {
    type: call.CallRestrictionType.RESTRICTION_TYPE_ALL_OUTGOING,
    password: "123456",
    mode: call.CallRestrictionMode.RESTRICTION_MODE_ACTIVATION
}
call.setCallRestriction(0, callRestrictionInfo, (err: BusinessError) => {
    if (err) {
        console.error(`setCallRestriction fail, err->${JSON.stringify(err)}`);
    } else {
        console.info(`setCallRestriction success.`);
    }
});

call.setCallRestriction⁸⁺

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

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

System API: This is a system API.

Required permission: ohos.permission.SET_TELEPHONY_STATE

System capability: SystemCapability.Telephony.CallManager

Parameters

Name	Type	Mandatory	Description
slotId	number	Yes	Card slot ID. - 0: card slot 1. - 1: card slot 2.
info	CallRestrictionInfo	Yes	Call restriction information.

Return value

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

Error codes

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

ID	Error Message
201	Permission denied.
202	Non-system applications use system APIs.
401	Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2. Incorrect parameters types;
801	Capability not supported.
8300001	Invalid parameter value.
8300002	Operation failed. Cannot connect to service.
8300003	System internal error.

Example

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

let callRestrictionInfo: call.CallRestrictionInfo = {
    type: call.CallRestrictionType.RESTRICTION_TYPE_ALL_INCOMING,
    password: "123456",
    mode: call.CallRestrictionMode.RESTRICTION_MODE_ACTIVATION
}
call.setCallRestriction(0, callRestrictionInfo).then(() => {
    console.info(`setCallRestriction success.`);
}).catch((err: BusinessError) => {
    console.error(`setCallRestriction fail, promise: err->${JSON.stringify(err)}`);
});

call.setCallRestrictionPassword¹⁰⁺

setCallRestrictionPassword(slotId: number, oldPassword: string, newPassword: string, callback: AsyncCallback<void>): 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 error codes, see Telephony Error Codes and Universal Error Codes.

ID	Error Message
201	Permission denied.
202	Non-system applications use system APIs.
401	Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2. Incorrect parameters types;
801	Capability not supported.
8300001	Invalid parameter value.
8300002	Operation failed. Cannot connect to service.
8300003	System internal error.

Example

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

call.setCallRestrictionPassword(0, "123456", "654321", (err: BusinessError) => {
    if (err) {
        console.error(`setCallRestrictionPassword fail, err->${JSON.stringify(err)}`);
    } else {
        console.info(`setCallRestrictionPassword success.`);
    }
});

call.setCallRestrictionPassword¹⁰⁺

setCallRestrictionPassword(slotId: number, oldPassword: string, newPassword: string): Promise<void>

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 error codes, see Telephony Error Codes and Universal Error Codes.

ID	Error Message
201	Permission denied.
202	Non-system applications use system APIs.
401	Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2. Incorrect parameters types;
801	Capability not supported.
8300001	Invalid parameter value.
8300002	Operation failed. Cannot connect to service.
8300003	System internal error.

Example

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

call.setCallRestrictionPassword(0, "123456", "654321").then(() => {
    console.info(`setCallRestrictionPassword success.`);
}).catch((err: BusinessError) => {
    console.error(`setCallRestrictionPassword fail, promise: err->${JSON.stringify(err)}`);
});

call.getCallTransferInfo⁸⁺

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

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

System API: This is a system API.

Required permission: ohos.permission.GET_TELEPHONY_STATE

System capability: SystemCapability.Telephony.CallManager

Parameters

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

Error codes

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

ID	Error Message
201	Permission denied.
202	Non-system applications use system APIs.
401	Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2. Incorrect parameters types;
801	Capability not supported.
8300001	Invalid parameter value.
8300002	Operation failed. Cannot connect to service.
8300003	System internal error.

Example

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

call.getCallTransferInfo(0, call.CallTransferType.TRANSFER_TYPE_BUSY, (err: BusinessError, data: call.CallTransferResult) => {
    if (err) {
        console.error(`getCallTransferInfo fail, err->${JSON.stringify(err)}`);
    } else {
        console.info(`getCallTransferInfo success, data->${JSON.stringify(data)}`);
    }
});

call.getCallTransferInfo⁸⁺

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

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

System API: This is a system API.

Required permission: ohos.permission.GET_TELEPHONY_STATE

System capability: SystemCapability.Telephony.CallManager

Parameters

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

Return value

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

Error codes

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

ID	Error Message
201	Permission denied.
202	Non-system applications use system APIs.
401	Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2. Incorrect parameters types;
801	Capability not supported.
8300001	Invalid parameter value.
8300002	Operation failed. Cannot connect to service.
8300003	System internal error.

Example

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

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

call.setCallTransfer⁸⁺

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

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

System API: This is a system API.

Required permission: ohos.permission.SET_TELEPHONY_STATE

System capability: SystemCapability.Telephony.CallManager

Parameters

Name	Type	Mandatory	Description
slotId	number	Yes	Card slot ID. - 0: card slot 1. - 1: card slot 2.
info	CallTransferInfo	Yes	Call transfer information.
callback	AsyncCallback<void>	Yes	Callback used to return the result.

Error codes

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

ID	Error Message
201	Permission denied.
202	Non-system applications use system APIs.
401	Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2. Incorrect parameters types;
801	Capability not supported.
8300001	Invalid parameter value.
8300002	Operation failed. Cannot connect to service.
8300003	System internal error.

Example

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

let callTransferInfo: call.CallTransferInfo = {
    transferNum: "111",
    type: call.CallTransferType.TRANSFER_TYPE_BUSY,
    settingType: call.CallTransferSettingType.CALL_TRANSFER_ENABLE
}
call.setCallTransfer(0, callTransferInfo, (err: BusinessError) => {
    if (err) {
        console.error(`setCallTransfer fail, err->${JSON.stringify(err)}`);
    } else {
        console.info(`setCallTransfer success.`);
    }
});

call.setCallTransfer⁸⁺

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

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

System API: This is a system API.

Required permission: ohos.permission.SET_TELEPHONY_STATE

System capability: SystemCapability.Telephony.CallManager

Parameters

Name	Type	Mandatory	Description
slotId	number	Yes	Card slot ID. - 0: card slot 1. - 1: card slot 2.
info	CallTransferInfo	Yes	Call transfer information.

Return value

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

Error codes

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

ID	Error Message
201	Permission denied.
202	Non-system applications use system APIs.
401	Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2. Incorrect parameters types;
801	Capability not supported.
8300001	Invalid parameter value.
8300002	Operation failed. Cannot connect to service.
8300003	System internal error.

Example

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

let callTransferInfo: call.CallTransferInfo = {
    transferNum: "111",
    type: call.CallTransferType.TRANSFER_TYPE_BUSY,
    settingType: call.CallTransferSettingType.CALL_TRANSFER_ENABLE
}
call.setCallTransfer(0, callTransferInfo).then(() => {
    console.info(`setCallTransfer success.`);
}).catch((err: BusinessError) => {
    console.error(`setCallTransfer fail, promise: err->${JSON.stringify(err)}`);
});

call.isRinging⁸⁺

isRinging(callback: AsyncCallback<boolean>): void

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

System API: This is a system API.

Required permission: ohos.permission.SET_TELEPHONY_STATE

System capability: SystemCapability.Telephony.CallManager

Parameters

Name	Type	Mandatory	Description
callback	AsyncCallback<boolean>	Yes	Callback used to return the result. The value true indicates that the ringtone is playing, and the value false indicates the opposite.

Error codes

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

ID	Error Message
201	Permission denied.
202	Non-system applications use system APIs.
401	Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2. Incorrect parameters types;
8300001	Invalid parameter value.
8300002	Operation failed. Cannot connect to service.
8300003	System internal error.
8300999	Unknown error code.

Example

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

call.isRinging((err: BusinessError, data: boolean) => {
    if (err) {
        console.error(`isRinging fail, err->${JSON.stringify(err)}`);
    } else {
        console.info(`isRinging success, data->${JSON.stringify(data)}`);
    }
});

call.isRinging⁸⁺

isRinging(): Promise<boolean>

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

System API: This is a system API.

Required permission: ohos.permission.SET_TELEPHONY_STATE

System capability: SystemCapability.Telephony.CallManager

Return value

Type	Description
Promise<boolean>	Promise used to return the result. The value true indicates that the ringtone is playing, and the value false indicates the opposite.

Error codes

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

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

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

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

call.setMuted⁸⁺

setMuted(callback: AsyncCallback<void>): void

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

System API: This is a system API.

System capability: SystemCapability.Telephony.CallManager

Parameters

Name	Type	Mandatory	Description
callback	AsyncCallback<void>	Yes	Callback used to return the result.

Error codes

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

ID	Error Message
202	Non-system applications use system APIs.
401	Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2. Incorrect parameters types;
8300001	Invalid parameter value.
8300002	Operation failed. Cannot connect to service.
8300003	System internal error.
8300999	Unknown error code.

Example

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

call.setMuted((err: BusinessError) => {
    if (err) {
        console.error(`setMuted fail, err->${JSON.stringify(err)}`);
    } else {
        console.info(`setMuted success.`);
    }
});

call.setMuted⁸⁺

setMuted(): Promise<void>

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

System API: This is a system API.

System capability: SystemCapability.Telephony.CallManager

Return value

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

Error codes

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

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

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

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

call.cancelMuted⁸⁺

cancelMuted(callback: AsyncCallback<void>): void

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

System API: This is a system API.

System capability: SystemCapability.Telephony.CallManager

Parameters

Name	Type	Mandatory	Description
callback	AsyncCallback<void>	Yes	Callback used to return the result.

Error codes

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

ID	Error Message
202	Non-system applications use system APIs.
401	Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2. Incorrect parameters types;
8300001	Invalid parameter value.
8300002	Operation failed. Cannot connect to service.
8300003	System internal error.
8300999	Unknown error code.

Example

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

call.cancelMuted((err: BusinessError) => {
    if (err) {
        console.error(`cancelMuted fail, err->${JSON.stringify(err)}`);
    } else {
        console.info(`cancelMuted success.`);
    }
});

call.cancelMuted⁸⁺

cancelMuted(): Promise<void>

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

System API: This is a system API.

System capability: SystemCapability.Telephony.CallManager

Return value

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

Error codes

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

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

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

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

call.setAudioDevice⁸⁺

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

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

System API: This is a system API.

Required permission: ohos.permission.SET_TELEPHONY_STATE

System capability: SystemCapability.Telephony.CallManager

Parameters

Name	Type	Mandatory	Description
device	AudioDevice	Yes	Audio device.
callback	AsyncCallback<void>	Yes	Callback used to return the result.

Error codes

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

ID	Error Message
201	Permission denied.
202	Non-system applications use system APIs.
401	Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2. Incorrect parameters types;
8300001	Invalid parameter value.
8300002	Operation failed. Cannot connect to service.
8300003	System internal error.
8300999	Unknown error code.

Example

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

let audioDevice: call.AudioDevice = {
    deviceType: call.AudioDeviceType.DEVICE_EARPIECE
}
call.setAudioDevice(audioDevice, (err: BusinessError) => {
    if (err) {
        console.error(`setAudioDevice fail, err->${JSON.stringify(err)}`);
    } else {
        console.info(`setAudioDevice success.`);
    }
});

call.setAudioDevice¹⁰⁺

setAudioDevice(device: AudioDevice): Promise<void>

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	Yes	Audio device.

Return value

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

Error codes

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

ID	Error Message
201	Permission denied.
202	Non-system applications use system APIs.
401	Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2. Incorrect parameters types;
8300001	Invalid parameter value.
8300002	Operation failed. Cannot connect to service.
8300003	System internal error.
8300999	Unknown error code.

Example

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

let audioDevice: call.AudioDevice = {
    deviceType: call.AudioDeviceType.DEVICE_EARPIECE
}
call.setAudioDevice(audioDevice).then(() => {
    console.info(`setAudioDevice success.`);
}).catch((err: BusinessError) => {
    console.error(`setAudioDevice fail, promise: err->${JSON.stringify(err)}`);
});

call.joinConference⁸⁺

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

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

System API: This is a system API.

System capability: SystemCapability.Telephony.CallManager

Parameters

Name	Type	Mandatory	Description
mainCallId	number	Yes	Main call ID.
callNumberList	Array<string>	Yes	List of call numbers.
callback	AsyncCallback<void>	Yes	Callback used to return the result.

Error codes

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

ID	Error Message
202	Non-system applications use system APIs.
401	Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2. Incorrect parameters types;
8300001	Invalid parameter value.
8300002	Operation failed. Cannot connect to service.
8300003	System internal error.
8300999	Unknown error code.

Example

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

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

call.joinConference⁸⁺

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

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

System API: This is a system API.

System capability: SystemCapability.Telephony.CallManager

Parameters

Name	Type	Mandatory	Description
mainCallId	number	Yes	Main call ID.
callNumberList	Array<string>	Yes	List of call numbers.

Return value

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

Error codes

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

ID	Error Message
202	Non-system applications use system APIs.
401	Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2. Incorrect parameters types;
8300001	Invalid parameter value.
8300002	Operation failed. Cannot connect to service.
8300003	System internal error.
8300999	Unknown error code.

Example

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

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

call.updateImsCallMode⁸⁺

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

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

System API: This is a system API.

Required permission: ohos.permission.SET_TELEPHONY_STATE

System capability: SystemCapability.Telephony.CallManager

Parameters

Name	Type	Mandatory	Description
callId	number	Yes	Call ID.
mode	ImsCallMode	Yes	IMS call mode.
callback	AsyncCallback<void>	Yes	Callback used to return the result.

Error codes

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

ID	Error Message
202	Non-system applications use system APIs.
401	Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2. Incorrect parameters types;
8300001	Invalid parameter value.
8300002	Operation failed. Cannot connect to service.
8300003	System internal error.
8300999	Unknown error code.

Example

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

call.updateImsCallMode(1, 1, (err: BusinessError) => {
    if (err) {
        console.error(`updateImsCallMode fail, err->${JSON.stringify(err)}`);
    } else {
        console.info(`updateImsCallMode success.`);
    }
});

call.updateImsCallMode⁸⁺

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

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

System API: This is a system API.

System capability: SystemCapability.Telephony.CallManager

Parameters

Name	Type	Mandatory	Description
callId	number	Yes	Call ID.
mode	ImsCallMode	Yes	IMS call mode.

Return value

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

Error codes

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

ID	Error Message
202	Non-system applications use system APIs.
401	Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2. Incorrect parameters types;
8300001	Invalid parameter value.
8300002	Operation failed. Cannot connect to service.
8300003	System internal error.
8300999	Unknown error code.

Example

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

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

call.enableImsSwitch⁸⁺

enableImsSwitch(slotId: number, callback: AsyncCallback<void>): 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 error codes, see Telephony Error Codes and Universal Error Codes.

ID	Error Message
201	Permission denied.
202	Non-system applications use system APIs.
401	Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2. Incorrect parameters types;
8300001	Invalid parameter value.
8300002	Operation failed. Cannot connect to service.
8300003	System internal error.
8300999	Unknown error code.

Example

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

call.enableImsSwitch(0, (err: BusinessError) => {
    if (err) {
        console.error(`enableImsSwitch fail, err->${JSON.stringify(err)}`);
    } else {
        console.info(`enableImsSwitch success.`);
    }
});

call.enableImsSwitch⁸⁺

enableImsSwitch(slotId: number): Promise<void>

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 error codes, see Telephony Error Codes and Universal Error Codes.

ID	Error Message
201	Permission denied.
202	Non-system applications use system APIs.
401	Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2. Incorrect parameters types;
8300001	Invalid parameter value.
8300002	Operation failed. Cannot connect to service.
8300003	System internal error.
8300999	Unknown error code.

Example

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

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

call.disableImsSwitch⁸⁺

disableImsSwitch(slotId: number, callback: AsyncCallback<void>): 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 error codes, see Telephony Error Codes and Universal Error Codes.

ID	Error Message
201	Permission denied.
202	Non-system applications use system APIs.
401	Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2. Incorrect parameters types;
8300001	Invalid parameter value.
8300002	Operation failed. Cannot connect to service.
8300003	System internal error.
8300999	Unknown error code.

Example

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

call.disableImsSwitch(0, (err: BusinessError) => {
    if (err) {
        console.error(`disableImsSwitch fail, err->${JSON.stringify(err)}`);
    } else {
        console.info(`disableImsSwitch success.`);
    }
});

call.disableImsSwitch⁸⁺

disableImsSwitch(slotId: number): Promise<void>

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 error codes, see Telephony Error Codes and Universal Error Codes.

ID	Error Message
201	Permission denied.
202	Non-system applications use system APIs.
401	Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2. Incorrect parameters types;
8300001	Invalid parameter value.
8300002	Operation failed. Cannot connect to service.
8300003	System internal error.
8300999	Unknown error code.

Example

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

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

call.isImsSwitchEnabled⁸⁺

isImsSwitchEnabled(slotId: number, callback: AsyncCallback<boolean>): 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. The value true indicates that the IMS service is enabled, and the value false indicates the opposite. The value true indicates that the IMS service is enabled, and the value false indicates the opposite.

Error codes

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

ID	Error Message
202	Non-system applications use system APIs.
401	Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2. Incorrect parameters types;
8300001	Invalid parameter value.
8300002	Operation failed. Cannot connect to service.
8300003	System internal error.
8300999	Unknown error code.

Example

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

call.isImsSwitchEnabled(0, (err: BusinessError, data: boolean) => {
    if (err) {
        console.error(`isImsSwitchEnabled fail, err->${JSON.stringify(err)}`);
    } else {
        console.info(`isImsSwitchEnabled success, data->${JSON.stringify(data)}`);
    }
});

call.isImsSwitchEnabled⁸⁺

isImsSwitchEnabled(slotId: number): Promise<boolean>

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<boolean>	Promise used to return the result. The value true indicates that the IMS service is enabled, and the value false indicates the opposite.

Error codes

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

ID	Error Message
202	Non-system applications use system APIs.
401	Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2. Incorrect parameters types;
8300001	Invalid parameter value.
8300002	Operation failed. Cannot connect to service.
8300003	System internal error.
8300999	Unknown error code.

Example

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

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

call.isImsSwitchEnabledSync¹²⁺

isImsSwitchEnabledSync(slotId: number): boolean

Checks whether the IMS service is enabled. This API returns the result synchronously.

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
boolean	Boolean value indicating whether the IMS service is enabled. The value true indicates that the IMS service is enabled, and the value false indicates the opposite.

Error codes

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

ID	Error Message
202	Non-system applications use system APIs.
401	Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2. Incorrect parameters types;
8300001	Invalid parameter value.
8300002	Operation failed. Cannot connect to service.
8300003	System internal error.
8300999	Unknown error code.

Example

let slotId: number = 0;
try {
    let isEnabled: boolean = call.isImsSwitchEnabledSync(slotId);
    console.info(`isImsSwitchEnabledSync success : ${isEnabled}`);
} catch (error) {
    console.error(`isImsSwitchEnabledSync fail : err->${JSON.stringify(error)}`);  
}

call.closeUnfinishedUssd¹⁰⁺

closeUnfinishedUssd(slotId: number, callback: AsyncCallback<void>): 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 error codes, see Telephony Error Codes and Universal Error Codes.

ID	Error Message
201	Permission denied.
202	Non-system applications use system APIs.
401	Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2. Incorrect parameters types;
8300001	Invalid parameter value.
8300002	Operation failed. Cannot connect to service.
8300003	System internal error.
8300999	Unknown error code.

Example

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

let slotId: number = 0;
call.closeUnfinishedUssd(slotId, (err: BusinessError) => {
    if (err) {
        console.error(`closeUnfinishedUssd fail, err->${JSON.stringify(err)}`);
    } else {
        console.info(`closeUnfinishedUssd success.`);
    }
});

call.closeUnfinishedUssd¹⁰⁺

closeUnfinishedUssd(slotId: number): Promise<void>

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 error codes, see Telephony Error Codes and Universal Error Codes.

ID	Error Message
201	Permission denied.
202	Non-system applications use system APIs.
401	Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2. Incorrect parameters types;
8300001	Invalid parameter value.
8300002	Operation failed. Cannot connect to service.
8300003	System internal error.
8300999	Unknown error code.

Example

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

let slotId: number = 0;
call.closeUnfinishedUssd(slotId).then(() => {
    console.info(`closeUnfinishedUssd success.`);
}).catch((err: BusinessError) => {
    console.error(`closeUnfinishedUssd fail, promise: err->${JSON.stringify(err)}`);
});

call.setVoNRState¹⁰⁺

setVoNRState(slotId: number, state: VoNRState, callback: AsyncCallback<void>): 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	Yes	Status of the VoNR switch.
callback	AsyncCallback<void>	Yes	Callback used to return the result.

Error codes

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

ID	Error Message
201	Permission denied.
202	Non-system applications use system APIs.
401	Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2. Incorrect parameters types;
8300001	Invalid parameter value.
8300002	Operation failed. Cannot connect to service.
8300003	System internal error.
8300999	Unknown error code.

Example

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

let slotId: number = 0;
let state: call.VoNRState = call.VoNRState.VONR_STATE_ON;
call.setVoNRState(slotId, state, (err: BusinessError) => {
    if (err) {
        console.error(`setVoNRState fail, err->${JSON.stringify(err)}`);
    } else {
        console.info(`setVoNRState success`);
    }
});

call.setVoNRState¹⁰⁺

setVoNRState(slotId: number, state: VoNRState): Promise<void>

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	Yes	Status of the VoNR switch.

Return value

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

Error codes

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

ID	Error Message
201	Permission denied.
202	Non-system applications use system APIs.
401	Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2. Incorrect parameters types;
8300001	Invalid parameter value.
8300002	Operation failed. Cannot connect to service.
8300003	System internal error.
8300999	Unknown error code.

Example

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

let slotId: number = 0;
let state: call.VoNRState = call.VoNRState.VONR_STATE_ON;
call.setVoNRState(slotId, state).then(() => {
    console.info(`setVoNRState success`);
}).catch((err: BusinessError) => {
    console.error(`setVoNRState fail, promise: err->${JSON.stringify(err)}`);
});

call.getVoNRState¹⁰⁺

getVoNRState(slotId: number, callback: AsyncCallback<VoNRState>): 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>	Yes	Callback used to return the result.

Error codes

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

ID	Error Message
201	Permission denied.
202	Non-system applications use system APIs.
401	Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2. Incorrect parameters types;
8300001	Invalid parameter value.
8300002	Operation failed. Cannot connect to service.
8300003	System internal error.
8300999	Unknown error code.

Example

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

let slotId: number = 0;
call.getVoNRState(slotId, (err: BusinessError, data: call.VoNRState) => {
    if (err) {
        console.error(`getVoNRState fail, err->${JSON.stringify(err)}`);
    } else {
        console.info(`getVoNRState success, data->${JSON.stringify(data)}`);
    }
});

call.getVoNRState¹⁰⁺

getVoNRState(slotId: number): Promise<VoNRState>

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>	Promise used to return the result.

Error codes

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

ID	Error Message
201	Permission denied.
202	Non-system applications use system APIs.
401	Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2. Incorrect parameters types;
8300001	Invalid parameter value.
8300002	Operation failed. Cannot connect to service.
8300003	System internal error.
8300999	Unknown error code.

Example

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

let slotId: number = 0;
call.getVoNRState(slotId).then((data: call.VoNRState) => {
    console.info(`getVoNRState success, promise: data->${JSON.stringify(data)}`);
}).catch((err: BusinessError) => {
    console.error(`getVoNRState fail, promise: err->${JSON.stringify(err)}`);
});

call.canSetCallTransferTime¹⁰⁺

canSetCallTransferTime(slotId: number, callback: AsyncCallback<boolean>): 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. 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 error codes, see Telephony Error Codes and Universal Error Codes.

ID	Error Message
201	Permission denied.
202	Non-system applications use system APIs.
401	Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2. Incorrect parameters types;
8300001	Invalid parameter value.
8300002	Operation failed. Cannot connect to service.
8300003	System internal error.
8300999	Unknown error code.

Example

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

let slotId: number = 0;
call.canSetCallTransferTime(slotId, (err: BusinessError, data: boolean) => {
    if (err) {
        console.error(`canSetCallTransferTime fail, err->${JSON.stringify(err)}`);
    } else {
        console.info(`canSetCallTransferTime success, data->${JSON.stringify(data)}`);
    }
});

call.canSetCallTransferTime¹⁰⁺

canSetCallTransferTime(slotId: number): Promise<boolean>

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. 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 error codes, see Telephony Error Codes and Universal Error Codes.

ID	Error Message
201	Permission denied.
202	Non-system applications use system APIs.
401	Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2. Incorrect parameters types;
8300001	Invalid parameter value.
8300002	Operation failed. Cannot connect to service.
8300003	System internal error.
8300999	Unknown error code.

Example

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

let slotId: number = 0;
call.canSetCallTransferTime(slotId).then((data: boolean) => {
    console.info(`canSetCallTransferTime success, promise: data->${JSON.stringify(data)}`);
}).catch((err: BusinessError) => {
    console.error(`canSetCallTransferTime fail, promise: err->${JSON.stringify(err)}`);
});

call.inputDialerSpecialCode¹⁰⁺

inputDialerSpecialCode(inputCode: string, callback: AsyncCallback<void>): 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 error codes, see Telephony Error Codes and Universal Error Codes.

ID	Error Message
201	Permission denied.
202	Non-system applications use system APIs.
401	Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2. Incorrect parameters types;
8300001	Invalid parameter value.
8300002	Operation failed. Cannot connect to service.
8300003	System internal error.

Example

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

call.inputDialerSpecialCode('*#*#2846579#*#*', (err: BusinessError) => {
    if (err) {
        console.error(`inputDialerSpecialCode fail, err->${JSON.stringify(err)}`);
    } else {
        console.info(`inputDialerSpecialCode success`);
    }
});

call.inputDialerSpecialCode¹⁰⁺

inputDialerSpecialCode(inputCode: string): Promise<void>

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 error codes, see Telephony Error Codes and Universal Error Codes.

ID	Error Message
201	Permission denied.
202	Non-system applications use system APIs.
401	Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2. Incorrect parameters types;
8300001	Invalid parameter value.
8300002	Operation failed. Cannot connect to service.
8300003	System internal error.

Example

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

try {
    call.inputDialerSpecialCode('*#*#2846579#*#*');
    console.info(`inputDialerSpecialCode success`);
} catch (error) {
    console.error(`inputDialerSpecialCode fail, promise: err->${JSON.stringify(error)}`);
}

call.removeMissedIncomingCallNotification¹⁰⁺

removeMissedIncomingCallNotification(callback: AsyncCallback<void>): 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 error codes, see Telephony Error Codes and Universal Error Codes.

ID	Error Message
201	Permission denied.
202	Non-system applications use system APIs.
401	Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2. Incorrect parameters types;
8300002	Operation failed. Cannot connect to service.
8300003	System internal error.
8300999	Unknown error code.

Example

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

call.removeMissedIncomingCallNotification((err: BusinessError) => {
    if (err) {
        console.error(`removeMissedIncomingCallNotification failed, err->${JSON.stringify(err)}`);
    } else {
        console.info(`removeMissedIncomingCallNotification success`);
    }
});

call.removeMissedIncomingCallNotification¹⁰⁺

removeMissedIncomingCallNotification(): Promise<void>

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 error codes, see Telephony Error Codes and Universal Error Codes.

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

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

call.removeMissedIncomingCallNotification().then(() => {
    console.info(`removeMissedIncomingCallNotification success`);
}).catch((err: BusinessError) => {
    console.error(`removeMissedIncomingCallNotification failed, promise: err->${JSON.stringify(err)}`);
});

call.sendCallUiEvent¹²⁺

sendCallUiEvent(callId: number, eventName: string): Promise<void>

Sends a call UI event. 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
callId	number	Yes	Call ID.
eventName	string	Yes	Event name.

Return value

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

Error codes

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

ID	Error Message
201	Permission denied.
202	Non-system applications use system APIs.
401	Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2. Incorrect parameters types;
8300001	Invalid parameter value.
8300002	Operation failed. Cannot connect to service.
8300003	System internal error.
8300999	Unknown error code.

Example

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

let callId: number = 0;
call.sendCallUiEvent(callId, 'eventName').then(() => {
    console.info(`sendCallUiEvent success.`);
}).catch((err: BusinessError) => {
    console.error(`sendCallUiEvent fail, 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
accountId 8+	number	No	Account ID. - 0: card slot 1. - 1: card slot 2. This is a system API.
videoState 8+	VideoStateType	No	Video state type. This is a system API.
dialScene 8+	DialScene	No	Dialup scenario. This is a system API.
dialType 8+	DialType	No	Dialup type. This is a system API.

DialCallOptions⁹⁺

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	No	Video state type.
dialScene 9+	DialScene	No	Dialup scenario.
dialType 9+	DialType	No	Dialup type.

ImsCallMode⁸⁺

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.

VoNRState¹⁰⁺

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.

AudioDevice¹⁰⁺

Enumerates audio devices.

System API: This is a system API.

System capability: SystemCapability.Telephony.CallManager

Name	Type	Mandatory	Description
deviceType	AudioDeviceType	Yes	Audio device type.
address	string	No	Audio device address.
deviceName 11+	string	No	Audio device name.

AudioDeviceType¹⁰⁺

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.
DEVICE_DISTRIBUTED_AUTOMOTIVE11+	4	Distributed head unit.

AudioDeviceCallbackInfo¹⁰⁺

Defines the audio device information.

System API: This is a system API.

System capability: SystemCapability.Telephony.CallManager

Name	Type	Mandatory	Description
audioDeviceList	Array<AudioDevice>	Yes	Audio device list.
currentAudioDevice	AudioDevice	Yes	Current audio device.
isMuted	boolean	Yes	Whether the audio device is muted.

CallRestrictionType⁸⁺

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.

CallTransferInfo⁸⁺

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	Yes	Call transfer type.
settingType	CallTransferSettingType	Yes	Enumerates call transfer setting types.
startHour9+	number	No	Hour in the start time.
startMinute9+	number	No	Minute in the start time.
endHour9+	number	No	Hour in the end time.
endMinute9+	number	No	Minute in the end time.

CallTransferType⁸⁺

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.

CallTransferSettingType⁸⁺

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.

CallAttributeOptions⁷⁺

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	Whether the speakerphone is used to answer a call. The default value is false. - true: yes - false: no
accountId	number	Yes	Account ID.
videoState	VideoStateType	Yes	Video state type.
startTime	number	Yes	Start time.
isEcc	boolean	Yes	Whether the call is an ECC. The default value is false. - true: yes - false: no
callType	CallType	Yes	Enumerates call types.
callId	number	Yes	Call ID.
callState	DetailedCallState	Yes	Detailed call state.
conferenceState	ConferenceState	Yes	Enumerates conference states.
voipCallAttribute11+	VoipCallAttribute	No	Defines the VoIP call information.
crsType11+	number	Yes	Video RBT type.
originalCallType11+	number	Yes	Original call type of the Video RBT service.
numberLocation12+	string	No	Home location area of the number.
numberMarkInfo12+	NumberMarkInfo	No	Number mark.

VoipCallAttribute¹¹⁺

Defines the VoIP call information.

System API: This is a system API.

System capability: SystemCapability.Telephony.CallManager

Name	Type	Mandatory	Description
voipCallId	string	Yes	Unique ID of a VoIP call.
userName	string	Yes	User nickname.
userProfile	image.PixelMap	Yes	User profile picture.
extensionId	string	Yes	Process ID of the third-party application.
abilityName	string	Yes	Ability name of the third-party application.
voipBundleName	string	Yes	Bundle name of the third-party application.
showBannerForIncomingCall12+	boolean	No	Whether to display the incoming call banner.
isConferenceCall12+	boolean	No	Whether the call is a conference call.
isVoiceAnswerSupported12+	boolean	No	Whether call answering with voice commands is supported.

ConferenceState⁷⁺

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.

CallType⁷⁺

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.
TYPE_VOIP11+	4	VoIP call.

VideoStateType⁷⁺

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_SEND_ONLY11+	1	Data sending only during a video call.
TYPE_VIDEO_RECEIVE_ONLY11+	2	Data receiving only during a video call.
TYPE_VIDEO	3	Video state.
TYPE_VIDEO_BIDIRECTIONAL11+	4	Data receiving/sending status during a video call.

DetailedCallState⁷⁺

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	Enumerates call waiting states.
CALL_STATUS_DISCONNECTED	6	Disconnected state.
CALL_STATUS_DISCONNECTING	7	Disconnecting state.
CALL_STATUS_IDLE	8	Idle state.

CallRestrictionInfo⁸⁺

Defines the call restriction information.

System API: This is a system API.

System capability: SystemCapability.Telephony.CallManager

Name	Type	Mandatory	Description
type	CallRestrictionType	Yes	Call restriction type.
password	string	Yes	Password.
mode	CallRestrictionMode	Yes	Enumerates call restriction modes.

CallRestrictionMode⁸⁺

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.

CallEventOptions⁸⁺

Defines the call event options.

System API: This is a system API.

System capability: SystemCapability.Telephony.CallManager

Name	Type	Mandatory	Description
eventId	CallAbilityEventId	Yes	Enumerates call ability event IDs.

CallAbilityEventId⁸⁺

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.
EVENT_HOLD_CALL_FAILED11+	3	Failed to place the call on hold.
EVENT_SWAP_CALL_FAILED11+	4	Failed to place the current call on hold and answer the waiting call.
EVENT_COMBINE_CALL_FAILED11+	5	Failed to combine calls.
EVENT_SPLIT_CALL_FAILED11+	6	Failed to split the call.
EVENT_SHOW_FULL_SCREEN12+	7	Displaying the call UI in full screen.
EVENT_SHOW_FLOAT_WINDOW12+	8	Displaying the call UI in a floating widow.

DialScene⁸⁺

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.

DialType⁸⁺

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.

RejectMessageOptions⁷⁺

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.

CallTransferResult⁸⁺

Defines the call transfer result.

System API: This is a system API.

System capability: SystemCapability.Telephony.CallManager

Name	Type	Mandatory	Description
status	TransferStatus	Yes	Enumerates call transfer states.
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	Hour in the end time.
endMinute9+	number	Yes	Minute in the end time.

CallWaitingStatus⁷⁺

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.

RestrictionStatus⁸⁺

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.

TransferStatus⁸⁺

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.

DisconnectedDetails⁹⁺

Defines the call disconnection cause.

System API: This is a system API.

System capability: SystemCapability.Telephony.CallManager

Name	Type	Mandatory	Description
reason	DisconnectedReason	Yes	Defines the call disconnection cause.
message	string	Yes	Call ending message.

DisconnectedReason⁸⁺

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 reasons of the destination, for example, activation of Anonymous Call Rejection.
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	Stops the 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.

MmiCodeResults⁹⁺

Defines the MMI code result.

System API: This is a system API.

System capability: SystemCapability.Telephony.CallManager

Name	Type	Mandatory	Description
result	MmiCodeResult	Yes	Defines the MMI code result.
message	string	Yes	MMI code message.

MmiCodeResult⁹⁺

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.

call.answerCall¹¹⁺

answerCall(videoState: VideoStateType, callId: number): Promise<void>

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

System API: This is a system API.

Required permission: ohos.permission.ANSWER_CALL

System capability: SystemCapability.Telephony.CallManager

Parameters

Name	Type	Mandatory	Description
videoState	VideoStateType	Yes	Video state.
callId	number	Yes	Call ID. You can obtain the value by subscribing to callDetailsChange events.

Return value

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

Error codes

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

ID	Error Message
201	Permission denied.
202	Non-system applications use system APIs.
401	Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2. Incorrect parameters types;
8300001	Invalid parameter value.
8300002	Operation failed. Cannot connect to service.
8300003	System internal error.
8300999	Unknown error code.

Example

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

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

call.cancelCallUpgrade¹¹⁺

cancelCallUpgrade(callId: number): Promise<void>

Cancels the upgrade of a video 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. You can obtain the value by subscribing to callDetailsChange events.

Return value

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

Error codes

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

ID	Error Message
201	Permission denied.
202	Non-system applications use system APIs.
401	Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2. Incorrect parameters types;
8300001	Invalid parameter value.
8300002	Operation failed. Cannot connect to service.
8300003	System internal error.
8300999	Unknown error code.

Example

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

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

call.controlCamera¹¹⁺

controlCamera(callId: number, cameraId: string): Promise<void>

Uses the specified camera to make a video call. If cameraId is left empty, the camera is disabled. 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
callId	number	Yes	Call ID. You can obtain the value by subscribing to callDetailsChange events.
cameraId	string	Yes	Camera ID. For details about how to obtain the camera ID, see Camera Management.

Return value

Type	Description
Promise<void>	Promise used to return the result of starting, closing, or switching a camera.

Error codes

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

ID	Error Message
201	Permission denied.
202	Non-system applications use system APIs.
401	Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2. Incorrect parameters types;
8300001	Invalid parameter value.
8300002	Operation failed. Cannot connect to service.
8300003	System internal error.
8300999	Unknown error code.

Example

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

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

call.setPreviewSurface¹¹⁺

setPreviewSurface(callId: number, surfaceId: string): Promise<void>

Sets the local preview window. 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
callId	number	Yes	Call ID. You can obtain the value by subscribing to callDetailsChange events.
surfaceId	string	Yes	Preview window ID. For details about how to obtain surfaceId, see getXComponentSurfaceId.

Return value

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

Error codes

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

ID	Error Message
201	Permission denied.
202	Non-system applications use system APIs.
401	Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2. Incorrect parameters types;
8300001	Invalid parameter value.
8300002	Operation failed. Cannot connect to service.
8300003	System internal error.
8300999	Unknown error code.

Example

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

call.setPreviewSurface(1, "surfaceId1").then(() => {
    console.info(`setPreviewSurface success.`);
}).catch((err: BusinessError) => {
    console.error(`setPreviewSurface fail, promise: err->${JSON.stringify(err)}`);
});

call.setDisplaySurface¹¹⁺

setDisplaySurface(callId: number, surfaceId: string): Promise<void>

Sets the remote display window. 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
callId	number	Yes	Call ID. You can obtain the value by subscribing to callDetailsChange events.
surfaceId	string	Yes	Display window ID. For details about how to obtain surfaceId, see getXComponentSurfaceId.

Return value

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

Error codes

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

ID	Error Message
201	Permission denied.
202	Non-system applications use system APIs.
401	Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2. Incorrect parameters types;
8300001	Invalid parameter value.
8300002	Operation failed. Cannot connect to service.
8300003	System internal error.
8300999	Unknown error code.

Example

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

call.setDisplaySurface(1, "surfaceId1").then(() => {
    console.info(`setDisplaySurface success.`);
}).catch((err: BusinessError) => {
    console.error(`setDisplaySurface fail, promise: err->${JSON.stringify(err)}`);
});

call.setDeviceDirection¹¹⁺

setDeviceDirection(callId: number, deviceDirection: DeviceDirection): Promise<void>

Sets the video call screen to follow the device direction. 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
callId	number	Yes	Call ID. You can obtain the value by subscribing to callDetailsChange events.
deviceDirection	DeviceDirection	Yes	Device direction. It determines the direction of the video call screen.

Return value

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

Error codes

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

ID	Error Message
201	Permission denied.
202	Non-system applications use system APIs.
401	Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2. Incorrect parameters types;
8300001	Invalid parameter value.
8300002	Operation failed. Cannot connect to service.
8300003	System internal error.
8300999	Unknown error code.

Example

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

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

call.on('imsCallModeChange')¹¹⁺

on(type: 'imsCallModeChange', callback: Callback<ImsCallModeInfo>): void

Subscribes to imsCallModeChange 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 mode change. This field has a fixed value of imsCallModeChange.
callback	Callback<ImsCallModeInfo>	Yes	Callback used to return the result.

Error codes

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

ID	Error Message
201	Permission denied.
202	Non-system applications use system APIs.
401	Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2. Incorrect parameters types;
8300001	Invalid parameter value.
8300002	Operation failed. Cannot connect to service.
8300003	System internal error.
8300999	Unknown error code.

Example

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

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

call.off('imsCallModeChange')¹¹⁺

off(type: 'imsCallModeChange', callback?: Callback<ImsCallModeInfo>): void

Unsubscribes from imsCallModeChange 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 mode change. This field has a fixed value of imsCallModeChange.
callback	Callback<ImsCallModeInfo>	No	Callback used to return the result. If this field is not set, no subscription cancellation result will be received.

Error codes

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

ID	Error Message
201	Permission denied.
202	Non-system applications use system APIs.
401	Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2. Incorrect parameters types;
8300001	Invalid parameter value.
8300002	Operation failed. Cannot connect to service.
8300003	System internal error.
8300999	Unknown error code.

Example

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

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

call.on('callSessionEvent')¹¹⁺

on(type: 'callSessionEvent', callback: Callback<CallSessionEvent>): void

Subscribes to callSessionEvent 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 session event. This field has a fixed value of callSessionEvent.
callback	Callback<CallSessionEvent>	Yes	Callback used to return the result.

Error codes

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

ID	Error Message
201	Permission denied.
202	Non-system applications use system APIs.
401	Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2. Incorrect parameters types;
8300001	Invalid parameter value.
8300002	Operation failed. Cannot connect to service.
8300003	System internal error.
8300999	Unknown error code.

Example

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

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

call.off('callSessionEvent')¹¹⁺

off(type: 'callSessionEvent', callback?: Callback<CallSessionEvent>): void

Unsubscribes from callSessionEvent 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 session event. This field has a fixed value of callSessionEvent.
callback	Callback<CallSessionEvent>	No	Callback used to return the result. If this field is not set, no subscription cancellation result will be received.

Error codes

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

ID	Error Message
201	Permission denied.
202	Non-system applications use system APIs.
401	Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2. Incorrect parameters types;
8300001	Invalid parameter value.
8300002	Operation failed. Cannot connect to service.
8300003	System internal error.
8300999	Unknown error code.

Example

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

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

call.on('peerDimensionsChange')¹¹⁺

on(type: 'peerDimensionsChange', callback: Callback<PeerDimensionsDetail>): void

Subscribes to peerDimensionsChange 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	Screen resolution change. This field has a fixed value of peerDimensionsChange.
callback	Callback<PeerDimensionsDetail>	Yes	Callback used to return the result.

Error codes

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

ID	Error Message
201	Permission denied.
202	Non-system applications use system APIs.
401	Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2. Incorrect parameters types;
8300001	Invalid parameter value.
8300002	Operation failed. Cannot connect to service.
8300003	System internal error.
8300999	Unknown error code.

Example

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

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

call.off('peerDimensionsChange')¹¹⁺

off(type: 'peerDimensionsChange', callback?: Callback<PeerDimensionsDetail>): void

Unsubscribes from peerDimensionsChange 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	Screen resolution change. This field has a fixed value of peerDimensionsChange.
callback	Callback<PeerDimensionsDetail>	No	Callback used to return the result. If this field is not set, no subscription cancellation result will be received.

Error codes

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

ID	Error Message
201	Permission denied.
202	Non-system applications use system APIs.
401	Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2. Incorrect parameters types;
8300001	Invalid parameter value.
8300002	Operation failed. Cannot connect to service.
8300003	System internal error.
8300999	Unknown error code.

Example

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

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

call.on('cameraCapabilitiesChange')¹¹⁺

on(type: 'cameraCapabilitiesChange', callback: Callback<CameraCapabilities>): void

Subscribes to cameraCapabilitiesChange 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	Camera capability change. This field has a fixed value of cameraCapabilitiesChange.
callback	Callback<CameraCapabilities>	Yes	Callback used to return the result.

Error codes

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

ID	Error Message
201	Permission denied.
202	Non-system applications use system APIs.
401	Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2. Incorrect parameters types;
8300001	Invalid parameter value.
8300002	Operation failed. Cannot connect to service.
8300003	System internal error.
8300999	Unknown error code.

Example

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

call.off('cameraCapabilitiesChange')¹¹⁺

off(type: 'cameraCapabilitiesChange', callback?: Callback<CameraCapabilities>): void

Unsubscribes from cameraCapabilitiesChange 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	Camera capability change. This field has a fixed value of cameraCapabilitiesChange.
callback	Callback<CameraCapabilities>	No	Callback used to return the result. If this field is not set, no subscription cancellation result will be received.

Error codes

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

ID	Error Message
201	Permission denied.
202	Non-system applications use system APIs.
401	Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2. Incorrect parameters types;
8300001	Invalid parameter value.
8300002	Operation failed. Cannot connect to service.
8300003	System internal error.
8300999	Unknown error code.

Example

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

VideoRequestResultType¹¹⁺

Enumerates video call upgrade or downgrade request types.

System API: This is a system API.

System capability: SystemCapability.Telephony.CallManager

Name	Value	Description
TYPE_REQUEST_SUCCESS	0	Success.
TYPE_REQUEST_FAILURE	1	Failed.
TYPE_REQUEST_INVALID	2	Invalid request.
TYPE_REQUEST_TIMED_OUT	3	Request timeout.
TYPE_REQUEST_REJECTED_BY_REMOTE	4	Request denied.
TYPE_REQUEST_UPGRADE_CANCELED	5	Upgrade request canceled.
TYPE_DOWNGRADE_RTP_OR_RTCP_TIMEOUT	100	RTP or RTCP downgrade timeout.
TYPE_DOWNGRADE_RTP_AND_RTCP_TIMEOUT	101	RTP and RTCP downgrade timeout.

DeviceDirection¹¹⁺

Enumerates device directions in a video call.

System API: This is a system API.

System capability: SystemCapability.Telephony.CallManager

Name	Value	Description
DEVICE_DIRECTION_0	0	0-degree direction.
DEVICE_DIRECTION_90	90	90-degree direction.
DEVICE_DIRECTION_180	180	180-degree direction.
DEVICE_DIRECTION_270	270	270-degree direction.

CallSessionEventId¹¹⁺

Enumerates video call event types.

System API: This is a system API.

System capability: SystemCapability.Telephony.CallManager

Name	Value	Description
EVENT_CONTROL_CAMERA_FAILURE	0	Camera setting failed.
EVENT_CONTROL_CAMERA_READY	1	Camera setting succeeded.
EVENT_DISPLAY_SURFACE_RELEASED	100	Remote display window released.
EVENT_PREVIEW_SURFACE_RELEASED	101	Local preview window released.

ImsCallModeInfo¹¹⁺

Defines the video call mode information.

System API: This is a system API.

System capability: SystemCapability.Telephony.CallManager

Name	Type	Mandatory	Description
callId	number	Yes	Call ID.
isRequestInfo	boolean	Yes	Whether the information is request information.
imsCallMode	ImsCallMode	Yes	Video call mode.
result	VideoRequestResultType	Yes	Call ending message.

CallSessionEvent¹¹⁺

Defines the video call event information.

System API: This is a system API.

System capability: SystemCapability.Telephony.CallManager

Name	Type	Mandatory	Description
callId	number	Yes	Call ID.
eventId	CallSessionEventId	Yes	Video call event.

PeerDimensionsDetail¹¹⁺

Defines the peer image resolution in a video call.

System API: This is a system API.

System capability: SystemCapability.Telephony.CallManager

Name	Type	Mandatory	Description
callId	number	Yes	Call ID.
width	number	Yes	Width of the peer image, in pixels.
height	number	Yes	Height of the peer image, in pixels.

CameraCapabilities¹¹⁺

Defines the local image resolution in a video call.

System API: This is a system API.

System capability: SystemCapability.Telephony.CallManager

Name	Type	Mandatory	Description
callId	number	Yes	Call ID.
width	number	Yes	Width of the local image, in pixels.
height	number	Yes	Height of the local image, in pixels.

NumberMarkInfo¹²⁺

Defines a number mark.

System API: This is a system API.

System capability: SystemCapability.Telephony.CallManager

Name	Type	Mandatory	Description
markType	MarkType	Yes	Mark type.
markContent	string	No	Mark content. When markType is set to MARK_TYPE_ENTERPRISE, the returned information consists of the employee name and ID.
markCount	number	No	Mark count.
markSource	string	No	Mark source.
isCloud	boolean	No	Whether the number mark is from the cloud. The default value is false. - true: yes - false: no
markDetails14+	string	No	Mark details. When markType is set to MARK_TYPE_ENTERPRISE, the value of this parameter is the department position.

MarkType¹²⁺

Enumerates number mark types.

System API: This is a system API.

System capability: SystemCapability.Telephony.CallManager

Name	Value	Description
MARK_TYPE_NONE	0	No mark.
MARK_TYPE_CRANK	1	Spam call.
MARK_TYPE_FRAUD	2	Fraud call.
MARK_TYPE_EXPRESS	3	Express & delivery.
MARK_TYPE_PROMOTE_SALES	4	Advertising.
MARK_TYPE_HOUSE_AGENT	5	Estate agent.
MARK_TYPE_INSURANCE	6	Insurance & loans.
MARK_TYPE_TAXI	7	Taxi.
MARK_TYPE_CUSTOM	8	User-defined.
MARK_TYPE_OTHERS	9	Other.
MARK_TYPE_YELLOW_PAGE	10	Yellow page.
MARK_TYPE_ENTERPRISE14+	11	Enterprise contact.