tencentcloud-sdk-nodejs-essbasic 4.0.814 → 4.0.816

package/tencentcloud/services/essbasic/v20210526/essbasic_models.d.ts

@@ -340,6 +340,11 @@ export interface ChannelBatchCancelFlowsResponse {
   注:  `如果全部撤销成功, 此数组为空数组`
      */
     FailMessages?: Array<string>;
+    /**
+     * 批量撤销任务编号，为32位字符串，可用于[查询批量撤销合同结果](https://qian.tencent.com/developers/partnerApis/operateFlows/DescribeCancelFlowsTask) 或关联[批量撤销任务结果回调](https://qian.tencent.com/developers/partner/callback_types_contracts_sign#%E4%B9%9D-%E6%89%B9%E9%87%8F%E6%92%A4%E9%94%80%E7%BB%93%E6%9E%9C%E5%9B%9E%E8%B0%83)
+  
+     */
+    TaskId?: string;
     /**
      * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
      */
@@ -419,6 +424,31 @@ export interface CommonApproverOption {
      */
     CanEditApprover?: boolean;
 }
+/**
+ * DescribeCancelFlowsTask返回参数结构体
+ */
+export interface DescribeCancelFlowsTaskResponse {
+    /**
+     * 批量撤销任务编号，为32位字符串。
+     */
+    TaskId?: string;
+    /**
+     * 任务状态，需要关注的状态<ul><li>**PROCESSING**  - 任务执行中</li><li>**END** - 任务处理完成</li><li>**TIMEOUT** 任务超时未处理完成，用户未在批量撤销链接有效期内操作</li></ul>
+     */
+    TaskStatus?: string;
+    /**
+     * 批量撤销成功的签署流程编号
+     */
+    SuccessFlowIds?: Array<string>;
+    /**
+     * 批量撤销失败的签署流程信息
+     */
+    FailureFlows?: Array<CancelFailureFlow>;
+    /**
+     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
+     */
+    RequestId?: string;
+}
 /**
  * ChannelCreateFlowGroupByTemplates返回参数结构体
  */
@@ -819,6 +849,18 @@ export interface WebThemeConfig {
      */
     HideAuthenticateTopLogo?: boolean;
 }
+/**
+ * 视频认证结果
+ */
+export interface DetectInfoVideoData {
+    /**
+     * 活体视频的base64编码，mp4格式
+  
+  注:`需进行base64解码获取活体视频文件`
+  注意：此字段可能返回 null，表示取不到有效值。
+     */
+    LiveNessVideo?: string;
+}
 /**
  * OperateChannelTemplate返回参数结构体
  */
@@ -1083,7 +1125,7 @@ export interface BaseFlowInfo {
  */
 export interface ReleasedApprover {
     /**
-     * 签署人在原合同签署人列表中的顺序序号(从0开始，按顺序依次递增)。</br>
+     * 签署人在原合同签署人列表中的顺序序号(从0开始，按顺序依次递增)。
   可以通过<a href="https://qian.tencent.com/developers/partnerApis/flows/DescribeFlowDetailInfo" target="_blank">DescribeFlowDetailInfo</a>接口查看原流程中的签署人列表。
      */
     ApproverNumber: number;
@@ -1107,7 +1149,8 @@ export interface ReleasedApprover {
     /**
      * 证件号码，应符合以下规则
   <ul><li>居民身份证号码应为18位字符串，由数字和大写字母X组成(如存在X，请大写)。</li>
-  <li>港澳居民来往内地通行证号码应为9位字符串，第1位为“C”，第2位为英文字母(但“I”、“O”除外)，后7位为阿拉伯数字。</li>
+  <li>港澳居民来往内地通行证号码共11位。第1位为字母，“H”字头签发给香港居民，“M”字头签发给澳门居民；第2位至第11位为数字。
+  </li>
   <li>港澳台居民居住证号码编码规则与中国大陆身份证相同，应为18位字符串。</li></ul>
      */
     IdCardNumber?: string;
@@ -1123,12 +1166,12 @@ export interface ReleasedApprover {
      */
     OrganizationName?: string;
     /**
-     * 第三方平台子客企业的唯一标识，定义Agent中的ProxyOrganizationOpenId一样, 可以参考<a href="https://qian.tencent.com/developers/partnerApis/dataTypes/#agent" target="_blank">Agent结构体</a>。</br>
+     * 第三方平台子客企业的唯一标识，定义Agent中的ProxyOrganizationOpenId一样, 可以参考<a href="https://qian.tencent.com/developers/partnerApis/dataTypes/#agent" target="_blank">Agent结构体</a>。
   当为子客企业指定经办人时，此OrganizationOpenId必传。
      */
     OrganizationOpenId?: string;
     /**
-     * 第三方平台子客企业员工的唯一标识，长度不能超过64，只能由字母和数字组成。</br>
+     * 第三方平台子客企业员工的唯一标识，长度不能超过64，只能由字母和数字组成。
   当签署方为同一第三方平台下的员工时，此OpenId必传。
      */
     OpenId?: string;
@@ -1139,7 +1182,7 @@ export interface ReleasedApprover {
      */
     ApproverSignComponentType?: string;
     /**
-     * 参与方在合同中的角色是按照创建合同的时候来排序的，解除协议默认会将第一个参与人叫`甲方`,第二个叫`乙方`,  第三个叫`丙方`，以此类推。</br>
+     * 参与方在合同中的角色是按照创建合同的时候来排序的，解除协议默认会将第一个参与人叫`甲方`,第二个叫`乙方`,  第三个叫`丙方`，以此类推。
   如果需改动此参与人的角色名字，可用此字段指定，由汉字,英文字符,数字组成，最大20个字。
      */
     ApproverSignRole?: string;
@@ -1530,7 +1573,7 @@ export interface NeedReviewApproverInfo {
     /**
      * 签署方经办人的证件号码，应符合以下规则
   <ul><li>居民身份证号码应为18位字符串，由数字和大写字母X组成（如存在X，请大写）。</li>
-  <li>港澳居民来往内地通行证号码应为9位字符串，第1位为“C”，第2位为英文字母（但“I”、“O”除外），后7位为阿拉伯数字。</li>
+  <li>港澳居民来往内地通行证号码共11位。第1位为字母，“H”字头签发给香港居民，“M”字头签发给澳门居民；第2位至第11位为数字。。</li>
   <li>港澳台居民居住证号码编码规则与中国大陆身份证相同，应为18位字符串。</li></ul>
      */
     ApproverIdCardNumber?: string;
@@ -2067,16 +2110,17 @@ export interface RecipientComponentInfo {
     Components?: Array<FilledComponent>;
 }
 /**
- * 视频认证结果
+ * 撤销失败的流程信息
  */
-export interface DetectInfoVideoData {
+export interface CancelFailureFlow {
     /**
-     * 活体视频的base64编码，mp4格式
-  
-  注:`需进行base64解码获取活体视频文件`
-  注意：此字段可能返回 null，表示取不到有效值。
+     * 签署流程编号，为32位字符串
      */
-    LiveNessVideo?: string;
+    FlowId?: string;
+    /**
+     * 撤销失败原因
+     */
+    Reason?: string;
 }
 /**
  * ChannelDescribeRoles请求参数结构体
@@ -3200,7 +3244,8 @@ export interface CommonFlowApprover {
     /**
      * 签署方经办人的证件号码，应符合以下规则
   <ul><li>居民身份证号码应为18位字符串，由数字和大写字母X组成（如存在X，请大写）。</li>
-  <li>港澳居民来往内地通行证号码应为9位字符串，第1位为“C”，第2位为英文字母（但“I”、“O”除外），后7位为阿拉伯数字。</li>
+  <li>港澳居民来往内地通行证号码共11位。第1位为字母，“H”字头签发给香港居民，“M”字头签发给澳门居民；第2位至第11位为数字。
+  </li>
   <li>港澳台居民居住证号码编码规则与中国大陆身份证相同，应为18位字符串。</li></ul>
      */
     ApproverIdCardNumber?: string;
@@ -3306,7 +3351,7 @@ export interface FillApproverInfo {
     /**
      * 签署方经办人的证件号码，应符合以下规则
   <ul><li>居民身份证号码应为18位字符串，由数字和大写字母X组成（如存在X，请大写）。</li>
-  <li>港澳居民来往内地通行证号码应为9位字符串，第1位为“C”，第2位为英文字母（但“I”、“O”除外），后7位为阿拉伯数字。</li>
+  <li>港澳居民来往内地通行证号码共11位。第1位为字母，“H”字头签发给香港居民，“M”字头签发给澳门居民；第2位至第11位为数字。</li>
   <li>港澳台居民居住证号码编码规则与中国大陆身份证相同，应为18位字符串。</li></ul>
   
   注：`补充个人签署方时，若该用户已在电子签完成实名则可通过指定姓名和证件类型、证件号码完成补充。`
@@ -3447,7 +3492,7 @@ export interface UserThreeFactor {
     /**
      * 证件号码，应符合以下规则
   <ul><li>居民身份证号码应为18位字符串，由数字和大写字母X组成（如存在X，请大写）。</li>
-  <li>港澳居民来往内地通行证号码应为9位字符串，第1位为“C”，第2位为英文字母（但“I”、“O”除外），后7位为阿拉伯数字。</li>
+  <li>港澳居民来往内地通行证号码共11位。第1位为字母，“H”字头签发给香港居民，“M”字头签发给澳门居民；第2位至第11位为数字。</li>
   <li>港澳台居民居住证号码编码规则与中国大陆身份证相同，应为18位字符串。</li></ul>
      */
     IdCardNumber: string;
@@ -4139,10 +4184,14 @@ export interface Intention {
     IntentionType?: number;
     /**
      * 意愿核身语音问答模式（即语音播报+语音回答）使用的文案，包括：系统语音播报的文本、需要核验的标准文本。当前仅支持1轮问答。
+  
+  注：`选择问答模式时，此字段可不传，不传则使用默认语音文本：请问，您是否同意签署本协议？可语音回复“同意”或“不同意”。`
      */
     IntentionQuestions?: Array<IntentionQuestion>;
     /**
      * 意愿核身（点头确认模式）使用的文案，若未使用意愿核身（点头确认模式），则该字段无需传入。当前仅支持一个提示文本。
+  
+  注：`选择点头模式时，此字段可不传，不传则使用默认语音文本：请问，您是否同意签署本协议？可点头同意。`
      */
     IntentionActions?: Array<IntentionAction>;
 }
@@ -4301,7 +4350,7 @@ export interface CreateSignUrlsRequest {
     /**
      * 证件号码，应符合以下规则
   <ul><li>居民身份证号码应为18位字符串，由数字和大写字母X组成(如存在X，请大写)。</li>
-  <li>港澳居民来往内地通行证号码应为9位字符串，第1位为“C”，第2位为英文字母(但“I”、“O”除外)，后7位为阿拉伯数字。</li>
+  <li>港澳居民来往内地通行证号码共11位。第1位为字母，“H”字头签发给香港居民，“M”字头签发给澳门居民；第2位至第11位为数字。</li>
   <li>港澳台居民居住证号码编码规则与中国大陆身份证相同，应为18位字符串。</li></ul>
      */
     IdCardNumber?: string;
@@ -4585,7 +4634,7 @@ export interface FlowApproverInfo {
     /**
      * 签署方经办人的证件号码，应符合以下规则
   <ul><li>居民身份证号码应为18位字符串，由数字和大写字母X组成（如存在X，请大写）。</li>
-  <li>港澳居民来往内地通行证号码应为9位字符串，第1位为“C”，第2位为英文字母（但“I”、“O”除外），后7位为阿拉伯数字。</li>
+  <li>港澳居民来往内地通行证号码共11位。第1位为字母，“H”字头签发给香港居民，“M”字头签发给澳门居民；第2位至第11位为数字。</li>
   <li>港澳台居民居住证号码编码规则与中国大陆身份证相同，应为18位字符串。</li></ul>
      */
     IdCardNumber?: string;
@@ -4906,7 +4955,7 @@ export interface ChannelCreatePreparedPersonalEsignRequest {
     /**
      * 证件号码, 应符合以下规则
   <ul><li>居民身份证号码应为18位字符串，由数字和大写字母X组成（如存在X，请大写）。</li>
-  <li>港澳居民来往内地通行证号码应为9位字符串，第1位为“C”，第2位为英文字母（但“I”、“O”除外），后7位为阿拉伯数字。</li>
+  <li>港澳居民来往内地通行证号码共11位。第1位为字母，“H”字头签发给香港居民，“M”字头签发给澳门居民；第2位至第11位为数字。</li>
   <li>港澳台居民居住证号码编码规则与中国大陆身份证相同，应为18位字符串。</li></ul>
      */
     IdCardNumber: string;
@@ -5887,6 +5936,27 @@ export interface ApproverOption {
      */
     FlowReadLimit?: string;
 }
+/**
+ * DescribeCancelFlowsTask请求参数结构体
+ */
+export interface DescribeCancelFlowsTaskRequest {
+    /**
+     * 关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
+  
+  此接口下面信息必填。
+  <ul>
+  <li>渠道应用标识:  Agent.AppId</li>
+  <li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
+  <li>第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId</li>
+  </ul>
+  第三方平台子客企业和员工必须已经经过实名认证
+     */
+    Agent: Agent;
+    /**
+     * 批量撤销任务编号，为32位字符串，通过接口[批量撤销合同流程](https://qian.tencent.com/developers/partnerApis/operateFlows/ChannelBatchCancelFlows)或者[获取批量撤销签署流程腾讯电子签小程序链接](https://qian.tencent.com/developers/partnerApis/operateFlows/ChannelCreateBatchCancelFlowUrl)获得。
+     */
+    TaskId: string;
+}
 /**
  * ChannelDescribeUserAutoSignStatus返回参数结构体
  */
@@ -6120,7 +6190,7 @@ export interface ChannelCreateBatchSignUrlRequest {
     /**
      * 证件号码，应符合以下规则
   <ul><li>居民身份证号码应为18位字符串，由数字和大写字母X组成（如存在X，请大写）。</li>
-  <li>港澳居民来往内地通行证号码应为9位字符串，第1位为“C”，第2位为英文字母（但“I”、“O”除外），后7位为阿拉伯数字。</li>
+  <li>港澳居民来往内地通行证号码共11位。第1位为字母，“H”字头签发给香港居民，“M”字头签发给澳门居民；第2位至第11位为数字。</li>
   <li>港澳台居民居住证号码编码规则与中国大陆身份证相同，应为18位字符串。</li></ul>
   
   注：`请确保和合同中填入的一致`
@@ -7219,6 +7289,10 @@ export interface ChannelCreateBatchCancelFlowUrlResponse {
   
      */
     UrlExpireOn?: string;
+    /**
+     * 批量撤销任务编号，为32位字符串，可用于[查询批量撤销合同结果](https://qian.tencent.com/developers/partnerApis/operateFlows/DescribeCancelFlowsTask) 或关联[批量撤销任务结果回调](https://qian.tencent.com/developers/partner/callback_types_contracts_sign#%E4%B9%9D-%E6%89%B9%E9%87%8F%E6%92%A4%E9%94%80%E7%BB%93%E6%9E%9C%E5%9B%9E%E8%B0%83)
+     */
+    TaskId?: string;
     /**
      * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
      */