该模块提供呼叫管理功能,包括拨打电话、跳转到拨号界面、获取通话状态、格式化电话号码等。
如需订阅通话状态请使用observer.on('callStateChange')。
本模块首批接口从API version 6开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
dial(phoneNumber: string, callback: AsyncCallback<boolean>): void
拨打电话。使用callback异步回调。
从API version 6 开始支持,从API version 9 开始废弃。替代接口能力仅对系统应用开放。
需要权限:ohos.permission.PLACE_CALL(该权限仅系统应用可申请)
系统能力:SystemCapability.Telephony.CallManager
参数:
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| phoneNumber | string | 是 | 电话号码。 |
| callback | AsyncCallback<boolean> | 是 | 回调函数,返回true为成功,false为失败。 |
示例:
import { BusinessError } from '@kit.BasicServicesKit';
call.dial("138xxxxxxxx", (err: BusinessError, data: boolean) => {
console.info(`callback: err->${JSON.stringify(err)}, data->${JSON.stringify(data)}`);
}); dial(phoneNumber: string, options: DialOptions, callback: AsyncCallback<boolean>): void
拨打电话,可设置通话参数。使用callback异步回调。
从API version 6 开始支持,从API version 9 开始废弃。替代接口能力仅对系统应用开放。
需要权限:ohos.permission.PLACE_CALL(该权限仅系统应用可申请)
系统能力:SystemCapability.Telephony.CallManager
参数:
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| phoneNumber | string | 是 | 电话号码。 |
| options | DialOptions | 是 | 通话参数,选择为语音通话还是视频通话。 |
| callback | AsyncCallback<boolean> | 是 | 回调函数,返回true为成功,false为失败。 |
示例:
import { BusinessError } from '@kit.BasicServicesKit';
let dialOptions: call.DialOptions = {
extras: false
};
call.dial("138xxxxxxxx", dialOptions, (err: BusinessError, data: boolean) => {
console.info(`callback: err->${JSON.stringify(err)}, data->${JSON.stringify(data)}`);
}); dial(phoneNumber: string, options?: DialOptions): Promise<boolean>
拨打电话,可设置通话参数。使用Promise异步回调。
从API version 6 开始支持,从API version 9 开始废弃。替代接口能力仅对系统应用开放。
需要权限:ohos.permission.PLACE_CALL(该权限仅系统应用可申请)
系统能力:SystemCapability.Telephony.CallManager
参数:
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| phoneNumber | string | 是 | 电话号码。 |
| options | DialOptions | 否 | 通话参数,选择为语音通话还是视频通话。默认值为语音通话。 |
返回值:
| 类型 | 说明 |
|---|---|
| Promise<boolean> | 以Promise形式返回拨打电话的结果,返回true为成功,false为失败。 |
示例:
import { BusinessError } from '@kit.BasicServicesKit';
let dialOptions: call.DialOptions = {
extras: false
};
call.dial("138xxxxxxxx", dialOptions).then((data: boolean) => {
console.info(`dial success, promise: data->${JSON.stringify(data)}`);
}).catch((err: BusinessError) => {
console.error(`dial fail, promise: err->Code${err.code}, message:${err.message}`);
}); makeCall(phoneNumber: string, callback: AsyncCallback<void>): void
跳转到拨号界面,并显示待拨出的号码。只支持在UIAbility中调用。使用callback异步回调。
元服务API:从API version 11开始,该接口支持在元服务中使用。
系统能力:SystemCapability.Applications.Contacts
参数:
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| phoneNumber | string | 是 | 电话号码。支持纯数字格式的号码和以URI格式编码的号码(如"tel:13xxxx")。 |
| callback | AsyncCallback<void> | 是 | 以callback形式异步返回跳转拨号界面的结果。 |
错误码:
| 错误码ID | 错误信息 |
|---|---|
| 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. |
示例:
import { BusinessError } from '@kit.BasicServicesKit';
// 从API15开始支持tel格式电话号码,如:"tel:13xxxx"
call.makeCall("138xxxxxxxx", (err: BusinessError) => {
if (err) {
console.error(`makeCall fail, err->Code${err.code}, message:${err.message}`);
} else {
console.info(`makeCall success`);
}
}); makeCall(phoneNumber: string): Promise<void>
跳转到拨号界面,并显示待拨出的号码。只支持在UIAbility中调用。使用Promise异步回调。
元服务API:从API version 11开始,该接口支持在元服务中使用。
系统能力:SystemCapability.Applications.Contacts
参数:
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| phoneNumber | string | 是 | 电话号码。 |
返回值:
| 类型 | 说明 |
|---|---|
| Promise<void> | Promise对象,无返回结果。 |
错误码:
| 错误码ID | 错误信息 |
|---|---|
| 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. |
示例:
import { BusinessError } from '@kit.BasicServicesKit';
// 从API15开始支持tel格式电话号码,如:"tel:13xxxx"
call.makeCall("138xxxxxxxx").then(() => {
console.info(`makeCall success`);
}).catch((err: BusinessError) => {
console.error(`makeCall fail, promise: err->Code${err.code}, message:${err.message}`);
}); makeCall(phoneNumber: string, options?: MakeCallOptions): Promise<void>
跳转到拨号界面,并显示待拨出的号码。只支持在UIAbility中调用。使用Promise异步回调。
元服务API:从API version 24开始,该接口支持在元服务中使用。
系统能力:SystemCapability.Applications.Contacts
参数:
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| phoneNumber | string | 是 | 电话号码,支持数字格式和tel格式(如"tel:13xxxx")。 |
| options | MakeCallOptions | 否 | 通话参数。 |
返回值:
| 类型 | 说明 |
|---|---|
| Promise<void> | Promise对象,无返回结果。 |
错误码:
| 错误码ID | 错误信息 |
|---|---|
| 8300001 | Invalid parameter value. |
| 8300002 | Operation failed. Cannot connect to service. |
| 8300003 | System internal error. |
| 8300999 | Unknown error code. |
示例:
import { call } from '@kit.TelephonyKit';
import { BusinessError } from '@kit.BasicServicesKit';
// 设置是否隐藏拨号界面
let makeOptions: call.MakeCallOptions = {
isHideDialScreen: true
};
call.makeCall("138xxxxxxxx", makeOptions).then(() => {
console.info(`makeCall success`);
}).catch((err: BusinessError) => {
console.error(`makeCall fail, promise: err->Code${err.code}, message:${err.message}`);
}); makeCall(context: Context, phoneNumber: string): Promise<void>
跳转到拨号界面,并显示待拨出的号码。使用Promise异步回调。后台调用需要申请ohos.permission.START_ABILITIES_FROM_BACKGROUND权限。
元服务API:从API version 12开始,该接口支持在元服务中使用。
系统能力:SystemCapability.Applications.Contacts
参数:
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| context | Context | 是 | 应用上下文Context。 |
| phoneNumber | string | 是 | 电话号码。 |
返回值:
| 类型 | 说明 |
|---|---|
| Promise<void> | Promise对象,无返回结果。 |
错误码:
| 错误码ID | 错误信息 |
|---|---|
| 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. |
示例:
在本文档的示例中,通过this.context来获取UIAbilityContext,其中this代表继承自UIAbility的UIAbility实例。如需要在页面中使用UIAbilityContext提供的能力,请参见获取UIAbility的上下文信息。
import { BusinessError } from '@kit.BasicServicesKit';
// 获取context
let context = this.getUIContext().getHostContext() as Context;
// 从API15开始支持tel格式电话号码,如:"tel:13xxxx"
call.makeCall(context, "138xxxxxxxx").then(() => {
console.info(`makeCall success`);
}).catch((err: BusinessError) => {
console.error(`makeCall fail, promise: err->${err.code},message:${err.message}`);
}); makeCallWithToken(phoneNumber: string, options?: MakeCallOptions): Promise<string>
跳转到拨号界面,并显示待拨出的号码。使用Promise异步回调。只支持在UIAbility中调用。
该接口返回校验token,应用可以利用phoneNumber和token实现特定能力,比如蜂窝下行流的录制。
起始版本: 26.0.0
元服务API:从API版本26.0.0开始,该接口支持在元服务中使用。
系统能力:SystemCapability.Applications.Contacts
参数:
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| phoneNumber | string | 是 | 电话号码。 |
| options | MakeCallOptions | 否 | 通话参数。 |
返回值:
| 类型 | 说明 |
|---|---|
| Promise<string> | Promise对象,返回鉴权校验token。 |
错误码:
| 错误码ID | 错误信息 |
|---|---|
| 8300001 | Invalid parameter value. |
| 8300002 | Operation failed. Cannot connect to service. |
| 8300003 | System internal error. |
| 8300999 | Unknown error code. |
示例:
import { call } from '@kit.TelephonyKit';
import { BusinessError } from '@kit.BasicServicesKit';
// 设置是否隐藏拨号界面与应用是否开启自定义无障碍功能
let makeOptions: call.MakeCallOptions = {
isHideDialScreen: true,
isCustomAccessibility: true
};
call.makeCallWithToken("138xxxxxxxx", makeOptions).then(() => {
console.info(`makeCallWithToken success`);
}).catch((err: BusinessError) => {
console.error(`makeCallWithToken fail, promise: err->Code${err.code}, message:${err.message}`);
}); makeDirectCall(phoneNumber: string): Promise<void>
允许应用一键拨号。只支持在UIAbility中调用。使用Promise异步回调。
起始版本: 26.0.1
模型约束: 此接口仅可在Stage模型下使用。
系统能力:SystemCapability.Telephony.CallManager
需要权限:ohos.permission.DIRECT_CALL
参数:
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| phoneNumber | string | 是 | 电话号码。 |
返回值:
| 类型 | 说明 |
|---|---|
| Promise<void> | Promise对象,无返回结果。 |
错误码:
| 错误码ID | 错误信息 |
|---|---|
| 201 | Permission denied. |
| 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. |
示例:
import { call } from '@kit.TelephonyKit';
import { BusinessError } from '@kit.BasicServicesKit';
call.makeDirectCall("138xxxxxxxx").then(() => {
console.info(`makeDirectCall success`);
}).catch((err: BusinessError) => {
console.error(`makeDirectCall fail, promise: err->Code${err.code}, message:${err.message}`);
}); hasCall(callback: AsyncCallback<boolean>): void
判断是否存在通话。使用callback异步回调。
系统能力:SystemCapability.Telephony.CallManager
参数:
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| callback | AsyncCallback<boolean> | 是 | 回调函数。返回true表示当前存在通话,false表示当前不存在通话。 |
示例:
import { BusinessError } from '@kit.BasicServicesKit';
call.hasCall((err: BusinessError, data: boolean) => {
if (err) {
console.error(`hasCall fail, err->Code${err.code}, message:${err.message}`);
} else {
console.info(`hasCall success, data->${JSON.stringify(data)}`);
}
}); hasCall(): Promise<boolean>
判断是否存在通话。使用Promise异步回调。
系统能力:SystemCapability.Telephony.CallManager
返回值:
| 类型 | 说明 |
|---|---|
| Promise<boolean> | 以Promise形式异步返回判断是否存在通话。返回true表示当前存在通话,false表示当前不存在通话。 |
示例:
import { BusinessError } from '@kit.BasicServicesKit';
call.hasCall().then(() => {
console.info(`hasCall success`);
}).catch((err: BusinessError) => {
console.error(`hasCall fail, promise: err->Code${err.code}, message:${err.message}`);
}); hasCallSync(): boolean
判断是否存在通话。
系统能力:SystemCapability.Telephony.CallManager
返回值:
| 类型 | 说明 |
|---|---|
| boolean | 返回判断是否存在通话。返回true表示当前存在通话,false表示当前不存在通话。 |
示例:
let hasCall: boolean = call.hasCallSync(); console.info(`hasCallSync success, has call is ` + hasCall);
getCallState(callback: AsyncCallback<CallState>): void
获取当前通话状态。使用callback异步回调。
系统能力:SystemCapability.Telephony.CallManager
参数:
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| callback | AsyncCallback<CallState> | 是 | 回调函数,异步返回获取到的通话状态。 |
示例:
import { BusinessError } from '@kit.BasicServicesKit';
call.getCallState((err: BusinessError, data: call.CallState) => {
if (err) {
console.error(`getCallState fail, err->Code${err.code}, message:${err.message}`);
} else {
console.info(`getCallState success, data->${JSON.stringify(data)}`);
}
}); getCallState(): Promise<CallState>
获取当前通话状态。使用Promise异步回调。
系统能力:SystemCapability.Telephony.CallManager
返回值:
| 类型 | 说明 |
|---|---|
| Promise<CallState> | 以Promise形式异步返回获取到的通话状态。 |
示例:
import { BusinessError } from '@kit.BasicServicesKit';
call.getCallState().then((data: call.CallState) => {
console.info(`getCallState success, promise: data->${JSON.stringify(data)}`);
}).catch((err: BusinessError) => {
console.error(`getCallState fail, promise: err->Code${err.code}, message:${err.message}`);
}); getCallStateSync(): CallState
获取当前通话状态。
系统能力:SystemCapability.Telephony.CallManager
返回值:
| 类型 | 说明 |
|---|---|
| CallState | 返回获取到的通话状态。 |
示例:
let callState: call.CallState = call.getCallStateSync(); console.info(`the call state is:` + callState);
hasVoiceCapability(): boolean
检查当前设备是否具备语音通话能力。
系统能力:SystemCapability.Telephony.CallManager
返回值:
| 类型 | 说明 |
|---|---|
| boolean | 返回true表示设备具备语音通话能力,返回false表示设备不具备语音通话能力。 |
示例:
let result: boolean = call.hasVoiceCapability();
console.info(`hasVoiceCapability: ${JSON.stringify(result)}`); isEmergencyPhoneNumber(phoneNumber: string, callback: AsyncCallback<boolean>): void
判断是否是紧急电话号码。使用callback异步回调。
系统能力:SystemCapability.Telephony.CallManager
参数:
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| phoneNumber | string | 是 | 电话号码。 |
| callback | AsyncCallback<boolean> | 是 | 回调函数。返回true表示是紧急电话号码,返回false表示不是紧急电话号码。 |
错误码:
| 错误码ID | 错误信息 |
|---|---|
| 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. |
示例:
import { BusinessError } from '@kit.BasicServicesKit';
call.isEmergencyPhoneNumber("138xxxxxxxx", (err: BusinessError, data: boolean) => {
if (err) {
console.error(`isEmergencyPhoneNumber fail, err->Code${err.code}, message:${err.message}`);
} else {
console.info(`isEmergencyPhoneNumber success, data->${JSON.stringify(data)}`);
}
}); isEmergencyPhoneNumber(phoneNumber: string, options: EmergencyNumberOptions, callback: AsyncCallback<boolean>): void
根据电话号码参数,判断是否是紧急电话号码。使用callback异步回调。
系统能力:SystemCapability.Telephony.CallManager
参数:
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| phoneNumber | string | 是 | 电话号码。 |
| options | EmergencyNumberOptions | 是 | 电话号码参数。 |
| callback | AsyncCallback<boolean> | 是 | 回调函数。返回true表示是紧急电话号码,返回false表示不是紧急电话号码。 |
错误码:
| 错误码ID | 错误信息 |
|---|---|
| 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. |
示例:
import { BusinessError } from '@kit.BasicServicesKit';
let options: call.EmergencyNumberOptions = {slotId: 1};
call.isEmergencyPhoneNumber("112", options, (err: BusinessError, data: boolean) => {
if (err) {
console.error(`isEmergencyPhoneNumber fail, err->Code${err.code}, message:${err.message}`);
} else {
console.info(`isEmergencyPhoneNumber success, data->${JSON.stringify(data)}`);
}
}); isEmergencyPhoneNumber(phoneNumber: string, options?: EmergencyNumberOptions): Promise<boolean>
根据电话号码参数,判断是否是紧急电话号码。使用Promise异步回调。
系统能力:SystemCapability.Telephony.CallManager
参数:
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| phoneNumber | string | 是 | 电话号码。 |
| options | EmergencyNumberOptions | 否 | 电话号码参数。 |
返回值:
| 类型 | 说明 |
|---|---|
| Promise<boolean> | 以Promise形式异步返回判断是否是紧急电话号码的结果。返回true表示是紧急电话号码,返回false表示不是紧急电话号码。 |
错误码:
| 错误码ID | 错误信息 |
|---|---|
| 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. |
示例:
import { BusinessError } from '@kit.BasicServicesKit';
let options: call.EmergencyNumberOptions = {slotId: 1};
call.isEmergencyPhoneNumber("138xxxxxxxx", options).then((data: boolean) => {
console.info(`isEmergencyPhoneNumber success, promise: data->${JSON.stringify(data)}`);
}).catch((err: BusinessError) => {
console.error(`isEmergencyPhoneNumber fail, promise: err->Code:${err.code},message:${err.message}`);
}); formatPhoneNumber(phoneNumber: string, callback: AsyncCallback<string>): void
格式化电话号码。使用callback异步回调。
电话号码格式化后为标准数字字符串,例如:“138 xxxx xxxx”、“0755 xxxx xxxx”。
系统能力:SystemCapability.Telephony.CallManager
参数:
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| phoneNumber | string | 是 | 电话号码。 |
| callback | AsyncCallback<string> | 是 | 回调函数,返回格式化电话号码的结果。 |
错误码:
| 错误码ID | 错误信息 |
|---|---|
| 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. |
示例:
import { BusinessError } from '@kit.BasicServicesKit';
call.formatPhoneNumber("138xxxxxxxx", (err: BusinessError, data: string) => {
if (err) {
console.error(`formatPhoneNumber fail, err->Code${err.code}, message:${err.message}`);
} else {
console.info(`formatPhoneNumber success, data->${JSON.stringify(data)}`);
}
}); formatPhoneNumber(phoneNumber: string, options: NumberFormatOptions, callback: AsyncCallback<string>): void
格式化电话号码,可设置格式化参数。使用callback异步回调。
电话号码格式化后为标准数字字符串,例如:“138 xxxx xxxx”、“0755 xxxx xxxx”。
系统能力:SystemCapability.Telephony.CallManager
参数:
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| phoneNumber | string | 是 | 电话号码。 |
| options | NumberFormatOptions | 是 | 格式化参数,如国家码。 |
| callback | AsyncCallback<string> | 是 | 回调函数,返回格式化电话号码的结果。 |
错误码:
| 错误码ID | 错误信息 |
|---|---|
| 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. |
示例:
import { BusinessError } from '@kit.BasicServicesKit';
let options: call.NumberFormatOptions = {
countryCode: "CN"
};
call.formatPhoneNumber("138xxxxxxxx", options, (err: BusinessError, data: string) => {
if (err) {
console.error(`formatPhoneNumber fail, err->Code${err.code}, message:${err.message}`);
} else {
console.info(`formatPhoneNumber success, data->${JSON.stringify(data)}`);
}
}); formatPhoneNumber(phoneNumber: string, options?: NumberFormatOptions): Promise<string>
格式化电话号码,可设置格式化参数。使用Promise异步回调。
电话号码格式化后为标准数字字符串,例如:“138 xxxx xxxx”、“0755 xxxx xxxx”。
系统能力:SystemCapability.Telephony.CallManager
参数:
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| phoneNumber | string | 是 | 电话号码。 |
| options | NumberFormatOptions | 否 | 格式化参数,如国家码。不传时默认使用国家码CN。 |
返回值:
| 类型 | 说明 |
|---|---|
| Promise<string> | 以Promise形式异步返回格式化电话号码的结果。 |
错误码:
| 错误码ID | 错误信息 |
|---|---|
| 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. |
示例:
import { BusinessError } from '@kit.BasicServicesKit';
let options: call.NumberFormatOptions = {
countryCode: "CN"
};
call.formatPhoneNumber("138xxxxxxxx", options).then((data: string) => {
console.info(`formatPhoneNumber success, promise: data->${JSON.stringify(data)}`);
}).catch((err: BusinessError) => {
console.error(`formatPhoneNumber fail, promise: err->Code${err.code}, message:${err.message}`);
}); formatPhoneNumberToE164(phoneNumber: string, countryCode: string, callback: AsyncCallback<string>): void
将电话号码格式化为E.164表示形式,使用callback异步回调。
待格式化的电话号码需要与传入的国家码相匹配,如中国电话号码需要传入国家码CN,否则格式化后的电话号码为null。
系统能力:SystemCapability.Telephony.CallManager
参数:
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| phoneNumber | string | 是 | 电话号码。 |
| countryCode | string | 是 | 国家码,支持所有国家码,如:中国(CN)。 |
| callback | AsyncCallback<string> | 是 | 回调函数,返回将电话号码格式化为E.164表示形式的结果。 |
错误码:
| 错误码ID | 错误信息 |
|---|---|
| 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. |
示例:
import { BusinessError } from '@kit.BasicServicesKit';
call.formatPhoneNumberToE164("138xxxxxxxx", "CN", (err: BusinessError, data: string) => {
if (err) {
console.error(`formatPhoneNumberToE164 fail, err->Code${err.code}, message:${err.message}`);
} else {
console.info(`formatPhoneNumberToE164 success, data->${JSON.stringify(data)}`);
}
}); formatPhoneNumberToE164(phoneNumber: string, countryCode: string): Promise<string>
将电话号码格式化为E.164表示形式,使用Promise异步回调。
待格式化的电话号码需要与传入的国家码相匹配,如中国电话号码需要传入国家码CN,否则格式化后的电话号码为null。
支持所有国家码。
系统能力:SystemCapability.Telephony.CallManager
参数:
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| phoneNumber | string | 是 | 电话号码。 |
| countryCode | string | 是 | 国家码,支持所有国家码,如:中国(CN)。 |
返回值:
| 类型 | 说明 |
|---|---|
| Promise<string> | 以Promise形式异步返回将电话号码格式化为E.164表示形式的结果。 |
错误码:
| 错误码ID | 错误信息 |
|---|---|
| 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. |
示例:
import { BusinessError } from '@kit.BasicServicesKit';
call.formatPhoneNumberToE164("138xxxxxxxx", "CN").then((data: string) => {
console.info(`formatPhoneNumberToE164 success, promise: data->${JSON.stringify(data)}`);
}).catch((err: BusinessError) => {
console.error(`formatPhoneNumberToE164 fail, promise: err->Code${err.code}, message:${err.message}`);
}); answerCall(callback: AsyncCallback<void>): void
接听来电。使用callback异步回调。
需要权限:ohos.permission.ANSWER_CALL 或 ohos.permission.MANAGE_CALL_FOR_DEVICES
系统能力:SystemCapability.Telephony.CallManager
参数:
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| callback | AsyncCallback<void> | 是 | 回调函数。当接听电话成功,err为undefined,否则为错误对象。 |
错误码:
| 错误码ID | 错误信息 |
|---|---|
| 201 | Permission denied. |
| 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. |
示例:
import { BusinessError } from '@kit.BasicServicesKit';
call.answerCall((err: BusinessError) => {
if (err) {
console.error(`answerCall fail, err->Code${err.code}, message:${err.message}`);
} else {
console.info(`answerCall success.`);
}
}); hangUpCall(callback: AsyncCallback<void>): void
挂断电话。使用callback异步回调。
需要权限:ohos.permission.ANSWER_CALL 或 ohos.permission.SET_TELEPHONY_STATE 或 ohos.permission.MANAGE_CALL_FOR_DEVICES
系统能力:SystemCapability.Telephony.CallManager
参数:
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| callback | AsyncCallback<void> | 是 | 回调函数。当挂断电话成功,err为undefined,否则为错误对象。 |
错误码:
| 错误码ID | 错误信息 |
|---|---|
| 201 | Permission denied. |
| 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. |
示例:
import { BusinessError } from '@kit.BasicServicesKit';
call.hangUpCall((err: BusinessError) => {
if (err) {
console.error(`hangUpCall fail, err->Code${err.code}, message:${err.message}`);
} else {
console.info(`hangUpCall success.`);
}
}); rejectCall(callback: AsyncCallback<void>): void
拒绝来电。使用callback异步回调。
需要权限:ohos.permission.ANSWER_CALL 或 ohos.permission.MANAGE_CALL_FOR_DEVICES
系统能力:SystemCapability.Telephony.CallManager
参数:
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| callback | AsyncCallback<void> | 是 | 回调函数。当拒接来电成功,err为undefined,否则为错误对象。 |
错误码:
| 错误码ID | 错误信息 |
|---|---|
| 201 | Permission denied. |
| 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. |
示例:
import { BusinessError } from '@kit.BasicServicesKit';
call.rejectCall((err: BusinessError) => {
if (err) {
console.error(`rejectCall fail, err->Code${err.code}, message:${err.message}`);
} else {
console.info(`rejectCall success.`);
}
}); getCallTransferInfo(type: CallTransferType, number: string): Promise<CallTransferResult>
获取电话号码的呼叫转移状态。使用Promise异步回调。
起始版本: 26.0.0
需要权限:ohos.permission.GET_CALL_TRANSFER_INFO
系统能力:SystemCapability.Telephony.CallManager
参数:
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| type | CallTransferType | 是 | 指示要获取哪种类型的呼叫转移。 |
| number | string | 是 | 指示用于获取呼叫转移状态的号码。 |
返回值:
| 类型 | 说明 |
|---|---|
| Promise<CallTransferResult> | Promise对象,返回呼叫转移结果。 |
错误码:
| 错误码ID | 错误信息 |
|---|---|
| 201 | Permission denied. |
| 801 | Capability not supported. |
| 8300001 | Invalid parameter value. |
| 8300002 | Operation failed. Cannot connect to service. |
| 8300003 | System internal error. |
| 8401002 | Invalid input call number. |
| 8401003 | Operation too frequent. |
示例:
import { call } from '@kit.TelephonyKit';
import { BusinessError } from '@kit.BasicServicesKit';
let type: call.CallTransferType = call.CallTransferType.TRANSFER_TYPE_UNCONDITIONAL;
let number: string = "138xxxxxxxx";
call.getCallTransferInfo(type, number)
.then((data: call.CallTransferResult) => {
console.info(`getCallTransferInfo success, data->${JSON.stringify(data)}`);
})
.catch((err:BusinessError) => {
console.error(`getCallTransferInfo fail, err->Code${err.code}, message:${err.message}`);
}); 拨打电话的可选参数。
系统能力:SystemCapability.Telephony.CallManager
| 名称 | 类型 | 只读 | 可选 | 说明 |
|---|---|---|---|---|
| extras | boolean | 否 | 是 | 根据extras的值判断是否为视频通话,默认为语音通话(false)。 - true:视频通话 - false:语音通话。 |
通话状态码。
系统能力:SystemCapability.Telephony.CallManager
| 名称 | 值 | 说明 |
|---|---|---|
| CALL_STATE_UNKNOWN | -1 | 表示获取呼叫状态失败时的无效状态。 |
| CALL_STATE_IDLE | 0 | 表示没有正在进行的呼叫。 |
| CALL_STATE_RINGING | 1 | 表示来电正在振铃或等待。 |
| CALL_STATE_OFFHOOK | 2 | 表示至少有一个呼叫处于拨号、通话中或呼叫保持状态,并且没有新的来电振铃或等待。 |
| CALL_STATE_ANSWERED11+ | 3 | 表示来电已经接听。 |
拨打电话的可选参数。
系统能力:SystemCapability.Applications.Contacts
元服务API:从API version 24开始,该接口支持在元服务中使用。
| 名称 | 类型 | 只读 | 可选 | 说明 |
|---|---|---|---|---|
| isHideDialScreen | boolean | 否 | 是 | 是否隐藏拨号界面,true表示隐藏,false表示不隐藏。默认为false。 |
| isCustomAccessibility | boolean | 否 | 是 | 应用是否支持自定义无障碍能力,true表示支持,false表示不支持。默认为false。 起始版本: 26.0.0 元服务API:从API版本26.0.0开始,该接口支持在元服务中使用。 |
通话状态码。
系统能力:SystemCapability.Telephony.CallManager
| 名称 | 值 | 说明 |
|---|---|---|
| TEL_CALL_STATE_UNKNOWN | -1 | 表示获取呼叫状态失败时的无效状态。 |
| TEL_CALL_STATE_IDLE | 0 | 表示没有正在进行的呼叫。 |
| TEL_CALL_STATE_RINGING | 1 | 表示来电正在振铃或等待。 |
| TEL_CALL_STATE_OFFHOOK | 2 | 表示至少有一个呼叫处于拨号状态,并且没有新的来电振铃或等待。 |
| TEL_CALL_STATE_ANSWERED | 3 | 表示来电已经接听。 |
| TEL_CALL_STATE_CONNECTED | 4 | 表示电话已接通或呼叫保持。 |
运营商通话状态码。
系统能力:SystemCapability.Telephony.CallManager
| 名称 | 值 | 说明 |
|---|---|---|
| CCALL_STATE_UNKNOWN | -1 | 表示获取呼叫状态失败时的无效状态。 |
| CCALL_STATE_ACTIVE | 0 | 表示当前通话已经接通成功。 |
| CCALL_STATE_HOLDING | 1 | 表示当前通话处于保持状态。 |
| CCALL_STATE_DIALING | 2 | 表示去电处于拨号过程中,对端还没有收到振铃期间。 |
| CCALL_STATE_ALERTING | 3 | 表示去电处于振铃过程中,对端处于响铃阶段。 |
| CCALL_STATE_INCOMING | 4 | 表示收到来电。 |
| CCALL_STATE_WAITING | 5 | 表示同一个卡槽上已经存在一路通话的情况下,又收到一路来电。 |
| CCALL_STATE_DISCONNECTED | 6 | 表示通话已经释放完成。 |
| CCALL_STATE_DISCONNECTING | 7 | 表示通话正在释放中,还没有释放完成。 |
| CCALL_STATE_IDLE | 8 | 表示没有正在进行的呼叫。 |
| CCALL_STATE_ANSWERED | 9 | 表示来电已经接听。 |
判断是否是紧急电话号码的可选参数。
系统能力:SystemCapability.Telephony.CallManager
| 名称 | 类型 | 只读 | 可选 | 说明 |
|---|---|---|---|---|
| slotId | number | 否 | 是 | 卡槽ID,默认值为0。 - 卡槽1:0 - 卡槽2:1。 |
格式化号码的可选参数。
系统能力:SystemCapability.Telephony.CallManager
| 名称 | 类型 | 只读 | 可选 | 说明 |
|---|---|---|---|---|
| countryCode | string | 否 | 是 | 国家码,支持所有国家的国家码,如:CN(中国)。默认为:CN。 |
转移状态。
起始版本: 26.0.0
系统能力:SystemCapability.Telephony.CallManager
| 名称 | 值 | 说明 |
|---|---|---|
| TRANSFER_DISABLE | 0 | 禁用转移。 |
| TRANSFER_ENABLE | 1 | 启用转移。 |
呼叫转移类型。
起始版本: 26.0.0
系统能力:SystemCapability.Telephony.CallManager
| 名称 | 值 | 说明 |
|---|---|---|
| TRANSFER_TYPE_UNCONDITIONAL | 0 | 无条件转移。 |
| TRANSFER_TYPE_BUSY | 1 | 忙线转移。 |
| TRANSFER_TYPE_NO_REPLY | 2 | 无回复转移。 |
| TRANSFER_TYPE_NOT_REACHABLE | 3 | 无法访问转移。 |
呼叫转移结果。
起始版本: 26.0.0
系统能力:SystemCapability.Telephony.CallManager
| 名称 | 类型 | 只读 | 可选 | 说明 |
|---|---|---|---|---|
| status | TransferStatus | 否 | 否 | 转移状态。 |
| startHour | number | 否 | 否 | 开始时间的小时数。取值范围:0-23。 |
| startMinute | number | 否 | 否 | 开始时间的分钟数。取值范围:0-59。 |
| endHour | number | 否 | 否 | 结束时间的小时数。取值范围:0-23。 |
| endMinute | number | 否 | 否 | 结束时间的分钟数。取值范围:0-59。 |