tencentcloud-sdk-nodejs 4.1.214 → 4.1.216

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.
Files changed (71) hide show
  1. package/es/common/sdk_version.js +1 -1
  2. package/es/services/cfw/v20190904/cfw_client.js +5 -2
  3. package/es/services/dts/v20211206/dts_client.js +10 -4
  4. package/es/services/emr/v20190103/emr_client.js +14 -8
  5. package/es/services/live/v20180801/live_client.js +9 -0
  6. package/es/services/mps/v20190612/mps_client.js +6 -0
  7. package/es/services/tcbr/v20220217/tcbr_client.js +8 -2
  8. package/es/services/tdmysql/v20211122/tdmysql_client.js +5 -2
  9. package/es/services/trtc/v20190722/trtc_client.js +12 -6
  10. package/es/services/vclm/v20240523/vclm_client.js +62 -8
  11. package/es/services/vpc/v20170312/vpc_client.js +3 -0
  12. package/package.json +1 -1
  13. package/tencentcloud/common/sdk_version.d.ts +1 -1
  14. package/tencentcloud/common/sdk_version.js +1 -1
  15. package/tencentcloud/services/ags/v20250920/ags_client.d.ts +1 -1
  16. package/tencentcloud/services/ags/v20250920/ags_models.d.ts +18 -4
  17. package/tencentcloud/services/aiart/v20221229/aiart_models.d.ts +4 -4
  18. package/tencentcloud/services/cdwdoris/v20211228/cdwdoris_models.d.ts +39 -4
  19. package/tencentcloud/services/cfw/v20190904/cfw_client.d.ts +7 -3
  20. package/tencentcloud/services/cfw/v20190904/cfw_client.js +9 -3
  21. package/tencentcloud/services/cfw/v20190904/cfw_models.d.ts +235 -5
  22. package/tencentcloud/services/cls/v20201016/cls_client.d.ts +1 -1
  23. package/tencentcloud/services/cls/v20201016/cls_client.js +1 -1
  24. package/tencentcloud/services/cls/v20201016/cls_models.d.ts +2 -2
  25. package/tencentcloud/services/config/v20220802/config_models.d.ts +7 -3
  26. package/tencentcloud/services/csip/v20221121/csip_models.d.ts +4 -0
  27. package/tencentcloud/services/dts/v20211206/dts_client.d.ts +13 -5
  28. package/tencentcloud/services/dts/v20211206/dts_client.js +18 -6
  29. package/tencentcloud/services/dts/v20211206/dts_models.d.ts +228 -79
  30. package/tencentcloud/services/emr/v20190103/emr_client.d.ts +19 -11
  31. package/tencentcloud/services/emr/v20190103/emr_client.js +26 -14
  32. package/tencentcloud/services/emr/v20190103/emr_models.d.ts +145 -10
  33. package/tencentcloud/services/ess/v20201111/ess_client.d.ts +2 -2
  34. package/tencentcloud/services/ess/v20201111/ess_client.js +2 -2
  35. package/tencentcloud/services/ess/v20201111/ess_models.d.ts +85 -312
  36. package/tencentcloud/services/essbasic/v20210526/essbasic_client.d.ts +2 -2
  37. package/tencentcloud/services/essbasic/v20210526/essbasic_client.js +2 -2
  38. package/tencentcloud/services/essbasic/v20210526/essbasic_models.d.ts +69 -236
  39. package/tencentcloud/services/faceid/v20180301/faceid_models.d.ts +5 -12
  40. package/tencentcloud/services/goosefs/v20220519/goosefs_models.d.ts +3 -3
  41. package/tencentcloud/services/iss/v20230517/iss_models.d.ts +53 -33
  42. package/tencentcloud/services/live/v20180801/live_client.d.ts +13 -1
  43. package/tencentcloud/services/live/v20180801/live_client.js +18 -0
  44. package/tencentcloud/services/live/v20180801/live_models.d.ts +70 -19
  45. package/tencentcloud/services/mongodb/v20190725/mongodb_models.d.ts +28 -60
  46. package/tencentcloud/services/mps/v20190612/mps_client.d.ts +10 -2
  47. package/tencentcloud/services/mps/v20190612/mps_client.js +13 -1
  48. package/tencentcloud/services/mps/v20190612/mps_models.d.ts +141 -444
  49. package/tencentcloud/services/mrs/v20200910/mrs_models.d.ts +53 -31
  50. package/tencentcloud/services/nlp/v20190408/nlp_client.d.ts +9 -3
  51. package/tencentcloud/services/nlp/v20190408/nlp_client.js +9 -3
  52. package/tencentcloud/services/oceanus/v20190422/oceanus_models.d.ts +78 -65
  53. package/tencentcloud/services/tcb/v20180608/tcb_models.d.ts +46 -41
  54. package/tencentcloud/services/tcbr/v20220217/tcbr_client.d.ts +11 -3
  55. package/tencentcloud/services/tcbr/v20220217/tcbr_client.js +15 -3
  56. package/tencentcloud/services/tcbr/v20220217/tcbr_models.d.ts +83 -27
  57. package/tencentcloud/services/tdmq/v20200217/tdmq_models.d.ts +35 -25
  58. package/tencentcloud/services/tdmysql/v20211122/tdmysql_client.d.ts +7 -3
  59. package/tencentcloud/services/tdmysql/v20211122/tdmysql_client.js +9 -3
  60. package/tencentcloud/services/tdmysql/v20211122/tdmysql_models.d.ts +142 -28
  61. package/tencentcloud/services/teo/v20220901/teo_models.d.ts +1 -53
  62. package/tencentcloud/services/trtc/v20190722/trtc_client.d.ts +15 -7
  63. package/tencentcloud/services/trtc/v20190722/trtc_client.js +21 -9
  64. package/tencentcloud/services/trtc/v20190722/trtc_models.d.ts +216 -75
  65. package/tencentcloud/services/vclm/v20240523/vclm_client.d.ts +80 -8
  66. package/tencentcloud/services/vclm/v20240523/vclm_client.js +119 -11
  67. package/tencentcloud/services/vclm/v20240523/vclm_models.d.ts +1839 -542
  68. package/tencentcloud/services/vod/v20180717/vod_models.d.ts +8 -0
  69. package/tencentcloud/services/vpc/v20170312/vpc_client.d.ts +5 -1
  70. package/tencentcloud/services/vpc/v20170312/vpc_client.js +6 -0
  71. package/tencentcloud/services/vpc/v20170312/vpc_models.d.ts +32 -2
@@ -690,7 +690,7 @@ Agent参数中的OpenId 必须为审批者的openId,且链接必须由审批
690
690
  * 该接口用于发起合同后,生成个人/企业用户的批量待办链接。
691
691
  **注意:**
692
692
  1. 该接口可生成签署人的批量、合同组签署/查看链接 。
693
- 2. 该签署链接**有效期为30分钟**,过期后将失效,如需签署可重新创建批量签署链接 。
693
+ 2. 该签署链接**默认有效期为30分钟**,过期后将失效,如需签署可重新创建批量签署链接 。
694
694
  4. 该接口返回的签署链接适用于APP集成的场景,支持APP打开或浏览器直接打开,**不支持微信小程序嵌入**。
695
695
  跳转到小程序的实现,参考微信官方文档(分为<a href="https://developers.weixin.qq.com/miniprogram/dev/api/navigate/wx.navigateToMiniProgram.html">全屏</a>、<a href="https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/openEmbeddedMiniProgram.html">半屏</a>两种方式),如何配置也可以请参考: <a href="https://qian.tencent.com/developers/company/openwxminiprogram">跳转电子签小程序配置</a>。
696
696
  6. 因h5涉及人脸身份认证能力基于慧眼人脸核身,对Android和iOS系统均有一定要求, 因此<font color='red'>App嵌入H5签署合同需要按照慧眼提供的<a href="https://cloud.tencent.com/document/product/1007/61076">慧眼人脸核身兼容性文档</a>做兼容性适配</font>。
@@ -873,7 +873,7 @@ httpProfile.setEndpoint("file.test.ess.tencent.cn");
873
873
 
874
874
 
875
875
  ⚠️ **注意**
876
- 1. 该签署**链接有效期为30分钟**,过期后将失效,如需签署可重新创建签署链接 。
876
+ 1. 该签署链接**默认有效期为30分钟**,过期后将失效,如需签署可重新创建签署链接 。
877
877
  2. 该接口返回的签署链接适用于APP集成的场景,支持在支付宝、APP打开、浏览器直接打开,**不支持微信小程序嵌入**。配置方式请参考:<a href="https://qian.tencent.com/developers/company/openqianh5/">跳转电子签H5</a>。
878
878
  如需跳转到小程序的实现,参考微信官方文档(分为<a href="https://developers.weixin.qq.com/miniprogram/dev/api/navigate/wx.navigateToMiniProgram.html">全屏</a>、<a href="https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/openEmbeddedMiniProgram.html">半屏</a>两种方式),如何配置也可以请参考: <a href="https://qian.tencent.com/developers/company/openwxminiprogram">跳转电子签小程序配置</a>。
879
879
  3. 因h5涉及人脸身份认证能力基于慧眼人脸核身,对Android和iOS系统均有一定要求, 因此<font color='red'>App嵌入H5签署合同需要按照慧眼提供的<a href="https://cloud.tencent.com/document/product/1007/61076">慧眼人脸核身兼容性文档</a>做兼容性适配</font>。
@@ -810,7 +810,7 @@ Agent参数中的OpenId 必须为审批者的openId,且链接必须由审批
810
810
  * 该接口用于发起合同后,生成个人/企业用户的批量待办链接。
811
811
  **注意:**
812
812
  1. 该接口可生成签署人的批量、合同组签署/查看链接 。
813
- 2. 该签署链接**有效期为30分钟**,过期后将失效,如需签署可重新创建批量签署链接 。
813
+ 2. 该签署链接**默认有效期为30分钟**,过期后将失效,如需签署可重新创建批量签署链接 。
814
814
  4. 该接口返回的签署链接适用于APP集成的场景,支持APP打开或浏览器直接打开,**不支持微信小程序嵌入**。
815
815
  跳转到小程序的实现,参考微信官方文档(分为<a href="https://developers.weixin.qq.com/miniprogram/dev/api/navigate/wx.navigateToMiniProgram.html">全屏</a>、<a href="https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/openEmbeddedMiniProgram.html">半屏</a>两种方式),如何配置也可以请参考: <a href="https://qian.tencent.com/developers/company/openwxminiprogram">跳转电子签小程序配置</a>。
816
816
  6. 因h5涉及人脸身份认证能力基于慧眼人脸核身,对Android和iOS系统均有一定要求, 因此<font color='red'>App嵌入H5签署合同需要按照慧眼提供的<a href="https://cloud.tencent.com/document/product/1007/61076">慧眼人脸核身兼容性文档</a>做兼容性适配</font>。
@@ -1017,7 +1017,7 @@ httpProfile.setEndpoint("file.test.ess.tencent.cn");
1017
1017
 
1018
1018
 
1019
1019
  ⚠️ **注意**
1020
- 1. 该签署**链接有效期为30分钟**,过期后将失效,如需签署可重新创建签署链接 。
1020
+ 1. 该签署链接**默认有效期为30分钟**,过期后将失效,如需签署可重新创建签署链接 。
1021
1021
  2. 该接口返回的签署链接适用于APP集成的场景,支持在支付宝、APP打开、浏览器直接打开,**不支持微信小程序嵌入**。配置方式请参考:<a href="https://qian.tencent.com/developers/company/openqianh5/">跳转电子签H5</a>。
1022
1022
  如需跳转到小程序的实现,参考微信官方文档(分为<a href="https://developers.weixin.qq.com/miniprogram/dev/api/navigate/wx.navigateToMiniProgram.html">全屏</a>、<a href="https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/openEmbeddedMiniProgram.html">半屏</a>两种方式),如何配置也可以请参考: <a href="https://qian.tencent.com/developers/company/openwxminiprogram">跳转电子签小程序配置</a>。
1023
1023
  3. 因h5涉及人脸身份认证能力基于慧眼人脸核身,对Android和iOS系统均有一定要求, 因此<font color='red'>App嵌入H5签署合同需要按照慧眼提供的<a href="https://cloud.tencent.com/document/product/1007/61076">慧眼人脸核身兼容性文档</a>做兼容性适配</font>。
@@ -724,7 +724,7 @@ export interface RemindFlowRecords {
724
724
  */
725
725
  export interface ChannelCreateFlowSignUrlResponse {
726
726
  /**
727
- * 签署人签署链接信息
727
+ * <p>签署人签署链接信息</p>
728
728
  */
729
729
  FlowApproverUrlInfos?: Array<FlowApproverUrlInfo>;
730
730
  /**
@@ -1516,67 +1516,43 @@ export interface ChannelCreatePrepareFlowRequest {
1516
1516
  */
1517
1517
  export interface ChannelCreateFlowSignUrlRequest {
1518
1518
  /**
1519
- * 关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
1520
-
1521
- 此接口下面信息必填。
1522
- <ul>
1523
- <li>渠道应用标识: Agent.AppId</li>
1524
- <li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
1525
- <li>第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId</li>
1526
- </ul>
1527
- 第三方平台子客企业和员工必须已经经过实名认证
1519
+ * <p>关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。</p><p>此接口下面信息必填。</p><ul><li>渠道应用标识: Agent.AppId</li><li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li><li>第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId</li></ul>第三方平台子客企业和员工必须已经经过实名认证
1528
1520
  */
1529
1521
  Agent: Agent;
1530
1522
  /**
1531
- * 合同流程ID,为32位字符串。
1532
- 建议开发者妥善保存此流程ID,以便于顺利进行后续操作。
1533
- 可登录腾讯电子签控制台,在 "合同"->"合同中心" 中查看某个合同的FlowId(在页面中展示为合同ID)。
1523
+ * <p>合同流程ID,为32位字符串。<br>建议开发者妥善保存此流程ID,以便于顺利进行后续操作。<br>可登录腾讯电子签控制台,在 &quot;合同&quot;-&gt;&quot;合同中心&quot; 中查看某个合同的FlowId(在页面中展示为合同ID)。</p>
1534
1524
  */
1535
1525
  FlowId: string;
1536
1526
  /**
1537
- * 流程签署人列表,其中结构体的ApproverType必传。
1538
- 若为个人签署方或saas企业签署方,则Name,Mobile必传。OrganizationName 传对应企业名称。
1539
- 若为子客企业签署方则需传OpenId、OrganizationOpenId、OrganizationName, 其他可不传。(如果对应OrganizationOpenId 子客已经认证激活了,则可以省去OrganizationName)
1540
-
1541
- 此结构体和发起接口参与方结构体复用,除了上述参数外,可传递的参数有:
1542
- 1. RecipientId: 发起合同会返回,可以直接用于指定需要生成链接的签署方。
1543
- 2. ApproverSignTypes: 指定签署方签署时候的认证方式,仅此链接生效。
1544
- 3. SignTypeSelector: 可以指定签署方签署合同的认证校验方式的选择模式。
1545
- 4. Intention: 指定H5签署视频核身的意图配置,仅视频签署需要使用。
1546
-
1547
- 注:
1548
- `1. 签署人只能有手写签名、时间类型、印章类型、签批类型的签署控件和内容填写控件,其他类型的签署控件暂时未支持。`
1549
- `2. 生成发起方预览链接时,该字段(FlowApproverInfos)传空或者不传`
1527
+ * <p>流程签署人列表,其中结构体的ApproverType必传。<br>若为个人签署方或saas企业签署方,则Name,Mobile必传。OrganizationName 传对应企业名称。<br>若为子客企业签署方则需传OpenId、OrganizationOpenId、OrganizationName, 其他可不传。(如果对应OrganizationOpenId 子客已经认证激活了,则可以省去OrganizationName)</p><p>此结构体和发起接口参与方结构体复用,除了上述参数外,可传递的参数有:</p><ol><li>RecipientId: 发起合同会返回,可以直接用于指定需要生成链接的签署方。</li><li>ApproverSignTypes: 指定签署方签署时候的认证方式,仅此链接生效。</li><li>SignTypeSelector: 可以指定签署方签署合同的认证校验方式的选择模式。</li><li>Intention: 指定H5签署视频核身的意图配置,仅视频签署需要使用。</li></ol><p>注:<br><code>1. 签署人只能有手写签名、时间类型、印章类型、签批类型的签署控件和内容填写控件,其他类型的签署控件暂时未支持。</code><br><code>2. 生成发起方预览链接时,该字段(FlowApproverInfos)传空或者不传</code></p>
1550
1528
  */
1551
1529
  FlowApproverInfos?: Array<FlowApproverInfo>;
1552
1530
  /**
1553
- * 用于指定进入视频签署的限制次数,次数取值范围:1 - 10,不设置则默认为5次,仅视频签署时生效。
1531
+ * <p>用于指定进入视频签署的限制次数,次数取值范围:1 - 10,不设置则默认为5次,仅视频签署时生效。</p>
1554
1532
  */
1555
1533
  VideoVerifyTimesLimit?: number;
1556
1534
  /**
1557
- * 用户信息,暂未开放
1535
+ * <p>用户信息,暂未开放</p>
1558
1536
  * @deprecated
1559
1537
  */
1560
1538
  Operator?: UserInfo;
1561
1539
  /**
1562
- * 机构信息,暂未开放
1540
+ * <p>机构信息,暂未开放</p>
1563
1541
  * @deprecated
1564
1542
  */
1565
1543
  Organization?: OrganizationInfo;
1566
1544
  /**
1567
- * 签署完之后的H5页面的跳转链接,最大长度1000个字符。链接类型请参考 <a href="https://qian.tencent.com/developers/company/openqianh5" target="_blank">跳转电子签H5</a>
1568
-
1545
+ * <p>签署完之后的H5页面的跳转链接,最大长度1000个字符。链接类型请参考 <a href="https://qian.tencent.com/developers/company/openqianh5" target="_blank">跳转电子签H5</a></p>
1569
1546
  */
1570
1547
  JumpUrl?: string;
1571
1548
  /**
1572
- * 链接类型,支持指定以下类型
1573
- <ul><li>0 : 签署链接 (默认值)</li>
1574
- <li>1 : 预览链接</li></ul>
1575
- 注:
1576
- `1. 当指定链接类型为1时,链接为预览链接,打开链接无法签署仅支持预览以及查看当前合同状态。`
1577
- `2. 如需生成发起方预览链接,则签署方信息传空,即FlowApproverInfos传空或者不传。`
1549
+ * <p>链接类型,支持指定以下类型</p><ul><li>0 : 签署链接 (默认值)</li><li>1 : 预览链接</li></ul>注:<code>1. 当指定链接类型为1时,链接为预览链接,打开链接无法签署仅支持预览以及查看当前合同状态。</code><code>2. 如需生成发起方预览链接,则签署方信息传空,即FlowApproverInfos传空或者不传。</code>
1578
1550
  */
1579
1551
  UrlType?: number;
1552
+ /**
1553
+ * <p>链接的有效时间,单位为秒。取值范围为 30分钟(1800)-90天(7776000)。如果不传,默认有效期为30分钟。</p><p>注意:</p><ol><li><code>出于安全性考虑,若有效期大于30分钟,同设备24小时内点击链接查看合同需要进行手机验证码校验。</code></li><li><code>若生成合同发起方预览链接,有效期大于30分钟,则需要进行验证码校验的手机号为发起方账号绑定的手机号。</code></li></ol>
1554
+ */
1555
+ ExpiredOn?: number;
1580
1556
  }
1581
1557
  /**
1582
1558
  * ChannelCreateSealPolicy返回参数结构体
@@ -4725,101 +4701,69 @@ export interface ResourceUrlInfo {
4725
4701
  */
4726
4702
  export interface ChannelCreateBatchQuickSignUrlRequest {
4727
4703
  /**
4728
- * 批量签署的流程签署人,其中姓名(ApproverName)、参与人类型(ApproverType)必传,手机号(ApproverMobile)和证件信息(ApproverIdCardType、ApproverIdCardNumber)可任选一种或全部传入。
4729
- <ul>
4730
- <li>若为个人参与方:ApproverType:"PERSON"</li>
4731
- <li>若为企业参与方:ApproverType:"ORGANIZATION"。同时若签署方为saas企业员工, OrganizationName 参数需传入参与方企业名称。若签署方为渠道子客企业员工,除了 OrganizationName 还需要传 OpenId、OrganizationOpenId。(如果OrganizationOpenId对应子客企业已经认证激活,则可以省略OrganizationName参数)</li>
4732
- </ul>
4733
-
4734
- 注:
4735
- `1. 暂不支持签署人拖动签署控件功能,以及签批控件。`
4736
- `2. 当需要通过短信验证码签署时,手机号ApproverMobile需要与发起合同时填写的用户手机号一致。`
4704
+ * <p>批量签署的流程签署人,其中姓名(ApproverName)、参与人类型(ApproverType)必传,手机号(ApproverMobile)和证件信息(ApproverIdCardType、ApproverIdCardNumber)可任选一种或全部传入。</p><ul><li>若为个人参与方:ApproverType:"PERSON"</li><li>若为企业参与方:ApproverType:"ORGANIZATION"。同时若签署方为saas企业员工, OrganizationName 参数需传入参与方企业名称。若签署方为渠道子客企业员工,除了 OrganizationName 还需要传 OpenId、OrganizationOpenId。(如果OrganizationOpenId对应子客企业已经认证激活,则可以省略OrganizationName参数)</li></ul><p>注:<br><code>1. 暂不支持签署人拖动签署控件功能,以及签批控件。</code><br><code>2. 当需要通过短信验证码签署时,手机号ApproverMobile需要与发起合同时填写的用户手机号一致。</code></p>
4737
4705
  */
4738
4706
  FlowApproverInfo: FlowApproverInfo;
4739
4707
  /**
4740
- * 关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
4708
+ * <p>关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。</p>
4741
4709
  */
4742
4710
  Agent?: Agent;
4743
4711
  /**
4744
- * 批量签署的合同流程ID数组。
4745
- 注: `在调用此接口时,请确保合同流程均为本企业发起,且合同数量不超过100个。`
4712
+ * <p>批量签署的合同流程ID数组。<br>注: <code>在调用此接口时,请确保合同流程均为本企业发起,且合同数量不超过100个。</code></p>
4746
4713
  */
4747
4714
  FlowIds?: Array<string>;
4748
4715
  /**
4749
- * 合同组编号
4750
- 注:`该参数和合同流程ID数组必须二选一`
4716
+ * <p>合同组编号<br>注:<code>该参数和合同流程ID数组必须二选一</code></p>
4751
4717
  */
4752
4718
  FlowGroupId?: string;
4753
4719
  /**
4754
- * 签署完之后的H5页面的跳转链接,此链接及支持http://和https://,最大长度1000个字符。(建议https协议)
4720
+ * <p>签署完之后的H5页面的跳转链接,此链接及支持http://和https://,最大长度1000个字符。(建议https协议)</p>
4755
4721
  */
4756
4722
  JumpUrl?: string;
4757
4723
  /**
4758
- * 指定批量签署合同的签名类型,可传递以下值:
4759
- <ul><li>**0**:手写签名(默认)</li>
4760
- <li>**1**:OCR楷体</li>
4761
- <li>**2**:姓名印章</li>
4762
- <li>**3**:图片印章</li>
4763
- <li>**4**:系统签名</li>
4764
- <li>**5**:长效手写签名(包含手写签名)</li></ul>
4765
- 注:
4766
- <ul><li>默认情况下,签名类型为手写签名</li>
4767
- <li>您可以传递多种值,表示可用多种签名类型。</li>
4768
- <li>该参数会覆盖您合同中的签名类型,若您在发起合同时限定了签名类型(赋值签名类型给ComponentTypeLimit),请将这些签名类型赋予此参数</li>
4769
- <li>若签署方为个人,签名类型“5:长效手写签名”不可用,签名方式将以合同中为准。</li>
4770
- </ul>
4724
+ * <p>指定批量签署合同的签名类型,可传递以下值:</p><ul><li>**0**:手写签名(默认)</li><li>**1**:OCR楷体</li><li>**2**:姓名印章</li><li>**3**:图片印章</li><li>**4**:系统签名</li><li>**5**:长效手写签名(包含手写签名)</li></ul>注:<ul><li>默认情况下,签名类型为手写签名</li><li>您可以传递多种值,表示可用多种签名类型。</li><li>该参数会覆盖您合同中的签名类型,若您在发起合同时限定了签名类型(赋值签名类型给ComponentTypeLimit),请将这些签名类型赋予此参数</li><li>若签署方为个人,签名类型“5:长效手写签名”不可用,签名方式将以合同中为准。</li></ul>
4771
4725
  */
4772
4726
  SignatureTypes?: Array<number | bigint>;
4773
4727
  /**
4774
- * 指定批量签署合同的认证校验方式,可传递以下值:
4775
- <ul><li>**1**:人脸认证(默认),需进行人脸识别成功后才能签署合同</li>
4776
- <li>**2**:密码认证(默认),需输入与用户在腾讯电子签设置的密码一致才能校验成功进行合同签署</li>
4777
- <li>**3**:运营商三要素,需到运营商处比对手机号实名信息(名字、手机号、证件号)校验一致才能成功进行合同签署。</li></ul>
4778
- 注:
4779
- <ul><li>默认情况下,认证校验方式为人脸和密码认证</li>
4780
- <li>您可以传递多种值,表示可用多种认证校验方式。</li></ul>
4728
+ * <p>指定批量签署合同的认证校验方式,可传递以下值:</p><ul><li>**1**:人脸认证(默认),需进行人脸识别成功后才能签署合同</li><li>**2**:密码认证(默认),需输入与用户在腾讯电子签设置的密码一致才能校验成功进行合同签署</li><li>**3**:运营商三要素,需到运营商处比对手机号实名信息(名字、手机号、证件号)校验一致才能成功进行合同签署。</li></ul>注:<ul><li>默认情况下,认证校验方式为人脸和密码认证</li><li>您可以传递多种值,表示可用多种认证校验方式。</li></ul>
4781
4729
  */
4782
4730
  ApproverSignTypes?: Array<number | bigint>;
4783
4731
  /**
4784
- * 生成H5签署链接时,您可以指定签署方签署合同的认证校验方式的选择模式,可传递一下值:
4785
- <ul><li>**0**:签署方自行选择,签署方可以从预先指定的认证方式中自由选择;</li>
4786
- <li>**1**:自动按顺序首位推荐,签署方无需选择,系统会优先推荐使用第一种认证方式。</li></ul>
4787
- 注:
4788
- `不指定该值时,默认为签署方自行选择。`
4732
+ * <p>生成H5签署链接时,您可以指定签署方签署合同的认证校验方式的选择模式,可传递一下值:</p><ul><li>**0**:签署方自行选择,签署方可以从预先指定的认证方式中自由选择;</li><li>**1**:自动按顺序首位推荐,签署方无需选择,系统会优先推荐使用第一种认证方式。</li></ul>注:<code>不指定该值时,默认为签署方自行选择。</code>
4789
4733
  */
4790
4734
  SignTypeSelector?: number;
4791
4735
  /**
4792
- * 批量签署合同相关信息,指定合同和签署方的信息,用于补充动态签署人。
4793
-
4794
- 注: `若签署方为企业员工,暂不支持通过H5端进行动态签署人的补充`
4736
+ * <p>批量签署合同相关信息,指定合同和签署方的信息,用于补充动态签署人。 </p><p>注: <code>若签署方为企业员工,暂不支持通过H5端进行动态签署人的补充</code></p>
4795
4737
  */
4796
4738
  FlowBatchUrlInfo?: FlowBatchUrlInfo;
4797
4739
  /**
4798
- * <b>只有在生成H5签署链接的情形下</b>( 如调用<a href="https://qian.tencent.com/developers/partnerApis/operateFlows/ChannelCreateFlowSignUrl" target="_blank">获取H5签署链接</a>、<a href="https://qian.tencent.com/developers/partnerApis/operateFlows/ChannelCreateBatchQuickSignUrl" target="_blank">获取H5批量签署链接</a>等接口),该配置才会生效。 您可以指定H5签署视频核身的意图配置,选择问答模式或点头模式的语音文本。 注意: 1. 视频认证为<b>白名单功能,使用前请联系对接的客户经理沟通</b>。 2. 使用视频认证时,<b>生成H5签署链接的时候必须将签署认证方式指定为人脸</b>(即ApproverSignTypes设置成人脸签署)。 3. 签署完成后,可以通过<a href="https://qian.tencent.com/developers/partnerApis/flows/ChannelDescribeSignFaceVideo" target="_blank">查询签署认证人脸视频</a>获取到当时的视频。
4740
+ * <p><b>只有在生成H5签署链接的情形下</b>( 如调用<a href="https://qian.tencent.com/developers/partnerApis/operateFlows/ChannelCreateFlowSignUrl" target="_blank">获取H5签署链接</a>、<a href="https://qian.tencent.com/developers/partnerApis/operateFlows/ChannelCreateBatchQuickSignUrl" target="_blank">获取H5批量签署链接</a>等接口),该配置才会生效。 您可以指定H5签署视频核身的意图配置,选择问答模式或点头模式的语音文本。 注意: 1. 视频认证为<b>白名单功能,使用前请联系对接的客户经理沟通</b>。 2. 使用视频认证时,<b>生成H5签署链接的时候必须将签署认证方式指定为人脸</b>(即ApproverSignTypes设置成人脸签署)。 3. 签署完成后,可以通过<a href="https://qian.tencent.com/developers/partnerApis/flows/ChannelDescribeSignFaceVideo" target="_blank">查询签署认证人脸视频</a>获取到当时的视频。</p>
4799
4741
  */
4800
4742
  Intention?: Intention;
4801
4743
  /**
4802
- * 用于指定进入视频签署的限制次数,次数取值范围:1 - 10,不设置则默认为5次,仅视频签署时生效。
4744
+ * <p>用于指定进入视频签署的限制次数,次数取值范围:1 - 10,不设置则默认为5次,仅视频签署时生效。</p>
4803
4745
  */
4804
4746
  VideoVerifyTimesLimit?: number;
4805
4747
  /**
4806
- * 缓存签署人信息。在H5签署链接动态领取场景,首次填写后,选择缓存签署人信息,在下次签署人点击领取链接时,会自动将个人信息(姓名、身份证号、手机号)填入,否则需要每次手动填写。
4807
-
4808
- 注: `若参与方为企业员工时,暂不支持对参与方信息进行缓存`
4748
+ * <p>缓存签署人信息。在H5签署链接动态领取场景,首次填写后,选择缓存签署人信息,在下次签署人点击领取链接时,会自动将个人信息(姓名、身份证号、手机号)填入,否则需要每次手动填写。</p><p>注: <code>若参与方为企业员工时,暂不支持对参与方信息进行缓存</code></p>
4809
4749
  */
4810
4750
  CacheApproverInfo?: boolean;
4811
4751
  /**
4812
- * 是否允许此链接中签署方批量拒签。 <ul><li>false (默认): 不允许批量拒签</li> <li>true : 允许批量拒签。</li></ul>注:`当前合同组不支持批量拒签功能。请对合同组中的每个子合同逐一执行拒签操作,以达到拒签整个合同组的效果。`
4752
+ * <p>是否允许此链接中签署方批量拒签。 <ul><li>false (默认): 不允许批量拒签</li> <li>true : 允许批量拒签。</li></ul>注:<code>当前合同组不支持批量拒签功能。请对合同组中的每个子合同逐一执行拒签操作,以达到拒签整个合同组的效果。</code></p>
4813
4753
  */
4814
4754
  CanBatchReject?: boolean;
4815
4755
  /**
4816
- * 预设的动态签署方的补充信息,仅匹配对应信息的签署方才能领取合同。暂时仅对个人参与方生效。
4756
+ * <p>预设的动态签署方的补充信息,仅匹配对应信息的签署方才能领取合同。暂时仅对个人参与方生效。</p>
4817
4757
  */
4818
4758
  PresetApproverInfo?: PresetApproverInfo;
4819
4759
  /**
4820
- * 是否允许此链接中签署方批量确认已读文件。 <ul><li>false (默认): 不允许批量确认已读文件。</li> <li>true : 允许批量确认已读文件。</li></ul>注:`1. 此功能为白名单功能,使用前请联系对应客户经理进行开通。2. 若批量签署的合同中第一份待签署合同所选择的印章或者签名无法完全覆盖后续合同要求,或者当前签署人没有指定印章使用权限,则无法使用此功能,会自动退化为逐份确认。`
4760
+ * <p>是否允许此链接中签署方批量确认已读文件。 <ul><li>false (默认): 不允许批量确认已读文件。</li> <li>true : 允许批量确认已读文件。</li></ul>注:<code>1. 此功能为白名单功能,使用前请联系对应客户经理进行开通。2. 若批量签署的合同中第一份待签署合同所选择的印章或者签名无法完全覆盖后续合同要求,或者当前签署人没有指定印章使用权限,则无法使用此功能,会自动退化为逐份确认。</code></p>
4821
4761
  */
4822
4762
  CanSkipReadFlow?: boolean;
4763
+ /**
4764
+ * <p>链接的有效时间,单位为秒。取值范围为 30分钟(1800)-90天(7776000)。如果不传,默认有效期为30分钟。</p><p>注意:</p><ol><li><code>出于安全性考虑,若有效期大于30分钟,同设备24小时内点击链接查看合同需要进行手机验证码校验。</code></li><li><code>动态签署方链接暂不支持修改过期时间。</code></li></ol>
4765
+ */
4766
+ ExpiredOn?: number;
4823
4767
  }
4824
4768
  /**
4825
4769
  * ChannelCreateBoundFlows请求参数结构体
@@ -5383,237 +5327,122 @@ RecipientId参数获取:
5383
5327
  */
5384
5328
  export interface FlowApproverInfo {
5385
5329
  /**
5386
- * 签署方经办人的姓名。
5387
- 经办人的姓名将用于身份认证和电子签名,请确保填写的姓名为签署方的真实姓名,而非昵称等代名。
5330
+ * <p>签署方经办人的姓名。<br>经办人的姓名将用于身份认证和电子签名,请确保填写的姓名为签署方的真实姓名,而非昵称等代名。</p>
5388
5331
  */
5389
5332
  Name?: string;
5390
5333
  /**
5391
- * 签署方经办人的证件类型,支持以下类型
5392
- <ul><li>ID_CARD : 中国大陆居民身份证 (默认值)</li>
5393
- <li>HONGKONG_AND_MACAO : 中国港澳居民来往内地通行证</li>
5394
- <li>HONGKONG_MACAO_AND_TAIWAN : 中国港澳台居民居住证(格式同中国大陆居民身份证)</li>
5395
- <li>OTHER_CARD_TYPE : 其他证件</li></ul>
5396
-
5397
- 注: `其他证件类型为白名单功能,使用前请联系对接的客户经理沟通。`
5334
+ * <p>签署方经办人的证件类型,支持以下类型</p><ul><li>ID_CARD : 中国大陆居民身份证 (默认值)</li><li>HONGKONG_AND_MACAO : 中国港澳居民来往内地通行证</li><li>HONGKONG_MACAO_AND_TAIWAN : 中国港澳台居民居住证(格式同中国大陆居民身份证)</li><li>OTHER_CARD_TYPE : 其他证件</li></ul><p>注: <code>其他证件类型为白名单功能,使用前请联系对接的客户经理沟通。</code></p>
5398
5335
  */
5399
5336
  IdCardType?: string;
5400
5337
  /**
5401
- * 签署方经办人的证件号码,应符合以下规则
5402
- <ul><li>中国大陆居民身份证号码应为18位字符串,由数字和大写字母X组成(如存在X,请大写)。</li>
5403
- <li>中国港澳居民来往内地通行证号码共11位。第1位为字母,“H”字头签发给中国香港居民,“M”字头签发给中国澳门居民;第2位至第11位为数字。</li>
5404
- <li>中国港澳台居民居住证号码编码规则与中国大陆身份证相同,应为18位字符串。</li></ul>
5338
+ * <p>签署方经办人的证件号码,应符合以下规则</p><ul><li>中国大陆居民身份证号码应为18位字符串,由数字和大写字母X组成(如存在X,请大写)。</li><li>中国港澳居民来往内地通行证号码共11位。第1位为字母,“H”字头签发给中国香港居民,“M”字头签发给中国澳门居民;第2位至第11位为数字。</li><li>中国港澳台居民居住证号码编码规则与中国大陆身份证相同,应为18位字符串。</li></ul>
5405
5339
  */
5406
5340
  IdCardNumber?: string;
5407
5341
  /**
5408
- * 签署方经办人手机号码, 支持国内手机号11位数字(无需加+86前缀或其他字符), 不支持海外手机号。
5409
- 请确认手机号所有方为此合同签署方。
5342
+ * <p>签署方经办人手机号码, 支持国内手机号11位数字(无需加+86前缀或其他字符), 不支持海外手机号。<br>请确认手机号所有方为此合同签署方。</p>
5410
5343
  */
5411
5344
  Mobile?: string;
5412
5345
  /**
5413
- * 组织机构名称。
5414
- 请确认该名称与企业营业执照中注册的名称一致。
5415
- 如果名称中包含英文括号(),请使用中文括号()代替。
5346
+ * <p>组织机构名称。<br>请确认该名称与企业营业执照中注册的名称一致。<br>如果名称中包含英文括号(),请使用中文括号()代替。</p>
5416
5347
  */
5417
5348
  OrganizationName?: string;
5418
5349
  /**
5419
- * 指定签署人非第三方平台子客企业下员工还是SaaS平台企业,在ApproverType为ORGANIZATION时指定。
5420
- <ul>
5421
- <li>false: 默认值,第三方平台子客企业下员工</li>
5422
- <li>true: SaaS平台企业下的员工</li>
5423
- </ul>
5424
-
5350
+ * <p>指定签署人非第三方平台子客企业下员工还是SaaS平台企业,在ApproverType为ORGANIZATION时指定。</p><ul><li>false: 默认值,第三方平台子客企业下员工</li><li>true: SaaS平台企业下的员工</li></ul>
5425
5351
  */
5426
5352
  NotChannelOrganization?: boolean;
5427
5353
  /**
5428
- * 第三方平台子客企业员工的唯一标识,长度不能超过64,只能由字母和数字组成
5429
-
5430
- 当签署方为同一第三方平台下的员工时,该字段若不指定,则发起【待领取】的流程
5431
-
5432
- 注:
5433
- 如果传进来的<font color="red">OpenId已经实名并且加入企业, 则忽略Name,IdCardType,IdCardNumber,Mobile这四个入参</font>(会用此OpenId实名的身份证和登录的手机号覆盖)
5354
+ * <p>第三方平台子客企业员工的唯一标识,长度不能超过64,只能由字母和数字组成</p><p>当签署方为同一第三方平台下的员工时,该字段若不指定,则发起【待领取】的流程</p><p>注:<br>如果传进来的<font color="red">OpenId已经实名并且加入企业, 则忽略Name,IdCardType,IdCardNumber,Mobile这四个入参</font>(会用此OpenId实名的身份证和登录的手机号覆盖)</p>
5434
5355
  */
5435
5356
  OpenId?: string;
5436
5357
  /**
5437
- * 同应用下第三方平台子客企业的唯一标识,定义Agent中的ProxyOrganizationOpenId一样,签署方为非发起方企业场景下必传,最大长度64个字符
5358
+ * <p>同应用下第三方平台子客企业的唯一标识,定义Agent中的ProxyOrganizationOpenId一样,签署方为非发起方企业场景下必传,最大长度64个字符</p>
5438
5359
  */
5439
5360
  OrganizationOpenId?: string;
5440
5361
  /**
5441
- * 在指定签署方时,可选择企业B端或个人C端等不同的参与者类型,可选类型如下:
5442
- <ul><li> **PERSON** :个人/自然人</li>
5443
- <li> **PERSON_AUTO_SIGN** :个人/自然人自动签署,适用于个人自动签场景</li>
5444
- <li> **ORGANIZATION** :企业/企业员工(企业签署方或模板发起时的企业静默签)</li>
5445
- <li> **ENTERPRISESERVER** :企业/企业员工自动签(他方企业自动签署或文件发起时的本方企业自动签)</li></ul>
5446
-
5447
- 注:
5448
- `1. 个人自动签场景(PERSON_AUTO_SIGN)为白名单功能, 使用前请联系对接的客户经理沟通。`
5449
- `2. 若要实现他方企业(同一应用下)自动签,需要满足3个条件:`
5450
- <ul><li>条件1:ApproverType 设置为ENTERPRISESERVER</li>
5451
- <li>条件2:子客之间完成授权</li>
5452
- <li>条件3:联系对接的客户经理沟通如何使用</li></ul>
5362
+ * <p>在指定签署方时,可选择企业B端或个人C端等不同的参与者类型,可选类型如下:</p><ul><li> **PERSON** :个人/自然人</li><li> **PERSON_AUTO_SIGN** :个人/自然人自动签署,适用于个人自动签场景</li><li> **ORGANIZATION** :企业/企业员工(企业签署方或模板发起时的企业静默签)</li><li> **ENTERPRISESERVER** :企业/企业员工自动签(他方企业自动签署或文件发起时的本方企业自动签)</li></ul><p>注:<br><code>1. 个人自动签场景(PERSON_AUTO_SIGN)为白名单功能, 使用前请联系对接的客户经理沟通。</code><br><code>2. 若要实现他方企业(同一应用下)自动签,需要满足3个条件:</code></p><ul><li>条件1:ApproverType 设置为ENTERPRISESERVER</li><li>条件2:子客之间完成授权</li><li>条件3:联系对接的客户经理沟通如何使用</li></ul>
5453
5363
  */
5454
5364
  ApproverType?: string;
5455
5365
  /**
5456
- * 签署流程签署人在模板中对应的签署人Id;在非单方签署、以及非B2C签署的场景下必传,用于指定当前签署方在签署流程中的位置;
5366
+ * <p>签署流程签署人在模板中对应的签署人Id;在非单方签署、以及非B2C签署的场景下必传,用于指定当前签署方在签署流程中的位置;</p>
5457
5367
  */
5458
5368
  RecipientId?: string;
5459
5369
  /**
5460
- * 签署人的签署截止时间,格式为Unix标准时间戳(秒)
5461
-
5462
- 注: `若不设置此参数,则默认使用合同的截止时间,此参数暂不支持合同组子合同`
5370
+ * <p>签署人的签署截止时间,格式为Unix标准时间戳(秒)</p><p>注: <code>若不设置此参数,则默认使用合同的截止时间,此参数暂不支持合同组子合同</code></p>
5463
5371
  */
5464
5372
  Deadline?: number;
5465
5373
  /**
5466
- * 签署完回调url,最大长度1000个字符
5374
+ * <p>签署完回调url,最大长度1000个字符</p>
5467
5375
  * @deprecated
5468
5376
  */
5469
5377
  CallbackUrl?: string;
5470
5378
  /**
5471
- * 使用PDF文件直接发起合同时,签署人指定的签署控件;<br/>使用模板发起合同时,指定本企业印章签署控件的印章ID:注意:(如果模板里面指定了印章,默认使用模板里面配置的印章,不能进行变更) <br/>通过ComponentId或ComponenetName指定签署控件,ComponentValue为印章ID
5472
-
5473
- ![image](https://qcloudimg.tencent-cloud.cn/raw/91757a7f9188ccf3057a4a8979cf3f93.png)
5379
+ * <p>使用PDF文件直接发起合同时,签署人指定的签署控件;<br>使用模板发起合同时,指定本企业印章签署控件的印章ID:注意:(如果模板里面指定了印章,默认使用模板里面配置的印章,不能进行变更) <br>通过ComponentId或ComponenetName指定签署控件,ComponentValue为印章ID。</p><p><img src="https://qcloudimg.tencent-cloud.cn/raw/91757a7f9188ccf3057a4a8979cf3f93.png" alt="image"></p>
5474
5380
  */
5475
5381
  SignComponents?: Array<Component>;
5476
5382
  /**
5477
- * 当签署方控件类型为 <b>SIGN_SIGNATURE</b> 时,可以指定签署方签名方式。如果不指定,签署人可以使用所有的签名类型,可指定的签名类型包括:
5478
-
5479
- <ul><li> <b>HANDWRITE</b> :需要实时手写的手写签名。</li>
5480
- <li> <b>HANDWRITTEN_ESIGN</b> :长效手写签名, 是使用保存到个人中心的印章列表的手写签名。(并且包含HANDWRITE)</li>
5481
- <li> <b>OCR_ESIGN</b> :AI智能识别手写签名。</li>
5482
- <li> <b>ESIGN</b> :个人印章类型。</li>
5483
- <li> <b>IMG_ESIGN</b> : 图片印章。该类型支持用户在签署将上传的PNG格式的图片作为签名。</li>
5484
- <li> <b>SYSTEM_ESIGN</b> :系统签名。该类型可以在用户签署时根据用户姓名一键生成一个签名来进行签署。</li></ul>
5485
-
5486
- 各种签名的样式可以参考下图:
5487
- ![image](https://qcloudimg.tencent-cloud.cn/raw/ee0498856c060c065628a0c5ba780d6b.jpg)
5383
+ * <p>当签署方控件类型为 <b>SIGN_SIGNATURE</b> 时,可以指定签署方签名方式。如果不指定,签署人可以使用所有的签名类型,可指定的签名类型包括:</p><ul><li> <b>HANDWRITE</b> :需要实时手写的手写签名。</li><li> <b>HANDWRITTEN_ESIGN</b> :长效手写签名, 是使用保存到个人中心的印章列表的手写签名。(并且包含HANDWRITE)</li><li> <b>OCR_ESIGN</b> :AI智能识别手写签名。</li><li> <b>ESIGN</b> :个人印章类型。</li><li> <b>IMG_ESIGN</b> : 图片印章。该类型支持用户在签署将上传的PNG格式的图片作为签名。</li><li> <b>SYSTEM_ESIGN</b> :系统签名。该类型可以在用户签署时根据用户姓名一键生成一个签名来进行签署。</li></ul><p>各种签名的样式可以参考下图:<br><img src="https://qcloudimg.tencent-cloud.cn/raw/ee0498856c060c065628a0c5ba780d6b.jpg" alt="image"></p>
5488
5384
  */
5489
5385
  ComponentLimitType?: Array<string>;
5490
5386
  /**
5491
- * 签署方在签署合同之前,需要强制阅读合同的时长,可指定为3秒至300秒之间的任意值。
5492
-
5493
- 若未指定阅读时间,则会按照合同页数大小计算阅读时间,计算规则如下:
5494
- <ul>
5495
- <li>合同页数少于等于2页,阅读时间为3秒;</li>
5496
- <li>合同页数为3到5页,阅读时间为5秒;</li>
5497
- <li>合同页数大于等于6页,阅读时间为10秒。</li>
5498
- </ul>
5387
+ * <p>签署方在签署合同之前,需要强制阅读合同的时长,可指定为3秒至300秒之间的任意值。</p><p>若未指定阅读时间,则会按照合同页数大小计算阅读时间,计算规则如下:</p><ul><li>合同页数少于等于2页,阅读时间为3秒;</li><li>合同页数为3到5页,阅读时间为5秒;</li><li>合同页数大于等于6页,阅读时间为10秒。</li></ul>
5499
5388
  */
5500
5389
  PreReadTime?: number;
5501
5390
  /**
5502
- * 签署完前端跳转的url,此字段的用法场景请联系客户经理确认
5391
+ * <p>签署完前端跳转的url,此字段的用法场景请联系客户经理确认</p>
5503
5392
  */
5504
5393
  JumpUrl?: string;
5505
5394
  /**
5506
- * 可以控制签署方在签署合同时能否进行某些操作,例如拒签、转交他人、是否为动态补充签署人等。
5507
- 详细操作可以参考开发者中心的ApproverOption结构体。
5395
+ * <p>可以控制签署方在签署合同时能否进行某些操作,例如拒签、转交他人、是否为动态补充签署人等。<br>详细操作可以参考开发者中心的ApproverOption结构体。</p>
5508
5396
  */
5509
5397
  ApproverOption?: ApproverOption;
5510
5398
  /**
5511
- * 此签署人(员工或者个人)签署前,是否需要发起方企业进行审批,取值如下:
5512
- <ul><li>**false**:(默认)不需要审批,直接签署。</li>
5513
- <li>**true**:需要走审批流程。当到对应参与人签署时,会阻塞其签署操作,等待发起方企业内部审批完成。</li></ul>
5514
- 企业可以通过ChannelCreateFlowSignReview审批接口通知腾讯电子签平台企业内部审批结果
5515
- <ul><li>如果企业通知腾讯电子签平台审核通过,签署方可继续签署动作。</li>
5516
- <li>如果企业通知腾讯电子签平台审核未通过,平台将继续阻塞签署方的签署动作,直到企业通知平台审核通过。</li></ul>
5517
-
5518
- 注:`此功能可用于与发起方企业内部的审批流程进行关联,支持手动、静默签署合同`
5519
-
5520
- ![image](https://qcloudimg.tencent-cloud.cn/raw/b14d5188ed0229d1401e74a9a49cab6d.png)
5399
+ * <p>此签署人(员工或者个人)签署前,是否需要发起方企业进行审批,取值如下:</p><ul><li>**false**:(默认)不需要审批,直接签署。</li><li>**true**:需要走审批流程。当到对应参与人签署时,会阻塞其签署操作,等待发起方企业内部审批完成。</li></ul>企业可以通过ChannelCreateFlowSignReview审批接口通知腾讯电子签平台企业内部审批结果<ul><li>如果企业通知腾讯电子签平台审核通过,签署方可继续签署动作。</li><li>如果企业通知腾讯电子签平台审核未通过,平台将继续阻塞签署方的签署动作,直到企业通知平台审核通过。</li></ul><p>注:<code>此功能可用于与发起方企业内部的审批流程进行关联,支持手动、静默签署合同</code></p><p><img src="https://qcloudimg.tencent-cloud.cn/raw/b14d5188ed0229d1401e74a9a49cab6d.png" alt="image"></p>
5521
5400
  */
5522
5401
  ApproverNeedSignReview?: boolean;
5523
5402
  /**
5524
- * 指定个人签署方查看合同的校验方式,可以传值如下:
5525
- <ul><li> **1** : (默认)人脸识别,人脸识别后才能合同内容</li>
5526
- <li> **2** : 手机号验证, 用户手机号和参与方手机号(ApproverMobile)相同即可查看合同内容(当手写签名方式为OCR_ESIGN时,该校验方式无效,因为这种签名方式依赖实名认证)
5527
- </li></ul>
5528
- 注:
5529
- <ul><li>如果合同流程设置ApproverVerifyType查看合同的校验方式, 则忽略此签署人的查看合同的校验方式</li>
5530
- <li>此字段可传多个校验方式</li></ul>
5403
+ * <p>指定个人签署方查看合同的校验方式,可以传值如下:</p><ul><li> **1** : (默认)人脸识别,人脸识别后才能合同内容</li><li> **2** : 手机号验证, 用户手机号和参与方手机号(ApproverMobile)相同即可查看合同内容(当手写签名方式为OCR_ESIGN时,该校验方式无效,因为这种签名方式依赖实名认证)</li></ul>注: <ul><li>如果合同流程设置ApproverVerifyType查看合同的校验方式, 则忽略此签署人的查看合同的校验方式</li><li>此字段可传多个校验方式</li></ul>
5531
5404
  */
5532
5405
  ApproverVerifyTypes?: Array<number | bigint>;
5533
5406
  /**
5534
- * 签署人签署合同时的认证方式
5535
- <ul><li> **1** :人脸认证</li>
5536
- <li> **2** :签署密码</li>
5537
- <li> **3** :运营商三要素(如果是港澳台客户,建议不要选择这个)</li>
5538
- <li>**5**:设备指纹识别,需要对比手机机主预留的指纹信息,校验一致才能成功进行合同签署。(iOS系统暂不支持该校验方式)</li>
5539
- <li>**6**:设备面容识别,需要对比手机机主预留的人脸信息,校验一致才能成功进行合同签署。(Android系统暂不支持该校验方式)</li></ul>
5540
-
5541
- 默认为:
5542
- 1(人脸认证 ),2(签署密码),3(运营商三要素),5(设备指纹识别),6(设备面容识别)
5543
-
5544
- 注:
5545
- 1. 用<font color='red'>模板创建合同场景</font>, 签署人的认证方式需要在配置模板的时候指定, <font color='red'>在创建合同重新指定无效</font>
5546
- 2. 运营商三要素认证方式对手机号运营商及前缀有限制,可以参考[运营商支持列表类](https://qian.tencent.com/developers/partner/mobile_support)得到具体的支持说明
5547
- 3. 校验方式不允许只包含<font color='red'>设备指纹识别</font>和<font color='red'>设备面容识别</font>,至少需要再增加一种其他校验方式。
5548
- 4. <font color='red'>设备指纹识别</font>和<font color='red'>设备面容识别</font>只支持小程序使用,其他端暂不支持。
5407
+ * <p>签署人签署合同时的认证方式</p><ul><li> **1** :人脸认证</li><li> **2** :签署密码</li><li> **3** :运营商三要素(如果是港澳台客户,建议不要选择这个)</li><li>**5**:设备指纹识别,需要对比手机机主预留的指纹信息,校验一致才能成功进行合同签署。(iOS系统暂不支持该校验方式)</li><li>**6**:设备面容识别,需要对比手机机主预留的人脸信息,校验一致才能成功进行合同签署。(Android系统暂不支持该校验方式)</li></ul><p>默认为:<br>1(人脸认证 ),2(签署密码),3(运营商三要素),5(设备指纹识别),6(设备面容识别)</p><p>注: </p><ol><li>用<font color="red">模板创建合同场景</font>, 签署人的认证方式需要在配置模板的时候指定, <font color="red">在创建合同重新指定无效</font></li><li>运营商三要素认证方式对手机号运营商及前缀有限制,可以参考<a href="https://qian.tencent.com/developers/partner/mobile_support">运营商支持列表类</a>得到具体的支持说明</li><li>校验方式不允许只包含<font color="red">设备指纹识别</font>和<font color="red">设备面容识别</font>,至少需要再增加一种其他校验方式。</li><li><font color="red">设备指纹识别</font>和<font color="red">设备面容识别</font>只支持小程序使用,其他端暂不支持。</li></ol>
5549
5408
  */
5550
5409
  ApproverSignTypes?: Array<number | bigint>;
5551
5410
  /**
5552
- * 签署ID
5553
- - 发起流程时系统自动补充
5554
- - 创建签署链接时,可以通过查询详情接口获得签署人的SignId,然后可传入此值为该签署人创建签署链接,无需再传姓名、手机号、证件号等其他信息
5411
+ * <p>签署ID</p><ul><li>发起流程时系统自动补充</li><li>创建签署链接时,可以通过查询详情接口获得签署人的SignId,然后可传入此值为该签署人创建签署链接,无需再传姓名、手机号、证件号等其他信息</li></ul>
5555
5412
  */
5556
5413
  SignId?: string;
5557
5414
  /**
5558
- * 通知签署方经办人的方式, 有以下途径:
5559
- <ul><li> **SMS** :(默认)短信</li>
5560
- <li> **NONE** : 不通知</li></ul>
5561
-
5562
- 注: `签署方为第三方子客企业时会被置为NONE, 不会发短信通知`
5415
+ * <p>通知签署方经办人的方式(仅在指定NotChannelOrganization=true时有效), 有以下途径:</p><ul><li> **SMS** :(默认)短信</li><li> **EMAIL** :邮件</li><li> **ALL** :短信+邮件</li><li> **NONE** : 不通知</li></ul><p>注: <code>签署方为第三方子客企业时会被置为NONE, 不会发短信通知</code></p><p>枚举值:</p><ul><li>SMS: 发送短信</li><li>EMAIL: 发送邮件</li><li>ALL: 同时发送短信和邮件</li><li>NODE: 不做任何形式的通知</li></ul>
5563
5416
  */
5564
5417
  NotifyType?: string;
5565
5418
  /**
5566
- * [通过文件创建签署流程](https://qian.tencent.com/developers/partnerApis/startFlows/ChannelCreateFlowByFiles)时,如果设置了外层参数SignBeanTag=1(允许签署过程中添加签署控件),则可通过此参数明确规定合同所使用的签署控件类型(骑缝章、普通章法人章等)和具体的印章(印章ID,或者印章类型)或签名方式。
5567
-
5568
- 注:`限制印章控件或骑缝章控件情况下,仅本企业签署方可以指定具体印章(通过传递ComponentValue,支持多个),他方企业或个人只支持限制控件类型。`
5419
+ * <p><a href="https://qian.tencent.com/developers/partnerApis/startFlows/ChannelCreateFlowByFiles">通过文件创建签署流程</a>时,如果设置了外层参数SignBeanTag=1(允许签署过程中添加签署控件),则可通过此参数明确规定合同所使用的签署控件类型(骑缝章、普通章法人章等)和具体的印章(印章ID,或者印章类型)或签名方式。</p><p>注:<code>限制印章控件或骑缝章控件情况下,仅本企业签署方可以指定具体印章(通过传递ComponentValue,支持多个),他方企业或个人只支持限制控件类型。</code></p>
5569
5420
  */
5570
5421
  AddSignComponentsLimits?: Array<ComponentLimit>;
5571
5422
  /**
5572
- * 可以自定义签署人角色名:收款人、开具人、见证人等,长度不能超过20,只能由中文、字母、数字和下划线组成。
5573
-
5574
- 注: `如果是用模板发起, 优先使用此处上传的, 如果不传则用模板的配置的`
5423
+ * <p>可以自定义签署人角色名:收款人、开具人、见证人等,长度不能超过20,只能由中文、字母、数字和下划线组成。</p><p>注: <code>如果是用模板发起, 优先使用此处上传的, 如果不传则用模板的配置的</code></p>
5575
5424
  */
5576
5425
  ApproverRoleName?: string;
5577
5426
  /**
5578
- * 生成H5签署链接时,您可以指定签署方签署合同的认证校验方式的选择模式,可传递一下值:
5579
- <ul><li>**0**:签署方自行选择,签署方可以从预先指定的认证方式中自由选择;</li>
5580
- <li>**1**:自动按顺序首位推荐,签署方无需选择,系统会优先推荐使用第一种认证方式。</li></ul>
5581
- 注:
5582
- `不指定该值时,默认为签署方自行选择。`
5427
+ * <p>生成H5签署链接时,您可以指定签署方签署合同的认证校验方式的选择模式,可传递一下值:</p><ul><li>**0**:签署方自行选择,签署方可以从预先指定的认证方式中自由选择;</li><li>**1**:自动按顺序首位推荐,签署方无需选择,系统会优先推荐使用第一种认证方式。</li></ul>注:<code>不指定该值时,默认为签署方自行选择。</code>
5583
5428
  */
5584
5429
  SignTypeSelector?: number;
5585
5430
  /**
5586
- * 签署人在合同中的填写控件列表,列表中可支持下列多种填写控件,控件的详细定义参考开发者中心的Component结构体
5587
- <ul><li>单行文本控件</li>
5588
- <li>多行文本控件</li>
5589
- <li>勾选框控件</li>
5590
- <li>数字控件</li>
5591
- <li>图片控件</li>
5592
- <li>数据表格等填写控件</li></ul>
5593
-
5594
- 具体使用说明可参考[为签署方指定填写控件](https://qian.tencent.cn/developers/partner/createFlowByFiles#为签署方指定填写控件)
5595
-
5596
- 注:`此参数仅在通过文件发起合同或者合同组时生效`
5597
-
5598
- ![image](https://qcloudimg.tencent-cloud.cn/raw/e004195ee4cb98a7f9bc12eb4a0a0b77.png)
5431
+ * <p>签署人在合同中的填写控件列表,列表中可支持下列多种填写控件,控件的详细定义参考开发者中心的Component结构体</p><ul><li>单行文本控件</li><li>多行文本控件</li><li>勾选框控件</li><li>数字控件</li><li>图片控件</li><li>数据表格等填写控件</li></ul><p>具体使用说明可参考<a href="https://qian.tencent.cn/developers/partner/createFlowByFiles#为签署方指定填写控件">为签署方指定填写控件</a></p><p>注:<code>此参数仅在通过文件发起合同或者合同组时生效</code></p><p><img src="https://qcloudimg.tencent-cloud.cn/raw/e004195ee4cb98a7f9bc12eb4a0a0b77.png" alt="image"></p>
5599
5432
  */
5600
5433
  Components?: Array<Component>;
5601
5434
  /**
5602
- * <b>只有在生成H5签署链接的情形下</b>( 如调用<a href="https://qian.tencent.com/developers/partnerApis/operateFlows/ChannelCreateFlowSignUrl" target="_blank">获取H5签署链接</a>、<a href="https://qian.tencent.com/developers/partnerApis/operateFlows/ChannelCreateBatchQuickSignUrl" target="_blank">获取H5批量签署链接</a>等接口),该配置才会生效。
5603
-
5604
- 您可以指定H5签署视频核身的意图配置,选择问答模式或点头模式的语音文本。
5605
-
5606
- 注意:
5607
- 1. 视频认证为<b>白名单功能,使用前请联系对接的客户经理沟通</b>。
5608
- 2. 使用视频认证时,<b>生成H5签署链接的时候必须将签署认证方式指定为人脸</b>(即ApproverSignTypes设置成人脸签署)。
5609
- 3. 签署完成后,可以通过<a href="https://qian.tencent.com/developers/partnerApis/flows/ChannelDescribeSignFaceVideo" target="_blank">查询签署认证人脸视频</a>获取到当时的视频。
5435
+ * <p><b>只有在生成H5签署链接的情形下</b>( 如调用<a href="https://qian.tencent.com/developers/partnerApis/operateFlows/ChannelCreateFlowSignUrl" target="_blank">获取H5签署链接</a>、<a href="https://qian.tencent.com/developers/partnerApis/operateFlows/ChannelCreateBatchQuickSignUrl" target="_blank">获取H5批量签署链接</a>等接口),该配置才会生效。</p><p>您可以指定H5签署视频核身的意图配置,选择问答模式或点头模式的语音文本。</p><p>注意:</p><ol><li>视频认证为<b>白名单功能,使用前请联系对接的客户经理沟通</b>。</li><li>使用视频认证时,<b>生成H5签署链接的时候必须将签署认证方式指定为人脸</b>(即ApproverSignTypes设置成人脸签署)。</li><li>签署完成后,可以通过<a href="https://qian.tencent.com/developers/partnerApis/flows/ChannelDescribeSignFaceVideo" target="_blank">查询签署认证人脸视频</a>获取到当时的视频。</li></ol>
5610
5436
  */
5611
5437
  Intention?: Intention;
5612
5438
  /**
5613
- * 进入签署流程的限制,目前支持以下选项:
5614
- <ul><li> <b>空值(默认)</b> :无限制,可在任何场景进入签署流程。</li><li> <b>link</b> :选择此选项后,将无法通过控制台或电子签小程序列表进入填写或签署操作,仅可预览合同。填写或签署流程只能通过短信或发起方提供的专用链接进行。</li></ul>
5439
+ * <p>进入签署流程的限制,目前支持以下选项:</p><ul><li> <b>空值(默认)</b> :无限制,可在任何场景进入签署流程。</li><li> <b>link</b> :选择此选项后,将无法通过控制台或电子签小程序列表进入填写或签署操作,仅可预览合同。填写或签署流程只能通过短信或发起方提供的专用链接进行。</li></ul>
5615
5440
  */
5616
5441
  SignEndpoints?: Array<string>;
5442
+ /**
5443
+ * <p>用户指定的邮箱地址</p>
5444
+ */
5445
+ ApproverEmail?: string;
5617
5446
  }
5618
5447
  /**
5619
5448
  * ChannelCreateUserAutoSignEnableUrl返回参数结构体
@@ -7023,7 +6852,7 @@ export interface CreateBatchOrganizationRegistrationTasksRequest {
7023
6852
  */
7024
6853
  export interface ChannelCreateBatchQuickSignUrlResponse {
7025
6854
  /**
7026
- * 签署人签署链接信息
6855
+ * <p>签署人签署链接信息</p>
7027
6856
  */
7028
6857
  FlowApproverUrlInfo?: FlowApproverUrlInfo;
7029
6858
  /**
@@ -7647,6 +7476,10 @@ export interface ApproverOption {
7647
7476
  * <p>禁止在签署过程中添加签署日期控件<br> <br>前置条件:文件发起合同时,指定SignBeanTag=1(可以在签署过程中添加签署控件):</p><ul><li> 默认值:false,在开启:签署过程中添加签署控件时,添加签署控件会默认自带签署日期控件</li><li> 可选值:true,在开启:签署过程中添加签署控件时,添加签署控件不会自带签署日期控件</li></ul>
7648
7477
  */
7649
7478
  ForbidAddSignDate?: boolean;
7479
+ /**
7480
+ * <p>签署人手机号传参模式</p><p>枚举值:</p><ul><li>REPLACE: 接受已有认证手机号并替换</li><li>GIVEN: 以客户入参输入手机号为主</li><li>VALIDATE: 若与认证手机号不一致则报错</li></ul><p>默认值:REPLACE</p><p>会触发手机号传参模式的前提是:签署人是指定了具体身份信息的</p><ul><li>渠道方签署人不会触发</li><li>非渠道方签署人在指定签署人姓名,证件号的情况下会触发</li></ul>
7481
+ */
7482
+ ApproverMobileMode?: string;
7650
7483
  }
7651
7484
  /**
7652
7485
  * ChannelCreatePrepareFlowGroup返回参数结构体