tencentcloud-sdk-nodejs-faceid 4.0.666 → 4.0.667

package/src/services/faceid/v20180301/faceid_models.ts

@@ -136,13 +136,13 @@ LIP为数字模式，ACTION为动作模式，SILENT为静默模式，三种模
 }
 
 /**
- * RuleId相关配置
+ * 意愿核身（点头确认模式）配置
  */
-export interface RuleIdConfig {
+export interface IntentionActionConfig {
   /**
-   * 意愿核身过程中识别用户的回答意图，开启后除了IntentionQuestions的Answers列表中的标准回答会通过，近似意图的回答也会通过，默认不开启。
+   * 点头确认模式下，系统语音播报使用的问题文本，问题最大长度为150个字符。
    */
-  IntentionRecognition?: boolean
+  Text: string
 }
 
 /**
@@ -408,6 +408,34 @@ export interface GetEidTokenConfig {
   IsSupportHMTResidentPermitOCR?: boolean
 }
 
+/**
+ * Liveness返回参数结构体
+ */
+export interface LivenessResponse {
+  /**
+   * 验证通过后的视频最佳截图照片，照片为BASE64编码后的值，jpg格式。
+注意：此字段可能返回 null，表示取不到有效值。
+   */
+  BestFrameBase64?: string
+  /**
+   * 业务错误码，成功情况返回Success, 错误情况请参考下方错误码 列表中FailedOperation部分
+   */
+  Result?: string
+  /**
+   * 业务结果描述。
+   */
+  Description?: string
+  /**
+   * 最佳最佳截图列表，仅在配置了返回多张最佳截图时有效。
+注意：此字段可能返回 null，表示取不到有效值。
+   */
+  BestFrameList?: Array<string>
+  /**
+   * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
+   */
+  RequestId?: string
+}
+
 /**
  * CheckIdCardInformation返回参数结构体
  */
@@ -519,6 +547,11 @@ export interface GetDetectInfoEnhancedResponse {
 注意：此字段可能返回 null，表示取不到有效值。
    */
   IntentionQuestionResult?: IntentionQuestionResult
+  /**
+   * 意愿核身点头确认模式的结果信息，若未使用该意愿核身功能，该字段返回值可以不处理。
+注意：此字段可能返回 null，表示取不到有效值。
+   */
+  IntentionActionResult?: IntentionActionResult
   /**
    * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
    */
@@ -604,12 +637,12 @@ export interface DetectAuthResponse {
   /**
    * 用于发起核身流程的URL，仅微信H5场景使用。
    */
-  Url: string
+  Url?: string
   /**
    * 一次核身流程的标识，有效时间为7,200秒；
 完成核身后，可用该标识获取验证结果信息。
    */
-  BizToken: string
+  BizToken?: string
   /**
    * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
    */
@@ -838,17 +871,43 @@ export interface BankCard4EVerificationResponse {
 }
 
 /**
- * MobileStatus请求参数结构体
+ * 意愿核身点头确认模式结果
  */
-export interface MobileStatusRequest {
+export interface IntentionActionResult {
   /**
-   * 手机号码
+   * 意愿核身错误码：
+0: "成功"       
+-1: "参数错误"    
+-2: "系统异常"    
+-101: "请保持人脸在框内"    
+-102: "检测到多张人脸"   
+-103: "人脸检测失败"   
+-104: "人脸检测不完整"   
+-105: "请勿遮挡眼睛"    
+-106: "请勿遮挡嘴巴"     
+-107: "请勿遮挡鼻子"     
+-201: "人脸比对相似度低"    
+-202: "人脸比对失败"    
+-301: "意愿核验不通过"   
+-800: "前端不兼容错误"    
+-801: "用户未授权摄像头和麦克风权限"   
+-802: "获取视频流失败"   
+-803: "用户主动关闭链接/异常断开链接"   
+-998: "系统数据异常"   
+-999: "系统未知错误，请联系人工核实"   
+注意：此字段可能返回 null，表示取不到有效值。
    */
-  Mobile: string
+  FinalResultDetailCode?: number
   /**
-   * 敏感数据加密信息。对传入信息（手机号）有加密需求的用户可使用此参数，详情请点击左侧链接。
+   * 意愿核身错误信息
+注意：此字段可能返回 null，表示取不到有效值。
    */
-  Encryption?: Encryption
+  FinalResultMessage?: string
+  /**
+   * 意愿核身结果详细数据，与每段点头确认过程一一对应
+注意：此字段可能返回 null，表示取不到有效值。
+   */
+  Details?: Array<IntentionActionResultDetail>
 }
 
 /**
@@ -1275,6 +1334,22 @@ export interface MobileStatusResponse {
   RequestId?: string
 }
 
+/**
+ * RuleId相关配置
+ */
+export interface RuleIdConfig {
+  /**
+   * 意愿核身过程中识别用户的回答意图，开启后除了IntentionQuestions的Answers列表中的标准回答会通过，近似意图的回答也会通过，默认不开启。
+   */
+  IntentionRecognition?: boolean
+  /**
+   * 意愿核身类型，默认为0：
+0：问答模式，DetectAuth接口需要传入IntentionQuestions字段；
+1：点头模式，DetectAuth接口需要传入IntentionActions字段；
+   */
+  IntentionType?: number
+}
+
 /**
  * PhoneVerificationCTCC请求参数结构体
  */
@@ -1406,31 +1481,19 @@ export interface ParseNfcDataRequest {
 }
 
 /**
- * Liveness返回参数结构体
+ * 意愿核身点头确认模式结果详细数据
  */
-export interface LivenessResponse {
+export interface IntentionActionResultDetail {
   /**
-   * 验证通过后的视频最佳截图照片，照片为BASE64编码后的值，jpg格式。
+   * 视频base64编码（其中包含全程提示文本和点头音频，mp4格式）
 注意：此字段可能返回 null，表示取不到有效值。
    */
-  BestFrameBase64?: string
-  /**
-   * 业务错误码，成功情况返回Success, 错误情况请参考下方错误码 列表中FailedOperation部分
-   */
-  Result?: string
-  /**
-   * 业务结果描述。
-   */
-  Description?: string
+  Video?: string
   /**
-   * 最佳最佳截图列表，仅在配置了返回多张最佳截图时有效。
+   * 屏幕截图base64编码列表
 注意：此字段可能返回 null，表示取不到有效值。
    */
-  BestFrameList?: Array<string>
-  /**
-   * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
-   */
-  RequestId?: string
+  ScreenShot?: Array<string>
 }
 
 /**
@@ -1682,13 +1745,17 @@ Base64编码后的图片数据大小不超过3M，仅支持jpg、png格式。请
    */
   IntentionVerifyText?: string
   /**
-   * 意愿核身（问答模式）使用的文案，包括：系统语音播报的文本、需要核验的标准文本。当前仅支持一个播报文本+回答文本。
+   * 意愿核身语音问答模式（即语音播报+语音回答）使用的文案，包括：系统语音播报的文本、需要核验的标准文本。当前仅支持1轮问答。
    */
   IntentionQuestions?: Array<IntentionQuestion>
   /**
    * RuleId相关配置
    */
   Config?: RuleIdConfig
+  /**
+   * 意愿核身（点头确认模式）使用的文案，若未使用意愿核身（点头确认模式），则该字段无需传入。当前仅支持一个提示文本。
+   */
+  IntentionActions?: Array<IntentionActionConfig>
 }
 
 /**
@@ -1957,6 +2024,20 @@ export interface GetActionSequenceResponse {
   RequestId?: string
 }
 
+/**
+ * MobileStatus请求参数结构体
+ */
+export interface MobileStatusRequest {
+  /**
+   * 手机号码
+   */
+  Mobile: string
+  /**
+   * 敏感数据加密信息。对传入信息（手机号）有加密需求的用户可使用此参数，详情请点击左侧链接。
+   */
+  Encryption?: Encryption
+}
+
 /**
  * BankCardVerification返回参数结构体
  */
@@ -2617,11 +2698,11 @@ export interface EncryptedPhoneVerificationRequest {
  */
 export interface IntentionQuestion {
   /**
-   * 系统播报的问题文本，问题最大长度为150个字符。
+   * 当选择语音问答模式时，系统自动播报的问题文本，最大长度为150个字符。
    */
   Question: string
   /**
-   * 用户答案的标准文本列表，用于识别用户回答的语音与标准文本是否一致。列表长度最大为50，单个答案长度限制10个字符。
+   * 当选择语音问答模式时，用于判断用户回答是否通过的标准答案列表，传入后可自动判断用户回答文本是否在标准文本列表中。列表长度最大为50，单个答案长度限制10个字符。
    */
   Answers: Array<string>
 }

package/tencentcloud/services/faceid/v20180301/faceid_client.d.ts

@@ -1,5 +1,5 @@
 import * as TencentCloudCommon from "tencentcloud-sdk-nodejs-common";
-import { GetDetectInfoEnhancedRequest, GetFaceIdTokenRequest, LivenessRequest, CheckBankCardInformationRequest, MobileNetworkTimeVerificationResponse, GetLiveCodeRequest, CheckIdNameDateResponse, IdCardVerificationRequest, BankCardVerificationRequest, CheckBankCardInformationResponse, CheckIdCardInformationResponse, GetDetectInfoEnhancedResponse, PhoneVerificationRequest, PhoneVerificationCMCCRequest, GetEidResultRequest, DetectAuthResponse, PhoneVerificationResponse, GetEidTokenRequest, GetWeChatBillDetailsResponse, CheckPhoneAndNameResponse, BankCard4EVerificationResponse, MobileStatusRequest, IdCardOCRVerificationRequest, LivenessRecognitionResponse, ParseNfcDataResponse, CheckIdNameDateRequest, BankCard2EVerificationRequest, LivenessRecognitionRequest, GetFaceIdTokenResponse, PhoneVerificationCMCCResponse, CheckEidTokenStatusResponse, PhoneVerificationCTCCResponse, MobileStatusResponse, PhoneVerificationCTCCRequest, IdCardOCRVerificationResponse, ParseNfcDataRequest, LivenessResponse, CheckIdCardInformationRequest, DetectAuthRequest, MinorsVerificationResponse, GetWeChatBillDetailsRequest, CheckEidTokenStatusRequest, GetEidResultResponse, ImageRecognitionRequest, PhoneVerificationCUCCRequest, BankCard4EVerificationRequest, MobileNetworkTimeVerificationRequest, GetFaceIdResultRequest, PhoneVerificationCUCCResponse, GetActionSequenceResponse, BankCardVerificationResponse, MinorsVerificationRequest, ImageRecognitionResponse, GetActionSequenceRequest, GetDetectInfoResponse, LivenessCompareResponse, GetLiveCodeResponse, GetDetectInfoRequest, BankCard2EVerificationResponse, IdCardVerificationResponse, CheckPhoneAndNameRequest, GetEidTokenResponse, LivenessCompareRequest, GetFaceIdResultResponse, EncryptedPhoneVerificationRequest, EncryptedPhoneVerificationResponse } from "./faceid_models";
+import { GetDetectInfoEnhancedRequest, GetFaceIdTokenRequest, LivenessRequest, CheckBankCardInformationRequest, MobileNetworkTimeVerificationResponse, GetLiveCodeRequest, CheckIdNameDateResponse, IdCardVerificationRequest, BankCardVerificationRequest, CheckBankCardInformationResponse, LivenessResponse, CheckIdCardInformationResponse, GetDetectInfoEnhancedResponse, PhoneVerificationRequest, PhoneVerificationCMCCRequest, GetEidResultRequest, DetectAuthResponse, PhoneVerificationResponse, GetEidTokenRequest, GetWeChatBillDetailsResponse, CheckPhoneAndNameResponse, BankCard4EVerificationResponse, IdCardOCRVerificationRequest, LivenessRecognitionResponse, ParseNfcDataResponse, CheckIdNameDateRequest, BankCard2EVerificationRequest, LivenessRecognitionRequest, GetFaceIdTokenResponse, PhoneVerificationCMCCResponse, CheckEidTokenStatusResponse, PhoneVerificationCTCCResponse, MobileStatusResponse, PhoneVerificationCTCCRequest, IdCardOCRVerificationResponse, ParseNfcDataRequest, CheckIdCardInformationRequest, DetectAuthRequest, MinorsVerificationResponse, GetWeChatBillDetailsRequest, CheckEidTokenStatusRequest, GetEidResultResponse, ImageRecognitionRequest, PhoneVerificationCUCCRequest, BankCard4EVerificationRequest, MobileNetworkTimeVerificationRequest, GetFaceIdResultRequest, PhoneVerificationCUCCResponse, GetActionSequenceResponse, MobileStatusRequest, BankCardVerificationResponse, MinorsVerificationRequest, ImageRecognitionResponse, GetActionSequenceRequest, GetDetectInfoResponse, LivenessCompareResponse, GetLiveCodeResponse, GetDetectInfoRequest, BankCard2EVerificationResponse, IdCardVerificationResponse, CheckPhoneAndNameRequest, GetEidTokenResponse, LivenessCompareRequest, GetFaceIdResultResponse, EncryptedPhoneVerificationRequest, EncryptedPhoneVerificationResponse } from "./faceid_models";
 /**
  * faceid client
  * @class

package/tencentcloud/services/faceid/v20180301/faceid_models.d.ts

@@ -115,13 +115,13 @@ export interface LivenessRequest {
     Optional?: string;
 }
 /**
- * RuleId相关配置
+ * 意愿核身（点头确认模式）配置
  */
-export interface RuleIdConfig {
+export interface IntentionActionConfig {
     /**
-     * 意愿核身过程中识别用户的回答意图，开启后除了IntentionQuestions的Answers列表中的标准回答会通过，近似意图的回答也会通过，默认不开启。
+     * 点头确认模式下，系统语音播报使用的问题文本，问题最大长度为150个字符。
      */
-    IntentionRecognition?: boolean;
+    Text: string;
 }
 /**
  * 敏感数据加密
@@ -375,6 +375,33 @@ export interface GetEidTokenConfig {
      */
     IsSupportHMTResidentPermitOCR?: boolean;
 }
+/**
+ * Liveness返回参数结构体
+ */
+export interface LivenessResponse {
+    /**
+     * 验证通过后的视频最佳截图照片，照片为BASE64编码后的值，jpg格式。
+  注意：此字段可能返回 null，表示取不到有效值。
+     */
+    BestFrameBase64?: string;
+    /**
+     * 业务错误码，成功情况返回Success, 错误情况请参考下方错误码 列表中FailedOperation部分
+     */
+    Result?: string;
+    /**
+     * 业务结果描述。
+     */
+    Description?: string;
+    /**
+     * 最佳最佳截图列表，仅在配置了返回多张最佳截图时有效。
+  注意：此字段可能返回 null，表示取不到有效值。
+     */
+    BestFrameList?: Array<string>;
+    /**
+     * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
+     */
+    RequestId?: string;
+}
 /**
  * CheckIdCardInformation返回参数结构体
  */
@@ -485,6 +512,11 @@ export interface GetDetectInfoEnhancedResponse {
   注意：此字段可能返回 null，表示取不到有效值。
      */
     IntentionQuestionResult?: IntentionQuestionResult;
+    /**
+     * 意愿核身点头确认模式的结果信息，若未使用该意愿核身功能，该字段返回值可以不处理。
+  注意：此字段可能返回 null，表示取不到有效值。
+     */
+    IntentionActionResult?: IntentionActionResult;
     /**
      * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
      */
@@ -566,12 +598,12 @@ export interface DetectAuthResponse {
     /**
      * 用于发起核身流程的URL，仅微信H5场景使用。
      */
-    Url: string;
+    Url?: string;
     /**
      * 一次核身流程的标识，有效时间为7,200秒；
   完成核身后，可用该标识获取验证结果信息。
      */
-    BizToken: string;
+    BizToken?: string;
     /**
      * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
      */
@@ -793,17 +825,43 @@ export interface BankCard4EVerificationResponse {
     RequestId?: string;
 }
 /**
- * MobileStatus请求参数结构体
+ * 意愿核身点头确认模式结果
  */
-export interface MobileStatusRequest {
+export interface IntentionActionResult {
     /**
-     * 手机号码
+     * 意愿核身错误码：
+  0: "成功"
+  -1: "参数错误"
+  -2: "系统异常"
+  -101: "请保持人脸在框内"
+  -102: "检测到多张人脸"
+  -103: "人脸检测失败"
+  -104: "人脸检测不完整"
+  -105: "请勿遮挡眼睛"
+  -106: "请勿遮挡嘴巴"
+  -107: "请勿遮挡鼻子"
+  -201: "人脸比对相似度低"
+  -202: "人脸比对失败"
+  -301: "意愿核验不通过"
+  -800: "前端不兼容错误"
+  -801: "用户未授权摄像头和麦克风权限"
+  -802: "获取视频流失败"
+  -803: "用户主动关闭链接/异常断开链接"
+  -998: "系统数据异常"
+  -999: "系统未知错误，请联系人工核实"
+  注意：此字段可能返回 null，表示取不到有效值。
      */
-    Mobile: string;
+    FinalResultDetailCode?: number;
     /**
-     * 敏感数据加密信息。对传入信息（手机号）有加密需求的用户可使用此参数，详情请点击左侧链接。
+     * 意愿核身错误信息
+  注意：此字段可能返回 null，表示取不到有效值。
      */
-    Encryption?: Encryption;
+    FinalResultMessage?: string;
+    /**
+     * 意愿核身结果详细数据，与每段点头确认过程一一对应
+  注意：此字段可能返回 null，表示取不到有效值。
+     */
+    Details?: Array<IntentionActionResultDetail>;
 }
 /**
  * IdCardOCRVerification请求参数结构体
@@ -1217,6 +1275,21 @@ export interface MobileStatusResponse {
      */
     RequestId?: string;
 }
+/**
+ * RuleId相关配置
+ */
+export interface RuleIdConfig {
+    /**
+     * 意愿核身过程中识别用户的回答意图，开启后除了IntentionQuestions的Answers列表中的标准回答会通过，近似意图的回答也会通过，默认不开启。
+     */
+    IntentionRecognition?: boolean;
+    /**
+     * 意愿核身类型，默认为0：
+  0：问答模式，DetectAuth接口需要传入IntentionQuestions字段；
+  1：点头模式，DetectAuth接口需要传入IntentionActions字段；
+     */
+    IntentionType?: number;
+}
 /**
  * PhoneVerificationCTCC请求参数结构体
  */
@@ -1344,31 +1417,19 @@ export interface ParseNfcDataRequest {
     ReqId: string;
 }
 /**
- * Liveness返回参数结构体
+ * 意愿核身点头确认模式结果详细数据
  */
-export interface LivenessResponse {
+export interface IntentionActionResultDetail {
     /**
-     * 验证通过后的视频最佳截图照片，照片为BASE64编码后的值，jpg格式。
+     * 视频base64编码（其中包含全程提示文本和点头音频，mp4格式）
   注意：此字段可能返回 null，表示取不到有效值。
      */
-    BestFrameBase64?: string;
+    Video?: string;
     /**
-     * 业务错误码，成功情况返回Success, 错误情况请参考下方错误码 列表中FailedOperation部分
-     */
-    Result?: string;
-    /**
-     * 业务结果描述。
-     */
-    Description?: string;
-    /**
-     * 最佳最佳截图列表，仅在配置了返回多张最佳截图时有效。
+     * 屏幕截图base64编码列表
   注意：此字段可能返回 null，表示取不到有效值。
      */
-    BestFrameList?: Array<string>;
-    /**
-     * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
-     */
-    RequestId?: string;
+    ScreenShot?: Array<string>;
 }
 /**
  * CheckIdCardInformation请求参数结构体
@@ -1617,13 +1678,17 @@ export interface DetectAuthRequest {
      */
     IntentionVerifyText?: string;
     /**
-     * 意愿核身（问答模式）使用的文案，包括：系统语音播报的文本、需要核验的标准文本。当前仅支持一个播报文本+回答文本。
+     * 意愿核身语音问答模式（即语音播报+语音回答）使用的文案，包括：系统语音播报的文本、需要核验的标准文本。当前仅支持1轮问答。
      */
     IntentionQuestions?: Array<IntentionQuestion>;
     /**
      * RuleId相关配置
      */
     Config?: RuleIdConfig;
+    /**
+     * 意愿核身（点头确认模式）使用的文案，若未使用意愿核身（点头确认模式），则该字段无需传入。当前仅支持一个提示文本。
+     */
+    IntentionActions?: Array<IntentionActionConfig>;
 }
 /**
  * MinorsVerification返回参数结构体
@@ -1880,6 +1945,19 @@ export interface GetActionSequenceResponse {
      */
     RequestId?: string;
 }
+/**
+ * MobileStatus请求参数结构体
+ */
+export interface MobileStatusRequest {
+    /**
+     * 手机号码
+     */
+    Mobile: string;
+    /**
+     * 敏感数据加密信息。对传入信息（手机号）有加密需求的用户可使用此参数，详情请点击左侧链接。
+     */
+    Encryption?: Encryption;
+}
 /**
  * BankCardVerification返回参数结构体
  */
@@ -2522,11 +2600,11 @@ export interface EncryptedPhoneVerificationRequest {
  */
 export interface IntentionQuestion {
     /**
-     * 系统播报的问题文本，问题最大长度为150个字符。
+     * 当选择语音问答模式时，系统自动播报的问题文本，最大长度为150个字符。
      */
     Question: string;
     /**
-     * 用户答案的标准文本列表，用于识别用户回答的语音与标准文本是否一致。列表长度最大为50，单个答案长度限制10个字符。
+     * 当选择语音问答模式时，用于判断用户回答是否通过的标准答案列表，传入后可自动判断用户回答文本是否在标准文本列表中。列表长度最大为50，单个答案长度限制10个字符。
      */
     Answers: Array<string>;
 }