tencentcloud-sdk-nodejs-essbasic 4.1.191 → 4.1.198

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "tencentcloud-sdk-nodejs-essbasic",
3
- "version": "4.1.191",
3
+ "version": "4.1.198",
4
4
  "description": "腾讯云 API NODEJS SDK",
5
5
  "main": "./tencentcloud/index.js",
6
6
  "module": "./es/index.js",
@@ -1960,6 +1960,10 @@ export interface ChannelCreateFlowByFilesRequest {
1960
1960
  * <p>是否开启动态合同(动态签署人2.0)<ul><li> <strong>false</strong> :(默认) 不开启动态合同(动态签署人2.0)</li><li> <strong>true</strong> :开启动态合同(动态签署人2.0),发起时不设置签署方,发起后可继续追加合同签署人</li></ul></p>
1961
1961
  */
1962
1962
  OpenDynamicSignFlow?: boolean;
1963
+ /**
1964
+ * <p>发起合同流程时对合同流程的部分操作加以限制的配置。</p>
1965
+ */
1966
+ FlowOperateLimit?: FlowOperateLimit;
1963
1967
  }
1964
1968
  /**
1965
1969
  * UploadFiles返回参数结构体
@@ -2906,6 +2910,15 @@ export interface CreateBatchOrganizationRegistrationTasksResponse {
2906
2910
  */
2907
2911
  RequestId?: string;
2908
2912
  }
2913
+ /**
2914
+ * 发起合同流程时对合同流程的部分操作加以限制的配置。
2915
+ */
2916
+ export interface FlowOperateLimit {
2917
+ /**
2918
+ * <p>发起合同流程时,对签署完成后是否能发起对应的解除合同加以限制:<ul><li><b>false(默认值)</b>: 合同流程完成签署后,支持发起对应的解除协议。</li><li><b>true </b>: 合同流程完成签署后,<b>不支持</b>发起对应的解除协议。</li></ul></p>
2919
+ */
2920
+ NoRelease?: boolean;
2921
+ }
2909
2922
  /**
2910
2923
  * ChannelVerifyPdf请求参数结构体
2911
2924
  */
@@ -4488,115 +4501,70 @@ export interface ArchiveDynamicFlowRequest {
4488
4501
  */
4489
4502
  export interface FlowInfo {
4490
4503
  /**
4491
- * 合同流程的名称(可自定义此名称),长度不能超过200,只能由中文、字母、数字和下划线组成。
4504
+ * <p>合同流程的名称(可自定义此名称),长度不能超过200,只能由中文、字母、数字和下划线组成。</p>
4492
4505
  */
4493
4506
  FlowName: string;
4494
4507
  /**
4495
- * 合同流程的签署截止时间,格式为Unix标准时间戳(秒),如果未设置签署截止时间,则默认为合同流程创建后的365天时截止。
4496
- 如果在签署截止时间前未完成签署,则合同状态会变为已过期,导致合同作废。
4497
- 示例值:1604912664
4508
+ * <p>合同流程的签署截止时间,格式为Unix标准时间戳(秒),如果未设置签署截止时间,则默认为合同流程创建后的365天时截止。<br>如果在签署截止时间前未完成签署,则合同状态会变为已过期,导致合同作废。<br>示例值:1604912664</p>
4498
4509
  */
4499
4510
  Deadline: number;
4500
4511
  /**
4501
- * 用户配置的合同模板ID,会基于此模板创建合同文档,为32位字符串。
4502
- 如果使用模板发起接口,此参数为必填。
4503
-
4504
- 可以通过<a href="https://qian.tencent.com/developers/partnerApis/accounts/CreateConsoleLoginUrl" target="_blank">生成子客登录链接</a>登录企业控制台, 在**企业模板**中得到合同模板ID。
4505
-
4506
- [点击产看模板Id在控制台上的位置](https://qcloudimg.tencent-cloud.cn/raw/e988be12bf28a89b4716aed4502c2e02.png)
4507
-
4512
+ * <p>用户配置的合同模板ID,会基于此模板创建合同文档,为32位字符串。<br>如果使用模板发起接口,此参数为必填。</p><p>可以通过<a href="https://qian.tencent.com/developers/partnerApis/accounts/CreateConsoleLoginUrl" target="_blank">生成子客登录链接</a>登录企业控制台, 在<strong>企业模板</strong>中得到合同模板ID。</p><p><a href="https://qcloudimg.tencent-cloud.cn/raw/e988be12bf28a89b4716aed4502c2e02.png">点击产看模板Id在控制台上的位置</a></p>
4508
4513
  */
4509
4514
  TemplateId?: string;
4510
4515
  /**
4511
- * 合同流程的参与方列表,最多可支持50个参与方。对应不同签署人的传参方式可以参考文档 [签署方入参指引](https://qian.tencent.com/developers/partner/flow_approver)
4512
-
4513
- 注:
4514
- <font color="red" > <b> 在发起流程时,需要保证 FlowApprovers中的顺序与模板定义顺序一致,否则会发起失败。
4515
- 例如,如果模板中定义的第一个参与人是个人用户,第二个参与人是企业员工,则在 approver 中传参时,第一个也必须是个人用户,第二个参与人必须是企业员工。</b></font>
4516
-
4517
- [点击查看模板参与人顺序定义位置](https://qcloudimg.tencent-cloud.cn/raw/c50e0a204fc5c66aaa2ca70e451ef2d6.png)
4518
-
4516
+ * <p>合同流程的参与方列表,最多可支持50个参与方。对应不同签署人的传参方式可以参考文档 <a href="https://qian.tencent.com/developers/partner/flow_approver">签署方入参指引</a></p><p>注:<br><font color="red"> <b> 在发起流程时,需要保证 FlowApprovers中的顺序与模板定义顺序一致,否则会发起失败。<br>例如,如果模板中定义的第一个参与人是个人用户,第二个参与人是企业员工,则在 approver 中传参时,第一个也必须是个人用户,第二个参与人必须是企业员工。</b></font></p><p><a href="https://qcloudimg.tencent-cloud.cn/raw/c50e0a204fc5c66aaa2ca70e451ef2d6.png">点击查看模板参与人顺序定义位置</a></p>
4519
4517
  */
4520
4518
  FlowApprovers?: Array<FlowApproverInfo>;
4521
4519
  /**
4522
- * 发起方角色的填写控件的填充内容。
4523
-
4524
- 注:只有在控制台编辑模板时,<font color="red">归属给发起方</font>的填写控件(如下图)才能在创建文档的时候进行内容填充。(<font color="red">白名单功能需要联系对接经理开通,否则模板编辑时无法将填写控件分配给发起方</font>)。
4525
- ![image](https://qcloudimg.tencent-cloud.cn/raw/b1d3978140ee2b44e2c9fdc96e467a5d.png)
4520
+ * <p>发起方角色的填写控件的填充内容。</p><p>注:只有在控制台编辑模板时,<font color="red">归属给发起方</font>的填写控件(如下图)才能在创建文档的时候进行内容填充。(<font color="red">白名单功能需要联系对接经理开通,否则模板编辑时无法将填写控件分配给发起方</font>)。<br><img src="https://qcloudimg.tencent-cloud.cn/raw/b1d3978140ee2b44e2c9fdc96e467a5d.png" alt="image"></p>
4526
4521
  */
4527
4522
  FormFields?: Array<FormField>;
4528
4523
  /**
4529
- * 该字段已废弃,请使用【应用号配置】中的回调地址统一接口消息
4524
+ * <p>该字段已废弃,请使用【应用号配置】中的回调地址统一接口消息</p>
4530
4525
  * @deprecated
4531
4526
  */
4532
4527
  CallbackUrl?: string;
4533
4528
  /**
4534
- * 合同流程的类别分类(可自定义名称,如销售合同/入职合同等),最大长度为200个字符,仅限中文、字母、数字和下划线组成。
4529
+ * <p>合同流程的类别分类(可自定义名称,如销售合同/入职合同等),最大长度为200个字符,仅限中文、字母、数字和下划线组成。</p>
4535
4530
  */
4536
4531
  FlowType?: string;
4537
4532
  /**
4538
- * 合同流程描述信息(可自定义此描述),最大长度1000个字符。
4533
+ * <p>合同流程描述信息(可自定义此描述),最大长度1000个字符。</p>
4539
4534
  */
4540
4535
  FlowDescription?: string;
4541
4536
  /**
4542
- * 调用方自定义的个性化字段(可自定义此名称),并以base64方式编码,支持的最大数据大小为1000长度。
4543
-
4544
- 在合同状态变更的回调信息等场景中,该字段的信息将原封不动地透传给贵方。回调的相关说明可参考开发者中心的回调通知模块。
4537
+ * <p>调用方自定义的个性化字段(可自定义此名称),并以base64方式编码,支持的最大数据大小为1000长度。</p><p>在合同状态变更的回调信息等场景中,该字段的信息将原封不动地透传给贵方。回调的相关说明可参考开发者中心的回调通知模块。</p>
4545
4538
  */
4546
4539
  CustomerData?: string;
4547
4540
  /**
4548
- * 您可以自定义腾讯电子签小程序合同列表页展示的合同内容模板,模板中支持以下变量:
4549
- <ul><li>{合同名称} </li>
4550
- <li>{发起方企业} </li>
4551
- <li>{发起方姓名} </li>
4552
- <li>{签署方N企业}</li>
4553
- <li>{签署方N姓名}</li></ul>
4554
- 其中,N表示签署方的编号,从1开始,不能超过签署人的数量。
4555
-
4556
- 例如,如果是腾讯公司张三发给李四名称为“租房合同”的合同,您可以将此字段设置为:`合同名称:{合同名称};发起方: {发起方企业}({发起方姓名});签署方:{签署方1姓名}`,则小程序中列表页展示此合同为以下样子
4557
-
4558
- 合同名称:租房合同
4559
- 发起方:腾讯公司(张三)
4560
- 签署方:李四
4561
-
4562
- ![image](https://qcloudimg.tencent-cloud.cn/raw/628f0928cac15d2e3bfa6088f53f5998.png)
4563
-
4541
+ * <p>您可以自定义腾讯电子签小程序合同列表页展示的合同内容模板,模板中支持以下变量:</p><ul><li>{合同名称} </li><li>{发起方企业} </li><li>{发起方姓名} </li><li>{签署方N企业}</li><li>{签署方N姓名}</li></ul>其中,N表示签署方的编号,从1开始,不能超过签署人的数量。<p>例如,如果是腾讯公司张三发给李四名称为“租房合同”的合同,您可以将此字段设置为:<code>合同名称:{合同名称};发起方: {发起方企业}({发起方姓名});签署方:{签署方1姓名}</code>,则小程序中列表页展示此合同为以下样子</p><p>合同名称:租房合同<br>发起方:腾讯公司(张三)<br>签署方:李四</p><p><img src="https://qcloudimg.tencent-cloud.cn/raw/628f0928cac15d2e3bfa6088f53f5998.png" alt="image"></p>
4564
4542
  */
4565
4543
  CustomShowMap?: string;
4566
4544
  /**
4567
- * 合同流程的抄送人列表,最多可支持50个抄送人,抄送人可查看合同内容及签署进度,但无需参与合同签署。
4568
-
4569
- <b>注</b>
4570
- 1. 抄送人名单中可以包括自然人以及本企业的员工(本企业员工必须已经完成认证并加入企业)。
4571
- 2. 请确保抄送人列表中的成员不与任何签署人重复。
4545
+ * <p>合同流程的抄送人列表,最多可支持50个抄送人,抄送人可查看合同内容及签署进度,但无需参与合同签署。</p><p><b>注</b></p><ol><li>抄送人名单中可以包括自然人以及本企业的员工(本企业员工必须已经完成认证并加入企业)。</li><li>请确保抄送人列表中的成员不与任何签署人重复。</li></ol>
4572
4546
  */
4573
4547
  CcInfos?: Array<CcInfo>;
4574
4548
  /**
4575
- * 发起方企业的签署人进行签署操作前,是否需要企业内部走审批流程,取值如下:
4576
- <ul><li> **false**:(默认)不需要审批,直接签署。</li>
4577
- <li> **true**:需要走审批流程。当到对应参与人签署时,会阻塞其签署操作,等待企业内部审批完成。</li></ul>
4578
- 企业可以通过CreateFlowSignReview审批接口通知腾讯电子签平台企业内部审批结果
4579
- <ul><li> 如果企业通知腾讯电子签平台审核通过,签署方可继续签署动作。</li>
4580
- <li> 如果企业通知腾讯电子签平台审核未通过,平台将继续阻塞签署方的签署动作,直到企业通知平台审核通过。</li></ul>
4581
- 注:`此功能可用于与企业内部的审批流程进行关联,支持手动、静默签署合同`
4549
+ * <p>发起方企业的签署人进行签署操作前,是否需要企业内部走审批流程,取值如下:</p><ul><li> **false**:(默认)不需要审批,直接签署。</li><li> **true**:需要走审批流程。当到对应参与人签署时,会阻塞其签署操作,等待企业内部审批完成。</li></ul>企业可以通过CreateFlowSignReview审批接口通知腾讯电子签平台企业内部审批结果<ul><li> 如果企业通知腾讯电子签平台审核通过,签署方可继续签署动作。</li><li> 如果企业通知腾讯电子签平台审核未通过,平台将继续阻塞签署方的签署动作,直到企业通知平台审核通过。</li></ul>注:<code>此功能可用于与企业内部的审批流程进行关联,支持手动、静默签署合同</code>
4582
4550
  */
4583
4551
  NeedSignReview?: boolean;
4584
4552
  /**
4585
- * 若在创建签署流程时指定了关注人CcInfos,此参数可设定向关注人发送短信通知的类型:
4586
- <ul><li> **0** :合同发起时通知通知对方来查看合同(默认)</li>
4587
- <li> **1** : 签署完成后通知对方来查看合同</li></ul>
4553
+ * <p>若在创建签署流程时指定了关注人CcInfos,此参数可设定向关注人发送短信通知的类型:</p><ul><li> **0** :合同发起时通知通知对方来查看合同(默认)</li><li> **1** : 签署完成后通知对方来查看合同</li></ul>
4588
4554
  */
4589
4555
  CcNotifyType?: number;
4590
4556
  /**
4591
- * 个人自动签名的使用场景包括以下, 个人自动签署(即ApproverType设置成个人自动签署时)业务此值必传:
4592
- <ul><li> **E_PRESCRIPTION_AUTO_SIGN**:电子处方单(医疗自动签) </li><li> **OTHER** : 通用场景</li></ul>
4593
- 注: `个人自动签名场景是白名单功能,使用前请与对接的客户经理联系沟通。`
4557
+ * <p>个人自动签名的使用场景包括以下, 个人自动签署(即ApproverType设置成个人自动签署时)业务此值必传:</p><ul><li> **E_PRESCRIPTION_AUTO_SIGN**:电子处方单(医疗自动签) </li><li> **OTHER** : 通用场景</li></ul>注: <code>个人自动签名场景是白名单功能,使用前请与对接的客户经理联系沟通。</code>
4594
4558
  */
4595
4559
  AutoSignScene?: string;
4596
4560
  /**
4597
- * 在短信通知、填写、签署流程中,若标题、按钮、合同详情等地方存在“合同”字样时,可根据此配置指定文案,可选文案如下: <ul><li> <b>0</b> :合同(默认值)</li> <li> <b>1</b> :文件</li> <li> <b>2</b> :协议</li><li> <b>3</b> :文书</li></ul>效果如下:![FlowDisplayType](https://qcloudimg.tencent-cloud.cn/raw/e4a2c4d638717cc901d3dbd5137c9bbc.png)
4561
+ * <p>在短信通知、填写、签署流程中,若标题、按钮、合同详情等地方存在“合同”字样时,可根据此配置指定文案,可选文案如下: <ul><li> <b>0</b> :合同(默认值)</li> <li> <b>1</b> :文件</li> <li> <b>2</b> :协议</li><li> <b>3</b> :文书</li></ul>效果如下:<img src="https://qcloudimg.tencent-cloud.cn/raw/e4a2c4d638717cc901d3dbd5137c9bbc.png" alt="FlowDisplayType"></p>
4598
4562
  */
4599
4563
  FlowDisplayType?: number;
4564
+ /**
4565
+ * <p>发起合同流程时对合同流程的部分操作加以限制的配置。</p><p> 注:此参数目前<strong>只支持 CreateFlowsByTemplates接口</strong> 。</p>
4566
+ */
4567
+ FlowOperateLimit?: FlowOperateLimit;
4600
4568
  }
4601
4569
  /**
4602
4570
  * ChannelCreateDynamicFlowApprover请求参数结构体
@@ -5101,149 +5069,86 @@ export interface DescribeUsageResponse {
5101
5069
  */
5102
5070
  export interface CreateSignUrlsRequest {
5103
5071
  /**
5104
- * 关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
5105
-
5106
- 此接口下面信息必填。
5107
- <ul>
5108
- <li>渠道应用标识: Agent.AppId</li>
5109
- <li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
5110
- <li>第三方平台子客企业中的员工标识: Agent.ProxyOperator.OpenId</li>
5111
- </ul>
5112
- 第三方平台子客企业和员工必须已经过实名认证
5072
+ * <p>关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。</p><p>此接口下面信息必填。</p><ul><li>渠道应用标识: Agent.AppId</li><li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li><li>第三方平台子客企业中的员工标识: Agent.ProxyOperator.OpenId</li></ul>第三方平台子客企业和员工必须已经过实名认证
5113
5073
  */
5114
5074
  Agent: Agent;
5115
5075
  /**
5116
- * 合同流程ID数组,最多支持100个。
5117
-
5118
- 注:
5119
- 1. 必须选择提供此参数或合同组编号中的一个。
5120
- 2. 当生成类型(GenerateType)设为“ALL”时,不可提供多个流程ID。
5076
+ * <p>合同流程ID数组,最多支持100个。</p><p>注: </p><ol><li>必须选择提供此参数或合同组编号中的一个。</li><li>当生成类型(GenerateType)设为“ALL”时,不可提供多个流程ID。</li></ol>
5121
5077
  */
5122
5078
  FlowIds?: Array<string>;
5123
5079
  /**
5124
- * 合同组编号
5125
- 注:`该参数和合同流程ID数组必须二选一`
5080
+ * <p>合同组编号<br>注:<code>该参数和合同流程ID数组必须二选一</code></p>
5126
5081
  */
5127
5082
  FlowGroupId?: string;
5128
5083
  /**
5129
- * 签署链接类型,可以设置的参数如下
5130
- <ul><li> **WEIXINAPP** :(默认)跳转电子签小程序的http_url, 短信通知或者H5跳转适合此类型 ,此时返回短链</li>
5131
- <li> **CHANNEL** :带有H5引导页的跳转电子签小程序的链接(<b>GenerateType非ALL时候不能设置成CHANNEL</b>)</li>
5132
- <li> **APP** :第三方App或小程序跳转电子签小程序的path, App或者小程序跳转适合此类型</li>
5133
- <li> **LONGURL2WEIXINAPP** :跳转电子签小程序的链接, H5跳转适合此类型,此时返回长链</li></ul>
5134
-
5135
- **注:**动态签署人场景,如果签署链接类型设置为`APP`,则仅支持跳转到封面页。
5136
-
5137
- 详细使用场景可以参考接口描述说明中的 **主要使用场景EndPoint分类**
5138
-
5084
+ * <p>签署链接类型,可以设置的参数如下</p><ul><li> **WEIXINAPP** :(默认)跳转电子签小程序的http_url, 短信通知或者H5跳转适合此类型 ,此时返回短链</li><li> **CHANNEL** :带有H5引导页的跳转电子签小程序的链接(<b>GenerateType非ALL时候不能设置成CHANNEL</b>)</li><li> **APP** :第三方App或小程序跳转电子签小程序的path, App或者小程序跳转适合此类型</li><li> **LONGURL2WEIXINAPP** :跳转电子签小程序的链接, H5跳转适合此类型,此时返回长链</li></ul><p><strong>注:</strong>动态签署人场景,如果签署链接类型设置为<code>APP</code>,则仅支持跳转到封面页。</p><p>详细使用场景可以参考接口描述说明中的 <strong>主要使用场景EndPoint分类</strong></p>
5139
5085
  */
5140
5086
  Endpoint?: string;
5141
5087
  /**
5142
- * 签署链接生成类型,可以选择的类型如下
5143
-
5144
- <ul><li><strong>ALL</strong>:(默认)为所有签署方生成签署链接,但不包括自动签署(静默签署)的签署方。注意:<strong>此中类型不支持多个合同ID(FlowIds)</strong>。</li>
5145
- <li><strong>CHANNEL</strong>:适用于第三方子企业的员工签署方。</li>
5146
- <li><strong>NOT_CHANNEL</strong>:适用于SaaS平台企业的员工签署方。</li>
5147
- <li><strong>PERSON</strong>:适用于个人或自然人签署方。</li>
5148
- <li><strong>FOLLOWER</strong>:适用于关注方,目前指合同的抄送方。</li>
5149
- <li><strong>RECIPIENT</strong>:根据RecipientId生成对应的签署链接,适用于动态添加签署人的情况。</li></ul>
5088
+ * <p>签署链接生成类型,可以选择的类型如下</p><ul><li><strong>ALL</strong>:(默认)为所有签署方生成签署链接,但不包括自动签署(静默签署)的签署方。注意:<strong>此中类型不支持多个合同ID(FlowIds)</strong>。</li><li><strong>CHANNEL</strong>:适用于第三方子企业的员工签署方。</li><li><strong>NOT_CHANNEL</strong>:适用于SaaS平台企业的员工签署方。</li><li><strong>PERSON</strong>:适用于个人或自然人签署方。</li><li><strong>FOLLOWER</strong>:适用于关注方,目前指合同的抄送方。</li><li><strong>RECIPIENT</strong>:根据RecipientId生成对应的签署链接,适用于动态添加签署人的情况。</li></ul>
5150
5089
  */
5151
5090
  GenerateType?: string;
5152
5091
  /**
5153
- * SaaS平台企业员工签署方的企业名称如果名称中包含英文括号(),请使用中文括号()代替。 注: `1.GenerateType为"NOT_CHANNEL"时必填` `2.获取B端动态签署人领取链接时,可指定此字段来预先设定签署人的企业,预设后只能以该企业身份去领取合同并完成签署`
5092
+ * <p>SaaS平台企业员工签署方的企业名称如果名称中包含英文括号(),请使用中文括号()代替。 注: <code>1.GenerateType为&quot;NOT_CHANNEL&quot;时必填</code> <code>2.获取B端动态签署人领取链接时,可指定此字段来预先设定签署人的企业,预设后只能以该企业身份去领取合同并完成签署</code></p>
5154
5093
  */
5155
5094
  OrganizationName?: string;
5156
5095
  /**
5157
- * 合同流程里边参与方的姓名。
5158
- 注:
5159
- 1. `GenerateType为"PERSON"(即个人签署方)时必填`。
5160
- 2. `在动态签署人补充链接场景中,可以通过传入这个值,对补充的个人参与方信息进行限制。仅匹配传入姓名的参与方才能补充合同。此参数预设信息功能暂时仅支持个人动态参与方。`
5096
+ * <p>合同流程里边参与方的姓名。<br>注: </p><ol><li><code>GenerateType为&quot;PERSON&quot;(即个人签署方)时必填</code>。</li><li><code>在动态签署人补充链接场景中,可以通过传入这个值,对补充的个人参与方信息进行限制。仅匹配传入姓名的参与方才能补充合同。此参数预设信息功能暂时仅支持个人动态参与方。</code></li></ol>
5161
5097
  */
5162
5098
  Name?: string;
5163
5099
  /**
5164
- * 合同流程里边签署方经办人手机号码, 支持国内手机号11位数字(无需加+86前缀或其他字符)
5165
- 注:
5166
- 1. `GenerateType为"PERSON"或"FOLLOWER"时必填。`
5167
- 2. `在动态签署人补充链接场景中,可以通过传入此值,对补充的个人参与方信息进行限制。仅匹配传入手机号的参与方才能补充合同。此参数预设信息功能暂时仅支持个人动态参与方。`
5100
+ * <p>合同流程里边签署方经办人手机号码, 支持国内手机号11位数字(无需加+86前缀或其他字符)。<br>注: </p><ol><li><code>GenerateType为&quot;PERSON&quot;或&quot;FOLLOWER&quot;时必填。</code></li><li><code>在动态签署人补充链接场景中,可以通过传入此值,对补充的个人参与方信息进行限制。仅匹配传入手机号的参与方才能补充合同。此参数预设信息功能暂时仅支持个人动态参与方。</code></li></ol>
5168
5101
  */
5169
5102
  Mobile?: string;
5170
5103
  /**
5171
- * 证件类型,支持以下类型
5172
- <ul><li>ID_CARD : 中国大陆居民身份证</li>
5173
- <li>HONGKONG_AND_MACAO : 中国港澳居民来往内地通行证</li>
5174
- <li>HONGKONG_MACAO_AND_TAIWAN : 中国港澳台居民居住证(格式同中国大陆居民身份证)</li></ul>
5175
-
5176
- `注:在动态签署人补充链接场景中,可以通过传入此值,对补充的个人参与方信息进行限制。仅匹配传入证件类型的参与方才能补充合同。此参数预设信息功能暂时仅支持个人动态参与方,且需要和证件号参数一同传递,不能单独进行限制。`
5104
+ * <p>证件类型,支持以下类型</p><ul><li>ID_CARD : 中国大陆居民身份证</li><li>HONGKONG_AND_MACAO : 中国港澳居民来往内地通行证</li><li>HONGKONG_MACAO_AND_TAIWAN : 中国港澳台居民居住证(格式同中国大陆居民身份证)</li></ul><p><code>注:在动态签署人补充链接场景中,可以通过传入此值,对补充的个人参与方信息进行限制。仅匹配传入证件类型的参与方才能补充合同。此参数预设信息功能暂时仅支持个人动态参与方,且需要和证件号参数一同传递,不能单独进行限制。</code></p>
5177
5105
  */
5178
5106
  IdCardType?: string;
5179
5107
  /**
5180
- * 证件号码,应符合以下规则
5181
- <ul><li>居民身份证号码应为18位字符串,由数字和大写字母X组成(如存在X,请大写)。</li>
5182
- <li>港澳居民来往内地通行证号码共11位。第1位为字母,“H”字头签发给中国香港居民,“M”字头签发给中国澳门居民;第2位至第11位为数字。</li>
5183
- <li>港澳台居民居住证号码编码规则与中国大陆身份证相同,应为18位字符串。</li></ul>
5184
-
5185
- `注:在动态签署人补充链接场景中,可以通过传入此值,对补充的个人参与方信息进行限制。仅匹配传入证件号的参与方才能补充合同。此参数预设信息功能暂时仅支持个人动态参与方。`
5108
+ * <p>证件号码,应符合以下规则</p><ul><li>居民身份证号码应为18位字符串,由数字和大写字母X组成(如存在X,请大写)。</li><li>港澳居民来往内地通行证号码共11位。第1位为字母,“H”字头签发给中国香港居民,“M”字头签发给中国澳门居民;第2位至第11位为数字。</li><li>港澳台居民居住证号码编码规则与中国大陆身份证相同,应为18位字符串。</li></ul><p><code>注:在动态签署人补充链接场景中,可以通过传入此值,对补充的个人参与方信息进行限制。仅匹配传入证件号的参与方才能补充合同。此参数预设信息功能暂时仅支持个人动态参与方。</code></p>
5186
5109
  */
5187
5110
  IdCardNumber?: string;
5188
5111
  /**
5189
- * 第三方平台子客企业的企业的标识, 即OrganizationOpenId。 注: `1.GenerateType为"CHANNEL"时必填` `2.获取B端动态签署人领取链接时,可指定此字段来预先设定签署人的平台子客企业,预设后只能以该平台子客企业身份去领取合同并完成签署`
5112
+ * <p>第三方平台子客企业的企业的标识, 即OrganizationOpenId。 注: <code>1.GenerateType为&quot;CHANNEL&quot;时必填</code> <code>2.获取B端动态签署人领取链接时,可指定此字段来预先设定签署人的平台子客企业,预设后只能以该平台子客企业身份去领取合同并完成签署</code></p>
5190
5113
  */
5191
5114
  OrganizationOpenId?: string;
5192
5115
  /**
5193
- * 第三方平台子客企业员工的标识OpenId,GenerateType为"CHANNEL"时可用,指定到具体参与人, 仅展示已经实名的经办人信息
5194
-
5195
- 注:
5196
- 如果传进来的<font color="red">OpenId已经实名并且加入企业, 则忽略Name,IdCardType,IdCardNumber,Mobile这四个入参</font>(会用此OpenId实名的身份证和登录的手机号覆盖)
5116
+ * <p>第三方平台子客企业员工的标识OpenId,GenerateType为&quot;CHANNEL&quot;时可用,指定到具体参与人, 仅展示已经实名的经办人信息</p><p>注:<br>如果传进来的<font color="red">OpenId已经实名并且加入企业, 则忽略Name,IdCardType,IdCardNumber,Mobile这四个入参</font>(会用此OpenId实名的身份证和登录的手机号覆盖)</p>
5197
5117
  */
5198
5118
  OpenId?: string;
5199
5119
  /**
5200
- * 签署完成后是否自动回跳
5201
- <ul><li>false:否, 签署完成不会自动跳转回来(默认)</li><li>true:是, 签署完成会自动跳转回来</li></ul>
5202
-
5203
- 注:
5204
- 1. 该参数<font color="red">只针对APP类型(电子签小程序跳转贵方小程序)场景</font> 的签署链接有效
5205
- 2. <font color="red">手机应用APP 或 微信小程序需要监控界面的返回走后序逻辑</font>, 微信小程序的文档可以参考[这个](https://developers.weixin.qq.com/miniprogram/dev/reference/api/App.html#onShow-Object-object)
5206
- 3. <font color="red">电子签小程序跳转贵方APP,不支持自动跳转,必需用户手动点击完成按钮(微信的限制)</font>
5120
+ * <p>签署完成后是否自动回跳</p><ul><li>false:否, 签署完成不会自动跳转回来(默认)</li><li>true:是, 签署完成会自动跳转回来</li></ul><p>注: </p><ol><li>该参数<font color="red">只针对APP类型(电子签小程序跳转贵方小程序)场景</font> 的签署链接有效</li><li><font color="red">手机应用APP 或 微信小程序需要监控界面的返回走后序逻辑</font>, 微信小程序的文档可以参考<a href="https://developers.weixin.qq.com/miniprogram/dev/reference/api/App.html#onShow-Object-object">这个</a></li><li><font color="red">电子签小程序跳转贵方APP,不支持自动跳转,必需用户手动点击完成按钮(微信的限制)</font></li></ol>
5207
5121
  */
5208
5122
  AutoJumpBack?: boolean;
5209
5123
  /**
5210
- * 签署完之后的H5页面的跳转链接,针对Endpoint为CHANNEL时有效,最大长度1000个字符。
5124
+ * <p>签署完之后的H5页面的跳转链接,针对Endpoint为CHANNEL时有效,最大长度1000个字符。</p>
5211
5125
  */
5212
5126
  JumpUrl?: string;
5213
5127
  /**
5214
- * 暂未开放
5128
+ * <p>暂未开放</p>
5215
5129
  * @deprecated
5216
5130
  */
5217
5131
  Operator?: UserInfo;
5218
5132
  /**
5219
- * 生成的签署链接在签署页面隐藏的按钮列表,可设置如下:
5220
-
5221
- <ul><li> **0** :合同签署页面更多操作按钮</li>
5222
- <li> **1** :合同签署页面更多操作的拒绝签署按钮</li>
5223
- <li> **2** :合同签署页面更多操作的转他人处理按钮</li>
5224
- <li> **3** :签署成功页的查看详情按钮</li>
5225
- <li> **4** :合同签署页面更多操作的查看合同基本信息按钮</li>
5226
- <li> **5** :合同签署页面更多操作的撤销按钮</li></ul>
5227
-
5228
- 注: `字段为数组, 可以传值隐藏多个按钮`
5133
+ * <p>生成的签署链接在签署页面隐藏的按钮列表,可设置如下:</p><ul><li> **0** :合同签署页面更多操作按钮</li><li> **1** :合同签署页面更多操作的拒绝签署按钮</li><li> **2** :合同签署页面更多操作的转他人处理按钮</li><li> **3** :签署成功页的查看详情按钮</li><li> **4** :合同签署页面更多操作的查看合同基本信息按钮</li><li> **5** :合同签署页面更多操作的撤销按钮</li></ul><p>注: <code>字段为数组, 可以传值隐藏多个按钮</code></p>
5229
5134
  */
5230
5135
  Hides?: Array<number | bigint>;
5231
5136
  /**
5232
- * 参与方角色ID,用于生成动态签署人链接完成领取。
5233
-
5234
- 注:`使用此参数需要与flow_ids数量一致并且一一对应, 表示在对应同序号的流程中的参与角色ID`,
5137
+ * <p>参与方角色ID,用于生成动态签署人链接完成领取。</p><p>注:<code>使用此参数需要与flow_ids数量一致并且一一对应, 表示在对应同序号的流程中的参与角色ID</code>,</p>
5235
5138
  */
5236
5139
  RecipientIds?: Array<string>;
5237
5140
  /**
5238
- * 合同组相关信息,指定合同组子合同和签署方的信息,用于补充动态签署人。
5141
+ * <p>合同组相关信息,指定合同组子合同和签署方的信息,用于补充动态签署人。</p>
5239
5142
  */
5240
5143
  FlowGroupUrlInfo?: FlowGroupUrlInfo;
5241
5144
  /**
5242
- * <font color="red">仅公众号 H5 跳转电子签小程序时</font>,如需签署完成的“返回应用”功能,在获取签署链接接口的 UrlUseEnv 参数需设置为 **WeChatOfficialAccounts**,小程序签署成功的结果页面中才会出现“返回应用”按钮。在用户点击“返回应用”按钮之后,会返回到公众号 H5。
5243
-
5244
- 参考 [公众号 H5 跳转电子签小程序](https://qian.tencent.com/developers/company/openwxminiprogram/#23-%E5%85%AC%E4%BC%97%E5%8F%B7-h5-%E4%B8%AD%E8%B7%B3%E8%BD%AC)。
5145
+ * <p><font color="red">仅公众号 H5 跳转电子签小程序时</font>,如需签署完成的“返回应用”功能,在获取签署链接接口的 UrlUseEnv 参数需设置为 <strong>WeChatOfficialAccounts</strong>,小程序签署成功的结果页面中才会出现“返回应用”按钮。在用户点击“返回应用”按钮之后,会返回到公众号 H5。 </p><p>参考 <a href="https://qian.tencent.com/developers/company/openwxminiprogram/#23-%E5%85%AC%E4%BC%97%E5%8F%B7-h5-%E4%B8%AD%E8%B7%B3%E8%BD%AC">公众号 H5 跳转电子签小程序</a>。</p>
5245
5146
  */
5246
5147
  UrlUseEnv?: string;
5148
+ /**
5149
+ * <p>是否允许此链接中签署方批量确认已读文件。 <ul><li>false (默认): 不允许批量确认已读文件。</li> <li>true : 允许批量确认已读文件。</li></ul> 注:<code>1. 此功能为白名单功能,使用前请联系对应客户经理进行开通。2. 使用此功能时,FlowIds参数必传。3. 对于企业签署方,如果对印章/签名控件有限制要求,需要保证所有印章/签名签署控件限制要求(印章id或印章/签名类型限制)一致,否则无法使用此功能。</code></p><p>默认值:false</p>
5150
+ */
5151
+ CanSkipReadFlow?: boolean;
5247
5152
  }
5248
5153
  /**
5249
5154
  * 企业认证信息参数, 需要保证这些参数跟营业执照中的信息一致。
@@ -7045,11 +6950,11 @@ export interface ChannelOrganizationInfo {
7045
6950
  */
7046
6951
  export interface CreateSignUrlsResponse {
7047
6952
  /**
7048
- * 生成的签署参与者的签署链接信息数组。
6953
+ * <p>生成的签署参与者的签署链接信息数组。</p>
7049
6954
  */
7050
6955
  SignUrlInfos?: Array<SignUrlInfo>;
7051
6956
  /**
7052
- * 生成失败时的错误信息,成功返回”“,顺序和出参SignUrlInfos保持一致
6957
+ * <p>生成失败时的错误信息,成功返回”“,顺序和出参SignUrlInfos保持一致</p>
7053
6958
  */
7054
6959
  ErrorMessages?: Array<string>;
7055
6960
  /**