tencentcloud-sdk-nodejs 4.0.814 → 4.0.816

package/src/services/ess/v20201111/ess_client.ts

@@ -20,6 +20,7 @@ import { ClientConfig } from "../../../common/interface"
 import {
   DescribePersonCertificateResponse,
   BillUsageDetail,
+  DescribeCancelFlowsTaskResponse,
   IntentionActionResult,
   CreateSealRequest,
   ModifyIntegrationDepartmentResponse,
@@ -75,7 +76,7 @@ import {
   DescribeSignFaceVideoRequest,
   DeleteSealPoliciesRequest,
   CreateFlowGroupByTemplatesResponse,
-  DetectInfoVideoData,
+  CancelFailureFlow,
   TemplateInfo,
   CreateDocumentResponse,
   DescribeIntegrationEmployeesRequest,
@@ -135,6 +136,7 @@ import {
   RecipientComponentInfo,
   CreateFlowEvidenceReportResponse,
   CreateIntegrationRoleResponse,
+  DetectInfoVideoData,
   DescribeFlowComponentsRequest,
   CreateIntegrationDepartmentRequest,
   GroupOrganization,
@@ -194,6 +196,7 @@ import {
   CreateSealResponse,
   CreatePrepareFlowRequest,
   ApproverOption,
+  DescribeCancelFlowsTaskRequest,
   CreateEmbedWebUrlResponse,
   ModifyExtendedServiceResponse,
   CreateSealPolicyRequest,
@@ -306,7 +309,7 @@ export class Client extends AbstractClient {
 ![image](https://qcloudimg.tencent-cloud.cn/raw/06f2bc0f1772d8deac2f92b5df61a5ac.png)
 
 注：
-1.<font color="red">合同发起后就会扣减合同的额度</font>, 如果未签署完成时撤销合同会返还此额度（过期，拒签，签署完成，解除完成等状态不会返还额度）
+1.<font color="red">合同发起后就会扣减合同的额度</font>, 只有撤销没有参与方签署过或只有自动签署签署过的合同，才会返还合同额度。（过期，拒签，签署完成，解除完成等状态不会返还额度）
 
 2.<font color="red">静默（自动）签署不支持合同签署方存在填写</font>功能
 
@@ -331,7 +334,7 @@ export class Client extends AbstractClient {
 2. 有对应合同撤销权限的人:  <font color='red'>合同的发起人（并已经授予撤销权限）或者发起人所在企业的超管、法人</font>
 ![image](https://qcloudimg.tencent-cloud.cn/raw/1f9f07fea6a70766cd286e0d58682ee2.png)
 
-3. <font color='red'>撤销合同会返还合同额度</font>
+3. <font color='red'>只有撤销没有参与方签署过或只有自动签署签署过的合同，才会返还合同额度。</font>
 
 4.  撤销后可以看合同PDF内容的人员： 发起方的超管， 发起方自己，发起方撤销合同的操作人员，已经签署合同、已经填写合同、邀请填写已经补充信息的参与人员
      */
@@ -524,13 +527,16 @@ export class Client extends AbstractClient {
 - **可撤回合同状态**：未全部签署完成
 - **不撤回合同状态**：已全部签署完成、已拒签、已过期、已撤回、拒绝填写、已解除等合同状态。
 
+批量撤销结果可以通过接口返回的TaskId关联[批量撤销任务结果回调](https://qian.tencent.com/developers/company/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)或通过接口[查询批量撤销签署流程任务结果](https://qian.tencent.com/developers/companyApis/operateFlows/CreateBatchCancelFlowUrl)
+
+
 注：
 1. 如果合同流程中的参与方均已签署完毕，则无法通过该接口撤销合同，签署完毕的合同需要双方走解除流程将合同作废，可以参考<a href="https://qian.tencent.com/developers/companyApis/operateFlows/CreateReleaseFlow" target="_blank">发起解除合同流程</a>接口。
 
 2. 有对应合同撤销权限的人:  <font color='red'>合同的发起人（并已经授予撤销权限）或者发起人所在企业的超管、法人</font>
 ![image](https://qcloudimg.tencent-cloud.cn/raw/1f9f07fea6a70766cd286e0d58682ee2.png)
 
-3. <font color='red'>撤销合同会返还合同额度</font>
+3. <font color='red'>只有撤销没有参与方签署过或只有自动签署签署过的合同，才会返还合同额度。</font>
      */
   async CreateBatchCancelFlowUrl(
     req: CreateBatchCancelFlowUrlRequest,
@@ -800,6 +806,16 @@ export class Client extends AbstractClient {
     return this.request("CreateFlow", req, cb)
   }
 
+  /**
+   * 通过[获取批量撤销签署流程腾讯电子签小程序链接](https://qian.tencent.com/developers/companyApis/operateFlows/CreateBatchCancelFlowUrl)发起批量撤销任务后，可通过此接口查询批量撤销任务的结果。
+   */
+  async DescribeCancelFlowsTask(
+    req: DescribeCancelFlowsTaskRequest,
+    cb?: (error: string, rep: DescribeCancelFlowsTaskResponse) => void
+  ): Promise<DescribeCancelFlowsTaskResponse> {
+    return this.request("DescribeCancelFlowsTask", req, cb)
+  }
+
   /**
      * 发起解除协议的主要应用场景为：基于一份已经签署的合同（签署流程），进行解除操作。
 解除协议的模板是官方提供 ，经过提供法务审核，暂不支持自定义。
@@ -1000,7 +1016,7 @@ httpProfile.setEndpoint("file.test.ess.tencent.cn");
 ![image](https://qcloudimg.tencent-cloud.cn/raw/f097a74b289e3e1acd740936bdfe9843.png)
 
 注：
--  合同**发起后就会扣减合同的额度**, 如果未签署完成时撤销合同会返还此额度（**过期，拒签，签署完成，解除完成等状态不会返还额度**）
+-  合同**发起后就会扣减合同的额度**, 只有撤销没有参与方签署过或只有自动签署签署过的合同，才会返还合同额度。（**过期，拒签，签署完成，解除完成等状态不会返还额度**）
 - **静默（自动）签署不支持合同签署方存在填写**功能
      */
   async CreateFlowByFiles(

package/src/services/ess/v20201111/ess_models.ts

@@ -115,6 +115,35 @@ export interface BillUsageDetail {
   Remark?: string
 }
 
+/**
+ * DescribeCancelFlowsTask返回参数结构体
+ */
+export interface DescribeCancelFlowsTaskResponse {
+  /**
+   * 批量撤销任务编号，为32位字符串，通过接口[获取批量撤销签署流程腾讯电子签小程序链接](https://qian.tencent.com/developers/companyApis/operateFlows/CreateBatchCancelFlowUrl)获得。
+   */
+  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
+}
+
 /**
  * 意愿核身点头确认模式结果
  */
@@ -312,7 +341,7 @@ export interface CreatePreparedPersonalEsignRequest {
   /**
    * 证件号码，应符合以下规则
 <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
@@ -841,10 +870,9 @@ export interface CreateIntegrationEmployeesRequest {
    */
   Agent?: Agent
   /**
-   * 员工邀请方式可通过以下方式进行设置：
-
-**H5**：会生成H5的链接，点击链接进入H5的认证加入企业的逻辑。
-**SMS（默认）**：会通过短信或企业微信消息进行邀请。如果非企业微信场景，则是企业微信消息。其他场景则是短信通知，短信中包含链接，点击后进入微信小程序进行认证加入企业的逻辑。
+   * 员工邀请方式
+可通过以下途径进行设置：
+<ul><li>**SMS（默认）**：邀请将通过短信或企业微信消息发送。若场景非企业微信，则采用企业微信消息；其他情境下则使用短信通知。短信内含链接，点击后将进入微信小程序进行认证并加入企业的流程。</li><li>**H5**：将生成H5链接，用户点击链接后可进入H5页面进行认证并加入企业的流程。</li><li>**NONE**：系统会根据Endpoint生成签署链接，业务方需获取链接并通知客户。</li></ul>
    */
   InvitationNotifyType?: string
   /**
@@ -854,6 +882,10 @@ export interface CreateIntegrationEmployeesRequest {
 
    */
   JumpUrl?: string
+  /**
+   * 要跳转的链接类型<ul><li> **HTTP**：跳转电子签小程序的http_url, 短信通知或者H5跳转适合此类型  ，此时返回长链 (默认类型)</li><li>**HTTP_SHORT_URL**：跳转电子签小程序的http_url, 短信通知或者H5跳转适合此类型，此时返回短链</li><li>**APP**： 第三方APP或小程序跳转电子签小程序的path,  APP或者小程序跳转适合此类型</li><li>**H5**： 第三方移动端浏览器进行嵌入，不支持小程序嵌入，过期时间一个月</li></ul>注意：InvitationNotifyType 和 Endpoint 的关系图<table><tbody><tr><td>通知类型（InvitationNotifyType）</td><td>Endpoint</td></tr><tr><td>SMS（默认）</td><td>不需要传递，会将 Endpoint 默认设置为HTTP_SHORT_URL</td></tr><tr><td>H5</td><td>不需要传递，会将 Endpoint 默认设置为 H5</td></tr><tr><td>NONE</td><td>所有 Endpoint 都支持（HTTP_URL/HTTP_SHORT_URL/H5/APP）默认为HTTP_SHORT_URL</td></tr></tbody></table>
+   */
+  Endpoint?: string
 }
 
 /**
@@ -1254,7 +1286,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
@@ -1658,16 +1690,17 @@ export interface CreateFlowGroupByTemplatesResponse {
 }
 
 /**
- * 视频认证结果
+ * 撤销失败的流程信息
  */
-export interface DetectInfoVideoData {
+export interface CancelFailureFlow {
   /**
-   * 活体视频的base64编码，mp4格式
-
-注:`需进行base64解码获取活体视频文件`
-注意：此字段可能返回 null，表示取不到有效值。
+   * 合同流程ID，为32位字符串。
    */
-  LiveNessVideo?: string
+  FlowId?: string
+  /**
+   * 撤销失败原因
+   */
+  Reason?: string
 }
 
 /**
@@ -2065,7 +2098,7 @@ export interface CreateSchemeUrlRequest {
   /**
    * 证件号码，应符合以下规则
 <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
@@ -2736,7 +2769,7 @@ WEWORKAPP: 企业微信
   /**
    * 签署方经办人的证件号码，应符合以下规则
 <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>
 
 注：`补充个人签署方时，若该用户已在电子签完成实名则可通过指定姓名和证件类型、证件号码完成补充。`
@@ -2955,6 +2988,10 @@ export interface CreateBatchCancelFlowUrlResponse {
 例如:2023-07-28 17:25:59
    */
   UrlExpireOn?: string
+  /**
+   * 批量撤销任务编号，为32位字符串，可用于[查询批量撤销签署流程任务结果](https://qian.tencent.com/developers/companyApis/operateFlows/CreateBatchCancelFlowUrl) 或关联[批量撤销任务结果回调](https://qian.tencent.com/developers/company/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。
    */
@@ -2980,7 +3017,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
@@ -4076,7 +4113,7 @@ export interface FlowCreateApprover {
   /**
    * 证件号码，应符合以下规则
 <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
@@ -4382,6 +4419,19 @@ export interface CreateIntegrationRoleResponse {
   RequestId?: string
 }
 
+/**
+ * 视频认证结果
+ */
+export interface DetectInfoVideoData {
+  /**
+   * 活体视频的base64编码，mp4格式
+
+注:`需进行base64解码获取活体视频文件`
+注意：此字段可能返回 null，表示取不到有效值。
+   */
+  LiveNessVideo?: string
+}
+
 /**
  * DescribeFlowComponents请求参数结构体
  */
@@ -4542,10 +4592,14 @@ export interface Intention {
   IntentionType?: number
   /**
    * 意愿核身语音问答模式（即语音播报+语音回答）使用的文案，包括：系统语音播报的文本、需要核验的标准文本。当前仅支持1轮问答。
+
+注：`选择问答模式时，此字段可不传，不传则使用默认语音文本：请问，您是否同意签署本协议？可语音回复“同意”或“不同意”。`
    */
   IntentionQuestions?: Array<IntentionQuestion>
   /**
    * 意愿核身（点头确认模式）使用的文案，若未使用意愿核身（点头确认模式），则该字段无需传入。当前仅支持一个提示文本。
+
+注：`选择点头模式时，此字段可不传，不传则使用默认语音文本：请问，您是否同意签署本协议？可点头同意。`
    */
   IntentionActions?: Array<IntentionAction>
 }
@@ -5164,7 +5218,7 @@ export interface CreatePersonAuthCertificateImageRequest {
   /**
    * 证件号码，应符合以下规则
 <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
@@ -5233,8 +5287,8 @@ export interface UploadFilesResponse {
 }
 
 /**
- * 创建员工成功返回的信息
-支持saas/企微/H5端进行加入。
+ * 创建/修改员工成功返回的信息
+现在支持saas/企微/H5端进行加入。
  */
 export interface SuccessCreateStaffData {
   /**
@@ -5259,9 +5313,7 @@ export interface SuccessCreateStaffData {
    */
   WeworkOpenId?: string
   /**
-   * H5端员工加入\实名链接
-
-只有入参 InvitationNotifyType = H5的时候才会进行返回。
+   * 员工邀请返回链接 根据入参的 InvitationNotifyType 和 Endpoint 返回链接 <table><tbody><tr><td>链接类型</td><td>有效期</td><td>示例</td></tr><tr><td>HTTP_SHORT_URL（短链）</td><td>一天</td><td>https://test.essurl.cn/fvG7UBEd0F</td></tr><tr><td>HTTP（长链）</td><td>一天</td><td>https://res.ess.tencent.cn/cdn/h5-activity-dev/jump-mp.html?where=mini&from=MSG&to=USER_VERIFY&verifyToken=yDCVbUUckpwocmfpUySko7IS83LTV0u0&expireTime=1710840183</td></tr><tr><td>H5</td><td>30 天</td><td>https://quick.test.qian.tencent.cn/guide?Code=yDCVbUUckpwtvxqoUbTw4VBBjLbfAtW7&CodeType=QUICK&shortKey=yDCVbUY7lhqV7mZlCL2d</td></tr><tr><td>APP</td><td>一天</td><td>/pages/guide/index?to=USER_VERIFY&verifyToken=yDCVbUUckpwocm96UySko7ISvEIZH7Yz&expireTime=1710840455 </td></tr></tbody></table>
    */
   Url?: string
 }
@@ -5442,7 +5494,7 @@ export interface ApproverInfo {
   /**
    * 签署方经办人的证件号码，应符合以下规则
 <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
@@ -6314,6 +6366,26 @@ export interface ApproverOption {
   FlowReadLimit?: string
 }
 
+/**
+ * DescribeCancelFlowsTask请求参数结构体
+ */
+export interface DescribeCancelFlowsTaskRequest {
+  /**
+   * 执行本接口操作的员工信息。
+<br/>注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。
+   */
+  Operator: UserInfo
+  /**
+   * 批量撤销任务编号，为32位字符串，通过接口[获取批量撤销签署流程腾讯电子签小程序链接](https://qian.tencent.com/developers/companyApis/operateFlows/CreateBatchCancelFlowUrl)获得。
+   */
+  TaskId: string
+  /**
+   * 代理企业和员工的信息。
+<br/>在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
+   */
+  Agent?: Agent
+}
+
 /**
  * CreateEmbedWebUrl返回参数结构体
  */
@@ -6914,7 +6986,7 @@ export interface CreateBatchSignUrlRequest {
   /**
    * 证件号码，应符合以下规则
 <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>
 
 注：`请确保和合同中填入的一致`
@@ -6996,18 +7068,17 @@ export interface UpdateIntegrationEmployeesRequest {
    */
   Agent?: Agent
   /**
-   * 员工邀请方式可通过以下方式进行设置：
-
-**H5**：会生成H5的链接，点击链接进入H5的认证加入企业的逻辑。
-**SMS（默认）**：会通过短信或企业微信消息进行邀请。如果非企业微信场景，则是企业微信消息。其他场景则是短信通知，短信中包含链接，点击后进入微信小程序进行认证加入企业的逻辑。
+   * 员工邀请方式可通过以下途径进行设置：<ul><li>**SMS（默认）**：邀请将通过短信或企业微信消息发送。若场景非企业微信，则采用企业微信消息；其他情境下则使用短信通知。短信内含链接，点击后将进入微信小程序进行认证并加入企业的流程。</li><li>**H5**：将生成H5链接，用户点击链接后可进入H5页面进行认证并加入企业的流程。</li><li>**NONE**：系统会根据Endpoint生成签署链接，业务方需获取链接并通知客户。</li></ul>
    */
   InvitationNotifyType?: string
   /**
-   * 回跳地址，为认证成功后页面进行回跳的URL，请确保回跳地址的可用性。
-
-注：`只有在员工邀请方式（InvitationNotifyType参数）为H5场景下才生效， 其他方式下设置无效。`
+   * 回跳地址，为认证成功后页面进行回跳的URL，请确保回跳地址的可用性。注：`只有在员工邀请方式（InvitationNotifyType参数）为H5场景下才生效， 其他方式下设置无效。`
    */
   JumpUrl?: string
+  /**
+   * 要跳转的链接类型<ul><li> **HTTP**：跳转电子签小程序的http_url, 短信通知或者H5跳转适合此类型  ，此时返回长链 (默认类型)</li><li>**HTTP_SHORT_URL**：跳转电子签小程序的http_url, 短信通知或者H5跳转适合此类型，此时返回短链</li><li>**APP**： 第三方APP或小程序跳转电子签小程序的path,  APP或者小程序跳转适合此类型</li><li>**H5**： 第三方移动端浏览器进行嵌入，不支持小程序嵌入，过期时间一个月</li></ul>注意：InvitationNotifyType 和 Endpoint 的关系图<table><tbody><tr><td>通知类型（InvitationNotifyType）</td><td>Endpoint</td></tr><tr><td>SMS（默认）</td><td>不需要传递，会将 Endpoint 默认设置为HTTP_SHORT_URL</td></tr><tr><td>H5</td><td>不需要传递，会将 Endpoint 默认设置为 H5</td></tr><tr><td>NONE</td><td>所有 Endpoint 都支持（HTTP_URL/HTTP_SHORT_URL/H5/APP）默认为HTTP_SHORT_URL</td></tr></tbody></table>
+   */
+  Endpoint?: string
 }
 
 /**

package/src/services/essbasic/v20210526/essbasic_client.ts

@@ -29,6 +29,7 @@ import {
   DescribeExtendedServiceAuthDetailResponse,
   Department,
   CommonApproverOption,
+  DescribeCancelFlowsTaskResponse,
   ChannelCreateFlowGroupByTemplatesResponse,
   ChannelCreateFlowSignReviewRequest,
   AuthFailMessage,
@@ -45,6 +46,7 @@ import {
   ChannelCreateBatchSignUrlResponse,
   ChannelCreatePrepareFlowResponse,
   WebThemeConfig,
+  DetectInfoVideoData,
   OperateChannelTemplateResponse,
   FlowFileInfo,
   CreateFlowOption,
@@ -79,7 +81,7 @@ import {
   ChannelCreateFlowByFilesResponse,
   DescribeFlowDetailInfoResponse,
   RecipientComponentInfo,
-  DetectInfoVideoData,
+  CancelFailureFlow,
   ChannelDescribeRolesRequest,
   DescribeBatchOrganizationRegistrationUrlsRequest,
   PrepareFlowsResponse,
@@ -187,6 +189,7 @@ import {
   ChannelCreateFlowGroupByFilesResponse,
   ChannelCreateMultiFlowSignQRCodeResponse,
   ApproverOption,
+  DescribeCancelFlowsTaskRequest,
   ChannelDescribeUserAutoSignStatusResponse,
   ProxyOrganizationOperator,
   ModifyExtendedServiceResponse,
@@ -423,7 +426,7 @@ export class Client extends AbstractClient {
 
 `2. 不同类型的签署方传参不同, 可以参考开发者中心的FlowApproverInfo结构体说明`
 
-`3. 合同发起后就会扣减合同的额度, 如果未签署完成时撤销合同会返还此额度（过期，拒签，签署完成，解除完成等状态不会返还额度）`
+`3. 合同发起后就会扣减合同的额度, 只有撤销没有参与方签署过或只有自动签署签署过的合同，才会返还合同额度。（过期，拒签，签署完成，解除完成等状态不会返还额度）`
 
 `4. 静默（自动）签署不支持合同签署方存在填写功能`
      */
@@ -596,6 +599,7 @@ export class Client extends AbstractClient {
 注:
 - 有对应合同撤销权限的人:  <font color='red'>**合同的发起人（并已经授予撤销权限）或者发起人所在企业的超管、法人**</font>
 - 签署完毕的合同需要双方走解除流程将合同作废，可以参考<a href="https://qian.tencent.com/developers/partnerApis/startFlows/ChannelCreateReleaseFlow" target="_blank">发起解除合同流程接口</a>
+- <font color='red'>只有撤销没有参与方签署过或只有自动签署签署过的合同，才会返还合同额度。</font>
      */
   async ChannelCancelFlow(
     req: ChannelCancelFlowRequest,
@@ -619,6 +623,16 @@ export class Client extends AbstractClient {
     return this.request("ChannelCreateOrganizationBatchSignUrl", req, cb)
   }
 
+  /**
+   * 通过接口[批量撤销合同流程](https://qian.tencent.com/developers/partnerApis/operateFlows/ChannelBatchCancelFlows)或者[获取批量撤销签署流程腾讯电子签小程序链接](https://qian.tencent.com/developers/partnerApis/operateFlows/ChannelCreateBatchCancelFlowUrl)发起批量撤销任务后，可通过此接口查询批量撤销任务的结果。
+   */
+  async DescribeCancelFlowsTask(
+    req: DescribeCancelFlowsTaskRequest,
+    cb?: (error: string, rep: DescribeCancelFlowsTaskResponse) => void
+  ): Promise<DescribeCancelFlowsTaskResponse> {
+    return this.request("DescribeCancelFlowsTask", req, cb)
+  }
+
   /**
    * 将指定印章授权给第三方平台子客企业下的某些员工
    */
@@ -738,7 +752,7 @@ export class Client extends AbstractClient {
 
 2. 不同类型的签署方传参不同, 可以参考开发者中心的FlowApproverInfo结构体说明
 
-3. <font color="red">调用接口发起合同成功就会扣减合同的额度</font>, 如果未签署完成时撤销合同会返还此额度（过期，拒签，签署完成，解除完成等状态不会返还额度）
+3. <font color="red">调用接口发起合同成功就会扣减合同的额度</font>, 只有撤销没有参与方签署过或只有自动签署签署过的合同，才会返还合同额度。（过期，拒签，签署完成，解除完成等状态不会返还额度）
 
 4. <font color="red">静默（自动）签署不支持合同签署方存在填写</font>
 
@@ -1037,8 +1051,11 @@ Web链接访问后，会根据子客企业(**Agent中ProxyOrganizationOpenId表
 - **可撤回合同状态**：未全部签署完成
 - **不撤回合同状态**：已全部签署完成、已拒签、已过期、已撤回、拒绝填写、已解除等合同状态。
 
+批量撤销结果可以通过接口返回的TaskId关联[批量撤销任务结果回调](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)或通过接口[查询批量撤销合同结果](https://qian.tencent.com/developers/partnerApis/operateFlows/DescribeCancelFlowsTask)主动查询。
+
 注:
 - 签署完毕的合同需要双方走解除流程将合同作废，可以参考<a href="https://qian.tencent.com/developers/partnerApis/startFlows/ChannelCreateReleaseFlow" target="_blank">发起解除合同流程接口</a>
+- <font color='red'>只有撤销没有参与方签署过或只有自动签署签署过的合同，才会返还合同额度。</font>
      */
   async ChannelCreateBatchCancelFlowUrl(
     req: ChannelCreateBatchCancelFlowUrlRequest,
@@ -1256,9 +1273,13 @@ Web链接访问后，会根据子客企业(**Agent中ProxyOrganizationOpenId表
 - **可撤回合同状态**：未全部签署完成
 - **不撤回合同状态**：已全部签署完成、已拒签、已过期、已撤回、拒绝填写、已解除等合同状态。
 
+批量撤销结果可以通过接口返回的TaskId关联[批量撤销任务结果回调](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)或通过接口[查询批量撤销合同结果](https://qian.tencent.com/developers/partnerApis/operateFlows/DescribeCancelFlowsTask)主动查询。
+
+
 注:
 - 有对应合同撤销权限的人:  <font color='red'>**合同的发起人（并已经授予撤销权限）或者发起人所在企业的超管、法人**</font>
 - 签署完毕的合同需要双方走解除流程将合同作废，可以参考<a href="https://qian.tencent.com/developers/partnerApis/startFlows/ChannelCreateReleaseFlow" target="_blank">发起解除合同流程接口</a>
+- <font color='red'>只有撤销没有参与方签署过或只有自动签署签署过的合同，才会返还合同额度。</font>
      */
   async ChannelBatchCancelFlows(
     req: ChannelBatchCancelFlowsRequest,
@@ -1529,7 +1550,7 @@ Web链接访问后，会根据子客企业(**Agent中ProxyOrganizationOpenId表
 
 `2. 不同类型的签署方传参不同, 可以参考开发者中心的FlowApproverInfo结构体说明`
 
-`3. 合同发起后就会扣减合同的额度, 如果未签署完成时撤销合同会返还此额度（过期，拒签，签署完成，解除完成等状态不会返还额度），合同组中每个合同会扣减一个合同额度`
+`3. 合同发起后就会扣减合同的额度, 只有撤销没有参与方签署过或只有自动签署签署过的合同，才会返还合同额度。（过期，拒签，签署完成，解除完成等状态不会返还额度），合同组中每个合同会扣减一个合同额度`
 
 `4. 静默（自动）签署不支持合同签署方存在填写功能`
      */
@@ -1738,7 +1759,7 @@ Web链接访问后，会根据子客企业(**Agent中ProxyOrganizationOpenId表
 
 `2. 不同类型的签署方传参不同, 可以参考开发者中心的FlowApproverInfo结构体说明`
 
-`3. 合同发起后就会扣减合同的额度, 如果未签署完成时撤销合同会返还此额度（过期，拒签，签署完成，解除完成等状态不会返还额度），合同组中每个合同会扣减一个合同额度`
+`3. 合同发起后就会扣减合同的额度, 只有撤销没有参与方签署过或只有自动签署签署过的合同，才会返还合同额度。（过期，拒签，签署完成，解除完成等状态不会返还额度），合同组中每个合同会扣减一个合同额度`
 
 `4. 静默（自动）签署不支持合同签署方存在填写功能`
      */