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.
- package/CHANGELOG.md +123 -0
- package/SERVICE_CHANGELOG.md +144 -51
- package/package.json +1 -1
- package/products.md +15 -15
- package/src/common/sdk_version.ts +1 -1
- package/src/services/aiart/v20221229/aiart_models.ts +13 -5
- package/src/services/ccc/v20200210/ccc_models.ts +6 -2
- package/src/services/ckafka/v20190819/ckafka_models.ts +1 -1
- package/src/services/clb/v20180317/clb_models.ts +4 -6
- package/src/services/ess/v20201111/ess_client.ts +7 -3
- package/src/services/ess/v20201111/ess_models.ts +38 -30
- package/src/services/essbasic/v20210526/essbasic_client.ts +25 -11
- package/src/services/essbasic/v20210526/essbasic_models.ts +112 -63
- package/src/services/lighthouse/v20200324/lighthouse_client.ts +29 -2
- package/src/services/lighthouse/v20200324/lighthouse_models.ts +98 -50
- package/src/services/ses/v20201002/ses_models.ts +5 -1
- package/src/services/tione/v20211111/tione_models.ts +1 -1
- package/src/services/waf/v20180125/waf_client.ts +19 -6
- package/src/services/waf/v20180125/waf_models.ts +92 -0
- package/src/services/wedata/v20210820/wedata_models.ts +14 -2
- package/tencentcloud/common/sdk_version.d.ts +1 -1
- package/tencentcloud/common/sdk_version.js +1 -1
- package/tencentcloud/services/aiart/v20221229/aiart_models.d.ts +13 -5
- package/tencentcloud/services/ccc/v20200210/ccc_models.d.ts +6 -2
- package/tencentcloud/services/ckafka/v20190819/ckafka_models.d.ts +1 -1
- package/tencentcloud/services/clb/v20180317/clb_models.d.ts +4 -6
- package/tencentcloud/services/ess/v20201111/ess_client.d.ts +7 -3
- package/tencentcloud/services/ess/v20201111/ess_client.js +7 -3
- package/tencentcloud/services/ess/v20201111/ess_models.d.ts +38 -30
- package/tencentcloud/services/essbasic/v20210526/essbasic_client.d.ts +24 -10
- package/tencentcloud/services/essbasic/v20210526/essbasic_client.js +24 -10
- package/tencentcloud/services/essbasic/v20210526/essbasic_models.d.ts +112 -63
- package/tencentcloud/services/lighthouse/v20200324/lighthouse_client.d.ts +12 -1
- package/tencentcloud/services/lighthouse/v20200324/lighthouse_client.js +15 -0
- package/tencentcloud/services/lighthouse/v20200324/lighthouse_models.d.ts +94 -50
- package/tencentcloud/services/ses/v20201002/ses_models.d.ts +6 -1
- package/tencentcloud/services/tione/v20211111/tione_models.d.ts +1 -1
- package/tencentcloud/services/waf/v20180125/waf_client.d.ts +7 -3
- package/tencentcloud/services/waf/v20180125/waf_client.js +9 -3
- package/tencentcloud/services/waf/v20180125/waf_models.d.ts +89 -0
- package/tencentcloud/services/wedata/v20210820/wedata_models.d.ts +14 -2
- package/test/lighthouse.v20200324.test.js +20 -0
- 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:超强型
|
|
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:超强型
|
|
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
|
|
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
|
+

|
|
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
|
-
|
|
410
|
+
* 签署短链接。</br>
|
|
411
|
+
注意:
|
|
412
|
+
- 该链接有效期为**30分钟**,同时需要注意保密,不要外泄给无关用户。
|
|
413
|
+
- 该链接不支持小程序嵌入,仅支持**移动端浏览器**打开。
|
|
414
414
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
415
415
|
*/
|
|
416
416
|
SignUrl?: string
|
|
417
417
|
/**
|
|
418
|
-
*
|
|
419
|
-
|
|
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
|
-
|
|
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
|
-
* 签名域横坐标,单位
|
|
2426
|
+
* 签名域横坐标,单位px
|
|
2417
2427
|
*/
|
|
2418
2428
|
ComponentPosX?: number
|
|
2419
2429
|
/**
|
|
2420
|
-
* 签名域纵坐标,单位
|
|
2430
|
+
* 签名域纵坐标,单位px
|
|
2421
2431
|
*/
|
|
2422
2432
|
ComponentPosY?: number
|
|
2423
2433
|
/**
|
|
2424
|
-
* 签名域宽度,单位
|
|
2434
|
+
* 签名域宽度,单位px
|
|
2425
2435
|
*/
|
|
2426
2436
|
ComponentWidth?: number
|
|
2427
2437
|
/**
|
|
2428
|
-
* 签名域高度,单位
|
|
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
|
+

|
|
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
|
-
|
|
798
|
-
|
|
799
|
-
|
|
800
|
-
|
|
799
|
+
- 使用此功能**需搭配出证套餐** ,使用前请联系对接的客户经理沟通。
|
|
800
|
+
- 操作人必须是**发起方或者签署方企业的(非走授权书认证)法人或者超管**。
|
|
801
|
+
- 合同流程必须**所有参与方已经签署完成**。
|
|
802
|
+
- 出证过程需一定时间,建议在**提交出证任务后的24小时之后**,通过<a href="https://qian.tencent.com/developers/partnerApis/certificate/DescribeChannelFlowEvidenceReport" target="_blank">获取出证报告任务执行结果</a>接口进行查询执行结果和出证报告的下载URL。
|
|
803
|
+
|
|
801
804
|
|
|
802
|
-
|
|
805
|
+

|
|
803
806
|
*/
|
|
804
807
|
async CreateChannelFlowEvidenceReport(
|
|
805
808
|
req: CreateChannelFlowEvidenceReportRequest,
|
|
@@ -895,10 +898,14 @@ Web链接访问后,会根据子客企业(**Agent中ProxyOrganizationOpenId表
|
|
|
895
898
|
}
|
|
896
899
|
|
|
897
900
|
/**
|
|
898
|
-
*
|
|
899
|
-
|
|
900
|
-
|
|
901
|
-
|
|
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
|
-
|
|
1240
|
-
|
|
1246
|
+
* 获取出证报告任务执行结果,返回报告 URL。
|
|
1247
|
+
|
|
1248
|
+
注意:
|
|
1249
|
+
|
|
1250
|
+
- 使用此功能`需搭配出证套餐` ,使用前请联系对接的客户经理沟通。
|
|
1251
|
+
- 需调用创建并返回出证报告接口<a href="https://qian.tencent.com/developers/partnerApis/certificate/CreateChannelFlowEvidenceReport" target="_blank">提交申请出证报告任务</a>获取报告编号后调用当前接口获取报告链接。
|
|
1252
|
+
|
|
1253
|
+

|
|
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 可参考接口
|
|
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
|
-
*
|
|
1255
|
+
* 签署短链接。</br>
|
|
1256
|
+
注意:
|
|
1257
|
+
- 该链接有效期为**30分钟**,同时需要注意保密,不要外泄给无关用户。
|
|
1258
|
+
- 该链接不支持小程序嵌入,仅支持**移动端浏览器**打开。
|
|
1254
1259
|
*/
|
|
1255
|
-
SignUrl
|
|
1260
|
+
SignUrl?: string
|
|
1256
1261
|
/**
|
|
1257
|
-
*
|
|
1262
|
+
* 签署人类型。
|
|
1263
|
+
- **PERSON**: 个人
|
|
1258
1264
|
*/
|
|
1259
|
-
ApproverType
|
|
1265
|
+
ApproverType?: string
|
|
1260
1266
|
/**
|
|
1261
|
-
*
|
|
1267
|
+
* 签署人姓名。
|
|
1262
1268
|
*/
|
|
1263
|
-
Name
|
|
1269
|
+
Name?: string
|
|
1264
1270
|
/**
|
|
1265
|
-
*
|
|
1271
|
+
* 签署人手机号。
|
|
1266
1272
|
*/
|
|
1267
|
-
Mobile
|
|
1273
|
+
Mobile?: string
|
|
1268
1274
|
/**
|
|
1269
|
-
*
|
|
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
|
-
|
|
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
|
-
*
|
|
2178
|
+
* 关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
|
|
2164
2179
|
|
|
2165
2180
|
此接口下面信息必填。
|
|
2166
2181
|
<ul>
|
|
2167
|
-
<li>渠道应用标识: Agent.
|
|
2168
|
-
<li>第三方平台子客企业标识: Agent.
|
|
2169
|
-
<li>第三方平台子客企业中的员工标识: Agent.
|
|
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
|
|
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
|
-
*
|
|
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
|
|
2756
|
+
VerifyResult?: number
|
|
2741
2757
|
/**
|
|
2742
|
-
*
|
|
2758
|
+
* 签署平台
|
|
2759
|
+
如果文件是在腾讯电子签平台签署,则为**腾讯电子签**,
|
|
2760
|
+
如果文件不在腾讯电子签平台签署,则为**其他平台**。
|
|
2743
2761
|
*/
|
|
2744
|
-
SignPlatform
|
|
2762
|
+
SignPlatform?: string
|
|
2745
2763
|
/**
|
|
2746
|
-
*
|
|
2764
|
+
* 申请证书的主体的名字
|
|
2765
|
+
|
|
2766
|
+
如果是在腾讯电子签平台签署, 则对应的主体的名字个数如下
|
|
2767
|
+
**企业**: ESS@企业名称@编码
|
|
2768
|
+
**个人**: ESS@个人姓名@证件号@808854
|
|
2769
|
+
|
|
2770
|
+
如果在其他平台签署的, 主体的名字参考其他平台的说明
|
|
2747
2771
|
*/
|
|
2748
|
-
SignerName
|
|
2772
|
+
SignerName?: string
|
|
2749
2773
|
/**
|
|
2750
|
-
*
|
|
2774
|
+
* 签署时间的Unix时间戳,单位毫秒
|
|
2751
2775
|
*/
|
|
2752
|
-
SignTime
|
|
2776
|
+
SignTime?: number
|
|
2753
2777
|
/**
|
|
2754
|
-
*
|
|
2778
|
+
* 证书签名算法, 如SHA1withRSA等算法
|
|
2755
2779
|
*/
|
|
2756
|
-
SignAlgorithm
|
|
2780
|
+
SignAlgorithm?: string
|
|
2757
2781
|
/**
|
|
2758
|
-
*
|
|
2782
|
+
* CA供应商下发给用户的证书编号
|
|
2783
|
+
|
|
2784
|
+
注意:`腾讯电子签接入多家CA供应商以提供容灾能力,不同CA下发的证书编号区别较大,但基本都是由数字和字母组成,长度在200以下`。
|
|
2759
2785
|
*/
|
|
2760
|
-
CertSn
|
|
2786
|
+
CertSn?: string
|
|
2761
2787
|
/**
|
|
2762
|
-
*
|
|
2788
|
+
* 证书起始时间的Unix时间戳,单位毫秒
|
|
2763
2789
|
*/
|
|
2764
|
-
CertNotBefore
|
|
2790
|
+
CertNotBefore?: number
|
|
2765
2791
|
/**
|
|
2766
|
-
*
|
|
2792
|
+
* 证书过期时间的时间戳,单位毫秒
|
|
2767
2793
|
*/
|
|
2768
|
-
CertNotAfter
|
|
2794
|
+
CertNotAfter?: number
|
|
2769
2795
|
/**
|
|
2770
|
-
*
|
|
2796
|
+
* 签名类型, 保留字段, 现在全部为0
|
|
2797
|
+
|
|
2798
|
+
|
|
2771
2799
|
*/
|
|
2772
|
-
SignType
|
|
2800
|
+
SignType?: number
|
|
2773
2801
|
/**
|
|
2774
2802
|
* 签名域横坐标,单位px
|
|
2775
2803
|
*/
|
|
2776
|
-
ComponentPosX
|
|
2804
|
+
ComponentPosX?: number
|
|
2777
2805
|
/**
|
|
2778
2806
|
* 签名域纵坐标,单位px
|
|
2779
2807
|
*/
|
|
2780
|
-
ComponentPosY
|
|
2808
|
+
ComponentPosY?: number
|
|
2781
2809
|
/**
|
|
2782
2810
|
* 签名域宽度,单位px
|
|
2783
2811
|
*/
|
|
2784
|
-
ComponentWidth
|
|
2812
|
+
ComponentWidth?: number
|
|
2785
2813
|
/**
|
|
2786
2814
|
* 签名域高度,单位px
|
|
2787
2815
|
*/
|
|
2788
|
-
ComponentHeight
|
|
2816
|
+
ComponentHeight?: number
|
|
2789
2817
|
/**
|
|
2790
2818
|
* 签名域所在页码,1~N
|
|
2791
2819
|
*/
|
|
2792
|
-
ComponentPage
|
|
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
|
-
*
|
|
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 可参考接口
|
|
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
|
-
*
|
|
6164
|
+
* 出证报告PDF的下载 URL,有效期为5分钟,超过有效期后将无法再下载。
|
|
6129
6165
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
6130
6166
|
*/
|
|
6131
6167
|
ReportUrl?: string
|
|
6132
6168
|
/**
|
|
6133
|
-
*
|
|
6169
|
+
* 出证任务执行的状态, 状态含义如下:
|
|
6134
6170
|
|
|
6135
|
-
|
|
6136
|
-
|
|
6137
|
-
|
|
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
|
-
*
|
|
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
|
-
*
|
|
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
|
|
6339
|
+
* 签署完之后的H5页面的跳转链接,此链接及支持http://和https://,最大长度1000个字符。(建议https协议)
|
|
6291
6340
|
*/
|
|
6292
6341
|
JumpUrl?: string
|
|
6293
6342
|
}
|