tencentcloud-sdk-nodejs 4.0.684 → 4.0.686
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 +515 -0
- package/SERVICE_CHANGELOG.md +824 -140
- package/package.json +1 -1
- package/products.md +26 -26
- package/src/common/sdk_version.ts +1 -1
- package/src/services/antiddos/v20200309/antiddos_client.ts +1 -1
- package/src/services/antiddos/v20200309/antiddos_models.ts +1 -1
- package/src/services/as/v20180419/as_models.ts +4 -0
- package/src/services/cdc/v20201214/cdc_client.ts +1 -0
- package/src/services/cdc/v20201214/cdc_models.ts +72 -5
- package/src/services/cdn/v20180606/cdn_models.ts +2 -2
- package/src/services/cfw/v20190904/cfw_client.ts +113 -15
- package/src/services/cfw/v20190904/cfw_models.ts +584 -148
- package/src/services/clb/v20180317/clb_models.ts +1 -1
- package/src/services/csip/v20221121/csip_models.ts +5 -0
- package/src/services/dnspod/v20210323/dnspod_models.ts +1 -1
- package/src/services/ess/v20201111/ess_client.ts +37 -18
- package/src/services/ess/v20201111/ess_models.ts +100 -40
- package/src/services/essbasic/v20210526/essbasic_client.ts +1 -0
- package/src/services/essbasic/v20210526/essbasic_models.ts +53 -1
- package/src/services/iai/v20180301/iai_client.ts +0 -2
- package/src/services/iai/v20180301/iai_models.ts +13 -17
- package/src/services/iai/v20200303/iai_models.ts +1 -5
- package/src/services/lcic/v20220817/lcic_models.ts +5 -1
- package/src/services/monitor/v20180724/monitor_models.ts +2 -2
- package/src/services/mrs/v20200910/mrs_client.ts +90 -16
- package/src/services/mrs/v20200910/mrs_models.ts +2328 -782
- package/src/services/ocr/v20181119/ocr_models.ts +8 -0
- package/src/services/ses/v20201002/ses_client.ts +13 -0
- package/src/services/ses/v20201002/ses_models.ts +58 -0
- package/src/services/sqlserver/v20180328/sqlserver_client.ts +25 -0
- package/src/services/sqlserver/v20180328/sqlserver_models.ts +107 -0
- package/src/services/ssa/v20180608/ssa_client.ts +14 -0
- package/src/services/ssa/v20180608/ssa_models.ts +86 -0
- package/src/services/ssl/v20191205/ssl_models.ts +65 -38
- package/src/services/tcr/v20190924/tcr_client.ts +1 -1
- package/src/services/tcr/v20190924/tcr_models.ts +9 -3
- package/src/services/trocket/v20230308/trocket_client.ts +129 -18
- package/src/services/trocket/v20230308/trocket_models.ts +705 -256
- package/src/services/tsf/v20180326/tsf_models.ts +40 -20
- package/src/services/vod/v20180717/vod_client.ts +44 -6
- package/src/services/vod/v20180717/vod_models.ts +286 -170
- package/src/services/vpc/v20170312/vpc_models.ts +16 -0
- package/src/services/waf/v20180125/waf_models.ts +28 -1
- package/tencentcloud/common/sdk_version.d.ts +1 -1
- package/tencentcloud/common/sdk_version.js +1 -1
- package/tencentcloud/services/antiddos/v20200309/antiddos_client.d.ts +1 -1
- package/tencentcloud/services/antiddos/v20200309/antiddos_client.js +1 -1
- package/tencentcloud/services/antiddos/v20200309/antiddos_models.d.ts +1 -1
- package/tencentcloud/services/as/v20180419/as_models.d.ts +4 -0
- package/tencentcloud/services/cdc/v20201214/cdc_models.d.ts +71 -5
- package/tencentcloud/services/cdn/v20180606/cdn_models.d.ts +2 -2
- package/tencentcloud/services/cfw/v20190904/cfw_client.d.ts +35 -3
- package/tencentcloud/services/cfw/v20190904/cfw_client.js +51 -3
- package/tencentcloud/services/cfw/v20190904/cfw_models.d.ts +566 -148
- package/tencentcloud/services/clb/v20180317/clb_models.d.ts +1 -1
- package/tencentcloud/services/csip/v20221121/csip_models.d.ts +5 -0
- package/tencentcloud/services/dnspod/v20210323/dnspod_models.d.ts +1 -1
- package/tencentcloud/services/ess/v20201111/ess_client.d.ts +33 -15
- package/tencentcloud/services/ess/v20201111/ess_client.js +33 -15
- package/tencentcloud/services/ess/v20201111/ess_models.d.ts +99 -40
- package/tencentcloud/services/essbasic/v20210526/essbasic_models.d.ts +52 -1
- package/tencentcloud/services/iai/v20180301/iai_client.d.ts +0 -2
- package/tencentcloud/services/iai/v20180301/iai_client.js +0 -2
- package/tencentcloud/services/iai/v20180301/iai_models.d.ts +13 -17
- package/tencentcloud/services/iai/v20200303/iai_models.d.ts +1 -5
- package/tencentcloud/services/lcic/v20220817/lcic_models.d.ts +5 -1
- package/tencentcloud/services/monitor/v20180724/monitor_models.d.ts +2 -2
- package/tencentcloud/services/mrs/v20200910/mrs_client.d.ts +5 -1
- package/tencentcloud/services/mrs/v20200910/mrs_client.js +6 -0
- package/tencentcloud/services/mrs/v20200910/mrs_models.d.ts +2272 -790
- package/tencentcloud/services/ocr/v20181119/ocr_models.d.ts +8 -0
- package/tencentcloud/services/ses/v20201002/ses_client.d.ts +5 -1
- package/tencentcloud/services/ses/v20201002/ses_client.js +6 -0
- package/tencentcloud/services/ses/v20201002/ses_models.d.ts +55 -0
- package/tencentcloud/services/sqlserver/v20180328/sqlserver_client.d.ts +9 -1
- package/tencentcloud/services/sqlserver/v20180328/sqlserver_client.js +12 -0
- package/tencentcloud/services/sqlserver/v20180328/sqlserver_models.d.ts +102 -0
- package/tencentcloud/services/ssa/v20180608/ssa_client.d.ts +5 -1
- package/tencentcloud/services/ssa/v20180608/ssa_client.js +6 -0
- package/tencentcloud/services/ssa/v20180608/ssa_models.d.ts +82 -0
- package/tencentcloud/services/ssl/v20191205/ssl_models.d.ts +65 -38
- package/tencentcloud/services/tcr/v20190924/tcr_client.d.ts +1 -1
- package/tencentcloud/services/tcr/v20190924/tcr_client.js +1 -1
- package/tencentcloud/services/tcr/v20190924/tcr_models.d.ts +9 -3
- package/tencentcloud/services/trocket/v20230308/trocket_client.d.ts +41 -3
- package/tencentcloud/services/trocket/v20230308/trocket_client.js +59 -3
- package/tencentcloud/services/trocket/v20230308/trocket_models.d.ts +665 -235
- package/tencentcloud/services/tsf/v20180326/tsf_models.d.ts +40 -20
- package/tencentcloud/services/vod/v20180717/vod_client.d.ts +13 -1
- package/tencentcloud/services/vod/v20180717/vod_client.js +18 -0
- package/tencentcloud/services/vod/v20180717/vod_models.d.ts +278 -170
- package/tencentcloud/services/vpc/v20170312/vpc_models.d.ts +16 -0
- package/tencentcloud/services/waf/v20180125/waf_models.d.ts +27 -0
- package/test/cfw.v20190904.test.js +82 -2
- package/test/mrs.v20200910.test.js +10 -0
- package/test/ses.v20201002.test.js +10 -0
- package/test/sqlserver.v20180328.test.js +20 -0
- package/test/ssa.v20180608.test.js +10 -0
- package/test/trocket.v20230308.test.js +92 -2
- package/test/vod.v20180717.test.js +30 -0
|
@@ -225,7 +225,7 @@ OPEN:公网属性, INTERNAL:内网属性。
|
|
|
225
225
|
*/
|
|
226
226
|
InternetAccessible?: InternetAccessible
|
|
227
227
|
/**
|
|
228
|
-
*
|
|
228
|
+
* 仅适用于公网负载均衡。目前仅广州、上海、南京、济南、杭州、福州、北京、石家庄、武汉、长沙、成都、重庆地域支持静态单线 IP 线路类型,如需体验,请联系商务经理申请。申请通过后,即可选择中国移动(CMCC)、中国联通(CUCC)或中国电信(CTCC)的运营商类型,网络计费模式只能使用按带宽包计费(BANDWIDTH_PACKAGE)。 如果不指定本参数,则默认使用BGP。可通过 [DescribeResources](https://cloud.tencent.com/document/api/214/70213) 接口查询一个地域所支持的Isp。
|
|
229
229
|
*/
|
|
230
230
|
VipIsp?: string
|
|
231
231
|
/**
|
|
@@ -75,6 +75,7 @@ import {
|
|
|
75
75
|
BindEmployeeUserIdWithClientOpenIdRequest,
|
|
76
76
|
DescribeIntegrationDepartmentsRequest,
|
|
77
77
|
Permission,
|
|
78
|
+
ComponentLimit,
|
|
78
79
|
CreateIntegrationDepartmentResponse,
|
|
79
80
|
DescribeFlowTemplatesRequest,
|
|
80
81
|
DeleteSealPoliciesResponse,
|
|
@@ -553,14 +554,16 @@ export class Client extends AbstractClient {
|
|
|
553
554
|
}
|
|
554
555
|
|
|
555
556
|
/**
|
|
556
|
-
*
|
|
557
|
-
|
|
558
|
-
|
|
559
|
-
|
|
560
|
-
|
|
561
|
-
|
|
562
|
-
|
|
563
|
-
|
|
557
|
+
* 发起解除协议的主要应用场景为:基于一份已经签署的合同(签署流程),进行解除操作。
|
|
558
|
+
解除协议的模板是官方提供 ,经过提供法务审核,暂不支持自定义。
|
|
559
|
+
|
|
560
|
+
注意:
|
|
561
|
+
<ul><li><code>原合同必须签署完</code>成后才能发起解除协议。</li>
|
|
562
|
+
<li>只有原合同企业类型的参与人才能发起解除协议,<code>个人参与方不能发起解除协议</code>。</li>
|
|
563
|
+
<li>原合同个人类型参与人必须是解除协议的参与人,<code>不能更换其他第三方个人</code>参与解除协议。</li>
|
|
564
|
+
<li>如果原合同企业参与人无法参与解除协议,可以指定同企业具有同等权限的<code>企业员工代为处理</code>。</li>
|
|
565
|
+
<li>发起解除协议同发起其他企业合同一样,也会参与合同<code>扣费</code>,扣费标准同其他类型合同。</li>
|
|
566
|
+
<li>在解除协议发起之后,原合同的状态将转变为解除中。一旦解除协议签署完毕,原合同及解除协议均变为已解除状态。</li></ul>
|
|
564
567
|
*/
|
|
565
568
|
async CreateReleaseFlow(
|
|
566
569
|
req: CreateReleaseFlowRequest,
|
|
@@ -728,10 +731,12 @@ httpProfile.setEndpoint("file.test.ess.tencent.cn");<br/>
|
|
|
728
731
|
/**
|
|
729
732
|
* 该接口用于发起合同后,生成个人用户的签署链接, 暂时不支持企业端签署 <br/>
|
|
730
733
|
|
|
731
|
-
|
|
732
|
-
`1. 该接口目前仅支持签署人类型是个人签署方的场景(PERSON
|
|
733
|
-
`2. 该接口可生成签署链接的C端签署人必须仅有手写签名和时间类型的签署控件,不支持填写控件
|
|
734
|
-
`3.
|
|
734
|
+
`注意:`<br/>
|
|
735
|
+
`1. 该接口目前仅支持签署人类型是个人签署方的场景(PERSON)。` <br/>
|
|
736
|
+
`2. 该接口可生成签署链接的C端签署人必须仅有手写签名和时间类型的签署控件,不支持填写控件 。` <br/>
|
|
737
|
+
`3. 该签署链接有效期为30分钟,过期后将失效,如需签署可重新创建签署链接 。` <br/>
|
|
738
|
+
`4. 该接口返回的签署链接是用于APP集成的场景,支持APP打开或浏览器直接打开,不支持微信小程序嵌入`。<br/>
|
|
739
|
+
跳转到小程序的实现,参考微信官方文档(分为<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>
|
|
735
740
|
*/
|
|
736
741
|
async CreateFlowSignUrl(
|
|
737
742
|
req: CreateFlowSignUrlRequest,
|
|
@@ -741,8 +746,14 @@ httpProfile.setEndpoint("file.test.ess.tencent.cn");<br/>
|
|
|
741
746
|
}
|
|
742
747
|
|
|
743
748
|
/**
|
|
744
|
-
|
|
745
|
-
|
|
749
|
+
* 获取个人用户认证证书图片下载URL
|
|
750
|
+
|
|
751
|
+
个人用户认证证书图片样式如下图
|
|
752
|
+
|
|
753
|
+

|
|
754
|
+
|
|
755
|
+
注: `只能获取个人用户证明图片, 企业员工的暂不支持`
|
|
756
|
+
*/
|
|
746
757
|
async CreatePersonAuthCertificateImage(
|
|
747
758
|
req: CreatePersonAuthCertificateImageRequest,
|
|
748
759
|
cb?: (error: string, rep: CreatePersonAuthCertificateImageResponse) => void
|
|
@@ -757,7 +768,7 @@ httpProfile.setEndpoint("file.test.ess.tencent.cn");<br/>
|
|
|
757
768
|
适用场景2:已经上传了一个jpg图片文件,希望将该图片文件转换成pdf文件后发起合同<br />
|
|
758
769
|
转换文件是一个耗时操作,若想查看转换任务是否完成,可以通过<a href="https://qian.tencent.com/developers/companyApis/templatesAndFiles/GetTaskResultApi" target="_blank">查询转换任务状态</a>接口获取任务状态。<br />
|
|
759
770
|
注:
|
|
760
|
-
1. `支持的文件类型有doc
|
|
771
|
+
1. `支持的文件类型有doc、docx、xls、xlsx、jpg、jpeg、png、bmp、txt`
|
|
761
772
|
2. `可通过发起合同时设置预览来检查转换文件是否达到预期效果`
|
|
762
773
|
*/
|
|
763
774
|
async CreateConvertTaskApi(
|
|
@@ -770,7 +781,8 @@ httpProfile.setEndpoint("file.test.ess.tencent.cn");<br/>
|
|
|
770
781
|
/**
|
|
771
782
|
* 查询流程基础信息
|
|
772
783
|
适用场景:可用于主动查询某个合同流程的签署状态信息。可以配合回调通知使用。
|
|
773
|
-
|
|
784
|
+
|
|
785
|
+
注: `每个企业限制日调用量限制:100W,当日超过此限制后再调用接口返回错误`
|
|
774
786
|
*/
|
|
775
787
|
async DescribeFlowBriefs(
|
|
776
788
|
req: DescribeFlowBriefsRequest,
|
|
@@ -868,8 +880,15 @@ httpProfile.setEndpoint("file.test.ess.tencent.cn");<br/>
|
|
|
868
880
|
}
|
|
869
881
|
|
|
870
882
|
/**
|
|
871
|
-
|
|
872
|
-
|
|
883
|
+
* 通过AuthCode查询个人用户是否实名
|
|
884
|
+
|
|
885
|
+
|
|
886
|
+
注意:
|
|
887
|
+
<ul>
|
|
888
|
+
<li>此接口为合作引流场景使用,使用`有白名单限制`,使用前请联系对接的客户经理沟通。</li>
|
|
889
|
+
<li>`AuthCode 只能使用一次`,查询一次再次查询会返回错误</li>
|
|
890
|
+
</ul>
|
|
891
|
+
*/
|
|
873
892
|
async DescribeThirdPartyAuthCode(
|
|
874
893
|
req: DescribeThirdPartyAuthCodeRequest,
|
|
875
894
|
cb?: (error: string, rep: DescribeThirdPartyAuthCodeResponse) => void
|
|
@@ -406,7 +406,10 @@ export interface ReviewerInfo {
|
|
|
406
406
|
*/
|
|
407
407
|
export interface DescribeThirdPartyAuthCodeResponse {
|
|
408
408
|
/**
|
|
409
|
-
*
|
|
409
|
+
* AuthCode 中对应个人用户是否实名
|
|
410
|
+
<ul>
|
|
411
|
+
<li> **VERIFIED** : 此个人已实名</li>
|
|
412
|
+
<li> **UNVERIFIED**: 此个人未实名</li></ul>
|
|
410
413
|
*/
|
|
411
414
|
VerifyStatus?: string
|
|
412
415
|
/**
|
|
@@ -587,7 +590,10 @@ export interface ReleasedApprover {
|
|
|
587
590
|
*/
|
|
588
591
|
ApproverSignComponentType?: string
|
|
589
592
|
/**
|
|
590
|
-
*
|
|
593
|
+
* 参与方在合同中的角色是按照创建合同的时候来排序的,解除协议默认会将第一个参与人叫`甲方`,第二个叫`乙方`, 第三个叫`丙方`,以此类推。
|
|
594
|
+
|
|
595
|
+
如果需改动此参与人的角色名字,可用此字段指定,由汉字,英文字符,数字组成,最大20个字。
|
|
596
|
+
|
|
591
597
|
*/
|
|
592
598
|
ApproverSignRole?: string
|
|
593
599
|
}
|
|
@@ -1235,7 +1241,9 @@ export interface DescribeIntegrationEmployeesRequest {
|
|
|
1235
1241
|
*/
|
|
1236
1242
|
Agent?: Agent
|
|
1237
1243
|
/**
|
|
1238
|
-
* 查询过滤实名用户,Key为Status,Values为["IsVerified"]
|
|
1244
|
+
* 查询过滤实名用户,Key为Status,Values为["IsVerified"],查询过滤未实名用户,Key为Status,Values为["NotVerified"]
|
|
1245
|
+
查询某个部门的用户,Key为DepartmentId,Values为["DepartmentId"]
|
|
1246
|
+
根据用户Id查询员工时,Key为UserId,Values为["UserId"]
|
|
1239
1247
|
根据第三方系统openId过滤查询员工时,Key为StaffOpenId,Values为["OpenId","OpenId",...]
|
|
1240
1248
|
*/
|
|
1241
1249
|
Filters?: Array<Filter>
|
|
@@ -1511,7 +1519,7 @@ export interface AutoSignConfig {
|
|
|
1511
1519
|
<li>**TELECOM** : 运营商三要素验证</li></ul>
|
|
1512
1520
|
注:
|
|
1513
1521
|
<ul><li>如果是小程序开通链接,支持传 WEIXINAPP / TELECOM。为空默认 WEIXINAPP</li>
|
|
1514
|
-
<li>如果是 H5 开通链接,支持传 INSIGHT / TELECOM。为空默认 INSIGHT </li>
|
|
1522
|
+
<li>如果是 H5 开通链接,支持传 INSIGHT / TELECOM。为空默认 INSIGHT </li></ul>
|
|
1515
1523
|
*/
|
|
1516
1524
|
VerifyChannels?: Array<string>
|
|
1517
1525
|
/**
|
|
@@ -1529,15 +1537,17 @@ export interface AutoSignConfig {
|
|
|
1529
1537
|
*/
|
|
1530
1538
|
export interface DescribeThirdPartyAuthCodeRequest {
|
|
1531
1539
|
/**
|
|
1532
|
-
*
|
|
1540
|
+
* 腾讯电子签小程序跳转客户企业小程序时携带的授权查看码,AuthCode由腾讯电子签小程序生成。
|
|
1533
1541
|
*/
|
|
1534
1542
|
AuthCode: string
|
|
1535
1543
|
/**
|
|
1536
|
-
*
|
|
1544
|
+
* 执行本接口操作的员工信息。
|
|
1545
|
+
注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
|
|
1537
1546
|
*/
|
|
1538
1547
|
Operator?: UserInfo
|
|
1539
1548
|
/**
|
|
1540
|
-
*
|
|
1549
|
+
* 代理企业和员工的信息。
|
|
1550
|
+
在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
|
|
1541
1551
|
*/
|
|
1542
1552
|
Agent?: Agent
|
|
1543
1553
|
}
|
|
@@ -1689,6 +1699,35 @@ export interface Permission {
|
|
|
1689
1699
|
Children?: Array<Permission>
|
|
1690
1700
|
}
|
|
1691
1701
|
|
|
1702
|
+
/**
|
|
1703
|
+
* 签署控件的类型和范围限制条件,用于控制文件发起后签署人拖拽签署区时可使用的控件类型和具体的印章或签名方式。
|
|
1704
|
+
*/
|
|
1705
|
+
export interface ComponentLimit {
|
|
1706
|
+
/**
|
|
1707
|
+
* 控件类型,支持以下类型
|
|
1708
|
+
<ul><li>SIGN_SEAL : 印章控件</li>
|
|
1709
|
+
<li>SIGN_PAGING_SEAL : 骑缝章控件</li>
|
|
1710
|
+
<li>SIGN_LEGAL_PERSON_SEAL : 企业法定代表人控件</li>
|
|
1711
|
+
<li>SIGN_SIGNATURE : 用户签名控件</li></ul>
|
|
1712
|
+
*/
|
|
1713
|
+
ComponentType: string
|
|
1714
|
+
/**
|
|
1715
|
+
* 签署控件类型的值(可选),用与限制签署时印章或者签名的选择范围
|
|
1716
|
+
|
|
1717
|
+
1.当ComponentType 是 SIGN_SEAL 或者 SIGN_PAGING_SEAL 时可传入企业印章Id(支持多个)
|
|
1718
|
+
|
|
1719
|
+
2.当ComponentType 是 SIGN_SIGNATURE 时可传入以下类型(支持多个)
|
|
1720
|
+
|
|
1721
|
+
<ul><li>HANDWRITE : 手写签名</li>
|
|
1722
|
+
<li>OCR_ESIGN : OCR印章(智慧手写签名)</li>
|
|
1723
|
+
<li>ESIGN : 个人印章</li>
|
|
1724
|
+
<li>SYSTEM_ESIGN : 系统印章</li></ul>
|
|
1725
|
+
|
|
1726
|
+
3.当ComponentType 是 SIGN_LEGAL_PERSON_SEAL 时无需传递此参数。
|
|
1727
|
+
*/
|
|
1728
|
+
ComponentValue?: Array<string>
|
|
1729
|
+
}
|
|
1730
|
+
|
|
1692
1731
|
/**
|
|
1693
1732
|
* CreateIntegrationDepartment返回参数结构体
|
|
1694
1733
|
*/
|
|
@@ -1926,26 +1965,33 @@ export interface OccupiedSeal {
|
|
|
1926
1965
|
*/
|
|
1927
1966
|
export interface CreatePersonAuthCertificateImageResponse {
|
|
1928
1967
|
/**
|
|
1929
|
-
*
|
|
1968
|
+
* 个人用户认证证书图片下载URL,`有效期为5分钟`,超过有效期后将无法再下载。
|
|
1930
1969
|
*/
|
|
1931
1970
|
AuthCertUrl?: string
|
|
1932
1971
|
/**
|
|
1933
|
-
*
|
|
1972
|
+
* 个人用户认证证书的编号, 为20位数字组成的字符串, 由腾讯电子签下发此编号 。
|
|
1973
|
+
该编号会合成到个人用户证书证明图片。
|
|
1974
|
+
|
|
1975
|
+
注: `个人用户认证证书的编号和证明图片绑定, 获取新的证明图片编号会变动`
|
|
1934
1976
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
1935
1977
|
*/
|
|
1936
1978
|
ImageCertId?: string
|
|
1937
1979
|
/**
|
|
1938
|
-
*
|
|
1980
|
+
* CA供应商下发给用户的证书编号,在证书到期后自动续期后此证书编号会发生变动,且不会合成到个人用户证书证明图片中。
|
|
1981
|
+
|
|
1982
|
+
注意:`腾讯电子签接入多家CA供应商以提供容灾能力,不同CA下发的证书编号区别较大,但基本都是由数字和字母组成,长度在200以下。`
|
|
1939
1983
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
1940
1984
|
*/
|
|
1941
1985
|
SerialNumber?: string
|
|
1942
1986
|
/**
|
|
1943
|
-
* CA
|
|
1987
|
+
* CA证书颁发时间,格式为Unix标准时间戳(秒)
|
|
1988
|
+
该时间格式化后会合成到个人用户证书证明图片
|
|
1944
1989
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
1945
1990
|
*/
|
|
1946
1991
|
ValidFrom?: number
|
|
1947
1992
|
/**
|
|
1948
|
-
* CA
|
|
1993
|
+
* CA证书有效截止时间,格式为Unix标准时间戳(秒)
|
|
1994
|
+
该时间格式化后会合成到个人用户证书证明图片
|
|
1949
1995
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
1950
1996
|
*/
|
|
1951
1997
|
ValidTo?: number
|
|
@@ -3816,7 +3862,7 @@ export interface CreateReleaseFlowRequest {
|
|
|
3816
3862
|
*/
|
|
3817
3863
|
NeedRelievedFlowId: string
|
|
3818
3864
|
/**
|
|
3819
|
-
*
|
|
3865
|
+
* 解除协议内容, 包括解除理由等信息。
|
|
3820
3866
|
*/
|
|
3821
3867
|
ReliveInfo: RelieveInfo
|
|
3822
3868
|
/**
|
|
@@ -3824,12 +3870,12 @@ export interface CreateReleaseFlowRequest {
|
|
|
3824
3870
|
*/
|
|
3825
3871
|
Agent?: Agent
|
|
3826
3872
|
/**
|
|
3827
|
-
*
|
|
3828
|
-
|
|
3829
|
-
解除协议的签署人数量不能多于原流程的签署人数量。<br/>
|
|
3873
|
+
* 替换解除协议的签署人, 如不指定替换签署人, 则使用原流程的签署人。 <br/>
|
|
3874
|
+
如需更换原合同中的企业端签署人,可通过指定该签署人的RecipientId编号更换此企业端签署人。(可通过接口<a href="https://qian.tencent.com/developers/companyApis/queryFlows/DescribeFlowInfo/">DescribeFlowInfo</a>查询签署人的RecipientId编号)<br/>
|
|
3830
3875
|
|
|
3831
|
-
|
|
3832
|
-
|
|
3876
|
+
注意:
|
|
3877
|
+
`只能更换自己企业的签署人, 不支持更换个人类型或者其他企业的签署人。`
|
|
3878
|
+
`可以不指定替换签署人, 使用原流程的签署人 `
|
|
3833
3879
|
*/
|
|
3834
3880
|
ReleasedApprovers?: Array<ReleasedApprover>
|
|
3835
3881
|
/**
|
|
@@ -3910,7 +3956,8 @@ export interface SuccessUpdateStaffData {
|
|
|
3910
3956
|
*/
|
|
3911
3957
|
export interface CreatePersonAuthCertificateImageRequest {
|
|
3912
3958
|
/**
|
|
3913
|
-
*
|
|
3959
|
+
* 执行本接口操作的员工信息。
|
|
3960
|
+
注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
|
|
3914
3961
|
*/
|
|
3915
3962
|
Operator: UserInfo
|
|
3916
3963
|
/**
|
|
@@ -3918,20 +3965,24 @@ export interface CreatePersonAuthCertificateImageRequest {
|
|
|
3918
3965
|
*/
|
|
3919
3966
|
UserName: string
|
|
3920
3967
|
/**
|
|
3921
|
-
*
|
|
3922
|
-
ID_CARD
|
|
3923
|
-
PASSPORT
|
|
3924
|
-
|
|
3925
|
-
|
|
3926
|
-
HONGKONG_MACAO_AND_TAIWAN 港澳台居民居住证(格式同居民身份证)
|
|
3968
|
+
* 证件类型,支持以下类型
|
|
3969
|
+
<ul><li> ID_CARD : 居民身份证 (默认值)</li>
|
|
3970
|
+
<li> PASSPORT : 护照</li>
|
|
3971
|
+
<li> FOREIGN_ID_CARD : 外国人永久居留身份证</li>
|
|
3972
|
+
<li> HONGKONG_AND_MACAO : 港澳居民来往内地通行证</li>
|
|
3973
|
+
<li> HONGKONG_MACAO_AND_TAIWAN : 港澳台居民居住证(格式同居民身份证)</li></ul>
|
|
3927
3974
|
*/
|
|
3928
3975
|
IdCardType: string
|
|
3929
3976
|
/**
|
|
3930
|
-
*
|
|
3977
|
+
* 证件号码,应符合以下规则
|
|
3978
|
+
<ul><li>居民身份证号码应为18位字符串,由数字和大写字母X组成(如存在X,请大写)。</li>
|
|
3979
|
+
<li>港澳居民来往内地通行证号码应为9位字符串,第1位为“C”,第2位为英文字母(但“I”、“O”除外),后7位为阿拉伯数字。</li>
|
|
3980
|
+
<li>港澳台居民居住证号码编码规则与中国大陆身份证相同,应为18位字符串。</li></ul>
|
|
3931
3981
|
*/
|
|
3932
3982
|
IdCardNumber: string
|
|
3933
3983
|
/**
|
|
3934
|
-
* 代理企业和员工的信息。
|
|
3984
|
+
* 代理企业和员工的信息。
|
|
3985
|
+
在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
|
|
3935
3986
|
*/
|
|
3936
3987
|
Agent?: Agent
|
|
3937
3988
|
}
|
|
@@ -4242,6 +4293,12 @@ export interface ApproverInfo {
|
|
|
4242
4293
|
注:`此功能可用于与企业内部的审批流程进行关联,支持手动、静默签署合同`
|
|
4243
4294
|
*/
|
|
4244
4295
|
ApproverNeedSignReview?: boolean
|
|
4296
|
+
/**
|
|
4297
|
+
* [用PDF文件创建签署流程](https://qian.tencent.com/developers/companyApis/startFlows/CreateFlowByFiles)时,如果设置了外层参数SignBeanTag=1(允许签署过程中添加签署控件),则可通过此参数明确规定合同所使用的签署控件类型(骑缝章、普通章法人章等)和具体的印章(印章ID)或签名方式。
|
|
4298
|
+
|
|
4299
|
+
注:`限制印章控件或骑缝章控件情况下,仅本企业签署方可以指定具体印章(通过传递ComponentValue,支持多个),他方企业或个人只支持限制控件类型。`
|
|
4300
|
+
*/
|
|
4301
|
+
AddSignComponentsLimits?: Array<ComponentLimit>
|
|
4245
4302
|
}
|
|
4246
4303
|
|
|
4247
4304
|
/**
|
|
@@ -4343,7 +4400,7 @@ export interface CreateUserAutoSignEnableUrlRequest {
|
|
|
4343
4400
|
/**
|
|
4344
4401
|
* 生成的链接类型:
|
|
4345
4402
|
<ul><li> 不传(即为空值) 则会生成小程序端开通链接(默认)</li>
|
|
4346
|
-
<li> **H5SIGN** : 生成H5端开通链接</li
|
|
4403
|
+
<li> **H5SIGN** : 生成H5端开通链接</li></ul>
|
|
4347
4404
|
*/
|
|
4348
4405
|
UrlType?: string
|
|
4349
4406
|
/**
|
|
@@ -5487,15 +5544,20 @@ export interface UpdateIntegrationEmployeesRequest {
|
|
|
5487
5544
|
*/
|
|
5488
5545
|
export interface DescribeFlowBriefsRequest {
|
|
5489
5546
|
/**
|
|
5490
|
-
*
|
|
5547
|
+
* 执行本接口操作的员工信息。
|
|
5548
|
+
注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
|
|
5491
5549
|
*/
|
|
5492
5550
|
Operator: UserInfo
|
|
5493
5551
|
/**
|
|
5494
|
-
*
|
|
5552
|
+
* 查询的合同流程ID列表最多支持100个流程ID。
|
|
5553
|
+
如果某个合同流程ID不存在,系统会跳过此ID的查询,继续查询剩余存在的合同流程。
|
|
5554
|
+
|
|
5555
|
+
可登录腾讯电子签控制台,在 "合同"->"合同中心" 中查看某个合同的FlowId(在页面中展示为合同ID)。
|
|
5495
5556
|
*/
|
|
5496
5557
|
FlowIds: Array<string>
|
|
5497
5558
|
/**
|
|
5498
|
-
*
|
|
5559
|
+
* 代理企业和员工的信息。
|
|
5560
|
+
在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
|
|
5499
5561
|
*/
|
|
5500
5562
|
Agent?: Agent
|
|
5501
5563
|
}
|
|
@@ -5590,7 +5652,8 @@ export interface DeleteStaffsResult {
|
|
|
5590
5652
|
*/
|
|
5591
5653
|
export interface DescribeFlowBriefsResponse {
|
|
5592
5654
|
/**
|
|
5593
|
-
*
|
|
5655
|
+
* 合同流程基础信息列表,包含流程的名称、状态、创建日期等基本信息。
|
|
5656
|
+
注:`与入参 FlowIds 的顺序可能存在不一致的情况。`
|
|
5594
5657
|
*/
|
|
5595
5658
|
FlowBriefs?: Array<FlowBrief>
|
|
5596
5659
|
/**
|
|
@@ -5744,27 +5807,24 @@ DISABLE:未开通
|
|
|
5744
5807
|
*/
|
|
5745
5808
|
export interface RelieveInfo {
|
|
5746
5809
|
/**
|
|
5747
|
-
*
|
|
5810
|
+
* 解除理由,长度不能超过200,只能由中文、字母、数字、中文标点和英文标点组成(不支持表情)。
|
|
5748
5811
|
*/
|
|
5749
5812
|
Reason: string
|
|
5750
5813
|
/**
|
|
5751
|
-
*
|
|
5814
|
+
* 解除后仍然有效的条款,保留条款,长度不能超过200,只能由中文、字母、数字、中文标点和英文标点组成(不支持表情)。
|
|
5752
5815
|
|
|
5753
5816
|
*/
|
|
5754
5817
|
RemainInForceItem?: string
|
|
5755
5818
|
/**
|
|
5756
|
-
*
|
|
5757
|
-
|
|
5819
|
+
* 原合同事项处理-费用结算,长度不能超过200,只能由中文、字母、数字、中文标点和英文标点组成(不支持表情)。
|
|
5758
5820
|
*/
|
|
5759
5821
|
OriginalExpenseSettlement?: string
|
|
5760
5822
|
/**
|
|
5761
|
-
*
|
|
5762
|
-
|
|
5823
|
+
* 原合同事项处理-其他事项,长度不能超过200,只能由中文、字母、数字、中文标点和英文标点组成(不支持表情)。
|
|
5763
5824
|
*/
|
|
5764
5825
|
OriginalOtherSettlement?: string
|
|
5765
5826
|
/**
|
|
5766
|
-
*
|
|
5767
|
-
|
|
5827
|
+
* 其他约定,长度不能超过200,只能由中文、字母、数字、中文标点和英文标点组成(不支持表情)。
|
|
5768
5828
|
*/
|
|
5769
5829
|
OtherDeals?: string
|
|
5770
5830
|
}
|
|
@@ -326,6 +326,16 @@ UpperRight-右下角。
|
|
|
326
326
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
327
327
|
*/
|
|
328
328
|
Placeholder?: string
|
|
329
|
+
/**
|
|
330
|
+
* 是否锁定控件值不允许编辑(嵌入式发起使用) <br/>默认false:不锁定控件值,允许在页面编辑控件值
|
|
331
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
332
|
+
*/
|
|
333
|
+
LockComponentValue?: boolean
|
|
334
|
+
/**
|
|
335
|
+
* 是否禁止移动和删除控件 <br/>默认false,不禁止移动和删除控件
|
|
336
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
337
|
+
*/
|
|
338
|
+
ForbidMoveAndDelete?: boolean
|
|
329
339
|
}
|
|
330
340
|
|
|
331
341
|
/**
|
|
@@ -1874,6 +1884,35 @@ export interface ChannelCancelUserAutoSignEnableUrlRequest {
|
|
|
1874
1884
|
UserInfo: UserThreeFactor
|
|
1875
1885
|
}
|
|
1876
1886
|
|
|
1887
|
+
/**
|
|
1888
|
+
* 签署控件的类型和范围限制条件,用于控制文件发起后签署人拖拽签署区时可使用的控件类型和具体的印章或签名方式。
|
|
1889
|
+
*/
|
|
1890
|
+
export interface ComponentLimit {
|
|
1891
|
+
/**
|
|
1892
|
+
* 控件类型,支持以下类型
|
|
1893
|
+
<ul><li>SIGN_SEAL : 印章控件</li>
|
|
1894
|
+
<li>SIGN_PAGING_SEAL : 骑缝章控件</li>
|
|
1895
|
+
<li>SIGN_LEGAL_PERSON_SEAL : 企业法定代表人控件</li>
|
|
1896
|
+
<li>SIGN_SIGNATURE : 用户签名控件</li></ul>
|
|
1897
|
+
*/
|
|
1898
|
+
ComponentType: string
|
|
1899
|
+
/**
|
|
1900
|
+
* 签署控件类型的值(可选),用与限制签署时印章或者签名的选择范围
|
|
1901
|
+
|
|
1902
|
+
1.当ComponentType 是 SIGN_SEAL 或者 SIGN_PAGING_SEAL 时可传入企业印章Id(支持多个)
|
|
1903
|
+
|
|
1904
|
+
2.当ComponentType 是 SIGN_SIGNATURE 时可传入以下类型(支持多个)
|
|
1905
|
+
|
|
1906
|
+
<ul><li>HANDWRITE : 手写签名</li>
|
|
1907
|
+
<li>OCR_ESIGN : OCR印章(智慧手写签名)</li>
|
|
1908
|
+
<li>ESIGN : 个人印章</li>
|
|
1909
|
+
<li>SYSTEM_ESIGN : 系统印章</li></ul>
|
|
1910
|
+
|
|
1911
|
+
3.当ComponentType 是 SIGN_LEGAL_PERSON_SEAL 时无需传递此参数。
|
|
1912
|
+
*/
|
|
1913
|
+
ComponentValue?: Array<string>
|
|
1914
|
+
}
|
|
1915
|
+
|
|
1877
1916
|
/**
|
|
1878
1917
|
* ChannelVerifyPdf返回参数结构体
|
|
1879
1918
|
*/
|
|
@@ -2139,7 +2178,6 @@ export interface CommonFlowApprover {
|
|
|
2139
2178
|
IsFullText?: boolean
|
|
2140
2179
|
/**
|
|
2141
2180
|
* 通知类型:SMS(短信) NONE(不做通知), 不传 默认SMS
|
|
2142
|
-
* @deprecated
|
|
2143
2181
|
*/
|
|
2144
2182
|
NotifyType?: string
|
|
2145
2183
|
/**
|
|
@@ -2150,6 +2188,14 @@ export interface CommonFlowApprover {
|
|
|
2150
2188
|
* 签署控件:文件发起使用
|
|
2151
2189
|
*/
|
|
2152
2190
|
SignComponents?: Array<Component>
|
|
2191
|
+
/**
|
|
2192
|
+
* 签署人查看合同时认证方式, 1-实名查看 2-短信验证码查看(企业签署方不支持该方式) 如果不传默认为1 查看合同的认证方式 Flow层级的优先于approver层级的 (当手写签名方式为OCR_ESIGN时,合同认证方式2无效,因为这种签名方式依赖实名认证)
|
|
2193
|
+
*/
|
|
2194
|
+
ApproverVerifyTypes?: Array<number | bigint>
|
|
2195
|
+
/**
|
|
2196
|
+
* 签署人签署合同时的认证方式 1-人脸认证 2-签署密码 3-运营商三要素(默认为1,2)
|
|
2197
|
+
*/
|
|
2198
|
+
ApproverSignTypes?: Array<number | bigint>
|
|
2153
2199
|
}
|
|
2154
2200
|
|
|
2155
2201
|
/**
|
|
@@ -3115,6 +3161,12 @@ ENTERPRISESERVER-企业静默签(文件发起时的企业静默签字)。
|
|
|
3115
3161
|
默认为SMS(签署方为子客时该字段不生效)
|
|
3116
3162
|
*/
|
|
3117
3163
|
NotifyType?: string
|
|
3164
|
+
/**
|
|
3165
|
+
* [通过文件创建签署流程](https://qian.tencent.com/developers/partnerApis/startFlows/ChannelCreateFlowByFiles)时,如果设置了外层参数SignBeanTag=1(允许签署过程中添加签署控件),则可通过此参数明确规定合同所使用的签署控件类型(骑缝章、普通章法人章等)和具体的印章(印章ID)或签名方式。
|
|
3166
|
+
|
|
3167
|
+
注:`限制印章控件或骑缝章控件情况下,仅本企业签署方可以指定具体印章(通过传递ComponentValue,支持多个),他方企业或个人只支持限制控件类型。`
|
|
3168
|
+
*/
|
|
3169
|
+
AddSignComponentsLimits?: Array<ComponentLimit>
|
|
3118
3170
|
}
|
|
3119
3171
|
|
|
3120
3172
|
/**
|
|
@@ -232,31 +232,31 @@ export interface CreateFaceResponse {
|
|
|
232
232
|
/**
|
|
233
233
|
* 加入成功的人脸数量
|
|
234
234
|
*/
|
|
235
|
-
SucFaceNum
|
|
235
|
+
SucFaceNum?: number
|
|
236
236
|
/**
|
|
237
237
|
* 加入成功的人脸ID列表
|
|
238
238
|
*/
|
|
239
|
-
SucFaceIds
|
|
239
|
+
SucFaceIds?: Array<string>
|
|
240
240
|
/**
|
|
241
241
|
* 每张人脸图片添加结果,-1101 代表未检测到人脸,-1102 代表图片解码失败,
|
|
242
242
|
-1601代表不符合图片质量控制要求, -1604 代表人脸相似度没有超过FaceMatchThreshold。
|
|
243
243
|
其他非 0 值代表算法服务异常。
|
|
244
244
|
RetCode的顺序和入参中 Images 或 Urls 的顺序一致。
|
|
245
245
|
*/
|
|
246
|
-
RetCode
|
|
246
|
+
RetCode?: Array<number | bigint>
|
|
247
247
|
/**
|
|
248
248
|
* 加入成功的人脸索引。索引顺序和入参中 Images 或 Urls 的顺序一致。
|
|
249
249
|
例, Urls 中 有 3 个 url,第二个 url 失败,则 SucIndexes 值为 [0,2] 。
|
|
250
250
|
*/
|
|
251
|
-
SucIndexes
|
|
251
|
+
SucIndexes?: Array<number | bigint>
|
|
252
252
|
/**
|
|
253
253
|
* 加入成功的人脸框位置。顺序和入参中 Images 或 Urls 的顺序一致。
|
|
254
254
|
*/
|
|
255
|
-
SucFaceRects
|
|
255
|
+
SucFaceRects?: Array<FaceRect>
|
|
256
256
|
/**
|
|
257
257
|
* 人脸识别所用的算法模型版本。
|
|
258
258
|
*/
|
|
259
|
-
FaceModelVersion
|
|
259
|
+
FaceModelVersion?: string
|
|
260
260
|
/**
|
|
261
261
|
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
262
262
|
*/
|
|
@@ -626,15 +626,15 @@ export interface SearchFacesResponse {
|
|
|
626
626
|
/**
|
|
627
627
|
* 识别结果。
|
|
628
628
|
*/
|
|
629
|
-
Results
|
|
629
|
+
Results?: Array<Result>
|
|
630
630
|
/**
|
|
631
631
|
* 搜索的人员库中包含的人脸数。
|
|
632
632
|
*/
|
|
633
|
-
FaceNum
|
|
633
|
+
FaceNum?: number
|
|
634
634
|
/**
|
|
635
635
|
* 人脸识别所用的算法模型版本。
|
|
636
636
|
*/
|
|
637
|
-
FaceModelVersion
|
|
637
|
+
FaceModelVersion?: string
|
|
638
638
|
/**
|
|
639
639
|
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
640
640
|
*/
|
|
@@ -2276,27 +2276,23 @@ export interface DetectFaceResponse {
|
|
|
2276
2276
|
/**
|
|
2277
2277
|
* 请求的图片宽度。
|
|
2278
2278
|
*/
|
|
2279
|
-
ImageWidth
|
|
2279
|
+
ImageWidth?: number
|
|
2280
2280
|
/**
|
|
2281
2281
|
* 请求的图片高度。
|
|
2282
2282
|
*/
|
|
2283
|
-
ImageHeight
|
|
2283
|
+
ImageHeight?: number
|
|
2284
2284
|
/**
|
|
2285
2285
|
* 人脸信息列表。包含人脸坐标信息、属性信息(若需要)、质量分信息(若需要)。
|
|
2286
2286
|
*/
|
|
2287
|
-
FaceInfos
|
|
2287
|
+
FaceInfos?: Array<FaceInfo>
|
|
2288
2288
|
/**
|
|
2289
2289
|
* 人脸识别服务所用的算法模型版本。
|
|
2290
|
-
|
|
2291
2290
|
目前入参支持 “2.0”和“3.0“ 两个输入。
|
|
2292
|
-
|
|
2293
2291
|
2020年4月2日开始,默认为“3.0”,之前使用过本接口的账号若未填写本参数默认为“2.0”。
|
|
2294
|
-
|
|
2295
2292
|
2020年11月26日后开通服务的账号仅支持输入“3.0”。
|
|
2296
|
-
|
|
2297
2293
|
不同算法模型版本对应的人脸识别算法不同,新版本的整体效果会优于旧版本,建议使用“3.0”版本。
|
|
2298
2294
|
*/
|
|
2299
|
-
FaceModelVersion
|
|
2295
|
+
FaceModelVersion?: string
|
|
2300
2296
|
/**
|
|
2301
2297
|
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
2302
2298
|
*/
|
|
@@ -2058,13 +2058,9 @@ Url、Image必须提供一个,如果都提供,只使用 Url。
|
|
|
2058
2058
|
NeedQualityDetection?: number
|
|
2059
2059
|
/**
|
|
2060
2060
|
* 人脸识别服务所用的算法模型版本。
|
|
2061
|
-
|
|
2062
2061
|
目前入参支持 “2.0”和“3.0“ 两个输入。
|
|
2063
|
-
|
|
2064
2062
|
2020年4月2日开始,默认为“3.0”,之前使用过本接口的账号若未填写本参数默认为“2.0”。
|
|
2065
|
-
|
|
2066
2063
|
2020年11月26日后开通服务的账号仅支持输入“3.0”。
|
|
2067
|
-
|
|
2068
2064
|
不同算法模型版本对应的人脸识别算法不同,新版本的整体效果会优于旧版本,建议使用“3.0”版本。
|
|
2069
2065
|
*/
|
|
2070
2066
|
FaceModelVersion?: string
|
|
@@ -2234,7 +2230,7 @@ export interface GetGroupInfoResponse {
|
|
|
2234
2230
|
*/
|
|
2235
2231
|
FaceModelVersion?: string
|
|
2236
2232
|
/**
|
|
2237
|
-
* Group
|
|
2233
|
+
* Group的创建时间和日期。CreationTimestamp 的值是自 Unix 纪元时间到Group创建时间的毫秒数。
|
|
2238
2234
|
*/
|
|
2239
2235
|
CreationTimestamp?: number
|
|
2240
2236
|
/**
|