tencentcloud-sdk-nodejs-essbasic 4.0.716 → 4.0.718

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

@@ -261,8 +261,14 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
        */
     CreateFlowsByTemplates(req: CreateFlowsByTemplatesRequest, cb?: (error: string, rep: CreateFlowsByTemplatesResponse) => void): Promise<CreateFlowsByTemplatesResponse>;
     /**
-     * 企业方可以通过此接口关闭个人的自动签功能
-     */
+       * 通过此接口可以关闭个人用户自动签功能。
+  无需对应的用户刷脸等方式同意即可关闭。
+  
+  注意:
+  
+  <ul><li>处方单等特殊场景专用，此接口为白名单功能，使用前请联系对接的客户经理沟通。</li>
+  <li>如果此用户在开通时候绑定过个人自动签账号许可,  关闭此用户的自动签不会归还个人自动签账号许可的额度。</li></ul>
+       */
     ChannelDisableUserAutoSign(req: ChannelDisableUserAutoSignRequest, cb?: (error: string, rep: ChannelDisableUserAutoSignResponse) => void): Promise<ChannelDisableUserAutoSignResponse>;
     /**
        * 查询子客企业电子印章，需要操作者具有管理印章权限
@@ -290,7 +296,7 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
     /**
        * 创建跳转小程序查看或签署的链接
   
-  **腾讯电子签小程序的的AppID 和 原始Id如下:**
+  **腾讯电子签小程序的AppID 和 原始Id如下:**
   
   | 小程序 | AppID | 原始ID |
   | ------------ | ------------ | ------------ |
@@ -301,10 +307,10 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
   
   |EndPoint| 场景| 说明和示例|
   |  ----  | ----  | --- |
-  |  WEIXINAPP  | 短链跳转腾讯电子签签署场景  |  点击链接打开电子签小程序（与腾讯电子签官方短信提醒用户签署形式一样）<br> 示例: https://essurl.cn/x9nvWU8fTg|
-  |  LONGURL2WEIXINAPP  | 长链跳转腾讯电子签签署场景  |  点击链接打开电子签小程序, 是WEIXINAPP生成短链代表的那个长链|
+  |  WEIXINAPP  | 短链跳转腾讯电子签小程序签署场景  |  点击链接打开电子签小程序（与腾讯电子签官方短信提醒用户签署形式一样）<br> 示例: https://essurl.cn/x9nvWU8fTg|
+  |  LONGURL2WEIXINAPP  | 长链跳转腾讯电子签小程序签署场景  |  点击链接打开电子签小程序, 是WEIXINAPP生成短链代表的那个长链|
   |  CHANNEL  | 带有H5引导页的跳转腾讯电子签小程序签署场景 |  点击链接打开一个H5引导页面, 页面中有个"前往小程序"的按钮, 点击后会跳转到腾讯电子签小程序签署场景;  签署完成会回到H5引导页面, 然后跳转到指定创建链接指定的JumpUrl<br>示例: https://res.ess.tencent.cn/cdn/h5-activity-beta/jump-mp.html?use=channel-guide&type=warning&token=uIFKIU8fTd |
-  |APP| 贵方APP跳转腾讯电子签小程序签署场景|  贵方App直接跳转到小程序后, 在腾讯电子签小程序签署完成后返回贵方App的场景<br>跳转到腾讯电子签小程序的实现可以参考微信的官方文档:<a href="https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/launchApp.html" target="_blank">开放能力/打开 App</a> <br> 示例: pages/guide?from=default&where=mini& to=CONTRACT_DETAIL& id=yDwiBUUc*duRvquCSX8wd& shortKey=yDwivUA**W1yRsTre3 |
+  |APP| 贵方App跳转腾讯电子签小程序签署场景|  贵方App直接跳转到小程序后, 在腾讯电子签小程序签署完成后返回贵方App的场景<br>跳转到腾讯电子签小程序的实现可以参考微信的官方文档:<a href="https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/launchApp.html" target="_blank">开放能力/打开 App</a> <br> 示例: pages/guide?from=default&where=mini& to=CONTRACT_DETAIL& id=yDwiBUUc*duRvquCSX8wd& shortKey=yDwivUA**W1yRsTre3 |
   |APP| 贵方小程序跳转腾讯电子签小程序签署场景|  贵方App直接跳转到小程序后, 在腾讯电子签小程序签署完成后返回贵方小程序的场景<br>跳转到腾讯电子签小程序的实现可以参考微信官方文档<a href="https://developers.weixin.qq.com/miniprogram/dev/api/navigate/wx.navigateToMiniProgram.html" target="_blank">全屏方式</a>和<a href="https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/openEmbeddedMiniProgram.html " target="_blank">半屏方式</a><br>此时返回的SignUrl就是官方文档中的path<br> 示例:pages/guide?from=default&where=mini& to=CONTRACT_DETAIL& id=yDwiBUUc*duRvquCSX8wd& shortKey=yDwivUA**W1yRsTre3  |
        */
     CreateSignUrls(req: CreateSignUrlsRequest, cb?: (error: string, rep: CreateSignUrlsResponse) => void): Promise<CreateSignUrlsResponse>;
@@ -421,8 +427,10 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
        */
     ChannelCreateUserAutoSignSealUrl(req: ChannelCreateUserAutoSignSealUrlRequest, cb?: (error: string, rep: ChannelCreateUserAutoSignSealUrlResponse) => void): Promise<ChannelCreateUserAutoSignSealUrlResponse>;
     /**
-     * 企业方可以通过此接口查询个人用户自动签开启状态
-     */
+       * 通过此接口获取个人用户自动签的开通状态。
+  
+  注意: `处方单等特殊场景专用，此接口为白名单功能，使用前请联系对接的客户经理沟通。`
+       */
     ChannelDescribeUserAutoSignStatus(req: ChannelDescribeUserAutoSignStatusRequest, cb?: (error: string, rep: ChannelDescribeUserAutoSignStatusResponse) => void): Promise<ChannelDescribeUserAutoSignStatusResponse>;
     /**
      * 对合同流程文件进行数字签名验证，判断数字签名是否有效，合同文件内容是否被篡改。
@@ -448,22 +456,26 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
        */
     ChannelCreateReleaseFlow(req: ChannelCreateReleaseFlowRequest, cb?: (error: string, rep: ChannelCreateReleaseFlowResponse) => void): Promise<ChannelCreateReleaseFlowResponse>;
     /**
-     * 查询企业员工列表
+     * 用于分页查询企业员工信息列表，支持设置过滤条件以筛选员工查询结果。
      */
     ChannelDescribeEmployees(req: ChannelDescribeEmployeesRequest, cb?: (error: string, rep: ChannelDescribeEmployeesResponse) => void): Promise<ChannelDescribeEmployeesResponse>;
     /**
-       * 指定需要批量撤销的签署流程Id，批量撤销合同
-  客户指定需要撤销的签署流程Id，最多100个，超过100不处理；
-  
-  可以撤回：未全部签署完成
-   不可以撤回：已全部签署完成、已拒签、已过期、已撤回、拒绝填写、已解除等合同状态。
-  
-  **满足撤销条件的合同会发起异步撤销流程，不满足撤销条件的合同返回失败原因。**
-  
-  **合同撤销成功后，会通过合同状态为 CANCEL 的回调消息通知调用方 [具体可参考回调消息](https://qian.tencent.com/developers/scenes/partner/callback_data_types#-%E5%90%88%E5%90%8C%E7%8A%B6%E6%80%81%E9%80%9A%E7%9F%A5---flowstatuschange)**
-  
-  **注意:
-  能撤回合同的只能是合同的发起人或者发起企业的超管、法人**
+       * 用于批量撤销合同流程<br/>
+  适用场景：
+  如果某些合同流程当前至少还有一方没有签署，则可通过该接口取消该合同流程。常用于合同发错、内容填错，需要及时撤销的场景。<br/>
+  通过签署流程编号批量撤销合同，单次最多支持撤销100份合同。只有合同的发起人或者发起方企业的超管/法人才能进行合同撤销。需要注意的是，若合同处于以下已终止状态，则不可撤销：<br/>
+  - 已全部签署完成
+  - 已拒签
+  - 已过期
+  - 已撤回
+  - 拒绝填写
+  - 已解除
+  
+  <br/>
+  满足撤销条件的合同会发起异步撤销流程，而不满足撤销条件的合同将返回失败原因。合同撤销成功后，会通过合同状态为 CANCEL 的回调消息通知调用方。具体的回调消息内容可参考 <a href="https://qian.tencent.com/developers/partner/callback_types_contracts_sign" target="_blank">合同状态变更回调消息</a>。
+  <br/><br/>
+  注:
+  `如果合同流程中的参与方均已签署完毕，则无法通过该接口撤销合同，`签署完毕的合同需要双方走解除流程将合同作废，可以参考<a href="https://qian.tencent.com/developers/partnerApis/startFlows/ChannelCreateReleaseFlow" target="_blank">发起解除合同流程</a>接口。
        */
     ChannelBatchCancelFlows(req: ChannelBatchCancelFlowsRequest, cb?: (error: string, rep: ChannelBatchCancelFlowsResponse) => void): Promise<ChannelBatchCancelFlowsResponse>;
     /**
@@ -537,8 +549,7 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
        */
     UploadFiles(req: UploadFilesRequest, cb?: (error: string, rep: UploadFilesResponse) => void): Promise<UploadFilesResponse>;
     /**
-       * 创建个人签署H5签署链接，请联系客户经理申请使用<br/>
-  该接口用于发起合同后，生成C端签署人的签署链接<br/>
+       * 该接口用于发起合同后，生成C端签署人的签署链接<br/>
   注意：该接口目前签署人类型仅支持个人签署方（PERSON）<br/>
   注意：该接口可生成签署链接的C端签署人必须仅有手写签名和时间类型的签署控件<br/>
   注意：该接口返回的签署链接是用于APP集成的场景，支持APP打开或浏览器直接打开，不支持微信小程序嵌入。微信小程序请使用小程序跳转或半屏弹窗的方式<br/>

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

@@ -314,8 +314,14 @@ class Client extends TencentCloudCommon.AbstractClient {
         return this.request("CreateFlowsByTemplates", req, cb);
     }
     /**
-     * 企业方可以通过此接口关闭个人的自动签功能
-     */
+       * 通过此接口可以关闭个人用户自动签功能。
+  无需对应的用户刷脸等方式同意即可关闭。
+  
+  注意:
+  
+  <ul><li>处方单等特殊场景专用，此接口为白名单功能，使用前请联系对接的客户经理沟通。</li>
+  <li>如果此用户在开通时候绑定过个人自动签账号许可,  关闭此用户的自动签不会归还个人自动签账号许可的额度。</li></ul>
+       */
     async ChannelDisableUserAutoSign(req, cb) {
         return this.request("ChannelDisableUserAutoSign", req, cb);
     }
@@ -351,7 +357,7 @@ class Client extends TencentCloudCommon.AbstractClient {
     /**
        * 创建跳转小程序查看或签署的链接
   
-  **腾讯电子签小程序的的AppID 和 原始Id如下:**
+  **腾讯电子签小程序的AppID 和 原始Id如下:**
   
   | 小程序 | AppID | 原始ID |
   | ------------ | ------------ | ------------ |
@@ -362,10 +368,10 @@ class Client extends TencentCloudCommon.AbstractClient {
   
   |EndPoint| 场景| 说明和示例|
   |  ----  | ----  | --- |
-  |  WEIXINAPP  | 短链跳转腾讯电子签签署场景  |  点击链接打开电子签小程序（与腾讯电子签官方短信提醒用户签署形式一样）<br> 示例: https://essurl.cn/x9nvWU8fTg|
-  |  LONGURL2WEIXINAPP  | 长链跳转腾讯电子签签署场景  |  点击链接打开电子签小程序, 是WEIXINAPP生成短链代表的那个长链|
+  |  WEIXINAPP  | 短链跳转腾讯电子签小程序签署场景  |  点击链接打开电子签小程序（与腾讯电子签官方短信提醒用户签署形式一样）<br> 示例: https://essurl.cn/x9nvWU8fTg|
+  |  LONGURL2WEIXINAPP  | 长链跳转腾讯电子签小程序签署场景  |  点击链接打开电子签小程序, 是WEIXINAPP生成短链代表的那个长链|
   |  CHANNEL  | 带有H5引导页的跳转腾讯电子签小程序签署场景 |  点击链接打开一个H5引导页面, 页面中有个"前往小程序"的按钮, 点击后会跳转到腾讯电子签小程序签署场景;  签署完成会回到H5引导页面, 然后跳转到指定创建链接指定的JumpUrl<br>示例: https://res.ess.tencent.cn/cdn/h5-activity-beta/jump-mp.html?use=channel-guide&type=warning&token=uIFKIU8fTd |
-  |APP| 贵方APP跳转腾讯电子签小程序签署场景|  贵方App直接跳转到小程序后, 在腾讯电子签小程序签署完成后返回贵方App的场景<br>跳转到腾讯电子签小程序的实现可以参考微信的官方文档:<a href="https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/launchApp.html" target="_blank">开放能力/打开 App</a> <br> 示例: pages/guide?from=default&where=mini& to=CONTRACT_DETAIL& id=yDwiBUUc*duRvquCSX8wd& shortKey=yDwivUA**W1yRsTre3 |
+  |APP| 贵方App跳转腾讯电子签小程序签署场景|  贵方App直接跳转到小程序后, 在腾讯电子签小程序签署完成后返回贵方App的场景<br>跳转到腾讯电子签小程序的实现可以参考微信的官方文档:<a href="https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/launchApp.html" target="_blank">开放能力/打开 App</a> <br> 示例: pages/guide?from=default&where=mini& to=CONTRACT_DETAIL& id=yDwiBUUc*duRvquCSX8wd& shortKey=yDwivUA**W1yRsTre3 |
   |APP| 贵方小程序跳转腾讯电子签小程序签署场景|  贵方App直接跳转到小程序后, 在腾讯电子签小程序签署完成后返回贵方小程序的场景<br>跳转到腾讯电子签小程序的实现可以参考微信官方文档<a href="https://developers.weixin.qq.com/miniprogram/dev/api/navigate/wx.navigateToMiniProgram.html" target="_blank">全屏方式</a>和<a href="https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/openEmbeddedMiniProgram.html " target="_blank">半屏方式</a><br>此时返回的SignUrl就是官方文档中的path<br> 示例:pages/guide?from=default&where=mini& to=CONTRACT_DETAIL& id=yDwiBUUc*duRvquCSX8wd& shortKey=yDwivUA**W1yRsTre3  |
        */
     async CreateSignUrls(req, cb) {
@@ -506,8 +512,10 @@ class Client extends TencentCloudCommon.AbstractClient {
         return this.request("ChannelCreateUserAutoSignSealUrl", req, cb);
     }
     /**
-     * 企业方可以通过此接口查询个人用户自动签开启状态
-     */
+       * 通过此接口获取个人用户自动签的开通状态。
+  
+  注意: `处方单等特殊场景专用，此接口为白名单功能，使用前请联系对接的客户经理沟通。`
+       */
     async ChannelDescribeUserAutoSignStatus(req, cb) {
         return this.request("ChannelDescribeUserAutoSignStatus", req, cb);
     }
@@ -543,24 +551,28 @@ class Client extends TencentCloudCommon.AbstractClient {
         return this.request("ChannelCreateReleaseFlow", req, cb);
     }
     /**
-     * 查询企业员工列表
+     * 用于分页查询企业员工信息列表，支持设置过滤条件以筛选员工查询结果。
      */
     async ChannelDescribeEmployees(req, cb) {
         return this.request("ChannelDescribeEmployees", req, cb);
     }
     /**
-       * 指定需要批量撤销的签署流程Id，批量撤销合同
-  客户指定需要撤销的签署流程Id，最多100个，超过100不处理；
-  
-  可以撤回：未全部签署完成
-   不可以撤回：已全部签署完成、已拒签、已过期、已撤回、拒绝填写、已解除等合同状态。
-  
-  **满足撤销条件的合同会发起异步撤销流程，不满足撤销条件的合同返回失败原因。**
-  
-  **合同撤销成功后，会通过合同状态为 CANCEL 的回调消息通知调用方 [具体可参考回调消息](https://qian.tencent.com/developers/scenes/partner/callback_data_types#-%E5%90%88%E5%90%8C%E7%8A%B6%E6%80%81%E9%80%9A%E7%9F%A5---flowstatuschange)**
-  
-  **注意:
-  能撤回合同的只能是合同的发起人或者发起企业的超管、法人**
+       * 用于批量撤销合同流程<br/>
+  适用场景：
+  如果某些合同流程当前至少还有一方没有签署，则可通过该接口取消该合同流程。常用于合同发错、内容填错，需要及时撤销的场景。<br/>
+  通过签署流程编号批量撤销合同，单次最多支持撤销100份合同。只有合同的发起人或者发起方企业的超管/法人才能进行合同撤销。需要注意的是，若合同处于以下已终止状态，则不可撤销：<br/>
+  - 已全部签署完成
+  - 已拒签
+  - 已过期
+  - 已撤回
+  - 拒绝填写
+  - 已解除
+  
+  <br/>
+  满足撤销条件的合同会发起异步撤销流程，而不满足撤销条件的合同将返回失败原因。合同撤销成功后，会通过合同状态为 CANCEL 的回调消息通知调用方。具体的回调消息内容可参考 <a href="https://qian.tencent.com/developers/partner/callback_types_contracts_sign" target="_blank">合同状态变更回调消息</a>。
+  <br/><br/>
+  注:
+  `如果合同流程中的参与方均已签署完毕，则无法通过该接口撤销合同，`签署完毕的合同需要双方走解除流程将合同作废，可以参考<a href="https://qian.tencent.com/developers/partnerApis/startFlows/ChannelCreateReleaseFlow" target="_blank">发起解除合同流程</a>接口。
        */
     async ChannelBatchCancelFlows(req, cb) {
         return this.request("ChannelBatchCancelFlows", req, cb);
@@ -652,8 +664,7 @@ class Client extends TencentCloudCommon.AbstractClient {
         return this.request("UploadFiles", req, cb);
     }
     /**
-       * 创建个人签署H5签署链接，请联系客户经理申请使用<br/>
-  该接口用于发起合同后，生成C端签署人的签署链接<br/>
+       * 该接口用于发起合同后，生成C端签署人的签署链接<br/>
   注意：该接口目前签署人类型仅支持个人签署方（PERSON）<br/>
   注意：该接口可生成签署链接的C端签署人必须仅有手写签名和时间类型的签署控件<br/>
   注意：该接口返回的签署链接是用于APP集成的场景，支持APP打开或浏览器直接打开，不支持微信小程序嵌入。微信小程序请使用小程序跳转或半屏弹窗的方式<br/>

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

@@ -405,7 +405,7 @@ export interface ChannelCreateFlowGroupByTemplatesResponse {
      * 合同组中每个合同流程ID，每个ID均为32位字符串。
   
   注:
-  `此数组的顺序和入参中的FlowInfos顺序回不一致`
+  `此数组的顺序和入参中的FlowInfos顺序一致`
      */
     FlowIds?: Array<string>;
     /**
@@ -1932,19 +1932,25 @@ export interface DescribeTemplatesResponse {
  */
 export interface AutoSignConfig {
     /**
-     * 自动签开通个人用户的三要素
+     * 自动签开通个人用户信息, 包括名字,身份证等
      */
     UserInfo: UserThreeFactor;
     /**
-     * 是否回调证书信息
+     * 是否回调证书信息:
+  <ul><li>**false**: 不需要(默认)</li>
+  <li>**true**:需要</li></ul>
      */
     CertInfoCallback?: boolean;
     /**
-     * 是否支持用户自定义签名印章
+     * 是否支持用户自定义签名印章:
+  <ul><li>**false**: 不能自己定义(默认)</li>
+  <li>**true**: 可以自己定义</li></ul>
      */
     UserDefineSeal?: boolean;
     /**
-     * 是否需要回调的时候返回印章(签名) 图片的 base64
+     * 回调中是否需要自动签将要使用的印章（签名）图片的 base64:
+  <ul><li>**false**: 不需要(默认)</li>
+  <li>**true**: 需要</li></ul>
      */
     SealImgCallback?: boolean;
     /**
@@ -1952,11 +1958,20 @@ export interface AutoSignConfig {
      */
     CallbackUrl?: string;
     /**
-     * 开通时候的验证方式，取值：WEIXINAPP（微信人脸识别），INSIGHT（慧眼人脸认别），TELECOM（运营商三要素验证）。如果是小程序开通链接，支持传 WEIXINAPP / TELECOM。如果是 H5 开通链接，支持传 INSIGHT / TELECOM。默认值 WEIXINAPP / INSIGHT。
+     * 开通时候的身份验证方式, 取值为：
+  <ul><li>**WEIXINAPP** : 微信人脸识别</li>
+  <li>**INSIGHT** : 慧眼人脸认别</li>
+  <li>**TELECOM** : 运营商三要素验证</li></ul>
+  注：
+  <ul><li>如果是小程序开通链接，支持传 WEIXINAPP / TELECOM。为空默认 WEIXINAPP</li>
+  <li>如果是 H5 开通链接，支持传 INSIGHT / TELECOM。为空默认 INSIGHT </li></ul>
      */
     VerifyChannels?: Array<string>;
     /**
-     * 设置用户开通自动签时是否绑定个人自动签账号许可。一旦绑定后，将扣减购买的个人自动签账号许可一次（1年有效期），不可解绑释放。不传默认为绑定自动签账号许可。 0-绑定个人自动签账号许可，开通后将扣减购买的个人自动签账号许可一次
+     * 设置用户开通自动签时是否绑定个人自动签账号许可。
+  
+  <ul><li>**0**: (默认) 使用个人自动签账号许可进行开通，个人自动签账号许可有效期1年，注: `不可解绑释放更换他人`</li>
+  </ul>
      */
     LicenseType?: number;
 }
@@ -2272,7 +2287,7 @@ export interface CreateConsoleLoginUrlRequest {
      * 该参数和Module参数配合使用，用于指定模块下的资源Id，指定后链接登录将展示该资源的详情。
   
   根据Module参数的不同所代表的含义不同(ModuleId需要和Module对应，ModuleId可以通过API或者控制台获取到)。当前支持：
-  <table> <thead> <tr> <th>Module传值</th> <th>ModuleId传值</th> <th>进入的目标页面</th> </tr> </thead> <tbody> <tr> <td>SEAL</td> <td>印章ID</td> <td>查看指定印章的详情页面</td> </tr> <tr> <td>TEMPLATE</td> <td>合同模板ID</td> <td>指定模版的详情页面</td> </tr> <tr> <td>DOCUMENT</td> <td>合同ID</td> <td>指定合同的详情页面</td> </tr> </tbody> </table>
+  <table> <thead> <tr> <th>Module传值</th> <th>ModuleId传值</th> <th>进入的目标页面</th> </tr> </thead> <tbody> <tr> <td>SEAL</td> <td>印章ID</td> <td>查看指定印章的详情页面</td> </tr> <tr> <td>TEMPLATE</td> <td>合同模板ID</td> <td>指定模板的详情页面</td> </tr> <tr> <td>DOCUMENT</td> <td>合同ID</td> <td>指定合同的详情页面</td> </tr> </tbody> </table>
   注意：该参数**仅在企业和员工激活完成，登录控制台场景才生效**。
   
      */
@@ -2624,18 +2639,22 @@ export interface PdfVerifyResult {
  */
 export interface UserThreeFactor {
     /**
-     * 姓名
+     * 签署方经办人的姓名。
+  经办人的姓名将用于身份认证和电子签名，请确保填写的姓名为签署方的真实姓名，而非昵称等代名。
      */
     Name: string;
     /**
-     * 证件类型:
-  ID_CARD 身份证
-  HONGKONG_AND_MACAO 港澳居民来往内地通行证
-  HONGKONG_MACAO_AND_TAIWAN 港澳台居民居住证(格式同居民身份证)
+     * 证件类型，支持以下类型
+  <ul><li>ID_CARD : 居民身份证 (默认值)</li>
+  <li>HONGKONG_AND_MACAO : 港澳居民来往内地通行证</li>
+  <li>HONGKONG_MACAO_AND_TAIWAN : 港澳台居民居住证(格式同居民身份证)</li></ul>
      */
     IdCardType: string;
     /**
-     * 证件号，如果有 X 请大写
+     * 证件号码，应符合以下规则
+  <ul><li>居民身份证号码应为18位字符串，由数字和大写字母X组成（如存在X，请大写）。</li>
+  <li>港澳居民来往内地通行证号码应为9位字符串，第1位为“C”，第2位为英文字母（但“I”、“O”除外），后7位为阿拉伯数字。</li>
+  <li>港澳台居民居住证号码编码规则与中国大陆身份证相同，应为18位字符串。</li></ul>
      */
     IdCardNumber: string;
 }
@@ -3341,21 +3360,32 @@ export interface ChannelCreateBoundFlowsRequest {
  */
 export interface ChannelDescribeEmployeesRequest {
     /**
-     * 应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 必填。
+     * 关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
+  
+  此接口下面信息必填。
+  <ul>
+  <li>渠道应用标识:  Agent.AppId</li>
+  <li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
+  <li>第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId</li>
+  </ul>
+  第三方平台子客企业和员工必须已经经过实名认证
      */
     Agent: Agent;
     /**
-     * 指定每页多少条数据，单页最大20
+     * 指定分页每页返回的数据条数，单页最大支持 20。
      */
     Limit: number;
     /**
-     * 查询过滤实名用户，Key为Status，Values为["IsVerified"]
-  根据第三方系统openId过滤查询员工时,Key为StaffOpenId,Values为["OpenId","OpenId",...]
-  查询离职员工时，Key为Status，Values为["QuiteJob"]
+     * 查询的关键字段，支持Key-Values查询。可选键值如下：
+  <ul>
+    <li>Key:**"Status"**，根据实名状态查询员工，Values可选：
+      <ul><li>**["IsVerified"]**：查询已实名的员工</li><li>**["QuiteJob"]**：查询离职员工</li></ul></li>
+    <li>Key:**"StaffOpenId"**，根据第三方系统用户OpenId查询员工，Values为第三方系统用户OpenId列表：**["OpenId1","OpenId2",...]**</li>
+  </ul>
      */
     Filters?: Array<Filter>;
     /**
-     * 查询结果分页返回，此处指定第几页，如果不传默认从第一页返回。页码从 0 开始，即首页为 0,最大为20000
+     * 指定分页返回第几页的数据，如果不传默认返回第一页。页码从 0 开始，即首页为 0，最大20000。
      */
     Offset?: number;
     /**
@@ -3436,7 +3466,7 @@ export interface CreateSignUrlsRequest {
   <li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
   <li>第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId</li>
   </ul>
-  第三方平台子客企业和员工必须已经经过实名认证
+  第三方平台子客企业和员工必须已经过实名认证
      */
     Agent: Agent;
     /**
@@ -3453,7 +3483,7 @@ export interface CreateSignUrlsRequest {
      * 签署链接类型,可以设置的参数如下
   <ul><li> **WEIXINAPP** :(默认)跳转电子签小程序的http_url, 短信通知或者H5跳转适合此类型 ，此时返回短链</li>
   <li> **CHANNEL** :带有H5引导页的跳转电子签小程序的链接</li>
-  <li> **APP** :第三方APP或小程序跳转电子签小程序的path, APP或者小程序跳转适合此类型</li>
+  <li> **APP** :第三方App或小程序跳转电子签小程序的path, App或者小程序跳转适合此类型</li>
   <li> **LONGURL2WEIXINAPP** :跳转电子签小程序的链接, H5跳转适合此类型，此时返回长链</li></ul>
   
   详细使用场景可以参数接口说明中的 **主要使用场景可以更加EndPoint分类如下**
@@ -3792,7 +3822,13 @@ export interface FlowApproverInfo {
     ApproverVerifyTypes?: Array<number | bigint>;
     /**
      * 签署人签署合同时的认证方式
-  1-人脸认证 2-签署密码 3-运营商三要素(默认为1,2)
+  <ul><li> **1** :人脸认证</li>
+  <li> **2** :签署密码</li>
+  <li> **3** :运营商三要素</li></ul>
+  
+  默认为1(人脸认证 ),2(签署密码)
+  
+  注: `用模版创建合同场景, 签署人的认证方式需要在配置模板的时候指定, 在此创建合同指定无效`
      */
     ApproverSignTypes?: Array<number | bigint>;
     /**
@@ -4108,20 +4144,23 @@ export interface FailedCreateRoleData {
  */
 export interface ChannelDescribeUserAutoSignStatusRequest {
     /**
-     * 渠道应用相关信息
+     * 关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
      */
     Agent: Agent;
     /**
-     * 自动签场景:
-  E_PRESCRIPTION_AUTO_SIGN 电子处方
+     * 自动签使用的场景值, 可以选择的场景值如下:
+  <ul><li> **E_PRESCRIPTION_AUTO_SIGN** : 电子处方场景</li></ul>
+  
+  注: `现在仅支持电子处方场景`
      */
     SceneKey: string;
     /**
-     * 查询开启状态的用户信息
+     * 要查询状态的用户信息, 包括名字,身份证等
      */
     UserInfo: UserThreeFactor;
     /**
-     * 操作人信息
+     * 执行本接口操作的员工信息。
+  注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`
      */
     Operator?: UserInfo;
 }
@@ -4412,20 +4451,21 @@ export interface ChannelCreateFlowSignReviewResponse {
  */
 export interface ChannelDisableUserAutoSignRequest {
     /**
-     * 渠道应用相关信息
+     * 关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
      */
     Agent: Agent;
     /**
-     * 自动签场景:
-  E_PRESCRIPTION_AUTO_SIGN 电子处方
+     * 自动签使用的场景值, 可以选择的场景值如下:
+  <ul><li> **E_PRESCRIPTION_AUTO_SIGN** 电子处方</li></ul>
      */
     SceneKey: string;
     /**
-     * 关闭自动签的个人的三要素
+     * 需要关闭自动签的个人的信息，如姓名，证件信息等。
      */
     UserInfo: UserThreeFactor;
     /**
-     * 操作人信息
+     * 执行本接口操作的员工信息。
+  注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`
      */
     Operator?: UserInfo;
 }
@@ -4569,7 +4609,7 @@ export interface ChannelCreateFlowGroupByFilesResponse {
      * 合同组中每个合同流程ID，每个ID均为32位字符串。
   
   注:
-  `此数组的顺序和入参中的FlowGroupInfos顺序回不一致`
+  `此数组的顺序和入参中的FlowGroupInfos顺序一致`
   注意：此字段可能返回 null，表示取不到有效值。
      */
     FlowIds?: Array<string>;
@@ -4946,12 +4986,19 @@ export interface ChannelBatchCancelFlowsRequest {
      */
     CancelMessage?: string;
     /**
-     * 撤销理由自定义格式；选项：
+     * 撤销理由自定义格式，支持以下格式
+  <ul><li>0 : 默认值</li>
+  <li>1 : 只保留身份信息</li>
+  <li>2 : 保留身份信息+企业名称</li>
+  <li>3 : 保留身份信息+企业名称+经办人名称</li></ul>
+  例如,假设合同的发起方是典子谦示例企业的经办人张三，撤销理由是"合同内容错误，需要修正",合同撤销后，各签署方看到的撤销理由是会是
+  
+  0: 发起方-典子谦示例企业-张三以"合同内容错误，需要修正"的理由撤销当前合同
+  1: 发起方以"合同内容错误，需要修正"的理由撤销当前合同
+  2: 发起方-典子谦示例企业以"合同内容错误，需要修正"的理由撤销当前合同
+  3: 发起方-典子谦示例企业-张三以"合同内容错误，需要修正"的理由撤销当前合同</br>
   
-  - 0 默认格式
-  - 1 只保留身份信息：展示为【发起方】
-  - 2 保留身份信息+企业名称：展示为【发起方xxx公司】
-  - 3 保留身份信息+企业名称+经办人名称：展示为【发起方xxxx公司-经办人姓名】
+  备注:`如果不传递撤销理由，那么默认撤销理由是 "自动撤销（通过接口实现）"`
      */
     CancelMessageFormat?: number;
     /**
@@ -5552,21 +5599,21 @@ export interface SyncFailReason {
  */
 export interface ChannelDescribeEmployeesResponse {
     /**
-     * 员工数据列表
+     * 员工信息列表。
   注意：此字段可能返回 null，表示取不到有效值。
      */
     Employees?: Array<Staff>;
     /**
-     * 查询结果分页返回，此处指定第几页，如果不传默认从第一页返回。页码从 0 开始，即首页为 0，最大20000
+     * 指定分页返回第几页的数据。页码从 0 开始，即首页为 0，最大20000。
   注意：此字段可能返回 null，表示取不到有效值。
      */
     Offset?: number;
     /**
-     * 指定每页多少条数据，单页最大20
+     * 指定分页每页返回的数据条数，单页最大支持 20。
      */
     Limit?: number;
     /**
-     * 符合条件的员工数量
+     * 符合条件的员工数量。
      */
     TotalCount?: number;
     /**
@@ -5728,19 +5775,25 @@ export interface CreateSealByImageRequest {
  */
 export interface ChannelDescribeUserAutoSignStatusResponse {
     /**
-     * 是否开通
+     * 查询用户是否已开通自动签
      */
     IsOpen?: boolean;
     /**
-     * 自动签许可生效时间。当且仅当已开通自动签时有值。
+     * 自动签许可生效时间。当且仅当已通过许可开通自动签时有值。
+  
+  值为unix时间戳,单位为秒。
      */
     LicenseFrom?: number;
     /**
-     * 自动签许可到期时间。当且仅当已开通自动签时有值。
+     * 自动签许可到期时间。当且仅当已通过许可开通自动签时有值。
+  
+  值为unix时间戳,单位为秒。
      */
     LicenseTo?: number;
     /**
-     * 设置用户开通自动签时是否绑定个人自动签账号许可。一旦绑定后，将扣减购买的个人自动签账号许可一次（1年有效期），不可解绑释放。不传默认为绑定自动签账号许可。 0-绑定个人自动签账号许可，开通后将扣减购买的个人自动签账号许可一次
+     * 设置用户开通自动签时是否绑定个人自动签账号许可。
+  
+  <ul><li>**0**: 使用个人自动签账号许可进行开通，个人自动签账号许可有效期1年，注: `不可解绑释放更换他人`</li></ul>
      */
     LicenseType?: number;
     /**