tencentcloud-sdk-nodejs 4.0.722 → 4.0.723

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 (43) hide show
  1. package/CHANGELOG.md +123 -0
  2. package/SERVICE_CHANGELOG.md +144 -51
  3. package/package.json +1 -1
  4. package/products.md +15 -15
  5. package/src/common/sdk_version.ts +1 -1
  6. package/src/services/aiart/v20221229/aiart_models.ts +13 -5
  7. package/src/services/ccc/v20200210/ccc_models.ts +6 -2
  8. package/src/services/ckafka/v20190819/ckafka_models.ts +1 -1
  9. package/src/services/clb/v20180317/clb_models.ts +4 -6
  10. package/src/services/ess/v20201111/ess_client.ts +7 -3
  11. package/src/services/ess/v20201111/ess_models.ts +38 -30
  12. package/src/services/essbasic/v20210526/essbasic_client.ts +25 -11
  13. package/src/services/essbasic/v20210526/essbasic_models.ts +112 -63
  14. package/src/services/lighthouse/v20200324/lighthouse_client.ts +29 -2
  15. package/src/services/lighthouse/v20200324/lighthouse_models.ts +98 -50
  16. package/src/services/ses/v20201002/ses_models.ts +5 -1
  17. package/src/services/tione/v20211111/tione_models.ts +1 -1
  18. package/src/services/waf/v20180125/waf_client.ts +19 -6
  19. package/src/services/waf/v20180125/waf_models.ts +92 -0
  20. package/src/services/wedata/v20210820/wedata_models.ts +14 -2
  21. package/tencentcloud/common/sdk_version.d.ts +1 -1
  22. package/tencentcloud/common/sdk_version.js +1 -1
  23. package/tencentcloud/services/aiart/v20221229/aiart_models.d.ts +13 -5
  24. package/tencentcloud/services/ccc/v20200210/ccc_models.d.ts +6 -2
  25. package/tencentcloud/services/ckafka/v20190819/ckafka_models.d.ts +1 -1
  26. package/tencentcloud/services/clb/v20180317/clb_models.d.ts +4 -6
  27. package/tencentcloud/services/ess/v20201111/ess_client.d.ts +7 -3
  28. package/tencentcloud/services/ess/v20201111/ess_client.js +7 -3
  29. package/tencentcloud/services/ess/v20201111/ess_models.d.ts +38 -30
  30. package/tencentcloud/services/essbasic/v20210526/essbasic_client.d.ts +24 -10
  31. package/tencentcloud/services/essbasic/v20210526/essbasic_client.js +24 -10
  32. package/tencentcloud/services/essbasic/v20210526/essbasic_models.d.ts +112 -63
  33. package/tencentcloud/services/lighthouse/v20200324/lighthouse_client.d.ts +12 -1
  34. package/tencentcloud/services/lighthouse/v20200324/lighthouse_client.js +15 -0
  35. package/tencentcloud/services/lighthouse/v20200324/lighthouse_models.d.ts +94 -50
  36. package/tencentcloud/services/ses/v20201002/ses_models.d.ts +6 -1
  37. package/tencentcloud/services/tione/v20211111/tione_models.d.ts +1 -1
  38. package/tencentcloud/services/waf/v20180125/waf_client.d.ts +7 -3
  39. package/tencentcloud/services/waf/v20180125/waf_client.js +9 -3
  40. package/tencentcloud/services/waf/v20180125/waf_models.d.ts +89 -0
  41. package/tencentcloud/services/wedata/v20210820/wedata_models.d.ts +14 -2
  42. package/test/lighthouse.v20200324.test.js +20 -0
  43. package/test/waf.v20180125.test.js +12 -2
@@ -247,7 +247,7 @@ OPEN:公网属性, INTERNAL:内网属性。
247
247
  ExclusiveCluster?: ExclusiveCluster
248
248
  /**
249
249
  * 性能容量型规格。
250
- <ul><li>若需要创建性能容量型实例,则此参数必填,取值范围:<ul><li> SLA:超强型1规格。当您开通了超大型规格的性能容量型时,SLA对应超强型4规格 </li><li> clb.c2.medium:标准型规格 </li><li> clb.c3.small:高阶型1规格 </li><li> clb.c3.medium:高阶型2规格 </li><li> clb.c4.small:超强型1规格 </li><li> clb.c4.medium:超强型2规格 </li><li> clb.c4.large:超强型3规格 </li><li> clb.c4.xlarge:超强型4规格 </li>如需超大型规格(超强型2及以上),请提交[工单申请](https://console.cloud.tencent.com/workorder/category)。</ul></li><li>若需要创建共享型实例,则无需填写此参数。</li></ul>如需了解规格详情,请参见[实例规格对比](https://cloud.tencent.com/document/product/214/84689)。
250
+ <ul><li>若需要创建性能容量型实例,则此参数必填,取值范围:<ul><li> SLA:超强型4规格 </li><li> clb.c2.medium:标准型规格 </li><li> clb.c3.small:高阶型1规格 </li><li> clb.c3.medium:高阶型2规格 </li><li> clb.c4.small:超强型1规格 </li><li> clb.c4.medium:超强型2规格 </li><li> clb.c4.large:超强型3规格 </li><li> clb.c4.xlarge:超强型4规格 </li></ul></li><li>若需要创建共享型实例,则无需填写此参数。</li></ul>如需了解规格详情,请参见[实例规格对比](https://cloud.tencent.com/document/product/214/84689)。
251
251
  */
252
252
  SlaType?: string
253
253
  /**
@@ -1735,14 +1735,14 @@ export interface SlaUpdateParam {
1735
1735
  LoadBalancerId: string
1736
1736
  /**
1737
1737
  * 性能容量型规格,取值范围:
1738
- <li> SLA:超强型1规格。当您开通了超大型规格的性能容量型时,SLA对应超强型4规格 </li>
1738
+ <li> SLA:超强型4规格 </li>
1739
1739
  <li> clb.c2.medium:标准型规格 </li>
1740
1740
  <li> clb.c3.small:高阶型1规格 </li>
1741
1741
  <li> clb.c3.medium:高阶型2规格 </li>
1742
1742
  <li> clb.c4.small:超强型1规格 </li>
1743
1743
  <li> clb.c4.medium:超强型2规格 </li>
1744
1744
  <li> clb.c4.large:超强型3规格 </li>
1745
- <li> clb.c4.xlarge:超强型4规格 </li>如需超大型规格(超强型2及以上),请提交[工单申请](https://console.cloud.tencent.com/workorder/category)。如需了解规格详情,请参见[实例规格对比](https://cloud.tencent.com/document/product/214/84689)
1745
+ <li> clb.c4.xlarge:超强型4规格 </li>如需了解规格详情,请参见[实例规格对比](https://cloud.tencent.com/document/product/214/84689)
1746
1746
  */
1747
1747
  SlaType: string
1748
1748
  }
@@ -5174,9 +5174,7 @@ BANDWIDTH_PACKAGE 按带宽包计费;
5174
5174
  /**
5175
5175
  * 最大出带宽,单位Mbps,仅对公网属性的共享型、性能容量型和独占型 CLB 实例、以及内网属性的性能容量型 CLB 实例生效。
5176
5176
  - 对于公网属性的共享型和独占型 CLB 实例,最大出带宽的范围为1Mbps-2048Mbps。
5177
- - 对于公网属性和内网属性的性能容量型 CLB实例
5178
- - 默认为普通规格的性能容量型实例,SLA对应超强型1规格,最大出带宽的范围为1Mbps-10240Mbps。
5179
- - 当您开通了超大型规格的性能容量型时,最大出带宽的范围为1Mbps-61440Mbps。超大型规格的性能容量型正在内测中,请提交 [工单申请](https://console.cloud.tencent.com/workorder/category)。
5177
+ - 对于公网属性和内网属性的性能容量型 CLB实例,最大出带宽的范围为1Mbps-61440Mbps。
5180
5178
  注意:此字段可能返回 null,表示取不到有效值。
5181
5179
  */
5182
5180
  InternetMaxBandwidthOut?: number
@@ -308,6 +308,8 @@ export class Client extends AbstractClient {
308
308
  >- 签署控件 SignComponents
309
309
  >- 生成模板的文件基础信息 FileInfos
310
310
 
311
+ ![image](https://dyn.ess.tencent.cn/guide/capi/channel_DescribeTemplates.png)
312
+
311
313
  当模板较多或模板中的控件较多时,可以通过查询模板接口更方便的获取模板列表,以及每个模板内的控件信息。
312
314
 
313
315
  适用场景:
@@ -795,9 +797,10 @@ httpProfile.setEndpoint("file.test.ess.tencent.cn");
795
797
  }
796
798
 
797
799
  /**
798
- * 创建企业扩展服务授权,当前仅支持授权 “企业自动签” 给企业员工。
800
+ * 创建企业扩展服务授权,当前仅支持授权 “企业自动签” 和 “批量签署” 给企业员工。
801
+ 该接口作用和电子签控制台 企业设置-扩展服务-企业自动签署和批量签署授权 两个模块功能相同,可通过该接口授权给企业员工。
799
802
 
800
- 注:支持集团代子企业操作,请联系运营开通此功能。
803
+ 注:“企业自动签授权”支持集团代子企业操作,请联系运营开通此功能。
801
804
  */
802
805
  async CreateExtendedServiceAuthInfos(
803
806
  req: CreateExtendedServiceAuthInfosRequest,
@@ -1163,7 +1166,8 @@ httpProfile.setEndpoint("file.test.ess.tencent.cn");
1163
1166
  }
1164
1167
 
1165
1168
  /**
1166
- * 删除企业扩展服务授权,当前仅支持 “企业自动签” 取消授权。
1169
+ * 删除企业扩展服务授权,当前仅支持 “企业自动签” 和“批量签署” 的取消授权。
1170
+ 该接口作用和电子签控制台 企业设置-扩展服务-企业自动签署和批量签署授权 两个模块功能相同,可通过该接口取消企业员工授权。
1167
1171
 
1168
1172
  注:支持集团代子企业操作,请联系运营开通此功能。
1169
1173
  */
@@ -361,12 +361,10 @@ export interface CreateExtendedServiceAuthInfosRequest {
361
361
  */
362
362
  UserIds: Array<string>
363
363
  /**
364
- * 要查询的扩展服务类型。
365
- 默认为空,即查询当前支持的所有扩展服务信息。
366
- 若需查询单个扩展服务的开通情况,请传递相应的值,如下所示:
364
+ * 取值
367
365
  <ul><li>OPEN_SERVER_SIGN:企业自动签</li>
366
+ <li>BATCH_SIGN:批量签署</li>
368
367
  </ul>
369
-
370
368
  */
371
369
  ExtendServiceType?: string
372
370
  /**
@@ -405,36 +403,38 @@ export interface CreateMultiFlowSignQRCodeResponse {
405
403
  }
406
404
 
407
405
  /**
408
- * 签署链接信息
406
+ * 签署链接信息。
409
407
  */
410
408
  export interface FlowApproverUrlInfo {
411
409
  /**
412
- * 签署链接(短链形式呈现)。请注意保密,不要将其外泄给无关用户。
413
- 注: `注意该链接有效期为30分钟`
410
+ * 签署短链接。</br>
411
+ 注意:
412
+ - 该链接有效期为**30分钟**,同时需要注意保密,不要外泄给无关用户。
413
+ - 该链接不支持小程序嵌入,仅支持**移动端浏览器**打开。
414
414
  注意:此字段可能返回 null,表示取不到有效值。
415
415
  */
416
416
  SignUrl?: string
417
417
  /**
418
- * 签署参与人类型
419
- <ul><li> **1** :个人参与方</li></ul>
420
-
421
- 注: `现在仅支持个人参与方`
418
+ * 签署人类型。
419
+ - **1**: 个人
422
420
  注意:此字段可能返回 null,表示取不到有效值。
423
421
  */
424
422
  ApproverType?: number
425
423
  /**
426
- * 签署人姓名
424
+ * 签署人姓名。
427
425
  注意:此字段可能返回 null,表示取不到有效值。
428
426
  */
429
427
  ApproverName?: string
430
428
  /**
431
- * 签署人手机号
429
+ * 签署人手机号。
432
430
  注意:此字段可能返回 null,表示取不到有效值。
433
431
  */
434
432
  ApproverMobile?: string
435
433
  /**
436
- * 签署链接(长链形式呈现)。请注意保密,不要将其外泄给无关用户。
437
- 注: `注意该链接有效期为30分钟`
434
+ * 签署长链接。</br>
435
+ 注意:
436
+ - 该链接有效期为**30分钟**,同时需要注意保密,不要外泄给无关用户。
437
+ - 该链接不支持小程序嵌入,仅支持**移动端浏览器**打开。
438
438
  注意:此字段可能返回 null,表示取不到有效值。
439
439
  */
440
440
  LongUrl?: string
@@ -2385,47 +2385,57 @@ export interface PdfVerifyResult {
2385
2385
  */
2386
2386
  VerifyResult?: number
2387
2387
  /**
2388
- * 签署平台,如果文件是在腾讯电子签平台签署,则返回腾讯电子签,如果文件不在腾讯电子签平台签署,则返回其他平台。
2388
+ * 签署平台
2389
+ 如果文件是在腾讯电子签平台签署,则为**腾讯电子签**,
2390
+ 如果文件不在腾讯电子签平台签署,则为**其他平台**。
2389
2391
  */
2390
2392
  SignPlatform?: string
2391
2393
  /**
2392
- * 签署人名称
2394
+ * 申请证书的主体的名字
2395
+
2396
+ 如果是在腾讯电子签平台签署, 则对应的主体的名字个数如下
2397
+ **企业**: ESS@企业名称@编码
2398
+ **个人**: ESS@个人姓名@证件号@808854
2399
+
2400
+ 如果在其他平台签署的, 主体的名字参考其他平台的说明
2393
2401
  */
2394
2402
  SignerName?: string
2395
2403
  /**
2396
- * 签署时间戳,单位秒
2404
+ * 签署时间的Unix时间戳,单位毫秒
2397
2405
  */
2398
2406
  SignTime?: number
2399
2407
  /**
2400
- * 签名算法
2408
+ * 证书签名算法, 如SHA1withRSA等算法
2401
2409
  */
2402
2410
  SignAlgorithm?: string
2403
2411
  /**
2404
- * 签名证书序列号
2412
+ * CA供应商下发给用户的证书编号
2413
+
2414
+ 注意:`腾讯电子签接入多家CA供应商以提供容灾能力,不同CA下发的证书编号区别较大,但基本都是由数字和字母组成,长度在200以下`。
2405
2415
  */
2406
2416
  CertSn?: string
2407
2417
  /**
2408
- * 证书起始时间戳,单位毫秒
2418
+ * 证书起始时间的Unix时间戳,单位毫秒
2409
2419
  */
2410
2420
  CertNotBefore?: number
2411
2421
  /**
2412
- * 证书过期时间戳,单位毫秒
2422
+ * 证书过期时间的时间戳,单位毫秒
2413
2423
  */
2414
2424
  CertNotAfter?: number
2415
2425
  /**
2416
- * 签名域横坐标,单位pt
2426
+ * 签名域横坐标,单位px
2417
2427
  */
2418
2428
  ComponentPosX?: number
2419
2429
  /**
2420
- * 签名域纵坐标,单位pt
2430
+ * 签名域纵坐标,单位px
2421
2431
  */
2422
2432
  ComponentPosY?: number
2423
2433
  /**
2424
- * 签名域宽度,单位pt
2434
+ * 签名域宽度,单位px
2425
2435
  */
2426
2436
  ComponentWidth?: number
2427
2437
  /**
2428
- * 签名域高度,单位pt
2438
+ * 签名域高度,单位px
2429
2439
  */
2430
2440
  ComponentHeight?: number
2431
2441
  /**
@@ -6627,12 +6637,10 @@ export interface DeleteExtendedServiceAuthInfosRequest {
6627
6637
  */
6628
6638
  UserIds: Array<string>
6629
6639
  /**
6630
- * 要查询的扩展服务类型。
6631
- 默认为空,即查询当前支持的所有扩展服务信息。
6632
- 若需查询单个扩展服务的开通情况,请传递相应的值,如下所示:
6640
+ * 取值如下所示:
6633
6641
  <ul><li>OPEN_SERVER_SIGN:企业自动签</li>
6642
+ <li>BATCH_SIGN:批量签署</li>
6634
6643
  </ul>
6635
-
6636
6644
  */
6637
6645
  ExtendServiceType?: string
6638
6646
  /**
@@ -630,6 +630,8 @@ https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/launchAp
630
630
  - 发起方和签署方的填写控件 Components
631
631
  - 签署方的签署控件 SignComponents
632
632
 
633
+ ![image](https://dyn.ess.tencent.cn/guide/capi/channel_DescribeTemplates.png)
634
+
633
635
  **适用场景**
634
636
  该接口常用来配合<a href="https://qian.tencent.com/developers/partnerApis/startFlows/CreateFlowsByTemplates" target="_blank">用模板创建签署流程</a>和<a href="https://qian.tencent.com/developers/partnerApis/startFlows/ChannelCreateFlowGroupByTemplates" target="_blank">通过多模板创建合同组签署流程</a>接口,作为创建合同的前置接口使用。
635
637
  通过此接口查询到模板信息后,再通过调用创建合同的接口,指定模板ID,指定模板中需要的填写控件内容等,完成合同文档的的创建。
@@ -794,12 +796,13 @@ Web链接访问后,会根据子客企业(**Agent中ProxyOrganizationOpenId表
794
796
  * 提交申请出证报告任务并返回报告ID。
795
797
 
796
798
  注意:
797
- <ul><li>使用此功能`需搭配出证套餐` ,使用前请联系对接的客户经理沟通。</li>
798
- <li>操作人必须是`发起方或者签署方企业的(非走授权书认证)法人或者超管`。</li>
799
- <li>合同流程必须所有参与方`已经签署完成`。</li>
800
- <li>出证过程需一定时间,建议在`提交出证任务后的24小时之后`,通过<a href="https://qian.tencent.com/developers/partnerApis/certificate/DescribeChannelFlowEvidenceReport" target="_blank">获取出证报告任务执行结果</a>接口进行查询执行结果和出证报告的下载URL。</li></ul>
799
+ - 使用此功能**需搭配出证套餐** ,使用前请联系对接的客户经理沟通。
800
+ - 操作人必须是**发起方或者签署方企业的(非走授权书认证)法人或者超管**。
801
+ - 合同流程必须**所有参与方已经签署完成**。
802
+ - 出证过程需一定时间,建议在**提交出证任务后的24小时之后**,通过<a href="https://qian.tencent.com/developers/partnerApis/certificate/DescribeChannelFlowEvidenceReport" target="_blank">获取出证报告任务执行结果</a>接口进行查询执行结果和出证报告的下载URL
803
+
801
804
 
802
- <svg id="SvgjsSvg1006" width="262" height="229" xmlns="http://www.w3.org/2000/svg" version="1.1" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svgjs="http://svgjs.com/svgjs"><defs id="SvgjsDefs1007"><pattern patternUnits="userSpaceOnUse" id="pattern_mark_0" width="300" height="300"><text x="150" y="100" fill="rgba(229,229,229,0.8)" font-size="18" transform="rotate(-45, 150, 150)" style="dominant-baseline: middle; text-anchor: middle;"></text></pattern><pattern patternUnits="userSpaceOnUse" id="pattern_mark_1" width="300" height="300"><text x="150" y="200" fill="rgba(229,229,229,0.8)" font-size="18" transform="rotate(-45, 150, 150)" style="dominant-baseline: middle; text-anchor: middle;"></text></pattern><marker id="SvgjsMarker1021" markerWidth="12" markerHeight="8" refX="9" refY="4" viewBox="0 0 12 8" orient="auto" markerUnits="userSpaceOnUse" stroke-dasharray="0,0"><path id="SvgjsPath1022" d="M0,0 L12,4 L0,8 L0,0" fill="#323232" stroke="#323232" stroke-width="1"></path></marker></defs><rect id="svgbackgroundid" width="262" height="229" fill="transparent"></rect><rect id="SvgjsRect1009" width="262" height="229" fill="url(#pattern_mark_0)"></rect><rect id="SvgjsRect1010" width="262" height="229" fill="url(#pattern_mark_1)"></rect><g id="SvgjsG1011" transform="translate(31.75,25)"><path id="SvgjsPath1012" d="M 0 0L 198 0L 198 59L 0 59Z" stroke="rgba(86,146,48,1)" stroke-width="1" fill-opacity="1" fill="#e7ebed"></path><g id="SvgjsG1013"><text id="SvgjsText1014" font-family="微软雅黑" text-anchor="middle" font-size="13px" width="178px" fill="#323232" font-weight="400" align="middle" lineHeight="125%" anchor="middle" family="微软雅黑" size="13px" weight="400" font-style="" opacity="1" y="10.375" transform="rotate(0)"><tspan id="SvgjsTspan1015" dy="16" x="99"><tspan id="SvgjsTspan1016" style="text-decoration:;fill: rgb(28, 30, 33);">CreateFlowEvidenceReport</tspan></tspan><tspan id="SvgjsTspan1017" dy="16" x="99"><tspan id="SvgjsTspan1018" style="text-decoration:;fill: rgb(51, 51, 51);">提交申请出证报告任务</tspan></tspan></text></g></g><g id="SvgjsG1019"><path id="SvgjsPath1020" d="M130.75 84.5L130.75 114.5L130.75 114.5L130.75 143.2" stroke="#323232" stroke-width="1" fill="none" marker-end="url(#SvgjsMarker1021)"></path></g><g id="SvgjsG1023" transform="translate(25,145)"><path id="SvgjsPath1024" d="M 0 0L 211.5 0L 211.5 59L 0 59Z" stroke="rgba(86,146,48,1)" stroke-width="1" fill-opacity="1" fill="#e7ebed"></path><g id="SvgjsG1025"><text id="SvgjsText1026" font-family="微软雅黑" text-anchor="middle" font-size="13px" width="192px" fill="#323232" font-weight="400" align="middle" lineHeight="125%" anchor="middle" family="微软雅黑" size="13px" weight="400" font-style="" opacity="1" y="10.375" transform="rotate(0)"><tspan id="SvgjsTspan1027" dy="16" x="106"><tspan id="SvgjsTspan1028" style="text-decoration:;fill: rgb(28, 30, 33);">DescribeFlowEvidenceReport</tspan></tspan><tspan id="SvgjsTspan1029" dy="16" x="106"><tspan id="SvgjsTspan1030" style="text-decoration:;fill: rgb(51, 51, 51);">获取出证报告任务执行结果</tspan></tspan></text></g></g></svg>
805
+ ![image](https://dyn.ess.tencent.cn/guide/capi/channel_CreateChannelFlowEvidenceReport.png)
803
806
  */
804
807
  async CreateChannelFlowEvidenceReport(
805
808
  req: CreateChannelFlowEvidenceReportRequest,
@@ -895,10 +898,14 @@ Web链接访问后,会根据子客企业(**Agent中ProxyOrganizationOpenId表
895
898
  }
896
899
 
897
900
  /**
898
- * 该接口用于发起合同后,生成C端签署人的签署链接<br/>
899
- 注意:该接口目前签署人类型仅支持个人签署方(PERSON)<br/>
900
- 注意:该接口可生成签署链接的C端签署人必须仅有手写签名和时间类型的签署控件<br/>
901
- 注意:该接口返回的签署链接是用于APP集成的场景,支持APP打开或浏览器直接打开,不支持微信小程序嵌入。微信小程序请使用小程序跳转或半屏弹窗的方式<br/>
901
+ * 该接口用于发起合同后,生成个人用户的签署链接, 暂时不支持企业端签署。 <br/>
902
+
903
+ `注意:`<br/>
904
+ `1. 该接口目前仅支持签署人类型是个人签署方的场景(PERSON)。` <br/>
905
+ `2. 该接口可生成签署链接的C端签署人必须仅有手写签名和时间类型的签署控件,不支持填写控件 。` <br/>
906
+ `3. 该签署链接有效期为30分钟,过期后将失效,如需签署可重新创建签署链接 。` <br/>
907
+ `4. 该接口返回的签署链接适用于APP集成的场景,支持APP打开或浏览器直接打开,不支持微信小程序嵌入`。<br/>
908
+ 跳转到小程序的实现,参考微信官方文档(分为<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>
902
909
  */
903
910
  async ChannelCreateFlowSignUrl(
904
911
  req: ChannelCreateFlowSignUrlRequest,
@@ -1236,8 +1243,15 @@ httpProfile.setEndpoint("file.test.ess.tencent.cn");
1236
1243
  }
1237
1244
 
1238
1245
  /**
1239
- * 查询出证报告,返回报告 URL。
1240
- */
1246
+ * 获取出证报告任务执行结果,返回报告 URL。
1247
+
1248
+ 注意:
1249
+
1250
+ - 使用此功能`需搭配出证套餐` ,使用前请联系对接的客户经理沟通。
1251
+ - 需调用创建并返回出证报告接口<a href="https://qian.tencent.com/developers/partnerApis/certificate/CreateChannelFlowEvidenceReport" target="_blank">提交申请出证报告任务</a>获取报告编号后调用当前接口获取报告链接。
1252
+
1253
+ ![image](https://dyn.ess.tencent.cn/guide/capi/channel_CreateChannelFlowEvidenceReport.png)
1254
+ */
1241
1255
  async DescribeChannelFlowEvidenceReport(
1242
1256
  req: DescribeChannelFlowEvidenceReportRequest,
1243
1257
  cb?: (error: string, rep: DescribeChannelFlowEvidenceReportResponse) => void
@@ -374,6 +374,8 @@ export interface ChannelDeleteSealPoliciesRequest {
374
374
  export interface ChannelBatchCancelFlowsResponse {
375
375
  /**
376
376
  * 签署流程批量撤销失败原因,错误信息与流程Id一一对应,成功为"", 失败则对应失败原因
377
+
378
+ 注: `如果全部撤销成功, 此数组为空数组`
377
379
  */
378
380
  FailMessages?: Array<string>
379
381
  /**
@@ -877,7 +879,7 @@ export interface ChannelCreateRoleRequest {
877
879
  */
878
880
  Description?: string
879
881
  /**
880
- * 权限树,权限树内容 PermissionGroups 可参考接口 DescribeIntegrationRoles 的输出
882
+ * 权限树,权限树内容 PermissionGroups 可参考接口 ChannelDescribeRoles 的输出
881
883
  */
882
884
  PermissionGroups?: Array<PermissionGroup>
883
885
  }
@@ -977,7 +979,7 @@ export interface ReleasedApprover {
977
979
  * 签署方经办人的证件类型,支持以下类型
978
980
  <ul><li>ID_CARD : 居民身份证 (默认值)</li>
979
981
  <li>HONGKONG_AND_MACAO : 港澳居民来往内地通行证</li>
980
- <li>HONGKONG_MACAO_AND_TAIWAN : 港澳台居民居住证(格式同居民身份证)</li>
982
+ <li>HONGKONG_MACAO_AND_TAIWAN : 港澳台居民居住证(格式同居民身份证)</li></ul>
981
983
  */
982
984
  IdCardType?: string
983
985
  /**
@@ -1246,27 +1248,34 @@ export interface DownloadFlowInfo {
1246
1248
  }
1247
1249
 
1248
1250
  /**
1249
- * 签署人签署链接信息
1251
+ * 签署人签署链接信息。
1250
1252
  */
1251
1253
  export interface FlowApproverUrlInfo {
1252
1254
  /**
1253
- * 签署短链接,不支持小程序嵌入,只支持移动端浏览器打开。注意该链接有效期为30分钟,同时需要注意保密,不要外泄给无关用户。
1255
+ * 签署短链接。</br>
1256
+ 注意:
1257
+ - 该链接有效期为**30分钟**,同时需要注意保密,不要外泄给无关用户。
1258
+ - 该链接不支持小程序嵌入,仅支持**移动端浏览器**打开。
1254
1259
  */
1255
- SignUrl: string
1260
+ SignUrl?: string
1256
1261
  /**
1257
- * 签署人类型 PERSON-个人
1262
+ * 签署人类型。
1263
+ - **PERSON**: 个人
1258
1264
  */
1259
- ApproverType: string
1265
+ ApproverType?: string
1260
1266
  /**
1261
- * 签署人姓名
1267
+ * 签署人姓名。
1262
1268
  */
1263
- Name: string
1269
+ Name?: string
1264
1270
  /**
1265
- * 签署人手机号
1271
+ * 签署人手机号。
1266
1272
  */
1267
- Mobile: string
1273
+ Mobile?: string
1268
1274
  /**
1269
- * 签署长链接,支持小程序嵌入。注意该链接有效期为30分钟,同时需要注意保密,不要外泄给无关用户。
1275
+ * 签署长链接。</br>
1276
+ 注意:
1277
+ - 该链接有效期为**30分钟**,同时需要注意保密,不要外泄给无关用户。
1278
+ - 该链接不支持小程序嵌入,仅支持**移动端浏览器**打开。
1270
1279
  注意:此字段可能返回 null,表示取不到有效值。
1271
1280
  */
1272
1281
  LongUrl?: string
@@ -2140,12 +2149,18 @@ export interface StaffRole {
2140
2149
  export interface ChannelVerifyPdfRequest {
2141
2150
  /**
2142
2151
  * 合同流程ID,为32位字符串。
2143
- 可登录腾讯电子签控制台,在 "合同"->"合同中心" 中查看某个合同的FlowId(在页面中展示为合同ID)。
2144
2152
  */
2145
2153
  FlowId: string
2146
2154
  /**
2147
- * 代理企业和员工的信息。
2148
- 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
2155
+ * 关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
2156
+
2157
+ 此接口下面信息必填。
2158
+ <ul>
2159
+ <li>渠道应用标识: Agent.AppId</li>
2160
+ <li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
2161
+ <li>第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId</li>
2162
+ </ul>
2163
+ 第三方平台子客企业和员工必须已经经过实名认证
2149
2164
  */
2150
2165
  Agent?: Agent
2151
2166
  /**
@@ -2160,14 +2175,15 @@ export interface ChannelVerifyPdfRequest {
2160
2175
  */
2161
2176
  export interface CreateChannelFlowEvidenceReportRequest {
2162
2177
  /**
2163
- * 员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
2178
+ * 关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
2164
2179
 
2165
2180
  此接口下面信息必填。
2166
2181
  <ul>
2167
- <li>渠道应用标识: Agent.ProxyOrganizationOpenId</li>
2168
- <li>第三方平台子客企业标识: Agent. ProxyOperator.OpenId</li>
2169
- <li>第三方平台子客企业中的员工标识: Agent.AppId</li>
2182
+ <li>渠道应用标识: Agent.AppId</li>
2183
+ <li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
2184
+ <li>第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId</li>
2170
2185
  </ul>
2186
+ 第三方平台子客企业和员工必须已经经过实名认证
2171
2187
  */
2172
2188
  Agent: Agent
2173
2189
  /**
@@ -2358,17 +2374,12 @@ export interface ChannelVerifyPdfResponse {
2358
2374
  <ul><li>**1**:文件未被篡改,全部签名在腾讯电子签完成。</li>
2359
2375
  <li>**2**:文件未被篡改,部分签名在腾讯电子签完成。</li>
2360
2376
  <li>**3**:文件被篡改。</li>
2361
- <li>**4**:异常:文件内没有签名域。</li>
2377
+ <li>**4**:异常:文件内没有签名域。(如果合同还没有签署也会返回此代码)</li>
2362
2378
  <li>**5**:异常:文件签名格式错误。</li></ul>
2363
2379
  */
2364
2380
  VerifyResult?: number
2365
2381
  /**
2366
- * 验签结果详情,每个签名域对应的验签结果。状态值如下
2367
- <ul><li> **1** :验签成功,在电子签签署</li>
2368
- <li> **2** :验签成功,在其他平台签署</li>
2369
- <li> **3** :验签失败</li>
2370
- <li> **4** :pdf文件没有签名域</li>
2371
- <li> **5** :文件签名格式错误</li></ul>
2382
+ * 验签结果详情,所有签署区(包括签名区, 印章区, 日期签署区,骑缝章等)的签署验签结果
2372
2383
  */
2373
2384
  PdfVerifyResults?: Array<PdfVerifyResult>
2374
2385
  /**
@@ -2731,65 +2742,82 @@ export interface ChannelCreateUserAutoSignSealUrlRequest {
2731
2742
  }
2732
2743
 
2733
2744
  /**
2734
- * 合同文件验签单个结果结构体
2745
+ * 合同验签每个签署区的信息
2735
2746
  */
2736
2747
  export interface PdfVerifyResult {
2737
2748
  /**
2738
- * 验签结果。0-签名域未签名;1-验签成功; 3-验签失败;4-未找到签名域:文件内没有签名域;5-签名值格式不正确。
2749
+ * 验签结果详情,每个签名域对应的验签结果。状态值如下
2750
+ <ul><li> **1** :验签成功,在电子签签署</li>
2751
+ <li> **2** :验签成功,在其他平台签署</li>
2752
+ <li> **3** :验签失败</li>
2753
+ <li> **4** :pdf文件没有签名域</li>
2754
+ <li> **5** :文件签名格式错误</li></ul>
2739
2755
  */
2740
- VerifyResult: number
2756
+ VerifyResult?: number
2741
2757
  /**
2742
- * 签署平台,如果文件是在腾讯电子签平台签署,则返回腾讯电子签,如果文件不在腾讯电子签平台签署,则返回其他平台。
2758
+ * 签署平台
2759
+ 如果文件是在腾讯电子签平台签署,则为**腾讯电子签**,
2760
+ 如果文件不在腾讯电子签平台签署,则为**其他平台**。
2743
2761
  */
2744
- SignPlatform: string
2762
+ SignPlatform?: string
2745
2763
  /**
2746
- * 签署人名称
2764
+ * 申请证书的主体的名字
2765
+
2766
+ 如果是在腾讯电子签平台签署, 则对应的主体的名字个数如下
2767
+ **企业**: ESS@企业名称@编码
2768
+ **个人**: ESS@个人姓名@证件号@808854
2769
+
2770
+ 如果在其他平台签署的, 主体的名字参考其他平台的说明
2747
2771
  */
2748
- SignerName: string
2772
+ SignerName?: string
2749
2773
  /**
2750
- * 签署时间戳,单位秒
2774
+ * 签署时间的Unix时间戳,单位毫秒
2751
2775
  */
2752
- SignTime: number
2776
+ SignTime?: number
2753
2777
  /**
2754
- * 签名算法
2778
+ * 证书签名算法, 如SHA1withRSA等算法
2755
2779
  */
2756
- SignAlgorithm: string
2780
+ SignAlgorithm?: string
2757
2781
  /**
2758
- * 签名证书序列号
2782
+ * CA供应商下发给用户的证书编号
2783
+
2784
+ 注意:`腾讯电子签接入多家CA供应商以提供容灾能力,不同CA下发的证书编号区别较大,但基本都是由数字和字母组成,长度在200以下`。
2759
2785
  */
2760
- CertSn: string
2786
+ CertSn?: string
2761
2787
  /**
2762
- * 证书起始时间戳,单位秒
2788
+ * 证书起始时间的Unix时间戳,单位毫秒
2763
2789
  */
2764
- CertNotBefore: number
2790
+ CertNotBefore?: number
2765
2791
  /**
2766
- * 证书过期时间戳,单位秒
2792
+ * 证书过期时间的时间戳,单位毫秒
2767
2793
  */
2768
- CertNotAfter: number
2794
+ CertNotAfter?: number
2769
2795
  /**
2770
- * 签名类型
2796
+ * 签名类型, 保留字段, 现在全部为0
2797
+
2798
+
2771
2799
  */
2772
- SignType: number
2800
+ SignType?: number
2773
2801
  /**
2774
2802
  * 签名域横坐标,单位px
2775
2803
  */
2776
- ComponentPosX: number
2804
+ ComponentPosX?: number
2777
2805
  /**
2778
2806
  * 签名域纵坐标,单位px
2779
2807
  */
2780
- ComponentPosY: number
2808
+ ComponentPosY?: number
2781
2809
  /**
2782
2810
  * 签名域宽度,单位px
2783
2811
  */
2784
- ComponentWidth: number
2812
+ ComponentWidth?: number
2785
2813
  /**
2786
2814
  * 签名域高度,单位px
2787
2815
  */
2788
- ComponentHeight: number
2816
+ ComponentHeight?: number
2789
2817
  /**
2790
2818
  * 签名域所在页码,1~N
2791
2819
  */
2792
- ComponentPage: number
2820
+ ComponentPage?: number
2793
2821
  }
2794
2822
 
2795
2823
  /**
@@ -4386,11 +4414,19 @@ export interface CreateFlowsByTemplatesResponse {
4386
4414
  */
4387
4415
  export interface DescribeChannelFlowEvidenceReportRequest {
4388
4416
  /**
4389
- * 应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 必填
4417
+ * 关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
4418
+
4419
+ 此接口下面信息必填。
4420
+ <ul>
4421
+ <li>渠道应用标识: Agent.AppId</li>
4422
+ <li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
4423
+ <li>第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId</li>
4424
+ </ul>
4425
+ 第三方平台子客企业和员工必须已经经过实名认证
4390
4426
  */
4391
4427
  Agent: Agent
4392
4428
  /**
4393
- * 出证报告编号
4429
+ * 签署报告编号, 由<a href="https://qian.tencent.com/developers/partnerApis/certificate/CreateChannelFlowEvidenceReport" target="_blank">提交申请出证报告任务</a>产生
4394
4430
  */
4395
4431
  ReportId: string
4396
4432
  /**
@@ -5045,7 +5081,7 @@ export interface ProxyOrganizationOperator {
5045
5081
  * 签署方经办人的证件类型,支持以下类型
5046
5082
  <ul><li>ID_CARD : 居民身份证 (默认值)</li>
5047
5083
  <li>HONGKONG_AND_MACAO : 港澳居民来往内地通行证</li>
5048
- <li>HONGKONG_MACAO_AND_TAIWAN : 港澳台居民居住证(格式同居民身份证)</li>
5084
+ <li>HONGKONG_MACAO_AND_TAIWAN : 港澳台居民居住证(格式同居民身份证)</li></ul>
5049
5085
 
5050
5086
  */
5051
5087
  IdCardType?: string
@@ -5438,7 +5474,7 @@ export interface ChannelModifyRoleRequest {
5438
5474
  */
5439
5475
  Description?: string
5440
5476
  /**
5441
- * 权限树,权限树内容 PermissionGroups 可参考接口 DescribeIntegrationRoles 的输出
5477
+ * 权限树,权限树内容 PermissionGroups 可参考接口 ChannelDescribeRoles的输出
5442
5478
  */
5443
5479
  PermissionGroups?: Array<PermissionGroup>
5444
5480
  }
@@ -6125,16 +6161,16 @@ export interface ChannelCreateReleaseFlowResponse {
6125
6161
  */
6126
6162
  export interface DescribeChannelFlowEvidenceReportResponse {
6127
6163
  /**
6128
- * 出证报告下载 URL
6164
+ * 出证报告PDF的下载 URL,有效期为5分钟,超过有效期后将无法再下载。
6129
6165
  注意:此字段可能返回 null,表示取不到有效值。
6130
6166
  */
6131
6167
  ReportUrl?: string
6132
6168
  /**
6133
- * 出征任务的执行状态,状态列表如下
6169
+ * 出证任务执行的状态, 状态含义如下:
6134
6170
 
6135
- - EvidenceStatusExecuting : 出征任务正在执行中
6136
- - EvidenceStatusSuccess : 出征任务执行成功
6137
- - EvidenceStatusFailed : 出征任务执行失败
6171
+ <ul><li>**EvidenceStatusExecuting**: 出证任务在执行中</li>
6172
+ <li>**EvidenceStatusSuccess**: 出证任务执行成功</li>
6173
+ <li>**EvidenceStatusFailed** 出征任务执行失败</li></ul>
6138
6174
  */
6139
6175
  Status?: string
6140
6176
  /**
@@ -6265,15 +6301,28 @@ export interface ChannelUpdateSealStatusResponse {
6265
6301
  */
6266
6302
  export interface ChannelCreateFlowSignUrlRequest {
6267
6303
  /**
6268
- * 应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 必填
6304
+ * 关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
6305
+
6306
+ 此接口下面信息必填。
6307
+ <ul>
6308
+ <li>渠道应用标识: Agent.AppId</li>
6309
+ <li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
6310
+ <li>第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId</li>
6311
+ </ul>
6312
+ 第三方平台子客企业和员工必须已经经过实名认证
6269
6313
  */
6270
6314
  Agent: Agent
6271
6315
  /**
6272
- * 流程编号
6316
+ * 合同流程ID,为32位字符串。
6317
+ 建议开发者妥善保存此流程ID,以便于顺利进行后续操作。
6318
+ 可登录腾讯电子签控制台,在 "合同"->"合同中心" 中查看某个合同的FlowId(在页面中展示为合同ID)。
6273
6319
  */
6274
6320
  FlowId: string
6275
6321
  /**
6276
- * 流程签署人,其中Name和Mobile必传,其他可不传,ApproverType目前只支持PERSON类型的签署人,如果不传默认为该值。还需注意签署人只能有手写签名和时间类型的签署控件,其他类型的填写控件和签署控件暂时都未支持。
6322
+ * 流程签署人列表,其中结构体的Name,Mobile和ApproverType必传,其他可不传。
6323
+ 注:
6324
+ `1. ApproverType目前只支持个人(PERSON)类型的签署人。`
6325
+ `2. 签署人只能有手写签名和时间类型的签署控件,其他类型的填写控件和签署控件暂时都未支持。`
6277
6326
  */
6278
6327
  FlowApproverInfos: Array<FlowApproverInfo>
6279
6328
  /**
@@ -6287,7 +6336,7 @@ export interface ChannelCreateFlowSignUrlRequest {
6287
6336
  */
6288
6337
  Organization?: OrganizationInfo
6289
6338
  /**
6290
- * 签署完之后的H5页面的跳转链接,此链接支持http://和https://,最大长度1000个字符。
6339
+ * 签署完之后的H5页面的跳转链接,此链接及支持http://和https://,最大长度1000个字符。(建议https协议)
6291
6340
  */
6292
6341
  JumpUrl?: string
6293
6342
  }