tencentcloud-sdk-nodejs 4.1.289 → 4.1.291
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/es/common/sdk_version.js +1 -1
- package/es/services/config/v20220802/config_client.js +6 -0
- package/es/services/mps/v20190612/mps_client.js +3 -0
- package/es/services/rce/v20260130/rce_client.js +6 -0
- package/es/services/tcbr/v20220217/tcbr_client.js +30 -27
- package/es/services/tcr/v20190924/tcr_client.js +3 -0
- package/es/services/teo/v20220901/teo_client.js +3 -0
- package/package.json +1 -1
- package/tencentcloud/common/sdk_version.d.ts +1 -1
- package/tencentcloud/common/sdk_version.js +1 -1
- package/tencentcloud/services/adp/v20260520/adp_models.d.ts +69 -55
- package/tencentcloud/services/bh/v20230418/bh_client.d.ts +1 -1
- package/tencentcloud/services/bh/v20230418/bh_models.d.ts +257 -145
- package/tencentcloud/services/cam/v20190116/cam_models.d.ts +11 -7
- package/tencentcloud/services/config/v20220802/config_client.d.ts +9 -1
- package/tencentcloud/services/config/v20220802/config_client.js +12 -0
- package/tencentcloud/services/config/v20220802/config_models.d.ts +89 -33
- package/tencentcloud/services/csip/v20221121/csip_client.d.ts +1 -1
- package/tencentcloud/services/csip/v20221121/csip_models.d.ts +555 -313
- package/tencentcloud/services/cvm/v20170312/cvm_models.d.ts +51 -0
- package/tencentcloud/services/dlc/v20210125/dlc_models.d.ts +61 -12
- package/tencentcloud/services/dsgc/v20190723/dsgc_models.d.ts +4 -4
- package/tencentcloud/services/ess/v20201111/ess_client.d.ts +0 -2
- package/tencentcloud/services/ess/v20201111/ess_client.js +0 -2
- package/tencentcloud/services/ess/v20201111/ess_models.d.ts +29 -126
- package/tencentcloud/services/essbasic/v20210526/essbasic_client.d.ts +2 -4
- package/tencentcloud/services/essbasic/v20210526/essbasic_client.js +2 -4
- package/tencentcloud/services/essbasic/v20210526/essbasic_models.d.ts +7 -3
- package/tencentcloud/services/hai/v20230812/hai_models.d.ts +18 -18
- package/tencentcloud/services/ims/v20201229/ims_models.d.ts +26 -26
- package/tencentcloud/services/live/v20180801/live_models.d.ts +6 -5
- package/tencentcloud/services/mna/v20210119/mna_models.d.ts +20 -0
- package/tencentcloud/services/monitor/v20230616/monitor_models.d.ts +34 -0
- package/tencentcloud/services/mps/v20190612/mps_client.d.ts +5 -1
- package/tencentcloud/services/mps/v20190612/mps_client.js +6 -0
- package/tencentcloud/services/mps/v20190612/mps_models.d.ts +140 -17
- package/tencentcloud/services/oceanus/v20190422/oceanus_models.d.ts +4 -4
- package/tencentcloud/services/ocr/v20181119/ocr_models.d.ts +4 -24
- package/tencentcloud/services/postgres/v20170312/postgres_client.d.ts +1 -1
- package/tencentcloud/services/postgres/v20170312/postgres_models.d.ts +10 -1
- package/tencentcloud/services/rce/v20260130/rce_client.d.ts +9 -1
- package/tencentcloud/services/rce/v20260130/rce_client.js +12 -0
- package/tencentcloud/services/rce/v20260130/rce_models.d.ts +1673 -112
- package/tencentcloud/services/tcbr/v20220217/tcbr_client.d.ts +37 -33
- package/tencentcloud/services/tcbr/v20220217/tcbr_client.js +54 -48
- package/tencentcloud/services/tcbr/v20220217/tcbr_models.d.ts +56 -13
- package/tencentcloud/services/tcr/v20190924/tcr_client.d.ts +5 -1
- package/tencentcloud/services/tcr/v20190924/tcr_client.js +6 -0
- package/tencentcloud/services/tcr/v20190924/tcr_models.d.ts +81 -26
- package/tencentcloud/services/teo/v20220901/teo_client.d.ts +7 -3
- package/tencentcloud/services/teo/v20220901/teo_client.js +8 -2
- package/tencentcloud/services/teo/v20220901/teo_models.d.ts +475 -176
- package/tencentcloud/services/tione/v20211111/tione_models.d.ts +35 -21
- package/tencentcloud/services/tke/v20180525/tke_models.d.ts +7 -13
- package/tencentcloud/services/tse/v20201207/tse_models.d.ts +18 -36
- package/tencentcloud/services/vpc/v20170312/vpc_models.d.ts +6 -10
- package/tencentcloud/services/wedata/v20250806/wedata_models.d.ts +2 -2
- package/tencentcloud/services/wsa/v20250508/wsa_models.d.ts +4 -4
|
@@ -2689,6 +2689,10 @@ export interface InquiryPriceRunInstancesRequest {
|
|
|
2689
2689
|
* <p>实例启动模板。</p>
|
|
2690
2690
|
*/
|
|
2691
2691
|
LaunchTemplate?: LaunchTemplate;
|
|
2692
|
+
/**
|
|
2693
|
+
* <p>多网卡参数信息。 此功能仅部分地区灰度开放,如需使用<a href="https://console.cloud.tencent.com/workorder/category">请提交工单咨询</a></p>
|
|
2694
|
+
*/
|
|
2695
|
+
NetworkInterfaces?: Array<NetworkInterfaces>;
|
|
2692
2696
|
}
|
|
2693
2697
|
/**
|
|
2694
2698
|
* 一个关于镜像详细信息的结构体,主要包括镜像的主要状态与属性。
|
|
@@ -3746,6 +3750,10 @@ export interface CreateLaunchTemplateVersionRequest {
|
|
|
3746
3750
|
* <p>只允许传递 Update 和 Replace 参数,在模板使用自定义 Metadata 且在 RunInstances 也传递 Metadata 时生效。默认采用 Replace。</p><ul><li>Update:设模板 t含本参数值为Update、 metadata=[k1:v1, k2:v2] ,则RunInstances(给metadata=[k2:v3])+ t 创建的 cvm 使用metadata=[k1:v1, k2:v3] </li><li>Replace:模板 t含本参数值为Replace、 metadata=[k1:v1, k2:v2] ,则RunInstances(给metadata=[k2:v3])+ t 创建的 cvm 使用metadata=[k2:v3]<br><strong>注:内测中</strong>。</li></ul>
|
|
3747
3751
|
*/
|
|
3748
3752
|
TemplateDataModifyAction?: string;
|
|
3753
|
+
/**
|
|
3754
|
+
* <p>多网卡参数信息。 此功能仅部分地区灰度开放,如需使用<a href="https://console.cloud.tencent.com/workorder/category">请提交工单咨询</a></p>
|
|
3755
|
+
*/
|
|
3756
|
+
NetworkInterfaces?: Array<NetworkInterfaces>;
|
|
3749
3757
|
}
|
|
3750
3758
|
/**
|
|
3751
3759
|
* 描述了实例的增强服务启用情况与其设置,如云安全,云监控等实例 Agent
|
|
@@ -4024,6 +4032,10 @@ export interface CreateLaunchTemplateRequest {
|
|
|
4024
4032
|
* <p>只允许传递 Update 和 Replace 参数,在模板使用自定义 Metadata 且在 RunInstances 也传递 Metadata 时生效。默认采用 Replace。</p><ul><li>Update:设模板 t含本参数值为Update、 metadata=[k1:v1, k2:v2] ,则RunInstances(给metadata=[k2:v3])+ t 创建的 cvm 使用metadata=[k1:v1, k2:v3] </li><li>Replace:模板 t含本参数值为Replace、 metadata=[k1:v1, k2:v2] ,则RunInstances(给metadata=[k2:v3])+ t 创建的 cvm 使用metadata=[k2:v3]<br><strong>注:内测中</strong>。</li></ul>
|
|
4025
4033
|
*/
|
|
4026
4034
|
TemplateDataModifyAction?: string;
|
|
4035
|
+
/**
|
|
4036
|
+
* <p>多网卡参数信息。 此功能仅部分地区灰度开放,如需使用<a href="https://console.cloud.tencent.com/workorder/category">请提交工单咨询</a></p>
|
|
4037
|
+
*/
|
|
4038
|
+
NetworkInterfaces?: Array<NetworkInterfaces>;
|
|
4027
4039
|
}
|
|
4028
4040
|
/**
|
|
4029
4041
|
* InquiryPriceResetInstance请求参数结构体
|
|
@@ -4263,6 +4275,41 @@ export interface CreateLaunchTemplateResponse {
|
|
|
4263
4275
|
*/
|
|
4264
4276
|
RequestId?: string;
|
|
4265
4277
|
}
|
|
4278
|
+
/**
|
|
4279
|
+
* 创建实例时的网卡配置信息,包含主网卡和辅助网卡的VPC、子网、IP分配等网络参数。
|
|
4280
|
+
|
|
4281
|
+
此功能仅部分地区灰度开放,如需使用[请提交工单咨询](https://console.cloud.tencent.com/workorder/category)
|
|
4282
|
+
*/
|
|
4283
|
+
export interface NetworkInterfaces {
|
|
4284
|
+
/**
|
|
4285
|
+
* <p>表示是主网卡还是辅助网卡。注意:枚举值要全部大写;<strong>NetworkInterfaces数组中必须要有PRIMARY</strong>,且PRIMARY只能存在一个,SECONDARY可以存在多个。</p><p>枚举值:</p><ul><li>PRIMARY: 主网卡</li><li>SECONDARY: 辅助网卡</li></ul>
|
|
4286
|
+
*/
|
|
4287
|
+
InterfaceType: string;
|
|
4288
|
+
/**
|
|
4289
|
+
* <p>私有网络ID,形如<code>vpc-xxx</code>。有效的VpcId可通过登录<a href="https://console.cloud.tencent.com/vpc/vpc?rid=1">控制台</a>查询;也可以调用接口 <a href="https://cloud.tencent.com/document/product/215/15778">DescribeVpcs</a> ,从接口返回中的<code>VpcId</code>字段获取。若在创建子机时VpcId与SubnetId同时传入<code>DEFAULT</code>,则强制使用默认vpc网络。</p>
|
|
4290
|
+
*/
|
|
4291
|
+
VpcId: string;
|
|
4292
|
+
/**
|
|
4293
|
+
* <p>私有网络子网ID,形如<code>subnet-xxx</code>。有效的私有网络子网ID可通过登录<a href="https://console.cloud.tencent.com/vpc/subnet?rid=1">控制台</a>查询;也可以调用接口 <a href="https://cloud.tencent.com/document/product/215/15784">DescribeSubnets</a> ,从接口返回中的<code>SubnetId</code>字段获取。若在创建子机时SubnetId与VpcId同时传入<code>DEFAULT</code>,则强制使用默认vpc网络。</p>
|
|
4294
|
+
*/
|
|
4295
|
+
SubnetId: string;
|
|
4296
|
+
/**
|
|
4297
|
+
* <p>此字段是必填字段,表示每张网卡自动分配私有网卡IP个数。注意:不允许客户同时指定ip且动态分配ip。</p><p>取值范围:[1, 50]</p>
|
|
4298
|
+
*/
|
|
4299
|
+
PrivateIpv4AddressCount: number;
|
|
4300
|
+
/**
|
|
4301
|
+
* <p>指定存量的网卡ID用于绑定。只对辅助网卡生效,主网卡的生成采用既有流程。注:客户手动指定已有弹性网卡时,相关接口InstanceCount必须为1。主网卡不支持指定。</p>
|
|
4302
|
+
*/
|
|
4303
|
+
NetworkInterfaceId?: string;
|
|
4304
|
+
/**
|
|
4305
|
+
* <p>实例所属安全组。该参数可以通过调用 <a href="https://cloud.tencent.com/document/api/215/15808">DescribeSecurityGroups</a> 的返回值中的 <code>SecurityGroupId</code> 字段来获取。若不指定该参数,则绑定指定项目下的默认安全组,如默认安全组不存在则将自动创建。</p><p>每个用户在每个地域每个项目下最多可设置50个安全组。</p>
|
|
4306
|
+
*/
|
|
4307
|
+
SecurityGroupIds?: Array<string>;
|
|
4308
|
+
/**
|
|
4309
|
+
* <p>是否随CVM删除绑定的弹性网卡,参数只对辅助网卡生效。默认保留辅助网卡兼容当前线上行为。该参数放置在主网卡上不生效,主网卡会随着CVM一同销毁。</p><p>默认值:<code>false</code></p>
|
|
4310
|
+
*/
|
|
4311
|
+
DeleteWithInstance?: boolean;
|
|
4312
|
+
}
|
|
4266
4313
|
/**
|
|
4267
4314
|
* CreateKeyPair请求参数结构体
|
|
4268
4315
|
*/
|
|
@@ -4523,6 +4570,10 @@ export interface RunInstancesRequest {
|
|
|
4523
4570
|
* <p>实例是否开启巨型帧,取值范围:<br><li/> true:表示实例开启巨型帧,只有支持巨型帧的机型可设置为true。<br><li/>false:表示实例关闭巨型帧,只有支持巨型帧的机型可设置为false。<br> 支持巨型帧的实例规格: <a href="https://cloud.tencent.com/document/product/213/11518">实例规格</a></p>
|
|
4524
4571
|
*/
|
|
4525
4572
|
EnableJumboFrame?: boolean;
|
|
4573
|
+
/**
|
|
4574
|
+
* <p>多网卡参数信息。 此功能仅部分地区灰度开放,如需使用<a href="https://console.cloud.tencent.com/workorder/category">请提交工单咨询</a></p>
|
|
4575
|
+
*/
|
|
4576
|
+
NetworkInterfaces?: Array<NetworkInterfaces>;
|
|
4526
4577
|
}
|
|
4527
4578
|
/**
|
|
4528
4579
|
* DescribeResourcePoolPacks请求参数结构体
|
|
@@ -7826,6 +7826,51 @@ export interface DescribeUsersRequest {
|
|
|
7826
7826
|
*/
|
|
7827
7827
|
AccountType?: string;
|
|
7828
7828
|
}
|
|
7829
|
+
/**
|
|
7830
|
+
* TCHouseP 结构
|
|
7831
|
+
*/
|
|
7832
|
+
export interface TCHousePInfo {
|
|
7833
|
+
/**
|
|
7834
|
+
* <p>实例id</p>
|
|
7835
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
7836
|
+
*/
|
|
7837
|
+
InstanceId?: string;
|
|
7838
|
+
/**
|
|
7839
|
+
* <p>实例名称</p>
|
|
7840
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
7841
|
+
*/
|
|
7842
|
+
InstanceName?: string;
|
|
7843
|
+
/**
|
|
7844
|
+
* <p>JdbcUrl</p>
|
|
7845
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
7846
|
+
*/
|
|
7847
|
+
JdbcUrl?: string;
|
|
7848
|
+
/**
|
|
7849
|
+
* <p>用户名</p>
|
|
7850
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
7851
|
+
*/
|
|
7852
|
+
User?: string;
|
|
7853
|
+
/**
|
|
7854
|
+
* <p>密码</p>
|
|
7855
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
7856
|
+
*/
|
|
7857
|
+
Password?: string;
|
|
7858
|
+
/**
|
|
7859
|
+
* <p>地址</p>
|
|
7860
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
7861
|
+
*/
|
|
7862
|
+
Location?: DatasourceConnectionLocation;
|
|
7863
|
+
/**
|
|
7864
|
+
* <p>数据库名称</p>
|
|
7865
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
7866
|
+
*/
|
|
7867
|
+
DbName?: string;
|
|
7868
|
+
/**
|
|
7869
|
+
* <p>地址信息</p>
|
|
7870
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
7871
|
+
*/
|
|
7872
|
+
AccessInfo?: string;
|
|
7873
|
+
}
|
|
7829
7874
|
/**
|
|
7830
7875
|
* CreateExportTask返回参数结构体
|
|
7831
7876
|
*/
|
|
@@ -11241,63 +11286,67 @@ export interface CopyJobSpecRequest {
|
|
|
11241
11286
|
*/
|
|
11242
11287
|
export interface DatasourceConnectionConfig {
|
|
11243
11288
|
/**
|
|
11244
|
-
* Mysql
|
|
11289
|
+
* <p>Mysql数据源连接的属性</p>
|
|
11245
11290
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
11246
11291
|
*/
|
|
11247
11292
|
Mysql?: MysqlInfo;
|
|
11248
11293
|
/**
|
|
11249
|
-
* Hive
|
|
11294
|
+
* <p>Hive数据源连接的属性</p>
|
|
11250
11295
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
11251
11296
|
*/
|
|
11252
11297
|
Hive?: HiveInfo;
|
|
11253
11298
|
/**
|
|
11254
|
-
* Kafka
|
|
11299
|
+
* <p>Kafka数据源连接的属性</p>
|
|
11255
11300
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
11256
11301
|
*/
|
|
11257
11302
|
Kafka?: KafkaInfo;
|
|
11258
11303
|
/**
|
|
11259
|
-
*
|
|
11304
|
+
* <p>其他数据源连接的属性</p>
|
|
11260
11305
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
11261
11306
|
*/
|
|
11262
11307
|
OtherDatasourceConnection?: OtherDatasourceConnection;
|
|
11263
11308
|
/**
|
|
11264
|
-
* PostgreSQL
|
|
11309
|
+
* <p>PostgreSQL数据源连接的属性</p>
|
|
11265
11310
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
11266
11311
|
*/
|
|
11267
11312
|
PostgreSql?: DataSourceInfo;
|
|
11268
11313
|
/**
|
|
11269
|
-
* SQLServer
|
|
11314
|
+
* <p>SQLServer数据源连接的属性</p>
|
|
11270
11315
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
11271
11316
|
*/
|
|
11272
11317
|
SqlServer?: DataSourceInfo;
|
|
11273
11318
|
/**
|
|
11274
|
-
* ClickHouse
|
|
11319
|
+
* <p>ClickHouse数据源连接的属性</p>
|
|
11275
11320
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
11276
11321
|
*/
|
|
11277
11322
|
ClickHouse?: DataSourceInfo;
|
|
11278
11323
|
/**
|
|
11279
|
-
* Elasticsearch
|
|
11324
|
+
* <p>Elasticsearch数据源连接的属性</p>
|
|
11280
11325
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
11281
11326
|
*/
|
|
11282
11327
|
Elasticsearch?: ElasticsearchInfo;
|
|
11283
11328
|
/**
|
|
11284
|
-
* TDSQL-PostgreSQL
|
|
11329
|
+
* <p>TDSQL-PostgreSQL数据源连接的属性</p>
|
|
11285
11330
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
11286
11331
|
*/
|
|
11287
11332
|
TDSQLPostgreSql?: DataSourceInfo;
|
|
11288
11333
|
/**
|
|
11289
|
-
* Doris
|
|
11334
|
+
* <p>Doris数据源连接的属性</p>
|
|
11290
11335
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
11291
11336
|
*/
|
|
11292
11337
|
TCHouseD?: TCHouseD;
|
|
11293
11338
|
/**
|
|
11294
|
-
* TccHive
|
|
11339
|
+
* <p>TccHive数据目录连接信息</p>
|
|
11295
11340
|
*/
|
|
11296
11341
|
TccHive?: TccHive;
|
|
11297
11342
|
/**
|
|
11298
|
-
* MongoDB
|
|
11343
|
+
* <p>MongoDB 数据源</p>
|
|
11299
11344
|
*/
|
|
11300
11345
|
MongoDB?: DataSourceInfo;
|
|
11346
|
+
/**
|
|
11347
|
+
* <p>TCHouseP数据源</p>
|
|
11348
|
+
*/
|
|
11349
|
+
TCHouseP?: TCHousePInfo;
|
|
11301
11350
|
}
|
|
11302
11351
|
/**
|
|
11303
11352
|
* UpdateRowFilter请求参数结构体
|
|
@@ -4280,12 +4280,12 @@ export interface CosAsset {
|
|
|
4280
4280
|
*/
|
|
4281
4281
|
export interface DescribeDSPAAssessmentRiskSideListResponse {
|
|
4282
4282
|
/**
|
|
4283
|
-
*
|
|
4283
|
+
* <p>风险面列表</p>
|
|
4284
4284
|
* @deprecated
|
|
4285
4285
|
*/
|
|
4286
4286
|
RiskSideItmeList?: Array<Note>;
|
|
4287
4287
|
/**
|
|
4288
|
-
*
|
|
4288
|
+
* <p>风险面列表</p>
|
|
4289
4289
|
*/
|
|
4290
4290
|
RiskSideItemList?: Array<Note>;
|
|
4291
4291
|
/**
|
|
@@ -5368,11 +5368,11 @@ export interface CreateDSPACosMetaResourcesRequest {
|
|
|
5368
5368
|
*/
|
|
5369
5369
|
export interface DescribeDSPAAssessmentRiskSideListRequest {
|
|
5370
5370
|
/**
|
|
5371
|
-
* DSPA实例ID
|
|
5371
|
+
* <p>DSPA实例ID</p>
|
|
5372
5372
|
*/
|
|
5373
5373
|
DspaId: string;
|
|
5374
5374
|
/**
|
|
5375
|
-
*
|
|
5375
|
+
* <p>评估模板id</p>
|
|
5376
5376
|
*/
|
|
5377
5377
|
TemplateId: number;
|
|
5378
5378
|
}
|
|
@@ -906,7 +906,6 @@ export declare class Client extends AbstractClient {
|
|
|
906
906
|
2. 该接口返回的签署链接适用于APP集成的场景,支持APP、支付宝打开或浏览器直接打开,**不支持微信小程序嵌入**。配置方式请参考:<a href="https://qian.tencent.com/developers/company/openqianh5/">跳转电子签H5</a>。
|
|
907
907
|
如需跳转到小程序的实现,参考微信官方文档(分为<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>。
|
|
908
908
|
3. 因h5涉及人脸身份认证能力基于慧眼人脸核身,对Android和iOS系统均有一定要求, 因此<font color='red'>App嵌入H5签署合同需要按照慧眼提供的<a href="https://cloud.tencent.com/document/product/1007/61076">慧眼人脸核身兼容性文档</a>做兼容性适配</font>。
|
|
909
|
-
4. H5签署现在**仅支持中国大陆身份证、中国港澳台居民居住证**。
|
|
910
909
|
*/
|
|
911
910
|
CreateFlowSignUrl(req: CreateFlowSignUrlRequest, cb?: (error: string, rep: CreateFlowSignUrlResponse) => void): Promise<CreateFlowSignUrlResponse>;
|
|
912
911
|
/**
|
|
@@ -1450,7 +1449,6 @@ httpProfile.setEndpoint("file.test.ess.tencent.cn");
|
|
|
1450
1449
|
3. 该接口返回的签署链接适用于APP集成的场景,支持APP打开或浏览器直接打开,**不支持微信小程序嵌入**。
|
|
1451
1450
|
跳转到小程序的实现,参考微信官方文档(分为<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>。
|
|
1452
1451
|
4. 因h5涉及人脸身份认证能力基于慧眼人脸核身,对Android和iOS系统均有一定要求, 因此<font color='red'>App嵌入H5签署合同需要按照慧眼提供的<a href="https://cloud.tencent.com/document/product/1007/61076">慧眼人脸核身兼容性文档</a>做兼容性适配</font>。
|
|
1453
|
-
5. H5签署现在仅支持中国大陆身份证和中国港澳台居民居住证。
|
|
1454
1452
|
*/
|
|
1455
1453
|
CreateBatchQuickSignUrl(req: CreateBatchQuickSignUrlRequest, cb?: (error: string, rep: CreateBatchQuickSignUrlResponse) => void): Promise<CreateBatchQuickSignUrlResponse>;
|
|
1456
1454
|
/**
|
|
@@ -1074,7 +1074,6 @@ class Client extends abstract_client_1.AbstractClient {
|
|
|
1074
1074
|
2. 该接口返回的签署链接适用于APP集成的场景,支持APP、支付宝打开或浏览器直接打开,**不支持微信小程序嵌入**。配置方式请参考:<a href="https://qian.tencent.com/developers/company/openqianh5/">跳转电子签H5</a>。
|
|
1075
1075
|
如需跳转到小程序的实现,参考微信官方文档(分为<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>。
|
|
1076
1076
|
3. 因h5涉及人脸身份认证能力基于慧眼人脸核身,对Android和iOS系统均有一定要求, 因此<font color='red'>App嵌入H5签署合同需要按照慧眼提供的<a href="https://cloud.tencent.com/document/product/1007/61076">慧眼人脸核身兼容性文档</a>做兼容性适配</font>。
|
|
1077
|
-
4. H5签署现在**仅支持中国大陆身份证、中国港澳台居民居住证**。
|
|
1078
1077
|
*/
|
|
1079
1078
|
async CreateFlowSignUrl(req, cb) {
|
|
1080
1079
|
return this.request("CreateFlowSignUrl", req, cb);
|
|
@@ -1712,7 +1711,6 @@ httpProfile.setEndpoint("file.test.ess.tencent.cn");
|
|
|
1712
1711
|
3. 该接口返回的签署链接适用于APP集成的场景,支持APP打开或浏览器直接打开,**不支持微信小程序嵌入**。
|
|
1713
1712
|
跳转到小程序的实现,参考微信官方文档(分为<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>。
|
|
1714
1713
|
4. 因h5涉及人脸身份认证能力基于慧眼人脸核身,对Android和iOS系统均有一定要求, 因此<font color='red'>App嵌入H5签署合同需要按照慧眼提供的<a href="https://cloud.tencent.com/document/product/1007/61076">慧眼人脸核身兼容性文档</a>做兼容性适配</font>。
|
|
1715
|
-
5. H5签署现在仅支持中国大陆身份证和中国港澳台居民居住证。
|
|
1716
1714
|
*/
|
|
1717
1715
|
async CreateBatchQuickSignUrl(req, cb) {
|
|
1718
1716
|
return this.request("CreateBatchQuickSignUrl", req, cb);
|
|
@@ -270,7 +270,7 @@ export interface UploadFilesRequest {
|
|
|
270
270
|
*/
|
|
271
271
|
Agent?: Agent;
|
|
272
272
|
/**
|
|
273
|
-
* <p
|
|
273
|
+
* <p>文件的截止有效期,最长有效期是当前时间后的一年。如果超过截止有效期则文件会失效。此功能是白名单功能,如需使用,请联系电子签开通</p><p>如果没有传入,则默认过期时间是上传时间加1小时</p>
|
|
274
274
|
*/
|
|
275
275
|
Deadline?: number;
|
|
276
276
|
}
|
|
@@ -7148,203 +7148,106 @@ export interface CreateIntegrationEmployeesRequest {
|
|
|
7148
7148
|
*/
|
|
7149
7149
|
export interface CreateFlowOption {
|
|
7150
7150
|
/**
|
|
7151
|
-
*
|
|
7152
|
-
<br/>true:允许编辑<br/>false:不允许编辑(默认值)<br/>
|
|
7151
|
+
* <p>是否允许修改发起合同时确认弹窗的合同信息(合同名称、合同类型、签署截止时间),若不允许编辑,则表单字段将被禁止输入。<br><br>true:允许编辑<br>false:不允许编辑(默认值)<br></p>
|
|
7153
7152
|
*/
|
|
7154
7153
|
CanEditFlow?: boolean;
|
|
7155
7154
|
/**
|
|
7156
|
-
*
|
|
7157
|
-
<br/>true:允许编辑模板控件信息
|
|
7158
|
-
<br/>false:不允许编辑模板控件信息(默认值)
|
|
7159
|
-
<br/>
|
|
7155
|
+
* <p>是否允许编辑模板控件<br><br>true:允许编辑模板控件信息<br><br>false:不允许编辑模板控件信息(默认值)<br><br></p>
|
|
7160
7156
|
*/
|
|
7161
7157
|
CanEditFormField?: boolean;
|
|
7162
7158
|
/**
|
|
7163
|
-
*
|
|
7164
|
-
<br/>true:发起页面隐藏合同名称展示
|
|
7165
|
-
<br/>false:发起页面不隐藏合同名称展示(默认值)
|
|
7166
|
-
<br/>
|
|
7159
|
+
* <p>发起页面隐藏合同名称展示<br><br>true:发起页面隐藏合同名称展示<br><br>false:发起页面不隐藏合同名称展示(默认值)<br><br></p>
|
|
7167
7160
|
*/
|
|
7168
7161
|
HideShowFlowName?: boolean;
|
|
7169
7162
|
/**
|
|
7170
|
-
*
|
|
7171
|
-
<br/>true:发起页面隐藏合同类型展示
|
|
7172
|
-
<br/>false:发起页面不隐藏合同类型展示(默认值)
|
|
7173
|
-
<br/>
|
|
7174
|
-
|
|
7163
|
+
* <p>发起页面隐藏合同类型展示<br><br>true:发起页面隐藏合同类型展示<br><br>false:发起页面不隐藏合同类型展示(默认值)<br><br></p>
|
|
7175
7164
|
*/
|
|
7176
7165
|
HideShowFlowType?: boolean;
|
|
7177
7166
|
/**
|
|
7178
|
-
*
|
|
7179
|
-
<br/>true:发起页面隐藏合同截止日期展示
|
|
7180
|
-
<br/>false:发起页面不隐藏合同截止日期展示(默认值)
|
|
7181
|
-
<br/>
|
|
7167
|
+
* <p>发起页面隐藏合同截止日期展示<br><br>true:发起页面隐藏合同截止日期展示<br><br>false:发起页面不隐藏合同截止日期展示(默认值)<br><br></p>
|
|
7182
7168
|
*/
|
|
7183
7169
|
HideShowDeadline?: boolean;
|
|
7184
7170
|
/**
|
|
7185
|
-
*
|
|
7186
|
-
<br/>true:发起页面允许跳过添加签署人环节
|
|
7187
|
-
<br/>false:发起页面不允许跳过添加签署人环节(默认值)
|
|
7188
|
-
<br/>
|
|
7189
|
-
|
|
7171
|
+
* <p>发起页面允许跳过添加签署人环节<br><br>true:发起页面允许跳过添加签署人环节<br><br>false:发起页面不允许跳过添加签署人环节(默认值)<br><br></p>
|
|
7190
7172
|
*/
|
|
7191
7173
|
CanSkipAddApprover?: boolean;
|
|
7192
7174
|
/**
|
|
7193
|
-
*
|
|
7194
|
-
<br/>true:文件发起页面跳过文件上传步骤
|
|
7195
|
-
<br/>false:文件发起页面不跳过文件上传步骤(默认值)
|
|
7196
|
-
<br/>
|
|
7175
|
+
* <p>文件发起页面跳过文件上传步骤<br><br>true:文件发起页面跳过文件上传步骤<br><br>false:文件发起页面不跳过文件上传步骤(默认值)<br><br></p>
|
|
7197
7176
|
*/
|
|
7198
7177
|
SkipUploadFile?: boolean;
|
|
7199
7178
|
/**
|
|
7200
|
-
*
|
|
7201
|
-
<br/>true:禁止编辑填写控件
|
|
7202
|
-
<br/>false:允许编辑填写控件(默认值)
|
|
7203
|
-
<br/>
|
|
7179
|
+
* <p>禁止编辑填写控件<br><br>true:禁止编辑填写控件<br><br>false:允许编辑填写控件(默认值)<br><br></p>
|
|
7204
7180
|
*/
|
|
7205
7181
|
ForbidEditFillComponent?: boolean;
|
|
7206
7182
|
/**
|
|
7207
|
-
*
|
|
7208
|
-
|
|
7183
|
+
* <p>定制化发起合同弹窗的描述信息,描述信息最长500字符</p>
|
|
7209
7184
|
*/
|
|
7210
7185
|
CustomCreateFlowDescription?: string;
|
|
7211
7186
|
/**
|
|
7212
|
-
*
|
|
7213
|
-
|
|
7187
|
+
* <p>禁止添加签署方,若为true则在发起流程的可嵌入页面隐藏“添加签署人按钮”</p>
|
|
7214
7188
|
*/
|
|
7215
7189
|
ForbidAddApprover?: boolean;
|
|
7216
7190
|
/**
|
|
7217
|
-
*
|
|
7218
|
-
<ul><li>(默认) false -可以编辑签署人</li> <li> true - 禁止编辑签署人</li></ul>
|
|
7219
|
-
|
|
7220
|
-
注意:如果设置参数为 true, 则 参数签署人 [FlowApproverList](https://qian.tencent.com/developers/partnerApis/embedPages/ChannelCreatePrepareFlow) 不能为空
|
|
7191
|
+
* <p>是否可以编辑签署人包括新增,修改,删除 </p><ul><li>(默认) false -可以编辑签署人</li> <li> true - 禁止编辑签署人</li></ul><p>注意:如果设置参数为 true, 则 参数签署人 <a href="https://qian.tencent.com/developers/partnerApis/embedPages/ChannelCreatePrepareFlow">FlowApproverList</a> 不能为空</p>
|
|
7221
7192
|
*/
|
|
7222
7193
|
ForbidEditApprover?: boolean;
|
|
7223
7194
|
/**
|
|
7224
|
-
*
|
|
7225
|
-
|
|
7195
|
+
* <p>禁止设置签署流程属性 (顺序、合同签署认证方式等),若为true则在发起流程的可嵌入页面隐藏签署流程设置面板</p>
|
|
7226
7196
|
*/
|
|
7227
7197
|
ForbidEditFlowProperties?: boolean;
|
|
7228
7198
|
/**
|
|
7229
|
-
*
|
|
7230
|
-
<font color='red'>空数组代表未指定</font>),具体的控件类型如下
|
|
7231
|
-
|
|
7232
|
-
<ul><li>SIGN_SIGNATURE : 个人签名/印章</li>
|
|
7233
|
-
<li>SIGN_SEAL : 企业印章</li>
|
|
7234
|
-
<li>SIGN_PAGING_SEAL : 骑缝章</li>
|
|
7235
|
-
<li>SIGN_LEGAL_PERSON_SEAL : 法定代表人章</li>
|
|
7236
|
-
<li>SIGN_APPROVE : 签批</li>
|
|
7237
|
-
<li>SIGN_OPINION : 签署意见</li>
|
|
7238
|
-
<li>SIGN_PAGING_SIGNATURE : 手写签名骑缝控件</li>
|
|
7239
|
-
<li>BUSI-FULL-NAME : 企业全称</li>
|
|
7240
|
-
<li>BUSI-CREDIT-CODE : 统一社会信用代码</li>
|
|
7241
|
-
<li>BUSI-LEGAL-NAME : 法人/经营者姓名</li>
|
|
7242
|
-
<li>PERSONAL-NAME : 签署人姓名</li>
|
|
7243
|
-
<li>PERSONAL-MOBILE : 签署人手机号</li>
|
|
7244
|
-
<li>PERSONAL-IDCARD-TYPE : 签署人证件类型</li>
|
|
7245
|
-
<li>PERSONAL-IDCARD : 签署人证件号</li>
|
|
7246
|
-
<li>TEXT : 单行文本</li>
|
|
7247
|
-
<li>MULTI_LINE_TEXT : 多行文本</li>
|
|
7248
|
-
<li>CHECK_BOX : 勾选框</li>
|
|
7249
|
-
<li>SELECTOR : 选择器</li>
|
|
7250
|
-
<li>DIGIT : 数字</li>
|
|
7251
|
-
<li>DATE : 日期</li>
|
|
7252
|
-
<li>FILL_IMAGE : 图片</li>
|
|
7253
|
-
<li>ATTACHMENT : 附件</li>
|
|
7254
|
-
<li>EMAIL : 邮箱</li>
|
|
7255
|
-
<li>LOCATION : 地址</li>
|
|
7256
|
-
<li>EDUCATION : 学历</li>
|
|
7257
|
-
<li>GENDER : 性别</li>
|
|
7258
|
-
<li>DISTRICT : 省市区</li></ul>
|
|
7199
|
+
* <p>在发起流程的可嵌入页面要隐藏的控件列表,和 ShowComponentTypes 参数 只能二选一使用(注:<br><font color="red">空数组代表未指定</font>),具体的控件类型如下</p><ul><li>SIGN_SIGNATURE : 个人签名/印章</li><li>SIGN_SEAL : 企业印章</li><li>SIGN_PAGING_SEAL : 骑缝章</li><li>SIGN_LEGAL_PERSON_SEAL : 法定代表人章</li><li>SIGN_APPROVE : 签批</li><li>SIGN_OPINION : 签署意见</li><li>SIGN_PAGING_SIGNATURE : 手写签名骑缝控件</li><li>BUSI-FULL-NAME : 企业全称</li><li>BUSI-CREDIT-CODE : 统一社会信用代码</li><li>BUSI-LEGAL-NAME : 法人/经营者姓名</li><li>PERSONAL-NAME : 签署人姓名</li><li>PERSONAL-MOBILE : 签署人手机号</li><li>PERSONAL-IDCARD-TYPE : 签署人证件类型</li><li>PERSONAL-IDCARD : 签署人证件号</li><li>TEXT : 单行文本</li><li>MULTI_LINE_TEXT : 多行文本</li><li>CHECK_BOX : 勾选框</li><li>SELECTOR : 选择器</li><li>DIGIT : 数字</li><li>DATE : 日期</li><li>FILL_IMAGE : 图片</li><li>ATTACHMENT : 附件</li><li>EMAIL : 邮箱</li><li>LOCATION : 地址</li><li>EDUCATION : 学历</li><li>GENDER : 性别</li><li>DISTRICT : 省市区</li></ul>
|
|
7259
7200
|
*/
|
|
7260
7201
|
HideComponentTypes?: Array<string>;
|
|
7261
7202
|
/**
|
|
7262
|
-
*
|
|
7263
|
-
<font color='red'>空数组代表未指定</font>),具体的控件类型如下
|
|
7264
|
-
<ul><li>SIGN_SIGNATURE : 个人签名/印章</li>
|
|
7265
|
-
<li>SIGN_SEAL : 企业印章</li>
|
|
7266
|
-
<li>SIGN_PAGING_SEAL : 骑缝章</li>
|
|
7267
|
-
<li>SIGN_LEGAL_PERSON_SEAL : 法定代表人章</li>
|
|
7268
|
-
<li>SIGN_APPROVE : 签批</li>
|
|
7269
|
-
<li>SIGN_OPINION : 签署意见</li>
|
|
7270
|
-
<li>SIGN_PAGING_SIGNATURE : 手写签名骑缝控件</li>
|
|
7271
|
-
<li>BUSI-FULL-NAME : 企业全称</li>
|
|
7272
|
-
<li>BUSI-CREDIT-CODE : 统一社会信用代码</li>
|
|
7273
|
-
<li>BUSI-LEGAL-NAME : 法人/经营者姓名</li>
|
|
7274
|
-
<li>PERSONAL-NAME : 签署人姓名</li>
|
|
7275
|
-
<li>PERSONAL-MOBILE : 签署人手机号</li>
|
|
7276
|
-
<li>PERSONAL-IDCARD-TYPE : 签署人证件类型</li>
|
|
7277
|
-
<li>PERSONAL-IDCARD : 签署人证件号</li>
|
|
7278
|
-
<li>TEXT : 单行文本</li>
|
|
7279
|
-
<li>MULTI_LINE_TEXT : 多行文本</li>
|
|
7280
|
-
<li>CHECK_BOX : 勾选框</li>
|
|
7281
|
-
<li>SELECTOR : 选择器</li>
|
|
7282
|
-
<li>DIGIT : 数字</li>
|
|
7283
|
-
<li>DATE : 日期</li>
|
|
7284
|
-
<li>FILL_IMAGE : 图片</li>
|
|
7285
|
-
<li>ATTACHMENT : 附件</li>
|
|
7286
|
-
<li>EMAIL : 邮箱</li>
|
|
7287
|
-
<li>LOCATION : 地址</li>
|
|
7288
|
-
<li>EDUCATION : 学历</li>
|
|
7289
|
-
<li>GENDER : 性别</li>
|
|
7290
|
-
<li>DISTRICT : 省市区</li></ul>
|
|
7203
|
+
* <p>在发起流程的可嵌入页面要显示的控件列表,和 HideComponentTypes 参数 只能二选一使用(注:<br><font color="red">空数组代表未指定</font>),具体的控件类型如下</p><ul><li>SIGN_SIGNATURE : 个人签名/印章</li><li>SIGN_SEAL : 企业印章</li><li>SIGN_PAGING_SEAL : 骑缝章</li><li>SIGN_LEGAL_PERSON_SEAL : 法定代表人章</li><li>SIGN_APPROVE : 签批</li><li>SIGN_OPINION : 签署意见</li><li>SIGN_PAGING_SIGNATURE : 手写签名骑缝控件</li><li>BUSI-FULL-NAME : 企业全称</li><li>BUSI-CREDIT-CODE : 统一社会信用代码</li><li>BUSI-LEGAL-NAME : 法人/经营者姓名</li><li>PERSONAL-NAME : 签署人姓名</li><li>PERSONAL-MOBILE : 签署人手机号</li><li>PERSONAL-IDCARD-TYPE : 签署人证件类型</li><li>PERSONAL-IDCARD : 签署人证件号</li><li>TEXT : 单行文本</li><li>MULTI_LINE_TEXT : 多行文本</li><li>CHECK_BOX : 勾选框</li><li>SELECTOR : 选择器</li><li>DIGIT : 数字</li><li>DATE : 日期</li><li>FILL_IMAGE : 图片</li><li>ATTACHMENT : 附件</li><li>EMAIL : 邮箱</li><li>LOCATION : 地址</li><li>EDUCATION : 学历</li><li>GENDER : 性别</li><li>DISTRICT : 省市区</li></ul>
|
|
7291
7204
|
*/
|
|
7292
7205
|
ShowComponentTypes?: Array<string>;
|
|
7293
7206
|
/**
|
|
7294
|
-
*
|
|
7207
|
+
* <p>发起流程的可嵌入页面结果页配置</p>
|
|
7295
7208
|
*/
|
|
7296
7209
|
ResultPageConfig?: Array<CreateResultPageConfig>;
|
|
7297
7210
|
/**
|
|
7298
|
-
*
|
|
7299
|
-
- 签署控件 是否默认展示日期.
|
|
7211
|
+
* <p>签署控件的配置信息,用在嵌入式发起的页面配置,包括 </p><ul><li>签署控件 是否默认展示日期.</li></ul>
|
|
7300
7212
|
*/
|
|
7301
7213
|
SignComponentConfig?: SignComponentConfig;
|
|
7302
7214
|
/**
|
|
7303
|
-
*
|
|
7304
|
-
<ul><li>(默认) false -否</li> <li> true - 禁止编辑</li></ul>
|
|
7215
|
+
* <p>是否禁止编辑(展示)水印控件属性</p><ul><li>(默认) false -否</li> <li> true - 禁止编辑</li></ul>
|
|
7305
7216
|
*/
|
|
7306
7217
|
ForbidEditWatermark?: boolean;
|
|
7307
7218
|
/**
|
|
7308
|
-
*
|
|
7309
|
-
|
|
7310
|
-
<ul><li>1 : 操作指引入口</li>
|
|
7311
|
-
<li>2 : 操作文档</li>
|
|
7312
|
-
<li>3 : 操作视频</li>
|
|
7313
|
-
</ul>
|
|
7314
|
-
注:仅对新版页面生效
|
|
7219
|
+
* <p>隐藏操作指引: 具体的控件类型如下</p><ul><li>1 : 操作指引入口</li><li>2 : 操作文档</li><li>3 : 操作视频</li></ul>注:仅对新版页面生效
|
|
7315
7220
|
* @deprecated
|
|
7316
7221
|
*/
|
|
7317
7222
|
HideOperationInstructions?: Array<number | bigint>;
|
|
7318
7223
|
/**
|
|
7319
|
-
*
|
|
7320
|
-
|
|
7321
|
-
<ul><li>1 : 选择文件及签署方</li>
|
|
7322
|
-
<li>2 : 补充文件内容</li>
|
|
7323
|
-
<li>4 : 发起前合同信息与设置确认</li>
|
|
7324
|
-
</ul>
|
|
7325
|
-
注:仅对新版页面生效
|
|
7224
|
+
* <p>隐藏操作步骤: 具体的控件类型如下</p><ul><li>1 : 选择文件及签署方</li><li>2 : 补充文件内容</li><li>4 : 发起前合同信息与设置确认</li></ul>注:仅对新版页面生效
|
|
7326
7225
|
*/
|
|
7327
7226
|
HideOperationSteps?: Array<number | bigint>;
|
|
7328
7227
|
/**
|
|
7329
|
-
*
|
|
7228
|
+
* <p>本企业简称,注:仅对新版页面生效</p>
|
|
7330
7229
|
*/
|
|
7331
7230
|
SelfName?: string;
|
|
7332
7231
|
/**
|
|
7333
|
-
*
|
|
7232
|
+
* <p>发起后签署码隐藏,默认false,注:仅对新版页面生效</p>
|
|
7334
7233
|
*/
|
|
7335
7234
|
HideSignCodeAfterStart?: boolean;
|
|
7336
7235
|
/**
|
|
7337
|
-
*
|
|
7236
|
+
* <p>发起成功后是否预览合同 <ul><li>(默认) false -否</li> <li> true - 展示预览按钮</li></ul></p>
|
|
7338
7237
|
*/
|
|
7339
7238
|
PreviewAfterStart?: boolean;
|
|
7340
7239
|
/**
|
|
7341
|
-
*
|
|
7240
|
+
* <p>发起成功之后是否签署合同,仅当前经办人作为签署人时生效 <ul><li>(默认) false -否</li> <li> true - 展示签署按钮</li></ul></p>
|
|
7342
7241
|
*/
|
|
7343
7242
|
SignAfterStart?: boolean;
|
|
7344
7243
|
/**
|
|
7345
|
-
*
|
|
7244
|
+
* <p>发起过程中是否保存草稿</p>
|
|
7346
7245
|
*/
|
|
7347
7246
|
NeedFlowDraft?: boolean;
|
|
7247
|
+
/**
|
|
7248
|
+
* <p>若指定了合同抄送人,此参数用来控制操作人能否在嵌入式页面看见或编辑(修改、增加、删除)抄送人信息。</p><p>枚举值:</p><ul><li>0: 不可见不可编辑</li><li>1: 可见不可编辑</li><li>2: 可见可编辑</li></ul><p>默认值:0</p>
|
|
7249
|
+
*/
|
|
7250
|
+
CcInfoVisibility?: number;
|
|
7348
7251
|
}
|
|
7349
7252
|
/**
|
|
7350
7253
|
* DescribeContractDiffTaskWebUrl返回参数结构体
|
|
@@ -374,7 +374,7 @@ export declare class Client extends AbstractClient {
|
|
|
374
374
|
适用场景1:已经上传了一个word文件,希望将该word文件转换成pdf文件后发起合同
|
|
375
375
|
适用场景2:已经上传了一个jpg图片文件,希望将该图片文件转换成pdf文件后发起合同<br />
|
|
376
376
|
转换文件是一个耗时操作,若想查看转换任务是否完成,可以通过<a href="https://qian.tencent.com/developers/partnerApis/files/ChannelGetTaskResultApi" target="_blank">查询转换任务状态</a>接口获取任务状态。<br />
|
|
377
|
-
<font color="red">此接口于 2026 年 12月 31 日下线</font>,请使用新接口: <a href="https://qian.tencent.com/developers/partnerApis/files/CreateFileConvertTask" target="_blank"
|
|
377
|
+
<font color="red">此接口于 2026 年 12月 31 日下线</font>,请使用新接口: <a href="https://qian.tencent.com/developers/partnerApis/files/CreateFileConvertTask" target="_blank">新建文件转换任务(CreateFileConvertTask)</a><br />
|
|
378
378
|
注:
|
|
379
379
|
1. `支持的文件类型有doc、docx、xls、xlsx、html、jpg、jpeg、png、bmp、txt`
|
|
380
380
|
2. `可通过发起合同时设置预览来检查转换文件是否达到预期效果`
|
|
@@ -779,7 +779,6 @@ Agent参数中的OpenId 必须为审批者的openId,且链接必须由审批
|
|
|
779
779
|
4. 该接口返回的签署链接适用于APP集成的场景,支持APP打开或浏览器直接打开,**不支持微信小程序嵌入**。
|
|
780
780
|
跳转到小程序的实现,参考微信官方文档(分为<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>。
|
|
781
781
|
6. 因h5涉及人脸身份认证能力基于慧眼人脸核身,对Android和iOS系统均有一定要求, 因此<font color='red'>App嵌入H5签署合同需要按照慧眼提供的<a href="https://cloud.tencent.com/document/product/1007/61076">慧眼人脸核身兼容性文档</a>做兼容性适配</font>。
|
|
782
|
-
7. H5签署现在仅支持中国大陆身份证和中国港澳台居民居住证。
|
|
783
782
|
*/
|
|
784
783
|
ChannelCreateBatchQuickSignUrl(req: ChannelCreateBatchQuickSignUrlRequest, cb?: (error: string, rep: ChannelCreateBatchQuickSignUrlResponse) => void): Promise<ChannelCreateBatchQuickSignUrlResponse>;
|
|
785
784
|
/**
|
|
@@ -932,7 +931,7 @@ Agent参数中的OpenId 必须为审批者的openId,且链接必须由审批
|
|
|
932
931
|
如果是其他类型可以配合<a href="https://qian.tencent.com/developers/partnerApis/files/ChannelCreateConvertTaskApi" target="_blank">创建文件转换任务</a>接口转换成PDF文件
|
|
933
932
|
|
|
934
933
|
注:
|
|
935
|
-
1. 图片类型(png/jpg/jpeg)限制大小为
|
|
934
|
+
1. 图片类型(png/jpg/jpeg)限制大小为8M以下, PDF/word/excel等其他格式限制大小为60M以下
|
|
936
935
|
2. <font color='red'>此接口调用时需要单独设置Domain请求域名 </font>, 联调开发环境为 <font color='red'>file.test.ess.tencent.cn</font>,正式环境需要设置为<font color='red'>file.ess.tencent.cn</font>,代码示例
|
|
937
936
|
```
|
|
938
937
|
HttpProfile httpProfile = new HttpProfile();
|
|
@@ -962,7 +961,6 @@ httpProfile.setEndpoint("file.test.ess.tencent.cn");
|
|
|
962
961
|
2. 该接口返回的签署链接适用于APP集成的场景,支持在支付宝、APP打开、浏览器直接打开,**不支持微信小程序嵌入**。配置方式请参考:<a href="https://qian.tencent.com/developers/company/openqianh5/">跳转电子签H5</a>。
|
|
963
962
|
如需跳转到小程序的实现,参考微信官方文档(分为<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>。
|
|
964
963
|
3. 因h5涉及人脸身份认证能力基于慧眼人脸核身,对Android和iOS系统均有一定要求, 因此<font color='red'>App嵌入H5签署合同需要按照慧眼提供的<a href="https://cloud.tencent.com/document/product/1007/61076">慧眼人脸核身兼容性文档</a>做兼容性适配</font>。
|
|
965
|
-
4. H5签署现在**仅支持中国大陆身份证、中国港澳台居民居住证**。
|
|
966
964
|
*/
|
|
967
965
|
ChannelCreateFlowSignUrl(req: ChannelCreateFlowSignUrlRequest, cb?: (error: string, rep: ChannelCreateFlowSignUrlResponse) => void): Promise<ChannelCreateFlowSignUrlResponse>;
|
|
968
966
|
/**
|
|
@@ -444,7 +444,7 @@ class Client extends abstract_client_1.AbstractClient {
|
|
|
444
444
|
适用场景1:已经上传了一个word文件,希望将该word文件转换成pdf文件后发起合同
|
|
445
445
|
适用场景2:已经上传了一个jpg图片文件,希望将该图片文件转换成pdf文件后发起合同<br />
|
|
446
446
|
转换文件是一个耗时操作,若想查看转换任务是否完成,可以通过<a href="https://qian.tencent.com/developers/partnerApis/files/ChannelGetTaskResultApi" target="_blank">查询转换任务状态</a>接口获取任务状态。<br />
|
|
447
|
-
<font color="red">此接口于 2026 年 12月 31 日下线</font>,请使用新接口: <a href="https://qian.tencent.com/developers/partnerApis/files/CreateFileConvertTask" target="_blank"
|
|
447
|
+
<font color="red">此接口于 2026 年 12月 31 日下线</font>,请使用新接口: <a href="https://qian.tencent.com/developers/partnerApis/files/CreateFileConvertTask" target="_blank">新建文件转换任务(CreateFileConvertTask)</a><br />
|
|
448
448
|
注:
|
|
449
449
|
1. `支持的文件类型有doc、docx、xls、xlsx、html、jpg、jpeg、png、bmp、txt`
|
|
450
450
|
2. `可通过发起合同时设置预览来检查转换文件是否达到预期效果`
|
|
@@ -907,7 +907,6 @@ Agent参数中的OpenId 必须为审批者的openId,且链接必须由审批
|
|
|
907
907
|
4. 该接口返回的签署链接适用于APP集成的场景,支持APP打开或浏览器直接打开,**不支持微信小程序嵌入**。
|
|
908
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>。
|
|
909
909
|
6. 因h5涉及人脸身份认证能力基于慧眼人脸核身,对Android和iOS系统均有一定要求, 因此<font color='red'>App嵌入H5签署合同需要按照慧眼提供的<a href="https://cloud.tencent.com/document/product/1007/61076">慧眼人脸核身兼容性文档</a>做兼容性适配</font>。
|
|
910
|
-
7. H5签署现在仅支持中国大陆身份证和中国港澳台居民居住证。
|
|
911
910
|
*/
|
|
912
911
|
async ChannelCreateBatchQuickSignUrl(req, cb) {
|
|
913
912
|
return this.request("ChannelCreateBatchQuickSignUrl", req, cb);
|
|
@@ -1080,7 +1079,7 @@ Agent参数中的OpenId 必须为审批者的openId,且链接必须由审批
|
|
|
1080
1079
|
如果是其他类型可以配合<a href="https://qian.tencent.com/developers/partnerApis/files/ChannelCreateConvertTaskApi" target="_blank">创建文件转换任务</a>接口转换成PDF文件
|
|
1081
1080
|
|
|
1082
1081
|
注:
|
|
1083
|
-
1. 图片类型(png/jpg/jpeg)限制大小为
|
|
1082
|
+
1. 图片类型(png/jpg/jpeg)限制大小为8M以下, PDF/word/excel等其他格式限制大小为60M以下
|
|
1084
1083
|
2. <font color='red'>此接口调用时需要单独设置Domain请求域名 </font>, 联调开发环境为 <font color='red'>file.test.ess.tencent.cn</font>,正式环境需要设置为<font color='red'>file.ess.tencent.cn</font>,代码示例
|
|
1085
1084
|
```
|
|
1086
1085
|
HttpProfile httpProfile = new HttpProfile();
|
|
@@ -1114,7 +1113,6 @@ httpProfile.setEndpoint("file.test.ess.tencent.cn");
|
|
|
1114
1113
|
2. 该接口返回的签署链接适用于APP集成的场景,支持在支付宝、APP打开、浏览器直接打开,**不支持微信小程序嵌入**。配置方式请参考:<a href="https://qian.tencent.com/developers/company/openqianh5/">跳转电子签H5</a>。
|
|
1115
1114
|
如需跳转到小程序的实现,参考微信官方文档(分为<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>。
|
|
1116
1115
|
3. 因h5涉及人脸身份认证能力基于慧眼人脸核身,对Android和iOS系统均有一定要求, 因此<font color='red'>App嵌入H5签署合同需要按照慧眼提供的<a href="https://cloud.tencent.com/document/product/1007/61076">慧眼人脸核身兼容性文档</a>做兼容性适配</font>。
|
|
1117
|
-
4. H5签署现在**仅支持中国大陆身份证、中国港澳台居民居住证**。
|
|
1118
1116
|
*/
|
|
1119
1117
|
async ChannelCreateFlowSignUrl(req, cb) {
|
|
1120
1118
|
return this.request("ChannelCreateFlowSignUrl", req, cb);
|