numberIdentify模块提供企业来电相关能力查询,包括查询是否有企业来电能力、陌生号码与信息识别开关、企业信息等。
起始版本: 6.1.0(23)
isSupportEnterpriseNumberIdentify(context: Context): Promise<boolean>
返回企业来电显示权限的开关状态,供设置页面展示。使用Promise异步回调。
模型约束: 该接口仅可在Stage模型下使用。
系统能力: SystemCapability.Telephony.NumberIdentifyService
起始版本: 6.1.0(23)
参数:
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| context | Context | 是 | 应用内上下文信息 |
返回值:
| 类型 | 说明 |
|---|---|
| Promise<boolean> | Promise对象,返回是否已开通企业来电显示权限,true:已开通。false:未开通。 |
错误码:
以下错误码的详细介绍请参见电话子系统错误码。
| 错误码ID | 错误信息 |
|---|---|
| 8300001 | Invalid parameter value. |
| 8300002 | The enterprise permission is not verified. |
| 8300003 | System internal error. |
| 8300999 | Unknown error code. |
示例:
import { numberIdentify } from '@kit.CallServiceKit';
import type {common} from '@kit.AbilityKit';
import { hilog } from '@kit.PerformanceAnalysisKit';
let context = this.getUIContext().getHostContext() as common.UIAbilityContext;
let isSupport = await numberIdentify.isSupportEnterpriseNumberIdentify(context);
hilog.info(0, 'TAG', `isSupport:${isSupport}`); queryNumberIdentifySwitchState(context: Context):SwitchState
查询陌生号码与信息识别总开关状态以及应用号码识别开关状态。
模型约束: 该接口仅可在Stage模型下使用。
系统能力: SystemCapability.Telephony.NumberIdentifyService
起始版本: 6.1.0(23)
参数:
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| context | Context | 是 | 应用内上下文信息 |
返回值:
| 类型 | 说明 |
|---|---|
| SwitchState | 查询陌生号码与信息识别总开关状态以及调用该接口的应用号码识别开关状态。 |
错误码:
以下错误码的详细介绍请参见电话子系统错误码。
| 错误码ID | 错误信息 |
|---|---|
| 8300001 | Invalid parameter value. |
| 8300002 | The enterprise permission is not verified. |
| 8300999 | Unknown error code. |
示例:
import type {common} from '@kit.AbilityKit';
import { numberIdentify } from '@kit.CallServiceKit';
import { hilog } from '@kit.PerformanceAnalysisKit';
let context = this.getUIContext().getHostContext() as common.UIAbilityContext;
let switchState = numberIdentify.queryNumberIdentifySwitchState(context);
hilog.info(0, 'TAG', `switchState is:${JSON.stringify(switchState)}`); 陌生号码与信息识别总开关状态以及应用号码识别开关状态。
模型约束: 该接口仅可在Stage模型下使用。
系统能力: SystemCapability.Telephony.NumberIdentifyService
起始版本: 6.1.0(23)
| 名称 | 类型 | 只读 | 可选 | 说明 |
|---|---|---|---|---|
| isNumberIdentifyEnabled | boolean | 否 | 否 | 是否开启号码识别能力。true:是。false:否。 |
| isApplicationNumberIdentifyEnabled | boolean | 否 | 否 | 企业应用是否开启号码识别能力。true:是。false:否。 |
| isBusinessServiceDataEnabled | boolean | 否 | 否 | 企业应用是否开启服务信息展示能力。true:是。false:否。 起始版本: 6.1.1(24) |
企业服务信息。
模型约束: 该接口仅可在Stage模型下使用。
系统能力: SystemCapability.Telephony.NumberIdentifyService
起始版本: 6.1.1(24)
| 名称 | 类型 | 只读 | 可选 | 说明 |
|---|---|---|---|---|
| type | BusinessServiceType | 否 | 否 | 企业服务类型。 |
| delivery | DeliveryData | 否 | 是 | 快递服务数据。 |
| carryout | CarryoutData | 否 | 是 | 外卖服务数据。 起始版本: 26.0.1 |
企业服务类型枚举。
模型约束: 该接口仅可在Stage模型下使用。
系统能力: SystemCapability.Telephony.NumberIdentifyService
起始版本: 6.1.1(24)
| 名称 | 值 | 说明 |
|---|---|---|
| DELIVERY | 0 | 企业服务类型为快递。 |
| CARRYOUT | 1 | 企业服务类型为外卖。 起始版本: 26.0.1 |
快递服务数据。
模型约束: 该接口仅可在Stage模型下使用。
系统能力: SystemCapability.Telephony.NumberIdentifyService
起始版本: 6.1.1(24)
| 名称 | 类型 | 只读 | 可选 | 说明 |
|---|---|---|---|---|
| customerName | string | 否 | 否 | 客户姓名。长度小于20个字符,如果超出将会截取前20个字符。 |
| deliveryNumber | string | 否 | 否 | 快递单号。长度小于20个字符,如果超出将会截取前20个字符。 |
| deliveryStatus | string | 否 | 否 | 订单状态。长度小于10个字符,如果超出将会截取前10个字符。 |
| deliveryStatusColor | DeliveryStatusColor | 否 | 否 | 订单状态颜色。 |
| deliveryAddress | string | 否 | 否 | 派送地址。长度小于150个字符,如果超出将会截取前150个字符。 |
| deliveryTimeout | string | 否 | 否 | 派送超时时间。长度小于20个字符,如果超出将会截取前20个字符。 |
订单状态颜色的枚举。
模型约束: 该接口仅可在Stage模型下使用。
系统能力: SystemCapability.Telephony.NumberIdentifyService
起始版本: 6.1.1(24)
| 名称 | 值 | 说明 |
|---|---|---|
| BLUE | 0 | 订单状态颜色为蓝色。 |
| GREEN | 1 | 订单状态颜色为绿色。 |
| RED | 2 | 订单状态颜色为红色。 |
外卖服务数据。
模型约束: 该接口仅可在Stage模型下使用。
系统能力: SystemCapability.Telephony.NumberIdentifyService
起始版本: 26.0.1
| 名称 | 类型 | 只读 | 可选 | 说明 |
|---|---|---|---|---|
| customerName | string | 否 | 否 | 用户姓名。长度小于20个字符,如果超出将会截取前20个字符。 |
| carryoutNumber | string | 否 | 否 | 外卖订单号。长度小于20个字符,如果超出将会截取前20个字符。 |
| carryoutMerchant | string | 否 | 否 | 外卖订单商家。长度小于20个字符,如果超出将会截取前20个字符。 |
| carryoutStatus | string | 否 | 否 | 外卖状态。 |
| carryoutStatusColor | StatusColor | 否 | 否 | 外卖订单状态颜色。 |
| carryoutAddress | string | 否 | 否 | 外卖配送地址。长度小于150个字符,如果超出将会截取前150个字符。 |
| carryoutTimeoutDescription | string | 否 | 否 | 配送超时时间描述。 |
| deepLinking | string | 否 | 否 | 传入的应用deepLinking地址。 |