tencentcloud-sdk-nodejs 4.0.666 → 4.0.668
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 +335 -0
- package/SERVICE_CHANGELOG.md +342 -61
- package/package.json +1 -1
- package/products.md +118 -118
- package/src/common/sdk_version.ts +1 -1
- package/src/services/batch/v20170312/batch_models.ts +8 -4
- package/src/services/cam/v20190116/cam_models.ts +11 -11
- package/src/services/cdb/v20170320/cdb_client.ts +13 -30
- package/src/services/cdb/v20170320/cdb_models.ts +1 -55
- package/src/services/cls/v20201016/cls_client.ts +4 -2
- package/src/services/cls/v20201016/cls_models.ts +1 -1
- package/src/services/cwp/v20180228/cwp_models.ts +5 -3
- package/src/services/cynosdb/v20190107/cynosdb_client.ts +1 -1
- package/src/services/cynosdb/v20190107/cynosdb_models.ts +2 -2
- package/src/services/ecm/v20190719/ecm_models.ts +4 -0
- package/src/services/ess/v20201111/ess_client.ts +2 -3
- package/src/services/ess/v20201111/ess_models.ts +108 -140
- package/src/services/essbasic/v20210526/essbasic_client.ts +3 -2
- package/src/services/essbasic/v20210526/essbasic_models.ts +55 -27
- package/src/services/faceid/v20180301/faceid_client.ts +6 -3
- package/src/services/faceid/v20180301/faceid_models.ts +114 -33
- package/src/services/iotvideo/v20211125/iotvideo_client.ts +24 -12
- package/src/services/iotvideo/v20211125/iotvideo_models.ts +56 -0
- package/src/services/lcic/v20220817/lcic_client.ts +15 -3
- package/src/services/lcic/v20220817/lcic_models.ts +32 -12
- package/src/services/mps/v20190612/mps_client.ts +1 -0
- package/src/services/mps/v20190612/mps_models.ts +45 -13
- package/src/services/ms/v20180408/ms_client.ts +127 -91
- package/src/services/ms/v20180408/ms_models.ts +145 -8
- package/src/services/nlp/v20190408/nlp_client.ts +15 -0
- package/src/services/nlp/v20190408/nlp_models.ts +117 -0
- package/src/services/privatedns/v20201028/privatedns_models.ts +5 -5
- package/src/services/redis/v20180412/redis_models.ts +89 -65
- package/src/services/ssa/v20180608/ssa_models.ts +2 -2
- package/src/services/tione/v20211111/tione_client.ts +1 -1
- package/src/services/vpc/v20170312/vpc_models.ts +5 -1
- package/src/services/wedata/v20210820/wedata_models.ts +5 -1
- package/tencentcloud/common/sdk_version.d.ts +1 -1
- package/tencentcloud/common/sdk_version.js +1 -1
- package/tencentcloud/services/batch/v20170312/batch_models.d.ts +8 -4
- package/tencentcloud/services/cam/v20190116/cam_models.d.ts +11 -11
- package/tencentcloud/services/cdb/v20170320/cdb_client.d.ts +5 -13
- package/tencentcloud/services/cdb/v20170320/cdb_client.js +6 -16
- package/tencentcloud/services/cdb/v20170320/cdb_models.d.ts +1 -52
- package/tencentcloud/services/cls/v20201016/cls_client.d.ts +2 -0
- package/tencentcloud/services/cls/v20201016/cls_client.js +2 -0
- package/tencentcloud/services/cls/v20201016/cls_models.d.ts +1 -1
- package/tencentcloud/services/cwp/v20180228/cwp_models.d.ts +5 -3
- package/tencentcloud/services/cynosdb/v20190107/cynosdb_client.d.ts +1 -1
- package/tencentcloud/services/cynosdb/v20190107/cynosdb_client.js +1 -1
- package/tencentcloud/services/cynosdb/v20190107/cynosdb_models.d.ts +2 -2
- package/tencentcloud/services/ecm/v20190719/ecm_models.d.ts +4 -0
- package/tencentcloud/services/ess/v20201111/ess_client.d.ts +0 -1
- package/tencentcloud/services/ess/v20201111/ess_client.js +0 -1
- package/tencentcloud/services/ess/v20201111/ess_models.d.ts +108 -140
- package/tencentcloud/services/essbasic/v20210526/essbasic_client.d.ts +2 -2
- package/tencentcloud/services/essbasic/v20210526/essbasic_client.js +1 -1
- package/tencentcloud/services/essbasic/v20210526/essbasic_models.d.ts +54 -27
- package/tencentcloud/services/faceid/v20180301/faceid_client.d.ts +1 -1
- package/tencentcloud/services/faceid/v20180301/faceid_models.d.ts +111 -33
- package/tencentcloud/services/iotvideo/v20211125/iotvideo_client.d.ts +9 -5
- package/tencentcloud/services/iotvideo/v20211125/iotvideo_client.js +12 -6
- package/tencentcloud/services/iotvideo/v20211125/iotvideo_models.d.ts +54 -0
- package/tencentcloud/services/lcic/v20220817/lcic_client.d.ts +5 -1
- package/tencentcloud/services/lcic/v20220817/lcic_client.js +6 -0
- package/tencentcloud/services/lcic/v20220817/lcic_models.d.ts +30 -12
- package/tencentcloud/services/mps/v20190612/mps_models.d.ts +44 -13
- package/tencentcloud/services/ms/v20180408/ms_client.d.ts +51 -39
- package/tencentcloud/services/ms/v20180408/ms_client.js +72 -54
- package/tencentcloud/services/ms/v20180408/ms_models.d.ts +139 -8
- package/tencentcloud/services/nlp/v20190408/nlp_client.d.ts +5 -1
- package/tencentcloud/services/nlp/v20190408/nlp_client.js +6 -0
- package/tencentcloud/services/nlp/v20190408/nlp_models.d.ts +112 -0
- package/tencentcloud/services/privatedns/v20201028/privatedns_models.d.ts +5 -5
- package/tencentcloud/services/redis/v20180412/redis_models.d.ts +89 -65
- package/tencentcloud/services/ssa/v20180608/ssa_models.d.ts +2 -2
- package/tencentcloud/services/tione/v20211111/tione_client.d.ts +1 -1
- package/tencentcloud/services/tione/v20211111/tione_client.js +1 -1
- package/tencentcloud/services/vpc/v20170312/vpc_models.d.ts +5 -1
- package/tencentcloud/services/wedata/v20210820/wedata_models.d.ts +5 -1
- package/test/cdb.v20170320.test.js +4 -14
- package/test/iotvideo.v20211125.test.js +14 -4
- package/test/lcic.v20220817.test.js +10 -0
- package/test/ms.v20180408.test.js +66 -36
- package/test/nlp.v20190408.test.js +10 -0
|
@@ -1129,16 +1129,6 @@ export interface ModifyBackupEncryptionStatusResponse {
|
|
|
1129
1129
|
RequestId?: string
|
|
1130
1130
|
}
|
|
1131
1131
|
|
|
1132
|
-
/**
|
|
1133
|
-
* 数据库表名
|
|
1134
|
-
*/
|
|
1135
|
-
export interface DatabaseName {
|
|
1136
|
-
/**
|
|
1137
|
-
* 数据库表名
|
|
1138
|
-
*/
|
|
1139
|
-
DatabaseName: string
|
|
1140
|
-
}
|
|
1141
|
-
|
|
1142
1132
|
/**
|
|
1143
1133
|
* DescribeInstanceParams请求参数结构体
|
|
1144
1134
|
*/
|
|
@@ -5607,24 +5597,6 @@ export interface DescribeDBImportRecordsResponse {
|
|
|
5607
5597
|
RequestId?: string
|
|
5608
5598
|
}
|
|
5609
5599
|
|
|
5610
|
-
/**
|
|
5611
|
-
* DescribeBackupDatabases返回参数结构体
|
|
5612
|
-
*/
|
|
5613
|
-
export interface DescribeBackupDatabasesResponse {
|
|
5614
|
-
/**
|
|
5615
|
-
* 返回的数据个数。
|
|
5616
|
-
*/
|
|
5617
|
-
TotalCount: number
|
|
5618
|
-
/**
|
|
5619
|
-
* 符合查询条件的数据库数组。
|
|
5620
|
-
*/
|
|
5621
|
-
Items: Array<DatabaseName>
|
|
5622
|
-
/**
|
|
5623
|
-
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
5624
|
-
*/
|
|
5625
|
-
RequestId?: string
|
|
5626
|
-
}
|
|
5627
|
-
|
|
5628
5600
|
/**
|
|
5629
5601
|
* 创建备份时,指定需要备份的库表信息
|
|
5630
5602
|
*/
|
|
@@ -5827,7 +5799,7 @@ sqlType - SQL类型;
|
|
|
5827
5799
|
errCode - 错误码;
|
|
5828
5800
|
threadId - 线程ID;
|
|
5829
5801
|
|
|
5830
|
-
|
|
5802
|
+
范围搜索(时间类型统一为微秒):
|
|
5831
5803
|
execTime - 执行时间;
|
|
5832
5804
|
lockWaitTime - 执行时间;
|
|
5833
5805
|
ioWaitTime - IO等待时间;
|
|
@@ -8780,32 +8752,6 @@ export interface RollbackTables {
|
|
|
8780
8752
|
Table: Array<RollbackTableName>
|
|
8781
8753
|
}
|
|
8782
8754
|
|
|
8783
|
-
/**
|
|
8784
|
-
* DescribeBackupDatabases请求参数结构体
|
|
8785
|
-
*/
|
|
8786
|
-
export interface DescribeBackupDatabasesRequest {
|
|
8787
|
-
/**
|
|
8788
|
-
* 实例 ID,格式如:cdb-c1nl9rpv。与云数据库控制台页面中显示的实例 ID 相同。
|
|
8789
|
-
*/
|
|
8790
|
-
InstanceId: string
|
|
8791
|
-
/**
|
|
8792
|
-
* 开始时间,格式为:2017-07-12 10:29:20。
|
|
8793
|
-
*/
|
|
8794
|
-
StartTime: string
|
|
8795
|
-
/**
|
|
8796
|
-
* 要查询的数据库名前缀。
|
|
8797
|
-
*/
|
|
8798
|
-
SearchDatabase?: string
|
|
8799
|
-
/**
|
|
8800
|
-
* 分页偏移量。
|
|
8801
|
-
*/
|
|
8802
|
-
Offset?: number
|
|
8803
|
-
/**
|
|
8804
|
-
* 分页大小,最小值为1,最大值为2000。
|
|
8805
|
-
*/
|
|
8806
|
-
Limit?: number
|
|
8807
|
-
}
|
|
8808
|
-
|
|
8809
8755
|
/**
|
|
8810
8756
|
* 本地binlog保留策略默认配置。
|
|
8811
8757
|
*/
|
|
@@ -897,8 +897,10 @@ cls.pb.cc cls.pb.h cls.proto
|
|
|
897
897
|
}
|
|
898
898
|
|
|
899
899
|
/**
|
|
900
|
-
|
|
901
|
-
|
|
900
|
+
* 本接口用于检索分析日志, 该接口除受默认接口请求频率限制外,针对单个日志主题,查询并发数不能超过15。
|
|
901
|
+
|
|
902
|
+
API返回数据包最大49MB,建议启用 gzip 压缩(HTTP Request Header Accept-Encoding:gzip)。
|
|
903
|
+
*/
|
|
902
904
|
async SearchLog(
|
|
903
905
|
req: SearchLogRequest,
|
|
904
906
|
cb?: (error: string, rep: SearchLogResponse) => void
|
|
@@ -5216,7 +5216,7 @@ export interface SearchLogRequest {
|
|
|
5216
5216
|
*/
|
|
5217
5217
|
TopicId?: string
|
|
5218
5218
|
/**
|
|
5219
|
-
*
|
|
5219
|
+
* 表示单次查询返回的原始日志条数,默认为100,最大值为1000,获取后续日志需使用Context参数
|
|
5220
5220
|
注意:
|
|
5221
5221
|
* 仅当检索分析语句(Query)不包含SQL时有效
|
|
5222
5222
|
* SQL结果条数指定方式参考<a href="https://cloud.tencent.com/document/product/614/58977" target="_blank">SQL LIMIT语法</a>
|
|
@@ -11849,11 +11849,11 @@ export interface DescribeLicenseBindListResponse {
|
|
|
11849
11849
|
/**
|
|
11850
11850
|
* 总条数
|
|
11851
11851
|
*/
|
|
11852
|
-
TotalCount
|
|
11852
|
+
TotalCount?: number
|
|
11853
11853
|
/**
|
|
11854
11854
|
* 绑定机器列表信息
|
|
11855
11855
|
*/
|
|
11856
|
-
List
|
|
11856
|
+
List?: Array<LicenseBindDetail>
|
|
11857
11857
|
/**
|
|
11858
11858
|
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
11859
11859
|
*/
|
|
@@ -16716,7 +16716,9 @@ export interface DescribeLicenseBindListRequest {
|
|
|
16716
16716
|
*/
|
|
16717
16717
|
ResourceId: string
|
|
16718
16718
|
/**
|
|
16719
|
-
* <li>
|
|
16719
|
+
* <li>InstanceID、IP、
|
|
16720
|
+
|
|
16721
|
+
MachineName 模糊查询</li>
|
|
16720
16722
|
*/
|
|
16721
16723
|
Filters?: Array<Filters>
|
|
16722
16724
|
/**
|
|
@@ -5548,11 +5548,11 @@ export interface DescribeProxyNodesResponse {
|
|
|
5548
5548
|
/**
|
|
5549
5549
|
* 数据库代理节点总数
|
|
5550
5550
|
*/
|
|
5551
|
-
TotalCount
|
|
5551
|
+
TotalCount?: number
|
|
5552
5552
|
/**
|
|
5553
5553
|
* 数据库代理节点列表
|
|
5554
5554
|
*/
|
|
5555
|
-
ProxyNodeInfos
|
|
5555
|
+
ProxyNodeInfos?: Array<ProxyNodeInfo>
|
|
5556
5556
|
/**
|
|
5557
5557
|
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
5558
5558
|
*/
|
|
@@ -759,9 +759,8 @@ httpProfile.setEndpoint("file.test.ess.tencent.cn");<br/>
|
|
|
759
759
|
}
|
|
760
760
|
|
|
761
761
|
/**
|
|
762
|
-
|
|
763
|
-
|
|
764
|
-
*/
|
|
762
|
+
* 查询流程填写控件内容,可以根据流程Id查询该流程相关联的填写控件信息和填写内容。
|
|
763
|
+
*/
|
|
765
764
|
async DescribeFlowComponents(
|
|
766
765
|
req: DescribeFlowComponentsRequest,
|
|
767
766
|
cb?: (error: string, rep: DescribeFlowComponentsResponse) => void
|
|
@@ -832,7 +832,7 @@ export interface CreateConvertTaskApiRequest {
|
|
|
832
832
|
*/
|
|
833
833
|
ResourceName: string
|
|
834
834
|
/**
|
|
835
|
-
*
|
|
835
|
+
* 文件Id,通过UploadFiles获取
|
|
836
836
|
*/
|
|
837
837
|
ResourceId: string
|
|
838
838
|
/**
|
|
@@ -2161,7 +2161,7 @@ export interface UnbindEmployeeUserIdWithClientOpenIdRequest {
|
|
|
2161
2161
|
*/
|
|
2162
2162
|
export interface CreateSchemeUrlResponse {
|
|
2163
2163
|
/**
|
|
2164
|
-
* 小程序链接地址,有效期
|
|
2164
|
+
* 小程序链接地址,有效期30天
|
|
2165
2165
|
*/
|
|
2166
2166
|
SchemeUrl?: string
|
|
2167
2167
|
/**
|
|
@@ -3234,24 +3234,28 @@ export interface DeleteIntegrationRoleUsersRequest {
|
|
|
3234
3234
|
*/
|
|
3235
3235
|
export interface CreateFlowByFilesRequest {
|
|
3236
3236
|
/**
|
|
3237
|
-
*
|
|
3238
|
-
使用此接口时,必须填写userId。
|
|
3239
|
-
在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。
|
|
3237
|
+
* 执行本接口操作的员工信息。使用此接口时,必须填写userId。
|
|
3240
3238
|
支持填入集团子公司经办人 userId 代发合同。
|
|
3239
|
+
|
|
3240
|
+
注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
|
|
3241
3241
|
*/
|
|
3242
3242
|
Operator: UserInfo
|
|
3243
3243
|
/**
|
|
3244
3244
|
* 合同流程的名称(可自定义此名称),长度不能超过200,只能由中文、字母、数字和下划线组成。
|
|
3245
|
+
|
|
3245
3246
|
该名称还将用于合同签署完成后的下载文件名。
|
|
3246
3247
|
*/
|
|
3247
3248
|
FlowName: string
|
|
3248
3249
|
/**
|
|
3249
3250
|
* 合同流程的参与方列表,最多可支持50个参与方,可在列表中指定企业B端签署方和个人C端签署方的联系和认证方式等信息,具体定义可以参考开发者中心的ApproverInfo结构体。
|
|
3251
|
+
|
|
3250
3252
|
如果合同流程是有序签署,Approvers列表中参与人的顺序就是默认的签署顺序,请确保列表中参与人的顺序符合实际签署顺序。
|
|
3251
3253
|
*/
|
|
3252
3254
|
Approvers: Array<ApproverInfo>
|
|
3253
3255
|
/**
|
|
3254
|
-
* 本合同流程需包含的PDF
|
|
3256
|
+
* 本合同流程需包含的PDF文件资源编号列表,通过<a href="https://qian.tencent.com/developers/companyApis/templatesAndFiles/UploadFiles" target="_blank">UploadFiles</a>接口获取PDF文件资源编号。
|
|
3257
|
+
|
|
3258
|
+
注: `目前,此接口仅支持单个文件发起。`
|
|
3255
3259
|
*/
|
|
3256
3260
|
FileIds: Array<string>
|
|
3257
3261
|
/**
|
|
@@ -3264,43 +3268,38 @@ export interface CreateFlowByFilesRequest {
|
|
|
3264
3268
|
FlowType?: string
|
|
3265
3269
|
/**
|
|
3266
3270
|
* 模板或者合同中的填写控件列表,列表中可支持下列多种填写控件,控件的详细定义参考开发者中心的Component结构体
|
|
3267
|
-
|
|
3268
|
-
|
|
3269
|
-
|
|
3270
|
-
|
|
3271
|
-
|
|
3272
|
-
|
|
3271
|
+
<ul><li> 单行文本控件 </li>
|
|
3272
|
+
<li> 多行文本控件 </li>
|
|
3273
|
+
<li> 勾选框控件 </li>
|
|
3274
|
+
<li> 数字控件 </li>
|
|
3275
|
+
<li> 图片控件 </li>
|
|
3276
|
+
<li> 动态表格等填写控件</li></ul>
|
|
3273
3277
|
*/
|
|
3274
3278
|
Components?: Array<Component>
|
|
3275
3279
|
/**
|
|
3276
3280
|
* 合同流程的抄送人列表,最多可支持50个抄送人,抄送人可查看合同内容及签署进度,但无需参与合同签署。
|
|
3277
|
-
|
|
3281
|
+
|
|
3282
|
+
注:`此功能为白名单功能,使用前请联系对接的客户经理沟通。`
|
|
3278
3283
|
*/
|
|
3279
3284
|
CcInfos?: Array<CcInfo>
|
|
3280
3285
|
/**
|
|
3281
3286
|
* 可以设置以下时间节点来给抄送人发送短信通知来查看合同内容:
|
|
3282
|
-
|
|
3283
|
-
|
|
3284
|
-
- 1:签署完成后通知
|
|
3287
|
+
<ul><li> **0**:合同发起时通知(默认值)</li>
|
|
3288
|
+
<li> **1**:签署完成后通知</li></ul>
|
|
3285
3289
|
*/
|
|
3286
3290
|
CcNotifyType?: number
|
|
3287
3291
|
/**
|
|
3288
3292
|
* 是否为预览模式,取值如下:
|
|
3289
|
-
|
|
3290
|
-
|
|
3291
|
-
|
|
3292
|
-
true:预览模式,不产生合同流程,不返回合同流程编号FlowId,而是返回预览链接PreviewUrl,有效期为300秒,用于查看真实发起后合同的样子。
|
|
3293
|
+
<ul><li> **false**:非预览模式(默认),会产生合同流程并返回合同流程编号FlowId。</li>
|
|
3294
|
+
<li> **true**:预览模式,不产生合同流程,不返回合同流程编号FlowId,而是返回预览链接PreviewUrl,有效期为300秒,用于查看真实发起后合同的样子。</li></ul>
|
|
3293
3295
|
*/
|
|
3294
3296
|
NeedPreview?: boolean
|
|
3295
3297
|
/**
|
|
3296
|
-
*
|
|
3297
|
-
|
|
3298
|
-
|
|
3299
|
-
|
|
3298
|
+
* 预览模式下产生的预览链接类型
|
|
3299
|
+
<ul><li> **0** :(默认) 文件流 ,点开后后下载预览的合同PDF文件 </li>
|
|
3300
|
+
<li> **1** :H5链接 ,点开后在浏览器中展示合同的样子</li></ul>
|
|
3301
|
+
注: `此参数在NeedPreview 为true时有效`
|
|
3300
3302
|
|
|
3301
|
-
- 1 :H5链接 ,点开后在浏览器中展示合同的样子
|
|
3302
|
-
|
|
3303
|
-
注意: 此参数在NeedPreview 为true时有效
|
|
3304
3303
|
*/
|
|
3305
3304
|
PreviewType?: number
|
|
3306
3305
|
/**
|
|
@@ -3310,71 +3309,60 @@ true:预览模式,不产生合同流程,不返回合同流程编号FlowId
|
|
|
3310
3309
|
Deadline?: number
|
|
3311
3310
|
/**
|
|
3312
3311
|
* 合同到期提醒时间,为Unix标准时间戳(秒)格式,支持的范围是从发起时间开始到后10年内。
|
|
3312
|
+
|
|
3313
3313
|
到达提醒时间后,腾讯电子签会短信通知发起方企业合同提醒,可用于处理合同到期事务,如合同续签等事宜。
|
|
3314
3314
|
*/
|
|
3315
3315
|
RemindedOn?: number
|
|
3316
3316
|
/**
|
|
3317
|
-
*
|
|
3318
|
-
|
|
3319
|
-
|
|
3320
|
-
- true:无序签署, 本合同多个参与人没有先后签署限制
|
|
3317
|
+
* 合同流程的签署顺序类型:
|
|
3318
|
+
<ul><li> **false**:(默认)有序签署, 本合同多个参与人需要依次签署 </li>
|
|
3319
|
+
<li> **true**:无序签署, 本合同多个参与人没有先后签署限制</li></ul>
|
|
3321
3320
|
*/
|
|
3322
3321
|
Unordered?: boolean
|
|
3323
3322
|
/**
|
|
3324
3323
|
* 您可以自定义腾讯电子签小程序合同列表页展示的合同内容模板,模板中支持以下变量:
|
|
3325
|
-
|
|
3326
|
-
|
|
3327
|
-
|
|
3328
|
-
|
|
3329
|
-
|
|
3330
|
-
- {签署方N姓名}
|
|
3331
|
-
|
|
3324
|
+
<ul><li>{合同名称} </li>
|
|
3325
|
+
<li>{发起方企业} </li>
|
|
3326
|
+
<li>{发起方姓名} </li>
|
|
3327
|
+
<li>{签署方N企业}</li>
|
|
3328
|
+
<li>{签署方N姓名}</li></ul>
|
|
3332
3329
|
其中,N表示签署方的编号,从1开始,不能超过签署人的数量。
|
|
3333
3330
|
|
|
3334
|
-
|
|
3335
|
-
合同名称:`合同名称:{合同名称};发起方: {发起方企业}({发起方姓名});签署方:{签署方1姓名}`
|
|
3331
|
+
例如,如果是腾讯公司张三发给李四名称为“租房合同”的合同,您可以将此字段设置为:`合同名称:{合同名称};发起方: {发起方企业}({发起方姓名});签署方:{签署方1姓名}`,则小程序中列表页展示此合同为以下样子
|
|
3336
3332
|
|
|
3337
|
-
则小程序中列表页展示此合同为以下样子
|
|
3338
|
-
```
|
|
3339
3333
|
合同名称:租房合同
|
|
3340
3334
|
发起方:腾讯公司(张三)
|
|
3341
3335
|
签署方:李四
|
|
3342
|
-
|
|
3336
|
+
|
|
3337
|
+
|
|
3343
3338
|
*/
|
|
3344
3339
|
CustomShowMap?: string
|
|
3345
3340
|
/**
|
|
3346
|
-
*
|
|
3347
|
-
|
|
3348
|
-
|
|
3349
|
-
- false:(默认)不需要审批,直接签署。
|
|
3350
|
-
- true:需要走审批流程。当到对应参与人签署时,会阻塞其签署操作,等待企业内部审批完成。
|
|
3351
|
-
|
|
3341
|
+
* 发起方企业的签署人进行签署操作前,是否需要企业内部走审批流程,取值如下:
|
|
3342
|
+
<ul><li> **false**:(默认)不需要审批,直接签署。</li>
|
|
3343
|
+
<li> **true**:需要走审批流程。当到对应参与人签署时,会阻塞其签署操作,等待企业内部审批完成。</li></ul>
|
|
3352
3344
|
企业可以通过CreateFlowSignReview审批接口通知腾讯电子签平台企业内部审批结果
|
|
3353
|
-
|
|
3354
|
-
|
|
3355
|
-
|
|
3356
|
-
|
|
3357
|
-
注:此功能可用于与企业内部的审批流程进行关联,支持手动、静默签署合同
|
|
3345
|
+
<ul><li> 如果企业通知腾讯电子签平台审核通过,签署方可继续签署动作。</li>
|
|
3346
|
+
<li> 如果企业通知腾讯电子签平台审核未通过,平台将继续阻塞签署方的签署动作,直到企业通知平台审核通过。</li></ul>
|
|
3347
|
+
注:`此功能可用于与企业内部的审批流程进行关联,支持手动、静默签署合同`
|
|
3358
3348
|
*/
|
|
3359
3349
|
NeedSignReview?: boolean
|
|
3360
3350
|
/**
|
|
3361
3351
|
* 调用方自定义的个性化字段(可自定义此名称),并以base64方式编码,支持的最大数据大小为 20480长度。
|
|
3362
|
-
|
|
3363
|
-
|
|
3352
|
+
|
|
3353
|
+
在合同状态变更的回调信息等场景中,该字段的信息将原封不动地透传给贵方。回调的相关说明可参考开发者中心的<a href="https://qian.tencent.com/developers/company/callback_types_v2" target="_blank">回调通知</a>模块。
|
|
3364
3354
|
*/
|
|
3365
3355
|
UserData?: string
|
|
3366
3356
|
/**
|
|
3367
3357
|
* 指定个人签署方查看合同的校验方式
|
|
3368
|
-
|
|
3369
|
-
|
|
3370
|
-
- MobileCheck: 手机号验证, 用户手机号和参与方手机号(ApproverMobile)相同即可查看合同内容
|
|
3358
|
+
<ul><li> **VerifyCheck** :(默认)人脸识别,人脸识别后才能合同内容 </li>
|
|
3359
|
+
<li> **MobileCheck** : 手机号验证, 用户手机号和参与方手机号(ApproverMobile)相同即可查看合同内容</li></ul>
|
|
3371
3360
|
*/
|
|
3372
3361
|
ApproverVerifyType?: string
|
|
3373
3362
|
/**
|
|
3374
3363
|
* 签署方签署控件(印章/签名等)的生成方式:
|
|
3375
|
-
|
|
3376
|
-
|
|
3377
|
-
- 1:签署方在签署时自行添加签署控件,可以拖动位置和控制数量。
|
|
3364
|
+
<ul><li> **0**:在合同流程发起时,由发起人指定签署方的签署控件的位置和数量。</li>
|
|
3365
|
+
<li> **1**:签署方在签署时自行添加签署控件,可以拖动位置和控制数量。</li></ul>
|
|
3378
3366
|
*/
|
|
3379
3367
|
SignBeanTag?: number
|
|
3380
3368
|
/**
|
|
@@ -3384,10 +3372,8 @@ true:预览模式,不产生合同流程,不返回合同流程编号FlowId
|
|
|
3384
3372
|
Agent?: Agent
|
|
3385
3373
|
/**
|
|
3386
3374
|
* 个人自动签名的使用场景包括以下, 个人自动签署(即ApproverType设置成个人自动签署时)业务此值必传:
|
|
3387
|
-
|
|
3388
|
-
|
|
3389
|
-
|
|
3390
|
-
注: 个人自动签名场景是白名单功能,使用前请与对接的客户经理联系沟通。
|
|
3375
|
+
<ul><li> **E_PRESCRIPTION_AUTO_SIGN**:处方单(医疗自动签) </li></ul>
|
|
3376
|
+
注: `个人自动签名场景是白名单功能,使用前请与对接的客户经理联系沟通。`
|
|
3391
3377
|
*/
|
|
3392
3378
|
AutoSignScene?: string
|
|
3393
3379
|
}
|
|
@@ -3716,12 +3702,12 @@ export interface FailedCreateRoleData {
|
|
|
3716
3702
|
export interface ApproverInfo {
|
|
3717
3703
|
/**
|
|
3718
3704
|
* 在指定签署方时,可选择企业B端或个人C端等不同的参与者类型,可选类型如下:
|
|
3719
|
-
0
|
|
3720
|
-
1
|
|
3721
|
-
3
|
|
3722
|
-
|
|
3723
|
-
7
|
|
3724
|
-
注:
|
|
3705
|
+
**0**:企业
|
|
3706
|
+
**1**:个人
|
|
3707
|
+
**3**:企业静默签署
|
|
3708
|
+
注:`类型为3(企业静默签署)时,此接口会默认完成该签署方的签署。静默签署仅进行盖章操作,不能自动签名。`
|
|
3709
|
+
**7**: 个人自动签署,适用于个人自动签场景。
|
|
3710
|
+
注: `个人自动签场景为白名单功能,使用前请联系对接的客户经理沟通。`
|
|
3725
3711
|
*/
|
|
3726
3712
|
ApproverType: number
|
|
3727
3713
|
/**
|
|
@@ -3731,57 +3717,54 @@ export interface ApproverInfo {
|
|
|
3731
3717
|
ApproverName: string
|
|
3732
3718
|
/**
|
|
3733
3719
|
* 本企业的签署方经办人的员工UserId
|
|
3734
|
-
|
|
3735
3720
|
可登录腾讯电子签控制台,在 "更多能力"->"组织管理" 中查看某位员工的UserId(在页面中展示为用户ID)。
|
|
3736
3721
|
|
|
3737
|
-
注:
|
|
3722
|
+
注: `若传该字段,则签署方经办人的其他信息(如签署方经办人的姓名、证件号码、手机号码等)将被忽略。`
|
|
3738
3723
|
*/
|
|
3739
3724
|
ApproverMobile: string
|
|
3740
3725
|
/**
|
|
3741
3726
|
* 组织机构名称。
|
|
3742
3727
|
如果签署方是企业签署方(approverType = 1 或者 approverType = 3), 则企业名称必填。
|
|
3743
3728
|
|
|
3744
|
-
注:
|
|
3729
|
+
注: `请确认该名称与企业营业执照中注册的名称一致 ; 如果名称中包含英文括号(),请使用中文括号()代替。`
|
|
3745
3730
|
*/
|
|
3746
3731
|
OrganizationName?: string
|
|
3747
3732
|
/**
|
|
3748
3733
|
* 合同中的签署控件列表,列表中可支持下列多种签署控件,控件的详细定义参考开发者中心的Component结构体
|
|
3749
|
-
|
|
3750
|
-
|
|
3751
|
-
|
|
3734
|
+
<ul><li> 个人签名/印章</li>
|
|
3735
|
+
<li> 企业印章</li>
|
|
3736
|
+
<li> 骑缝章等签署控件</li><ul>
|
|
3752
3737
|
*/
|
|
3753
3738
|
SignComponents?: Array<Component>
|
|
3754
3739
|
/**
|
|
3755
3740
|
* 签署方经办人的证件类型,支持以下类型
|
|
3756
|
-
|
|
3757
|
-
|
|
3758
|
-
|
|
3759
|
-
|
|
3741
|
+
<ul><li>ID_CARD 居民身份证 (默认值)</li>
|
|
3742
|
+
<li>HONGKONG_AND_MACAO 港澳居民来往内地通行证</li>
|
|
3743
|
+
<li>HONGKONG_MACAO_AND_TAIWAN 港澳台居民居住证(格式同居民身份证)</li>
|
|
3744
|
+
<li>OTHER_CARD_TYPE 其他证件</li></ul>
|
|
3760
3745
|
|
|
3761
|
-
注:
|
|
3746
|
+
注: `其他证件类型为白名单功能,使用前请联系对接的客户经理沟通。`
|
|
3762
3747
|
*/
|
|
3763
3748
|
ApproverIdCardType?: string
|
|
3764
3749
|
/**
|
|
3765
3750
|
* 签署方经办人的证件号码,应符合以下规则
|
|
3766
|
-
|
|
3767
|
-
|
|
3768
|
-
|
|
3751
|
+
<ul><li>居民身份证号码应为18位字符串,由数字和大写字母X组成(如存在X,请大写)。</li>
|
|
3752
|
+
<li>港澳居民来往内地通行证号码应为9位字符串,第1位为“C”,第2位为英文字母(但“I”、“O”除外),后7位为阿拉伯数字。</li>
|
|
3753
|
+
<li>港澳台居民居住证号码编码规则与中国大陆身份证相同,应为18位字符串。</li></ul>
|
|
3769
3754
|
*/
|
|
3770
3755
|
ApproverIdCardNumber?: string
|
|
3771
3756
|
/**
|
|
3772
3757
|
* 通知签署方经办人的方式, 有以下途径:
|
|
3773
|
-
|
|
3774
|
-
|
|
3775
|
-
- none: 不通知
|
|
3758
|
+
<ul><li> **sms** : (默认)短信</li>
|
|
3759
|
+
<li> **none** : 不通知</li></ul>
|
|
3776
3760
|
*/
|
|
3777
3761
|
NotifyType?: string
|
|
3778
3762
|
/**
|
|
3779
|
-
* 收据场景设置签署人角色类型,
|
|
3780
|
-
|
|
3781
|
-
|
|
3782
|
-
|
|
3783
|
-
|
|
3784
|
-
注: 收据场景为白名单功能,使用前请联系对接的客户经理沟通。
|
|
3763
|
+
* 收据场景设置签署人角色类型, 可以设置如下****类型****:
|
|
3764
|
+
<ul><li> **1** :收款人</li>
|
|
3765
|
+
<li> **2** :开具人</li>
|
|
3766
|
+
<li> **3** :见证人</li></ul>
|
|
3767
|
+
注: `收据场景为白名单功能,使用前请联系对接的客户经理沟通。`
|
|
3785
3768
|
*/
|
|
3786
3769
|
ApproverRole?: number
|
|
3787
3770
|
/**
|
|
@@ -3794,20 +3777,19 @@ export interface ApproverInfo {
|
|
|
3794
3777
|
* 签署方在签署合同之前,需要强制阅读合同的时长,可指定为3秒至300秒之间的任意值。
|
|
3795
3778
|
|
|
3796
3779
|
若未指定阅读时间,则会按照合同页数大小计算阅读时间,计算规则如下:
|
|
3797
|
-
|
|
3798
|
-
|
|
3799
|
-
|
|
3800
|
-
- 合同页数大于等于6页,阅读时间为10秒。
|
|
3780
|
+
<ul><li>合同页数少于等于2页,阅读时间为3秒;</li>
|
|
3781
|
+
<li>合同页数为3到5页,阅读时间为5秒;</li>
|
|
3782
|
+
<li>合同页数大于等于6页,阅读时间为10秒。</li></ul>
|
|
3801
3783
|
*/
|
|
3802
3784
|
PreReadTime?: number
|
|
3803
3785
|
/**
|
|
3804
3786
|
* 签署人userId,仅支持本企业的员工userid, 可在控制台组织管理处获得
|
|
3805
3787
|
|
|
3806
|
-
|
|
3788
|
+
注: `若传此字段 则以userid的信息为主,会覆盖传递过来的签署人基本信息, 包括姓名,手机号,证件类型等信息`
|
|
3807
3789
|
*/
|
|
3808
3790
|
UserId?: string
|
|
3809
3791
|
/**
|
|
3810
|
-
*
|
|
3792
|
+
* 在企微场景下使用,需设置参数为**WEWORKAPP**,以表明合同来源于企微。
|
|
3811
3793
|
*/
|
|
3812
3794
|
ApproverSource?: string
|
|
3813
3795
|
/**
|
|
@@ -3824,43 +3806,32 @@ export interface ApproverInfo {
|
|
|
3824
3806
|
ApproverOption?: ApproverOption
|
|
3825
3807
|
/**
|
|
3826
3808
|
* 指定个人签署方查看合同的校验方式,可以传值如下:
|
|
3827
|
-
|
|
3828
|
-
|
|
3829
|
-
- 2 : 手机号验证, 用户手机号和参与方手机号(ApproverMobile)相同即可查看合同内容
|
|
3830
|
-
|
|
3809
|
+
<ul><li> **1** : (默认)人脸识别,人脸识别后才能合同内容</li>
|
|
3810
|
+
<li> **2** : 手机号验证, 用户手机号和参与方手机号(ApproverMobile)相同即可查看合同内容</li></ul>
|
|
3831
3811
|
注:
|
|
3832
|
-
|
|
3833
|
-
|
|
3834
|
-
- 此字段不可传多个校验方式
|
|
3812
|
+
<ul><li>如果合同流程设置ApproverVerifyType查看合同的校验方式, 则忽略此签署人的查看合同的校验方式</li>
|
|
3813
|
+
<li>此字段不可传多个校验方式</li></ul>
|
|
3835
3814
|
*/
|
|
3836
3815
|
ApproverVerifyTypes?: Array<number>
|
|
3837
3816
|
/**
|
|
3838
3817
|
* 您可以指定签署方签署合同的认证校验方式,可传递以下值:
|
|
3839
|
-
|
|
3840
|
-
|
|
3841
|
-
|
|
3842
|
-
- 3:运营商三要素,需到运营商处比对手机号实名信息(名字、手机号、证件号)校验一致才能成功进行合同签署。
|
|
3843
|
-
|
|
3818
|
+
<ul><li>**1**:人脸认证,需进行人脸识别成功后才能签署合同;</li>
|
|
3819
|
+
<li>**2**:签署密码,需输入与用户在腾讯电子签设置的密码一致才能校验成功进行合同签署;</li>
|
|
3820
|
+
<li>**3**:运营商三要素,需到运营商处比对手机号实名信息(名字、手机号、证件号)校验一致才能成功进行合同签署。</li></ul>
|
|
3844
3821
|
注:
|
|
3845
|
-
|
|
3846
|
-
|
|
3847
|
-
- 您可以传递多种值,表示可用多种认证校验方式。
|
|
3848
|
-
|
|
3822
|
+
<ul><li>默认情况下,认证校验方式为人脸认证和签署密码两种形式;</li>
|
|
3823
|
+
<li>您可以传递多种值,表示可用多种认证校验方式。</li></ul>
|
|
3849
3824
|
*/
|
|
3850
3825
|
ApproverSignTypes?: Array<number>
|
|
3851
3826
|
/**
|
|
3852
|
-
*
|
|
3853
|
-
|
|
3854
|
-
|
|
3855
|
-
- false:(默认)不需要审批,直接签署。
|
|
3856
|
-
- true:需要走审批流程。当到对应参与人签署时,会阻塞其签署操作,等待企业内部审批完成。
|
|
3857
|
-
|
|
3827
|
+
* 发起方企业的签署人进行签署操作前,是否需要企业内部走审批流程,取值如下:
|
|
3828
|
+
<ul><li>**false**:(默认)不需要审批,直接签署。</li>
|
|
3829
|
+
<li>**true**:需要走审批流程。当到对应参与人签署时,会阻塞其签署操作,等待企业内部审批完成。</li></ul>
|
|
3858
3830
|
企业可以通过CreateFlowSignReview审批接口通知腾讯电子签平台企业内部审批结果
|
|
3831
|
+
<ul><li>如果企业通知腾讯电子签平台审核通过,签署方可继续签署动作。</li>
|
|
3832
|
+
<li>如果企业通知腾讯电子签平台审核未通过,平台将继续阻塞签署方的签署动作,直到企业通知平台审核通过。</li></ul>
|
|
3859
3833
|
|
|
3860
|
-
|
|
3861
|
-
- 如果企业通知腾讯电子签平台审核未通过,平台将继续阻塞签署方的签署动作,直到企业通知平台审核通过。
|
|
3862
|
-
|
|
3863
|
-
注:此功能可用于与企业内部的审批流程进行关联,支持手动、静默签署合同
|
|
3834
|
+
注:`此功能可用于与企业内部的审批流程进行关联,支持手动、静默签署合同`
|
|
3864
3835
|
*/
|
|
3865
3836
|
ApproverNeedSignReview?: boolean
|
|
3866
3837
|
}
|
|
@@ -4496,15 +4467,15 @@ export interface ApproverOption {
|
|
|
4496
4467
|
/**
|
|
4497
4468
|
* 签署方是否可以拒签
|
|
4498
4469
|
|
|
4499
|
-
|
|
4500
|
-
|
|
4470
|
+
<ul><li> **false** : ( 默认)可以拒签</li>
|
|
4471
|
+
<li> **true** :不可以拒签</li></ul>
|
|
4501
4472
|
*/
|
|
4502
4473
|
NoRefuse?: boolean
|
|
4503
4474
|
/**
|
|
4504
4475
|
* 签署方是否可以转他人处理
|
|
4505
4476
|
|
|
4506
|
-
|
|
4507
|
-
|
|
4477
|
+
<ul><li> **false** : ( 默认)可以转他人处理</li>
|
|
4478
|
+
<li> **true** :不可以转他人处理</li></ul>
|
|
4508
4479
|
*/
|
|
4509
4480
|
NoTransfer?: boolean
|
|
4510
4481
|
}
|
|
@@ -5670,23 +5641,20 @@ export interface CcInfo {
|
|
|
5670
5641
|
Name?: string
|
|
5671
5642
|
/**
|
|
5672
5643
|
* 被抄送方类型, 可设置以下类型:
|
|
5673
|
-
|
|
5674
|
-
|
|
5675
|
-
- 1:企业员工抄送方
|
|
5644
|
+
<ul><li> **0** :个人抄送方</li>
|
|
5645
|
+
<li> **1** :企业员工抄送方</li></ul>
|
|
5676
5646
|
*/
|
|
5677
5647
|
CcType?: number
|
|
5678
5648
|
/**
|
|
5679
5649
|
* 被抄送方权限, 可设置如下权限:
|
|
5680
|
-
|
|
5681
|
-
|
|
5682
|
-
- 1:可查看合同内容也可下载原文
|
|
5650
|
+
<ul><li> **0** :可查看合同内容</li>
|
|
5651
|
+
<li> **1** :可查看合同内容也可下载原文</li></ul>
|
|
5683
5652
|
*/
|
|
5684
5653
|
CcPermission?: number
|
|
5685
5654
|
/**
|
|
5686
5655
|
* 通知签署方经办人的方式, 有以下途径:
|
|
5687
|
-
|
|
5688
|
-
|
|
5689
|
-
- none: 不通知
|
|
5656
|
+
<ul><li> **sms** : (默认)短信</li>
|
|
5657
|
+
<li> **none** : 不通知</li></ul>
|
|
5690
5658
|
*/
|
|
5691
5659
|
NotifyType?: string
|
|
5692
5660
|
}
|