@ohos.telephony.call (Call)

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

To subscribe to 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.

Modules to Import

import call from '@ohos.telephony.call';

call.dial^(deprecated)

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

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

NOTE

This API is supported since API version 6 and deprecated since API version 9. The substitute API is available only for system applications.

Required permissions: ohos.permission.PLACE_CALL (available only for system applications)

System capability: SystemCapability.Telephony.CallManager

Parameters

Example

import { BusinessError } from '@ohos.base';

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

call.dial^(deprecated)

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

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

NOTE

This API is supported since API version 6 and deprecated since API version 9. The substitute API is available only for system applications.

Required permissions: ohos.permission.PLACE_CALL (available only for system applications)

System capability: SystemCapability.Telephony.CallManager

Parameters

Example

import { BusinessError } from '@ohos.base';

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

call.dial^(deprecated)

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

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

NOTE

This API is supported since API version 6 and deprecated since API version 9. The substitute API is available only for system applications.

Required permissions: ohos.permission.PLACE_CALL (available only for system applications)

System capability: SystemCapability.Telephony.CallManager

Parameters

Return value

Example

import { BusinessError } from '@ohos.base';

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

call.makeCall⁷⁺

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

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

System capability: SystemCapability.Applications.Contacts

Parameters

Error codes

For details about the error codes, see ohos.telephony (Telephony) Error Codes and Universal Error Codes.

Example

import { BusinessError } from '@ohos.base';

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

call.makeCall⁷⁺

makeCall(phoneNumber: string): Promise<void>

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

System capability: SystemCapability.Applications.Contacts

Parameters

Return value

Error codes

For details about the error codes, see ohos.telephony (Telephony) Error Codes and Universal Error Codes.

Example

import { BusinessError } from '@ohos.base';

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

call.hasCall

hasCall(callback: AsyncCallback<boolean>): void

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

System capability: SystemCapability.Telephony.CallManager

Parameters

Example

import { BusinessError } from '@ohos.base';

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

call.hasCall

hasCall(): Promise<boolean>

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

System capability: SystemCapability.Telephony.CallManager

Return value

Example

import { BusinessError } from '@ohos.base';

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

call.hasCallSync¹⁰⁺

hasCallSync(): boolean

Checks whether a call is in progress.

System capability: SystemCapability.Telephony.CallManager

Return value

Example

let hasCall: boolean = call.hasCallSync();
console.log(`hasCallSync success, has call is ` + hasCall);

call.getCallState

getCallState(callback: AsyncCallback<CallState>): void

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

System capability: SystemCapability.Telephony.CallManager

Parameters

Example

import { BusinessError } from '@ohos.base';

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

call.getCallState

getCallState(): Promise<CallState>

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

System capability: SystemCapability.Telephony.CallManager

Return value

Example

import { BusinessError } from '@ohos.base';

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

call.getCallStateSync¹⁰⁺

getCallStateSync(): CallState

Obtains the call status.

System capability: SystemCapability.Telephony.CallManager

Return value

Example

let callState: call.CallState = call.getCallStateSync();
console.log(`the call state is:` + callState);

call.hasVoiceCapability⁷⁺

hasVoiceCapability(): boolean

Checks whether a device supports voice calls.

System capability: SystemCapability.Telephony.CallManager

Return value

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

call.isEmergencyPhoneNumber⁷⁺

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

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

System capability: SystemCapability.Telephony.CallManager

Parameters

Error codes

For details about the error codes, see ohos.telephony (Telephony) Error Codes and Universal Error Codes.

Example

import { BusinessError } from '@ohos.base';

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

call.isEmergencyPhoneNumber⁷⁺

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

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

System capability: SystemCapability.Telephony.CallManager

Parameters

Error codes

For details about the error codes, see ohos.telephony (Telephony) Error Codes and Universal Error Codes.

Example

import { BusinessError } from '@ohos.base';

let options: call.EmergencyNumberOptions = {slotId: 1}
call.isEmergencyPhoneNumber("112", options, (err: BusinessError, data: boolean) => {
    if (err) {
        console.error(`isEmergencyPhoneNumber fail, err->${JSON.stringify(err)}`);
    } else {
        console.log(`isEmergencyPhoneNumber success, data->${JSON.stringify(data)}`);
    }
});

call.isEmergencyPhoneNumber⁷⁺

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

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

System capability: SystemCapability.Telephony.CallManager

Parameters

Return value

Error codes

For details about the error codes, see ohos.telephony (Telephony) Error Codes and Universal Error Codes.

Example

import { BusinessError } from '@ohos.base';

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

call.formatPhoneNumber⁷⁺

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

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

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

System capability: SystemCapability.Telephony.CallManager

Parameters

Error codes

For details about the error codes, see ohos.telephony (Telephony) Error Codes and Universal Error Codes.

Example

import { BusinessError } from '@ohos.base';

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

call.formatPhoneNumber⁷⁺

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

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

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

System capability: SystemCapability.Telephony.CallManager

Parameters

Error codes

For details about the error codes, see ohos.telephony (Telephony) Error Codes and Universal Error Codes.

Example

import { BusinessError } from '@ohos.base';

let options: call.NumberFormatOptions = {
    countryCode: "CN"
}
call.formatPhoneNumber("138xxxxxxxx", options, (err: BusinessError, data: string) => {
    if (err) {
        console.error(`formatPhoneNumber fail, err->${JSON.stringify(err)}`);
    } else {
        console.log(`formatPhoneNumber success, data->${JSON.stringify(data)}`);
    }
});

call.formatPhoneNumber⁷⁺

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

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

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

System capability: SystemCapability.Telephony.CallManager

Parameters

Return value

Error codes

For details about the error codes, see ohos.telephony (Telephony) Error Codes and Universal Error Codes.

Example

import { BusinessError } from '@ohos.base';

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

call.formatPhoneNumberToE164⁷⁺

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

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

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

System capability: SystemCapability.Telephony.CallManager

Parameters

Error codes

For details about the error codes, see ohos.telephony (Telephony) Error Codes and Universal Error Codes.

Example

import { BusinessError } from '@ohos.base';

call.formatPhoneNumberToE164("138xxxxxxxx", "CN", (err: BusinessError, data: string) => {
    if (err) {
        console.error(`formatPhoneNumberToE164 fail, err->${JSON.stringify(err)}`);
    } else {
        console.log(`formatPhoneNumberToE164 success, data->${JSON.stringify(data)}`);
    }
});

call.formatPhoneNumberToE164⁷⁺

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

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

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

All country codes are supported.

System capability: SystemCapability.Telephony.CallManager

Parameters

Return value

Error codes

For details about the error codes, see ohos.telephony (Telephony) Error Codes and Universal Error Codes.

Example

import { BusinessError } from '@ohos.base';

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

DialOptions

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

System capability: SystemCapability.Telephony.CallManager

CallState

Enumerates call states.

System capability: SystemCapability.Telephony.CallManager

EmergencyNumberOptions⁷⁺

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

System capability: SystemCapability.Telephony.CallManager

NumberFormatOptions⁷⁺

Provides an option for number formatting.

System capability: SystemCapability.Telephony.CallManager