tencentcloud-sdk-nodejs-essbasic 4.0.463 → 4.0.469

package/tencentcloud/services/essbasic/v20210526/essbasic_client.js

@@ -50,7 +50,7 @@ class Client extends TencentCloudCommon.AbstractClient {
         return this.request("ChannelCreateFlowByFiles", req, cb);
     }
     /**
-     * 渠道通过图片为子客代创建印章，图片最大5m；此接口不可直接使用，需要运营申请
+     * 渠道通过图片为子客代创建印章，图片最大5m；此接口不可直接使用，请联系运营/客服咨询相关流程
      */
     async CreateSealByImage(req, cb) {
         return this.request("CreateSealByImage", req, cb);
@@ -75,15 +75,40 @@ class Client extends TencentCloudCommon.AbstractClient {
         return this.request("DescribeUsage", req, cb);
     }
     /**
-       * 接口（CreateFlowsByTemplates）用于使用多个模板批量创建签署流程。当前可批量发起合同（签署流程）数量最大为20个。
+       * 渠道版撤销签署流程接口
+  注意:
+  能撤回合同的只能是合同的发起人或者发起企业的超管、法人
   
+       */
+    async ChannelCancelFlow(req, cb) {
+        return this.request("ChannelCancelFlow", req, cb);
+    }
+    /**
+       * 接口（CreateFlowsByTemplates）用于使用多个模板批量创建签署流程。当前可批量发起合同（签署流程）数量最大为20个。
+  合同发起人必须在电子签已经进行实名。
        */
     async CreateFlowsByTemplates(req, cb) {
         return this.request("CreateFlowsByTemplates", req, cb);
     }
     /**
-     * 创建跳转小程序查看或签署的链接；自动签署的签署方不创建签署链接；
-     */
+       * 创建跳转小程序查看或签署的链接。
+  
+  跳转小程序的几种方式：主要是设置不同的EndPoint
+  1. 通过链接Url直接跳转到小程序，不需要返回
+  设置EndPoint为WEIXINAPP，得到链接打开即可。（与短信提醒用户签署形式一样）。
+  2. 通过链接Url打开H5引导页-->点击跳转到小程序-->签署完退出小程序-->回到H5引导页-->跳转到指定JumpUrl
+  设置EndPoint为CHANNEL，指定JumpUrl，得到链接打开即可。
+  3. 客户App直接跳转到小程序-->小程序签署完成-->返回App
+  跳转到小程序的实现，参考官方文档（分为全屏、半屏两种方式）
+  全屏方式：
+  （https://developers.weixin.qq.com/miniprogram/dev/api/navigate/wx.navigateToMiniProgram.html）
+  半屏方式：
+  （https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/openEmbeddedMiniProgram.html）
+  其中小程序的原始Id，请联系<对接技术人员>获取，或者查看小程序信息自助获取。
+  使用CreateSignUrls，设置EndPoint为APP，得到path。
+  4. 客户小程序直接跳到电子签小程序-->签署完成退出电子签小程序-->回到客户小程序
+  实现方式同App跳小程序。
+       */
     async CreateSignUrls(req, cb) {
         return this.request("CreateSignUrls", req, cb);
     }
@@ -92,7 +117,7 @@ class Client extends TencentCloudCommon.AbstractClient {
   若子客企业未激活，会进入企业激活流程,首次参与激活流程的经办人会成为超管。（若企业激活过程中填写信息有误，需要重置激活流程，可以换一个经办人OpenId获取新的链接进入。）
   若子客企业已激活，使用了新的经办人OpenId进入，则会进入经办人的实名流程。
   若子客企业、经办人均已完成认证，则会直接进入子客Web控制台。
-  
+  返回的Url仅支持PC端操作。
        */
     async CreateConsoleLoginUrl(req, cb) {
         return this.request("CreateConsoleLoginUrl", req, cb);
@@ -158,19 +183,20 @@ class Client extends TencentCloudCommon.AbstractClient {
     /**
        * 该接口 (PrepareFlows) 用于创建待发起文件
   用户通过该接口进入签署流程发起的确认页面，进行发起信息二次确认， 如果确认则进行正常发起。
-  目前该接口只支持B2C，不建议使用。
+  目前该接口只支持B2C，不建议使用，将会废弃。
        */
     async PrepareFlows(req, cb) {
         return this.request("PrepareFlows", req, cb);
     }
     /**
-     * 根据签署流程信息批量获取资源下载链接，需合作企业先进行授权
-     */
+       * 根据签署流程信息批量获取资源下载链接，可以下载签署中、签署完的合同，需合作企业先进行授权。
+  此接口直接返回下载的资源的url，与接口GetDownloadFlowUrl跳转到控制台的下载方式不同。
+       */
     async DescribeResourceUrlsByFlows(req, cb) {
         return this.request("DescribeResourceUrlsByFlows", req, cb);
     }
     /**
-     * 通过此接口（DescribeTemplates）查询该子客企业在电子签拥有的的有效模板，不包括渠道模版
+     * 通过此接口（DescribeTemplates）查询该子客企业在电子签拥有的有效模板，不包括渠道模板
      */
     async DescribeTemplates(req, cb) {
         return this.request("DescribeTemplates", req, cb);

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

@@ -80,7 +80,17 @@ export interface PdfVerifyResult {
     ComponentPage: number;
 }
 /**
- * 创建签署流程签署人入参
+ * 创建签署流程签署人入参。
+
+其中签署方FlowApproverInfo需要传递的参数
+非单C、单B、B2C合同，ApproverType、RecipientId（模板发起合同时）必传，建议都传。其他身份标识
+1-个人：Name、Mobile必传
+2-渠道子客企业指定经办人：OpenId必传，OrgName必传、OrgOpenId必传；
+3-渠道合作企业不指定经办人：（暂不支持）
+4-非渠道合作企业：Name、Mobile必传，OrgName必传，且NotChannelOrganization=True。
+
+RecipientId参数：
+从DescribeTemplates接口中，可以得到模板下的签署方Recipient列表，根据模板自定义的Rolename在此结构体中确定其RecipientId
  */
 export interface FlowApproverInfo {
     /**
@@ -124,7 +134,7 @@ export interface FlowApproverInfo {
   PERSON_AUTO_SIGN-个人自动签；
   ORGANIZATION-企业；
   ENTERPRISESERVER-企业静默签;
-  注：ENTERPRISESERVER 类型仅用于使用文件创建签署流程（ChannelCreateFlowByFiles）接口；并且仅能指定发起方企业签署方为静默签署；
+  注：ENTERPRISESERVER 类型仅用于使用文件创建签署流程（ChannelCreateFlowByFiles）接口；
         */
     ApproverType?: string;
     /**
@@ -155,6 +165,14 @@ export interface FlowApproverInfo {
      * 签署完前端跳转的url，暂未使用
      */
     JumpUrl?: string;
+    /**
+     * 签署人个性化能力值
+     */
+    ApproverOption?: ApproverOption;
+    /**
+     * 当前签署方进行签署操作是否需要企业内部审批，true 则为需要
+     */
+    ApproverNeedSignReview?: boolean;
 }
 /**
  * ChannelCreateConvertTaskApi返回参数结构体
@@ -256,8 +274,9 @@ export interface ChannelDescribeEmployeesRequest {
      */
     Agent?: Agent;
     /**
-     * 查询过滤实名用户，key为Status，Values为["IsVerified"]
-     */
+        * 查询过滤实名用户，Key为Status，Values为["IsVerified"]
+  根据第三方系统openId过滤查询员工时,Key为StaffOpenId,Values为["OpenId","OpenId",...]
+        */
     Filters?: Array<Filter>;
     /**
      * 偏移量，默认为0，最大为20000
@@ -278,13 +297,19 @@ export interface SyncProxyOrganizationResponse {
     RequestId?: string;
 }
 /**
- * ChannelBatchCancelFlows返回参数结构体
+ * ChannelCreateFlowGroupByFiles返回参数结构体
  */
-export interface ChannelBatchCancelFlowsResponse {
+export interface ChannelCreateFlowGroupByFilesResponse {
     /**
-     * 签署流程批量撤销失败原因，错误信息与流程Id一一对应，如果部分流程不可撤销，不会返回错误信息，只会撤销可撤销流程
-     */
-    FailMessages: Array<string>;
+        * 合同组ID
+  注意：此字段可能返回 null，表示取不到有效值。
+        */
+    FlowGroupId: string;
+    /**
+        * 子合同ID列表
+  注意：此字段可能返回 null，表示取不到有效值。
+        */
+    FlowIds: Array<string>;
     /**
      * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
      */
@@ -363,6 +388,15 @@ export interface ChannelCreateMultiFlowSignQRCodeResponse {
      */
     RequestId?: string;
 }
+/**
+ * 签署人个性化能力信息
+ */
+export interface ApproverOption {
+    /**
+     * 是否隐藏一键签署 false-不隐藏,默认 true-隐藏
+     */
+    HideOneKeySign?: boolean;
+}
 /**
  * 签署参与者信息
  */
@@ -512,7 +546,7 @@ export interface CreateSignUrlsRequest {
     Endpoint?: string;
     /**
         * 签署链接生成类型，默认是 "ALL"；
-  "ALL"：全部签署方签署链接；
+  "ALL"：全部签署方签署链接，此时不会给自动签署的签署方创建签署链接；
   "CHANNEL"：渠道合作企业；
   "NOT_CHANNEL"：非渠道合作企业；
   "PERSON"：个人；
@@ -582,20 +616,24 @@ export interface ChannelCreateMultiFlowSignQRCodeRequest {
      * 二维码有效天数 默认7天 最高设置不超过90天
      */
     QrEffectiveDay?: number;
+    /**
+     * 限制二维码用户条件
+     */
+    Restrictions?: Array<ApproverRestriction>;
     /**
         * 回调地址，最大长度1000个字符
   不传默认使用渠道应用号配置的回调地址
   回调时机:用户通过签署二维码发起合同时，企业额度不足导致失败
         */
     CallbackUrl?: string;
-    /**
-     * 限制二维码用户条件
-     */
-    ApproverRestrictions?: ApproverRestriction;
     /**
      * 用户信息
      */
     Operator?: UserInfo;
+    /**
+     * 限制二维码用户条件（已弃用）
+     */
+    ApproverRestrictions?: ApproverRestriction;
 }
 /**
  * 授权出错信息
@@ -688,32 +726,53 @@ export interface UploadFile {
     FileName?: string;
 }
 /**
- * 合作企业经办人列表信息
+ * 合同组中每个子合同的发起信息
  */
-export interface ProxyOrganizationOperator {
+export interface FlowFileInfo {
     /**
-     * 经办人ID（渠道颁发），最大长度64个字符
+     * 签署文件资源Id列表，目前仅支持单个文件
      */
-    Id: string;
+    FileIds: Array<string>;
     /**
-     * 经办人姓名，最大长度50个字符
+     * 签署流程名称，长度不超过200个字符
      */
-    Name?: string;
+    FlowName: string;
     /**
-        * 经办人身份证件类型
-  1.ID_CARD 居民身份证
-  2.HONGKONG_MACAO_AND_TAIWAN 港澳台居民居住证
-  3.HONGKONG_AND_MACAO 港澳居民来往内地通行证
-        */
-    IdCardType?: string;
+     * 签署流程签约方列表，最多不超过5个参与方
+     */
+    FlowApprovers: Array<FlowApproverInfo>;
     /**
-     * 经办人证件号
+     * 签署流程截止时间，十位数时间戳，最大值为33162419560，即3020年
      */
-    IdCardNumber?: string;
+    Deadline?: number;
     /**
-     * 经办人手机号，大陆手机号输入11位，暂不支持海外手机号。
+     * 签署流程的描述，长度不超过1000个字符
      */
-    Mobile?: string;
+    FlowDescription?: string;
+    /**
+     * 签署流程的类型，长度不超过255个字符
+     */
+    FlowType?: string;
+    /**
+     * 签署流程回调地址，长度不超过255个字符
+     */
+    CallbackUrl?: string;
+    /**
+     * 渠道的业务信息，最大长度1000个字符。发起自动签署时，需设置对应自动签署场景，目前仅支持场景：处方单-E_PRESCRIPTION_AUTO_SIGN
+     */
+    CustomerData?: string;
+    /**
+     * 合同签署顺序类型(无序签,顺序签)，默认为false，即有序签署
+     */
+    Unordered?: boolean;
+    /**
+     * 合同显示的页卡模板，说明：只支持{合同名称}, {发起方企业}, {发起方姓名}, {签署方N企业}, {签署方N姓名}，且N不能超过签署人的数量，N从1开始
+     */
+    CustomShowMap?: string;
+    /**
+     * 本企业(发起方企业)是否需要签署审批
+     */
+    NeedSignReview?: boolean;
 }
 /**
  * ChannelGetTaskResultApi请求参数结构体
@@ -759,12 +818,12 @@ export interface ChannelVerifyPdfResponse {
  */
 export interface SignUrlInfo {
     /**
-        * 签署链接
+        * 签署链接，过期时间为30天
   注意：此字段可能返回 null，表示取不到有效值。
         */
     SignUrl: string;
     /**
-        * 链接失效时间,默认30分钟
+        * 合同过期时间
   注意：此字段可能返回 null，表示取不到有效值。
         */
     Deadline: number;
@@ -829,6 +888,12 @@ export interface SignUrlInfo {
 /**
  * 此结构体 (Component) 用于描述控件属性。
 
+在通过文件发起合同时，对应的component有三种定位方式
+1. 绝对定位方式
+2. 表单域(FIELD)定位方式
+3. 关键字(KEYWORD)定位方式
+可以参考官网说明
+https://cloud.tencent.com/document/product/1323/78346#component-.E4.B8.89.E7.A7.8D.E5.AE.9A.E4.BD.8D.E6.96.B9.E5.BC.8F.E8.AF.B4.E6.98.8E
  */
 export interface Component {
     /**
@@ -911,7 +976,10 @@ export interface Component {
     /**
         * 参数控件样式，json格式表述
   不同类型的控件会有部分非通用参数
-  TEXT控件可以指定字体
+  TEXT/MULTI_LINE_TEXT控件可以指定
+  1 Font：目前只支持黑体、宋体
+  2 FontSize： 范围12-72
+  3 FontAlign： Left/Right/Center，左对齐/居中/右对齐
   例如：{"FontSize":12}
         */
     ComponentExtra?: string;
@@ -977,6 +1045,18 @@ export interface ChannelBatchCancelFlowsRequest {
      * 签署流程Id数组，最多100个，超过100不处理
      */
     FlowIds: Array<string>;
+    /**
+     * 撤销理由
+     */
+    CancelMessage?: string;
+    /**
+        * 撤销理由自定义格式；选项：
+  0 默认格式
+  1 只保留身份信息：展示为【发起方】
+  2 保留身份信息+企业名称：展示为【发起方xxx公司】
+  3 保留身份信息+企业名称+经办人名称：展示为【发起方xxxx公司-经办人姓名】
+        */
+    CancelMessageFormat?: number;
     /**
      * 操作人信息
      */
@@ -1173,6 +1253,34 @@ export interface DescribeUsageResponse {
      */
     RequestId?: string;
 }
+/**
+ * 合作企业经办人列表信息
+ */
+export interface ProxyOrganizationOperator {
+    /**
+     * 经办人ID（渠道颁发），最大长度64个字符
+     */
+    Id: string;
+    /**
+     * 经办人姓名，最大长度50个字符
+     */
+    Name?: string;
+    /**
+        * 经办人身份证件类型
+  1.ID_CARD 居民身份证
+  2.HONGKONG_MACAO_AND_TAIWAN 港澳台居民居住证
+  3.HONGKONG_AND_MACAO 港澳居民来往内地通行证
+        */
+    IdCardType?: string;
+    /**
+     * 经办人证件号
+     */
+    IdCardNumber?: string;
+    /**
+     * 经办人手机号，大陆手机号输入11位，暂不支持海外手机号。
+     */
+    Mobile?: string;
+}
 /**
  * SyncProxyOrganizationOperators返回参数结构体
  */
@@ -1224,6 +1332,24 @@ export interface ChannelVerifyPdfRequest {
      */
     Operator?: UserInfo;
 }
+/**
+ * DescribeResourceUrlsByFlows请求参数结构体
+ */
+export interface DescribeResourceUrlsByFlowsRequest {
+    /**
+        * 渠道应用相关信息。
+  此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 均必填。
+        */
+    Agent: Agent;
+    /**
+     * 查询资源所对应的签署流程Id，最多支持50个
+     */
+    FlowIds?: Array<string>;
+    /**
+     * 操作者的信息
+     */
+    Operator?: UserInfo;
+}
 /**
  * 流程对应资源链接信息
  */
@@ -1240,53 +1366,33 @@ export interface FlowResourceUrlInfo {
     ResourceUrlInfos: Array<ResourceUrlInfo>;
 }
 /**
- * 合同组中每个子合同的发起信息
+ * ChannelCancelFlow请求参数结构体
  */
-export interface FlowFileInfo {
-    /**
-     * 签署文件资源Id列表，目前仅支持单个文件
-     */
-    FileIds: Array<string>;
-    /**
-     * 签署流程名称，长度不超过200个字符
-     */
-    FlowName: string;
-    /**
-     * 签署流程签约方列表，最多不超过5个参与方
-     */
-    FlowApprovers: Array<FlowApproverInfo>;
-    /**
-     * 签署流程截止时间，十位数时间戳，最大值为33162419560，即3020年
-     */
-    Deadline?: number;
-    /**
-     * 签署流程的描述，长度不超过1000个字符
-     */
-    FlowDescription?: string;
+export interface ChannelCancelFlowRequest {
     /**
-     * 签署流程的类型，长度不超过255个字符
-     */
-    FlowType?: string;
-    /**
-     * 签署流程回调地址，长度不超过255个字符
+     * 签署流程编号
      */
-    CallbackUrl?: string;
+    FlowId: string;
     /**
-     * 渠道的业务信息，最大长度1000个字符。发起自动签署时，需设置对应自动签署场景，目前仅支持场景：处方单-E_PRESCRIPTION_AUTO_SIGN
+     * 渠道应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 均必填。
      */
-    CustomerData?: string;
+    Agent?: Agent;
     /**
-     * 合同签署顺序类型(无序签,顺序签)，默认为false，即有序签署
+     * 撤回原因，最大不超过200字符
      */
-    Unordered?: boolean;
+    CancelMessage?: string;
     /**
-     * 合同显示的页卡模板，说明：只支持{合同名称}, {发起方企业}, {发起方姓名}, {签署方N企业}, {签署方N姓名}，且N不能超过签署人的数量，N从1开始
+     * 操作者的信息
      */
-    CustomShowMap?: string;
+    Operator?: UserInfo;
     /**
-     * 本企业(发起方企业)是否需要签署审批
-     */
-    NeedSignReview?: boolean;
+        * 撤销理由自定义格式；选项：
+  0 默认格式
+  1 只保留身份信息：展示为【发起方】
+  2 保留身份信息+企业名称：展示为【发起方xxx公司】
+  3 保留身份信息+企业名称+经办人名称：展示为【发起方xxxx公司-经办人姓名】
+        */
+    CancelMessageFormat?: number;
 }
 /**
  * DescribeTemplates请求参数结构体
@@ -1297,7 +1403,7 @@ export interface DescribeTemplatesRequest {
      */
     Agent: Agent;
     /**
-     * 模板唯一标识，查询单个模版时使用
+     * 模板唯一标识，查询单个模板时使用
      */
     TemplateId?: string;
     /**
@@ -1351,11 +1457,13 @@ export interface SyncProxyOrganizationOperatorsRequest {
  */
 export interface CreateConsoleLoginUrlResponse {
     /**
-     * 子客Web控制台url，此链接5分钟内有效，且只能访问一次
-     */
+        * 子客Web控制台url，此链接5分钟内有效，且只能访问一次。同时需要注意：
+  1. 此链接仅单次有效，使用后需要再次创建新的链接（部分聊天软件，如企业微信默认会对链接进行解析，此时需要使用类似“代码片段”的方式或者放到txt文件里发送链接）；
+  2. 创建的链接应避免被转义，如：&被转义为\u0026；如使用Postman请求后，请选择响应类型为 JSON，否则链接将被转义
+        */
     ConsoleUrl: string;
     /**
-     * 渠道子客企业是否已开通腾讯电子签。
+     * 渠道子客企业是否已开通腾讯电子签
      */
     IsActivated: boolean;
     /**
@@ -1376,7 +1484,7 @@ export interface CreateFlowsByTemplatesRequest {
      */
     FlowInfos: Array<FlowInfo>;
     /**
-        * 是否为预览模式；默认为false，即非预览模式，此时发起合同并返回FlowIds；若为预览模式，则返回PreviewUrls；
+        * 是否为预览模式；默认为false，即非预览模式，此时发起合同并返回FlowIds；若为预览模式，不会发起合同，会返回PreviewUrls（此Url返回的是PDF文件流 ）；
   预览链接有效期300秒；
         */
     NeedPreview?: boolean;
@@ -1480,19 +1588,13 @@ export interface SignUrl {
     HttpSignUrl: string;
 }
 /**
- * ChannelCreateFlowGroupByFiles返回参数结构体
+ * ChannelBatchCancelFlows返回参数结构体
  */
-export interface ChannelCreateFlowGroupByFilesResponse {
-    /**
-        * 合同组ID
-  注意：此字段可能返回 null，表示取不到有效值。
-        */
-    FlowGroupId: string;
+export interface ChannelBatchCancelFlowsResponse {
     /**
-        * 子合同ID列表
-  注意：此字段可能返回 null，表示取不到有效值。
-        */
-    FlowIds: Array<string>;
+     * 签署流程批量撤销失败原因，错误信息与流程Id一一对应，如果部分流程不可撤销，不会返回错误信息，只会撤销可撤销流程
+     */
+    FailMessages: Array<string>;
     /**
      * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
      */
@@ -1569,22 +1671,13 @@ export interface ChannelCreateBatchCancelFlowUrlResponse {
     RequestId?: string;
 }
 /**
- * DescribeResourceUrlsByFlows请求参数结构体
+ * ChannelCancelFlow返回参数结构体
  */
-export interface DescribeResourceUrlsByFlowsRequest {
+export interface ChannelCancelFlowResponse {
     /**
-        * 渠道应用相关信息。
-  此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 均必填。
-        */
-    Agent: Agent;
-    /**
-     * 查询资源所对应的签署流程Id，最多支持50个。
-     */
-    FlowIds?: Array<string>;
-    /**
-     * 操作者的信息
+     * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
      */
-    Operator?: UserInfo;
+    RequestId?: string;
 }
 /**
  * 签署流程下载信息