tencentcloud-sdk-nodejs 4.1.264 → 4.1.265
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/asr/v20190614/asr_client.js +3 -0
- package/es/services/dbbrain/v20210527/dbbrain_client.js +3 -0
- package/es/services/monitor/v20180724/monitor_client.js +3 -0
- package/es/services/ocr/v20181119/ocr_client.js +8 -2
- 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/ags/v20250920/ags_models.d.ts +9 -5
- package/tencentcloud/services/alb/v20251030/alb_client.d.ts +4 -4
- package/tencentcloud/services/alb/v20251030/alb_client.js +4 -4
- package/tencentcloud/services/alb/v20251030/alb_models.d.ts +75 -167
- package/tencentcloud/services/antiddos/v20200309/antiddos_models.d.ts +7 -10
- package/tencentcloud/services/asr/v20190614/asr_client.d.ts +5 -1
- package/tencentcloud/services/asr/v20190614/asr_client.js +6 -0
- package/tencentcloud/services/asr/v20190614/asr_models.d.ts +30 -0
- package/tencentcloud/services/cfs/v20190719/cfs_client.d.ts +3 -3
- package/tencentcloud/services/cfs/v20190719/cfs_client.js +2 -2
- package/tencentcloud/services/cfs/v20190719/cfs_models.d.ts +6 -1
- package/tencentcloud/services/cls/v20201016/cls_models.d.ts +24 -0
- package/tencentcloud/services/cynosdb/v20190107/cynosdb_models.d.ts +95 -56
- package/tencentcloud/services/dbbrain/v20210527/dbbrain_client.d.ts +5 -1
- package/tencentcloud/services/dbbrain/v20210527/dbbrain_client.js +6 -0
- package/tencentcloud/services/dbbrain/v20210527/dbbrain_models.d.ts +64 -34
- package/tencentcloud/services/dlc/v20210125/dlc_models.d.ts +17 -9
- package/tencentcloud/services/dnspod/v20210323/dnspod_models.d.ts +198 -113
- package/tencentcloud/services/dts/v20211206/dts_models.d.ts +13 -9
- package/tencentcloud/services/emr/v20190103/emr_models.d.ts +4 -0
- package/tencentcloud/services/ess/v20201111/ess_models.d.ts +50 -185
- package/tencentcloud/services/ga2/v20250115/ga2_models.d.ts +9 -5
- package/tencentcloud/services/iai/v20200303/iai_client.d.ts +7 -3
- package/tencentcloud/services/iai/v20200303/iai_client.js +7 -3
- package/tencentcloud/services/live/v20180801/live_models.d.ts +8 -4
- package/tencentcloud/services/monitor/v20180724/monitor_client.d.ts +5 -1
- package/tencentcloud/services/monitor/v20180724/monitor_client.js +6 -0
- package/tencentcloud/services/monitor/v20180724/monitor_models.d.ts +210 -184
- package/tencentcloud/services/ocr/v20181119/ocr_client.d.ts +15 -3
- package/tencentcloud/services/ocr/v20181119/ocr_client.js +19 -3
- package/tencentcloud/services/ocr/v20181119/ocr_models.d.ts +208 -91
- package/tencentcloud/services/ses/v20201002/ses_models.d.ts +2 -2
- package/tencentcloud/services/tcb/v20180608/tcb_models.d.ts +21 -13
- package/tencentcloud/services/tdmq/v20200217/tdmq_models.d.ts +81 -66
- package/tencentcloud/services/tdmysql/v20211122/tdmysql_client.d.ts +1 -1
- package/tencentcloud/services/tdmysql/v20211122/tdmysql_models.d.ts +6 -1
- package/tencentcloud/services/teo/v20220901/teo_models.d.ts +32 -34
- package/tencentcloud/services/thpc/v20230321/thpc_models.d.ts +22 -14
- package/tencentcloud/services/tione/v20211111/tione_models.d.ts +2 -7
- package/tencentcloud/services/tokenhub/v20260322/tokenhub_client.d.ts +1 -1
- package/tencentcloud/services/tokenhub/v20260322/tokenhub_client.js +1 -1
- package/tencentcloud/services/tokenhub/v20260322/tokenhub_models.d.ts +8 -4
- package/tencentcloud/services/trtc/v20190722/trtc_client.d.ts +6 -9
- package/tencentcloud/services/trtc/v20190722/trtc_client.js +6 -9
- package/tencentcloud/services/trtc/v20190722/trtc_models.d.ts +30 -35
- package/tencentcloud/services/wedata/v20210820/wedata_models.d.ts +108 -101
- package/tencentcloud/services/wedata/v20250806/wedata_models.d.ts +5 -5
|
@@ -2352,7 +2352,7 @@ export interface DescribeCompareDiffItemsResponse {
|
|
|
2352
2352
|
*/
|
|
2353
2353
|
export interface CreateSubscribeResponse {
|
|
2354
2354
|
/**
|
|
2355
|
-
*
|
|
2355
|
+
* <p>数据订阅实例的ID数组</p>
|
|
2356
2356
|
*/
|
|
2357
2357
|
SubscribeIds?: Array<string>;
|
|
2358
2358
|
/**
|
|
@@ -4850,35 +4850,39 @@ export interface ModifyMigrateNameRequest {
|
|
|
4850
4850
|
*/
|
|
4851
4851
|
export interface CreateSubscribeRequest {
|
|
4852
4852
|
/**
|
|
4853
|
-
*
|
|
4853
|
+
* <p>订阅的数据库类型,目前支持 cynosdbmysql(tdsql-c mysql版),mariadb,mongodb,mysql,percona,tdpg(tdsql postgresql版),tdsqlpercona(tdsql mysql版)</p>
|
|
4854
4854
|
*/
|
|
4855
4855
|
Product: string;
|
|
4856
4856
|
/**
|
|
4857
|
-
*
|
|
4857
|
+
* <p>付费方式,枚举值:0-包年包月,1-按量计费</p>
|
|
4858
4858
|
*/
|
|
4859
4859
|
PayType: number;
|
|
4860
4860
|
/**
|
|
4861
|
-
*
|
|
4861
|
+
* <p>购买时长。当 payType 为包年包月时,该项需要填,单位为月,最小值为 1,最大值为 120。不填默认1</p>
|
|
4862
4862
|
*/
|
|
4863
4863
|
Duration?: number;
|
|
4864
4864
|
/**
|
|
4865
|
-
*
|
|
4865
|
+
* <p>是否自动续费。当 payType 为包年包月时,该项需要填。枚举值:0-不自动续费,1-自动续费。默认不自动续费。按量计费设置该标识无效。</p>
|
|
4866
4866
|
*/
|
|
4867
4867
|
AutoRenew?: number;
|
|
4868
4868
|
/**
|
|
4869
|
-
*
|
|
4869
|
+
* <p>购买数量,默认为1,最大为10</p>
|
|
4870
4870
|
*/
|
|
4871
4871
|
Count?: number;
|
|
4872
4872
|
/**
|
|
4873
|
-
*
|
|
4873
|
+
* <p>实例资源标签</p>
|
|
4874
4874
|
*/
|
|
4875
4875
|
Tags?: Array<TagItem>;
|
|
4876
4876
|
/**
|
|
4877
|
-
*
|
|
4877
|
+
* <p>任务名,自定义</p>
|
|
4878
4878
|
*/
|
|
4879
4879
|
Name?: string;
|
|
4880
4880
|
/**
|
|
4881
|
-
*
|
|
4881
|
+
* <p>数据订阅版本,目前支持kafka和kafkaPro(专业版),如果不填,默认kafkaPro</p>
|
|
4882
|
+
*/
|
|
4883
|
+
SubscribeVersion?: string;
|
|
4884
|
+
/**
|
|
4885
|
+
* <p>订阅实例规格,当前仅支持small、medium、large</p>
|
|
4882
4886
|
*/
|
|
4883
4887
|
InstanceClass?: string;
|
|
4884
4888
|
}
|
|
@@ -1168,173 +1168,103 @@ export interface CreateBatchInformationExtractionTaskRequest {
|
|
|
1168
1168
|
*/
|
|
1169
1169
|
export interface CreateFlowByFilesRequest {
|
|
1170
1170
|
/**
|
|
1171
|
-
*
|
|
1172
|
-
|
|
1173
|
-
注: 支持填入集团子公司经办人 userId 代发合同。
|
|
1174
|
-
|
|
1171
|
+
* <p>本合同的发起人 <a href="https://qcloudimg.tencent-cloud.cn/raw/f850cfbe163a1cb38439a9f551c2505c.png" target="_blank">点击查看合同发起人展示的位置</a></p><p>注: 支持填入集团子公司经办人 userId 代发合同。</p>
|
|
1175
1172
|
*/
|
|
1176
1173
|
Operator: UserInfo;
|
|
1177
1174
|
/**
|
|
1178
|
-
*
|
|
1179
|
-
|
|
1180
|
-
该名称还将用于合同签署完成后文件下载的默认文件名称。
|
|
1175
|
+
* <p>自定义的合同流程的名称,长度不能超过200个字符,只能由中文汉字、中文标点、英文字母、阿拉伯数字、空格、小括号、中括号、中划线、下划线以及(,)、(;)、(.)、(&)、(+)组成。</p><p>该名称还将用于合同签署完成后文件下载的默认文件名称。</p>
|
|
1181
1176
|
*/
|
|
1182
1177
|
FlowName: string;
|
|
1183
1178
|
/**
|
|
1184
|
-
*
|
|
1185
|
-
|
|
1186
|
-
注: `目前,此接口仅支持单个文件发起。`
|
|
1179
|
+
* <p>本合同流程需包含的PDF文件资源编号列表,通过<a href="https://qian.tencent.com/developers/companyApis/templatesAndFiles/UploadFiles">UploadFiles</a>接口获取PDF文件资源编号。</p><p>注: <code>目前,此接口仅支持单个文件发起。</code></p>
|
|
1187
1180
|
*/
|
|
1188
1181
|
FileIds: Array<string>;
|
|
1189
1182
|
/**
|
|
1190
|
-
*
|
|
1191
|
-
|
|
1192
|
-
如果合同流程是有序签署,Approvers列表中参与人的顺序就是默认的签署顺序,请确保列表中参与人的顺序符合实际签署顺序。
|
|
1183
|
+
* <p>合同流程的参与方列表,最多可支持50个参与方,可在列表中指定企业B端签署方和个人C端签署方的联系和认证方式等信息,具体定义可以参考开发者中心的ApproverInfo结构体。</p><p>如果合同流程是有序签署,Approvers列表中参与人的顺序就是默认的签署顺序,请确保列表中参与人的顺序符合实际签署顺序。</p>
|
|
1193
1184
|
*/
|
|
1194
1185
|
Approvers?: Array<ApproverInfo>;
|
|
1195
1186
|
/**
|
|
1196
|
-
*
|
|
1187
|
+
* <p>合同流程描述信息(可自定义此描述),最大长度1000个字符。</p>
|
|
1197
1188
|
*/
|
|
1198
1189
|
FlowDescription?: string;
|
|
1199
1190
|
/**
|
|
1200
|
-
*
|
|
1201
|
-
如果用户已经在控制台创建了自定义合同类型,可以将这里的类型名称传入。 如果没有创建,我们会自动给发起方公司创建此自定义合同类型。
|
|
1202
|
-

|
|
1191
|
+
* <p>合同流程的类别分类(可自定义名称,如销售合同/入职合同等),最大长度为200个字符,仅限中文、字母、数字和下划线组成。<br>如果用户已经在控制台创建了自定义合同类型,可以将这里的类型名称传入。 如果没有创建,我们会自动给发起方公司创建此自定义合同类型。<br><img src="https://qcloudimg.tencent-cloud.cn/raw/36582cea03ae6a2559894844942b5d5c.png" alt="image"></p>
|
|
1203
1192
|
*/
|
|
1204
1193
|
FlowType?: string;
|
|
1205
1194
|
/**
|
|
1206
|
-
*
|
|
1207
|
-
<ul><li> 单行文本控件 </li>
|
|
1208
|
-
<li> 多行文本控件 </li>
|
|
1209
|
-
<li> 勾选框控件 </li>
|
|
1210
|
-
<li> 数字控件 </li>
|
|
1211
|
-
<li> 图片控件 </li>
|
|
1212
|
-
<li> 水印控件等 </li>
|
|
1213
|
-
</ul>
|
|
1214
|
-
|
|
1215
|
-

|
|
1195
|
+
* <p>发起的时候合成到PDF上的填写控件(需要提供填写控件的内容)</p><ul><li> 单行文本控件 </li><li> 多行文本控件 </li><li> 勾选框控件 </li><li> 数字控件 </li><li> 图片控件 </li><li> 水印控件等 </li></ul><p><img src="https://qcloudimg.tencent-cloud.cn/raw/e004195ee4cb98a7f9bc12eb4a0a0b77.png" alt="image"></p>
|
|
1216
1196
|
*/
|
|
1217
1197
|
Components?: Array<Component>;
|
|
1218
1198
|
/**
|
|
1219
|
-
*
|
|
1220
|
-
|
|
1221
|
-
<b>注</b>
|
|
1222
|
-
1. 抄送人名单中可以包括自然人以及本企业的员工。
|
|
1223
|
-
2. 请确保抄送人列表中的成员不与任何签署人重复。
|
|
1224
|
-
|
|
1199
|
+
* <p>合同流程的抄送人列表,最多可支持50个抄送人,抄送人可查看合同内容及签署进度,但无需参与合同签署。</p><p><b>注</b></p><ol><li>抄送人名单中可以包括自然人以及本企业的员工。</li><li>请确保抄送人列表中的成员不与任何签署人重复。</li></ol>
|
|
1225
1200
|
*/
|
|
1226
1201
|
CcInfos?: Array<CcInfo>;
|
|
1227
1202
|
/**
|
|
1228
|
-
*
|
|
1229
|
-
<ul><li> **0**:合同发起时通知(默认值)</li>
|
|
1230
|
-
<li> **1**:签署完成后通知</li></ul>
|
|
1203
|
+
* <p>可以设置以下时间节点来给抄送人发送短信通知来查看合同内容:</p><ul><li> **0**:合同发起时通知(默认值)</li><li> **1**:签署完成后通知</li></ul>
|
|
1231
1204
|
*/
|
|
1232
1205
|
CcNotifyType?: number;
|
|
1233
1206
|
/**
|
|
1234
|
-
*
|
|
1235
|
-
<ul><li> **false**:非预览模式(默认),会产生合同流程并返回合同流程编号FlowId。</li>
|
|
1236
|
-
<li> **true**:预览模式,不产生合同流程,不返回合同流程编号FlowId,而是返回预览链接PreviewUrl,有效期为300秒,用于查看真实发起后合同的样子。</li></ul>
|
|
1207
|
+
* <p>是否为预览模式,取值如下:</p><ul><li> **false**:非预览模式(默认),会产生合同流程并返回合同流程编号FlowId。</li><li> **true**:预览模式,不产生合同流程,不返回合同流程编号FlowId,而是返回预览链接PreviewUrl,有效期为300秒,用于查看真实发起后合同的样子。</li></ul>
|
|
1237
1208
|
*/
|
|
1238
1209
|
NeedPreview?: boolean;
|
|
1239
1210
|
/**
|
|
1240
|
-
*
|
|
1241
|
-
<ul><li> **0** :(默认) 文件流 ,点开后下载预览的合同PDF文件 </li>
|
|
1242
|
-
<li> **1** :H5链接 ,点开后在浏览器中展示合同的样子</li></ul>
|
|
1243
|
-
注: `此参数在NeedPreview 为true时有效`
|
|
1244
|
-
|
|
1211
|
+
* <p>预览模式下产生的预览链接类型 </p><ul><li> **0** :(默认) 文件流 ,点开后下载预览的合同PDF文件 </li><li> **1** :H5链接 ,点开后在浏览器中展示合同的样子</li></ul>注: <code>此参数在NeedPreview 为true时有效</code>
|
|
1245
1212
|
*/
|
|
1246
1213
|
PreviewType?: number;
|
|
1247
1214
|
/**
|
|
1248
|
-
*
|
|
1249
|
-
如果在签署截止时间前未完成签署,则合同状态会变为已过期,导致合同作废。
|
|
1215
|
+
* <p>合同流程的签署截止时间,格式为Unix标准时间戳(秒),如果未设置签署截止时间,则默认为合同流程创建后的365天时截止。<br>如果在签署截止时间前未完成签署,则合同状态会变为已过期,导致合同作废。</p>
|
|
1250
1216
|
*/
|
|
1251
1217
|
Deadline?: number;
|
|
1252
1218
|
/**
|
|
1253
|
-
*
|
|
1254
|
-
<ul><li> **false**:(默认)有序签署, 本合同多个参与人需要依次签署 </li>
|
|
1255
|
-
<li> **true**:无序签署, 本合同多个参与人没有先后签署限制</li></ul>
|
|
1219
|
+
* <p>合同流程的签署顺序类型:</p><ul><li> **false**:(默认)有序签署, 本合同多个参与人需要依次签署 </li><li> **true**:无序签署, 本合同多个参与人没有先后签署限制</li></ul>
|
|
1256
1220
|
*/
|
|
1257
1221
|
Unordered?: boolean;
|
|
1258
1222
|
/**
|
|
1259
|
-
*
|
|
1260
|
-
|
|
1261
|
-
在合同状态变更的回调信息等场景中,该字段的信息将原封不动地透传给贵方。回调的相关说明可参考开发者中心的[回调通知](https://qian.tencent.com/developers/company/callback_types_v2)模块。
|
|
1223
|
+
* <p>调用方自定义的个性化字段(可自定义此名称),并以base64方式编码,支持的最大数据大小为 20480长度。</p><p>在合同状态变更的回调信息等场景中,该字段的信息将原封不动地透传给贵方。回调的相关说明可参考开发者中心的<a href="https://qian.tencent.com/developers/company/callback_types_v2">回调通知</a>模块。</p>
|
|
1262
1224
|
*/
|
|
1263
1225
|
UserData?: string;
|
|
1264
1226
|
/**
|
|
1265
|
-
*
|
|
1266
|
-
|
|
1267
|
-
到达提醒时间后,腾讯电子签会短信通知发起方企业合同提醒,可用于处理合同到期事务,如合同续签等事宜。
|
|
1227
|
+
* <p>合同到期提醒时间,为Unix标准时间戳(秒)格式,支持的范围是从发起时间开始到后10年内。</p><p>到达提醒时间后,腾讯电子签会短信通知发起方企业合同提醒,可用于处理合同到期事务,如合同续签等事宜。</p>
|
|
1268
1228
|
*/
|
|
1269
1229
|
RemindedOn?: number;
|
|
1270
1230
|
/**
|
|
1271
|
-
*
|
|
1231
|
+
* <p>指定个人签署方查看合同的校验方式<ul><li> <strong>VerifyCheck</strong> :(默认)人脸识别,人脸识别后才能查看合同内容 </li><li> <strong>MobileCheck</strong> : 手机号验证, 用户手机号和参与方手机号(ApproverMobile)相同即可查看合同内容(当手写签名方式为OCR_ESIGN时,该校验方式无效,因为这种签名方式依赖实名认证)</li></ul></p>
|
|
1272
1232
|
*/
|
|
1273
1233
|
ApproverVerifyType?: string;
|
|
1274
1234
|
/**
|
|
1275
|
-
*
|
|
1276
|
-
<ul><li> **0**:在合同流程发起时,由发起人指定签署方的签署控件的位置和数量。</li>
|
|
1277
|
-
<li> **1**:签署方在签署时自行添加签署控件,可以拖动位置和控制数量。</li></ul>
|
|
1278
|
-
|
|
1279
|
-
注:签署方在签署时自行添加签署控件仅支持电子签小程序或web控制台签署,不支持H5
|
|
1235
|
+
* <p>签署方签署控件(印章/签名等)的生成方式:</p><ul><li> **0**:在合同流程发起时,由发起人指定签署方的签署控件的位置和数量。</li><li> **1**:签署方在签署时自行添加签署控件,可以拖动位置和控制数量。</li></ul><p>注:签署方在签署时自行添加签署控件仅支持电子签小程序或web控制台签署,不支持H5</p>
|
|
1280
1236
|
*/
|
|
1281
1237
|
SignBeanTag?: number;
|
|
1282
1238
|
/**
|
|
1283
|
-
*
|
|
1284
|
-
<ul><li>{合同名称} </li>
|
|
1285
|
-
<li>{发起方企业} </li>
|
|
1286
|
-
<li>{发起方姓名} </li>
|
|
1287
|
-
<li>{签署方N企业}</li>
|
|
1288
|
-
<li>{签署方N姓名}</li></ul>
|
|
1289
|
-
其中,N表示签署方的编号,从1开始,不能超过签署人的数量。
|
|
1290
|
-
|
|
1291
|
-
例如,如果是腾讯公司张三发给李四名称为“租房合同”的合同,您可以将此字段设置为:`合同名称:{合同名称};发起方: {发起方企业}({发起方姓名});签署方:{签署方1姓名}`,则小程序中列表页展示此合同为以下样子
|
|
1292
|
-
|
|
1293
|
-
合同名称:租房合同
|
|
1294
|
-
发起方:腾讯公司(张三)
|
|
1295
|
-
签署方:李四
|
|
1296
|
-
|
|
1297
|
-
|
|
1298
|
-

|
|
1299
|
-
|
|
1300
|
-
|
|
1239
|
+
* <p>您可以自定义腾讯电子签小程序合同列表页展示的合同内容模板,模板中支持以下变量:</p><ul><li>{合同名称} </li><li>{发起方企业} </li><li>{发起方姓名} </li><li>{签署方N企业}</li><li>{签署方N姓名}</li></ul>其中,N表示签署方的编号,从1开始,不能超过签署人的数量。<p>例如,如果是腾讯公司张三发给李四名称为“租房合同”的合同,您可以将此字段设置为:<code>合同名称:{合同名称};发起方: {发起方企业}({发起方姓名});签署方:{签署方1姓名}</code>,则小程序中列表页展示此合同为以下样子</p><p>合同名称:租房合同<br>发起方:腾讯公司(张三)<br>签署方:李四</p><p><img src="https://qcloudimg.tencent-cloud.cn/raw/628f0928cac15d2e3bfa6088f53f5998.png" alt="image"></p>
|
|
1301
1240
|
*/
|
|
1302
1241
|
CustomShowMap?: string;
|
|
1303
1242
|
/**
|
|
1304
|
-
*
|
|
1305
|
-
在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
|
|
1243
|
+
* <p>代理企业和员工的信息。<br>在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。</p>
|
|
1306
1244
|
*/
|
|
1307
1245
|
Agent?: Agent;
|
|
1308
1246
|
/**
|
|
1309
|
-
*
|
|
1310
|
-
<ul><li> **E_PRESCRIPTION_AUTO_SIGN**:电子处方单(医疗自动签) </li><li> **OTHER** : 通用场景</li></ul>
|
|
1311
|
-
注: `个人自动签名场景是白名单功能,使用前请与对接的客户经理联系沟通。`
|
|
1247
|
+
* <p>个人自动签名的使用场景包括以下, 个人自动签署(即ApproverType设置成个人自动签署时)业务此值必传:</p><ul><li> **E_PRESCRIPTION_AUTO_SIGN**:电子处方单(医疗自动签) </li><li> **OTHER** : 通用场景</li></ul>注: <code>个人自动签名场景是白名单功能,使用前请与对接的客户经理联系沟通。</code>
|
|
1312
1248
|
*/
|
|
1313
1249
|
AutoSignScene?: string;
|
|
1314
1250
|
/**
|
|
1315
|
-
*
|
|
1316
|
-
<ul><li> **false**:(默认)不需要审批,直接签署。</li>
|
|
1317
|
-
<li> **true**:需要走审批流程。当到对应参与人签署时,会阻塞其签署操作,等待企业内部审批完成。</li></ul>
|
|
1318
|
-
企业可以通过CreateFlowSignReview审批接口通知腾讯电子签平台企业内部审批结果
|
|
1319
|
-
<ul><li> 如果企业通知腾讯电子签平台审核通过,签署方可继续签署动作。</li>
|
|
1320
|
-
<li> 如果企业通知腾讯电子签平台审核未通过,平台将继续阻塞签署方的签署动作,直到企业通知平台审核通过。</li></ul>
|
|
1321
|
-
注:`此功能可用于与企业内部的审批流程进行关联,支持手动、静默签署合同`
|
|
1251
|
+
* <p>发起方企业的签署人进行签署操作前,是否需要企业内部走审批流程,取值如下:</p><ul><li> **false**:(默认)不需要审批,直接签署。</li><li> **true**:需要走审批流程。当到对应参与人签署时,会阻塞其签署操作,等待企业内部审批完成。</li></ul>企业可以通过CreateFlowSignReview审批接口通知腾讯电子签平台企业内部审批结果<ul><li> 如果企业通知腾讯电子签平台审核通过,签署方可继续签署动作。</li><li> 如果企业通知腾讯电子签平台审核未通过,平台将继续阻塞签署方的签署动作,直到企业通知平台审核通过。</li></ul>注:<code>此功能可用于与企业内部的审批流程进行关联,支持手动、静默签署合同</code>
|
|
1322
1252
|
*/
|
|
1323
1253
|
NeedSignReview?: boolean;
|
|
1324
1254
|
/**
|
|
1325
|
-
*
|
|
1255
|
+
* <p>在短信通知、填写、签署流程中,若标题、按钮、合同详情等地方存在“合同”字样时,可根据此配置指定文案,可选文案如下: <ul><li> <b>0</b> :合同(默认值)</li> <li> <b>1</b> :文件</li> <li> <b>2</b> :协议</li><li> <b>3</b> :文书</li></ul>效果如下:<img src="https://qcloudimg.tencent-cloud.cn/raw/e4a2c4d638717cc901d3dbd5137c9bbc.png" alt="FlowDisplayType"></p>
|
|
1326
1256
|
*/
|
|
1327
1257
|
FlowDisplayType?: number;
|
|
1328
1258
|
/**
|
|
1329
|
-
*
|
|
1259
|
+
* <p>是否开启动态签署合同:<ul><li> <strong>true</strong>:开启动态签署合同,可在发起时可以不传签署人,在签署过程中追加签署人(必须满足:1,发起方企业开启了模块化计费能力;2,发起方企业在企业应用管理中开启了动态签署人2.0能力) 。</li><li> <strong>false</strong>:不开启动态签署合同。</li></ul></p>
|
|
1330
1260
|
*/
|
|
1331
1261
|
OpenDynamicSignFlow?: boolean;
|
|
1332
1262
|
/**
|
|
1333
|
-
*
|
|
1263
|
+
* <p>是否开启发起合同审批,默认:false(不开启),开启后,发起合同(StartFlow),会提交电子签内置的审批流</p>
|
|
1334
1264
|
*/
|
|
1335
1265
|
Workflow?: boolean;
|
|
1336
1266
|
/**
|
|
1337
|
-
*
|
|
1267
|
+
* <p>发起合同流程时对合同流程的部分操作加以限制的配置。</p>
|
|
1338
1268
|
*/
|
|
1339
1269
|
FlowOperateLimit?: FlowOperateLimit;
|
|
1340
1270
|
}
|
|
@@ -5448,26 +5378,19 @@ export interface CreatePersonAuthCertificateImageRequest {
|
|
|
5448
5378
|
*/
|
|
5449
5379
|
export interface CreateFlowByFilesResponse {
|
|
5450
5380
|
/**
|
|
5451
|
-
*
|
|
5452
|
-
建议开发者妥善保存此流程ID,以便于顺利进行后续操作。
|
|
5453
|
-
|
|
5454
|
-
注: 如果是预览模式(即NeedPreview设置为true)时, 此处不会有值返回。
|
|
5455
|
-
|
|
5456
|
-
[点击查看FlowId在控制台中的位置](https://qcloudimg.tencent-cloud.cn/raw/0a83015166cfe1cb043d14f9ec4bd75e.png)
|
|
5381
|
+
* <p>合同流程ID,为32位字符串。<br>建议开发者妥善保存此流程ID,以便于顺利进行后续操作。</p><p>注: 如果是预览模式(即NeedPreview设置为true)时, 此处不会有值返回。</p><p><a href="https://qcloudimg.tencent-cloud.cn/raw/0a83015166cfe1cb043d14f9ec4bd75e.png">点击查看FlowId在控制台中的位置</a></p>
|
|
5457
5382
|
*/
|
|
5458
5383
|
FlowId?: string;
|
|
5459
5384
|
/**
|
|
5460
|
-
*
|
|
5461
|
-
|
|
5462
|
-
注:如果是预览模式(即NeedPreview设置为true)时, 才会有此预览链接URL
|
|
5385
|
+
* <p>合同预览链接URL。</p><p>注:如果是预览模式(即NeedPreview设置为true)时, 才会有此预览链接URL</p>
|
|
5463
5386
|
*/
|
|
5464
5387
|
PreviewUrl?: string;
|
|
5465
5388
|
/**
|
|
5466
|
-
*
|
|
5389
|
+
* <p>签署方信息,如角色ID、角色名称等</p>
|
|
5467
5390
|
*/
|
|
5468
5391
|
Approvers?: Array<ApproverItem>;
|
|
5469
5392
|
/**
|
|
5470
|
-
*
|
|
5393
|
+
* <p>发起审批流id,仅在CreateFlowByFiles时指定了WorkFlow=true时返回</p>
|
|
5471
5394
|
*/
|
|
5472
5395
|
WorkflowInstanceId?: string;
|
|
5473
5396
|
/**
|
|
@@ -6686,13 +6609,7 @@ export interface CreateOrganizationInfoChangeUrlResponse {
|
|
|
6686
6609
|
*/
|
|
6687
6610
|
export interface CreateFlowResponse {
|
|
6688
6611
|
/**
|
|
6689
|
-
*
|
|
6690
|
-
建议开发者妥善保存此流程ID,以便于顺利进行后续操作。
|
|
6691
|
-
|
|
6692
|
-
注:
|
|
6693
|
-
此返回的合同流程ID,需再次调用<a href="https://qian.tencent.com/developers/companyApis/startFlows/CreateDocument" target="_blank">创建电子文档</a>和<a href="https://qian.tencent.com/developers/companyApis/startFlows/StartFlow" target="_blank">发起签署流程</a>接口将合同开始后,合同才能进入签署环节,[点击查看FlowId在控制台中的位置(只在进入签署环节后有效)](https://qcloudimg.tencent-cloud.cn/raw/0a83015166cfe1cb043d14f9ec4bd75e.png)
|
|
6694
|
-
|
|
6695
|
-
|
|
6612
|
+
* <p>合同流程ID,为32位字符串。<br>建议开发者妥善保存此流程ID,以便于顺利进行后续操作。</p><p>注:<br>此返回的合同流程ID,需再次调用<a href="https://qian.tencent.com/developers/companyApis/startFlows/CreateDocument" target="_blank">创建电子文档</a>和<a href="https://qian.tencent.com/developers/companyApis/startFlows/StartFlow" target="_blank">发起签署流程</a>接口将合同开始后,合同才能进入签署环节,<a href="https://qcloudimg.tencent-cloud.cn/raw/0a83015166cfe1cb043d14f9ec4bd75e.png">点击查看FlowId在控制台中的位置(只在进入签署环节后有效)</a></p>
|
|
6696
6613
|
*/
|
|
6697
6614
|
FlowId?: string;
|
|
6698
6615
|
/**
|
|
@@ -11165,137 +11082,85 @@ export interface DescribeContractReviewTaskListWebUrlResponse {
|
|
|
11165
11082
|
*/
|
|
11166
11083
|
export interface CreateFlowRequest {
|
|
11167
11084
|
/**
|
|
11168
|
-
*
|
|
11169
|
-
|
|
11170
|
-
注: 支持填入集团子公司经办人 userId 代发合同。
|
|
11085
|
+
* <p>本合同的发起人,<a href="https://qcloudimg.tencent-cloud.cn/raw/f850cfbe163a1cb38439a9f551c2505c.png" target="_blank">点击查看合同发起人展示的位置</a></p><p>注: 支持填入集团子公司经办人 userId 代发合同。</p>
|
|
11171
11086
|
*/
|
|
11172
11087
|
Operator: UserInfo;
|
|
11173
11088
|
/**
|
|
11174
|
-
*
|
|
11175
|
-
|
|
11176
|
-
该名称还将用于合同签署完成后文件下载的默认文件名称。
|
|
11089
|
+
* <p>自定义的合同流程的名称,长度不能超过200个字符,只能由中文汉字、中文标点、英文字母、阿拉伯数字、空格、小括号、中括号、中划线、下划线以及(,)、(;)、(.)、(&)、(+)组成。</p><p>该名称还将用于合同签署完成后文件下载的默认文件名称。</p>
|
|
11177
11090
|
*/
|
|
11178
11091
|
FlowName: string;
|
|
11179
11092
|
/**
|
|
11180
|
-
*
|
|
11181
|
-
|
|
11182
|
-
注:
|
|
11183
|
-
<font color="red" > <b> 在发起流程时,需要保证 approver 中的顺序与模板定义顺序一致,否则会发起失败。
|
|
11184
|
-
例如,如果模板中定义的第一个参与人是个人用户,第二个参与人是企业员工,则在 approver 中传参时,第一个也必须是个人用户,第二个参与人必须是企业员工。</b></font>
|
|
11185
|
-
|
|
11186
|
-
[点击查看模板参与人顺序定义位置](https://qcloudimg.tencent-cloud.cn/raw/d14457b48cc66b29262ccb9d7b3ed556.png)
|
|
11093
|
+
* <p>合同流程的参与方列表,最多可支持50个参与方,可在列表中指定企业B端签署方和个人C端签署方的联系和认证方式等信息,具体定义可以参考开发者中心的ApproverInfo结构体。</p><p>注:<br><font color="red"> <b> 在发起流程时,需要保证 approver 中的顺序与模板定义顺序一致,否则会发起失败。<br>例如,如果模板中定义的第一个参与人是个人用户,第二个参与人是企业员工,则在 approver 中传参时,第一个也必须是个人用户,第二个参与人必须是企业员工。</b></font></p><p><a href="https://qcloudimg.tencent-cloud.cn/raw/d14457b48cc66b29262ccb9d7b3ed556.png">点击查看模板参与人顺序定义位置</a></p>
|
|
11187
11094
|
*/
|
|
11188
11095
|
Approvers: Array<FlowCreateApprover>;
|
|
11189
11096
|
/**
|
|
11190
|
-
*
|
|
11097
|
+
* <p>合同流程描述信息(可自定义此描述),最大长度1000个字符。</p>
|
|
11191
11098
|
*/
|
|
11192
11099
|
FlowDescription?: string;
|
|
11193
11100
|
/**
|
|
11194
|
-
*
|
|
11195
|
-
此合同类型需要跟模板配置的合同类型保持一致。
|
|
11101
|
+
* <p>合同流程的类别分类(可自定义名称,如销售合同/入职合同等),最大长度为200个字符,仅限中文、字母、数字和下划线组成。<br>此合同类型需要跟模板配置的合同类型保持一致。</p>
|
|
11196
11102
|
*/
|
|
11197
11103
|
FlowType?: string;
|
|
11198
11104
|
/**
|
|
11199
|
-
*
|
|
11105
|
+
* <p>该字段已不再使用</p>
|
|
11200
11106
|
*/
|
|
11201
11107
|
ClientToken?: string;
|
|
11202
11108
|
/**
|
|
11203
|
-
*
|
|
11204
|
-
如果在签署截止时间前未完成签署,则合同状态会变为已过期,导致合同作废。
|
|
11109
|
+
* <p>合同流程的签署截止时间,格式为Unix标准时间戳(秒),如果未设置签署截止时间,则默认为合同流程创建后的365天时截止。<br>如果在签署截止时间前未完成签署,则合同状态会变为已过期,导致合同作废。</p>
|
|
11205
11110
|
*/
|
|
11206
11111
|
DeadLine?: number;
|
|
11207
11112
|
/**
|
|
11208
|
-
*
|
|
11209
|
-
|
|
11210
|
-
到达提醒时间后,腾讯电子签会短信通知发起方企业合同提醒,可用于处理合同到期事务,如合同续签等事宜。
|
|
11113
|
+
* <p>合同到期提醒时间,为Unix标准时间戳(秒)格式,支持的范围是从发起时间开始到后10年内。</p><p>到达提醒时间后,腾讯电子签会短信通知发起方企业合同提醒,可用于处理合同到期事务,如合同续签等事宜。</p>
|
|
11211
11114
|
*/
|
|
11212
11115
|
RemindedOn?: number;
|
|
11213
11116
|
/**
|
|
11214
|
-
*
|
|
11215
|
-
|
|
11216
|
-
在合同状态变更的回调信息等场景中,该字段的信息将原封不动地透传给贵方。回调的相关说明可参考开发者中心的<a href="https://qian.tencent.com/developers/company/callback_types_v2" target="_blank">回调通知</a>模块。
|
|
11117
|
+
* <p>调用方自定义的个性化字段(可自定义此名称),并以base64格式编码,支持的最大数据大小为 20480长度。</p><p>在合同状态变更的回调信息等场景中,该字段的信息将原封不动地透传给贵方。回调的相关说明可参考开发者中心的<a href="https://qian.tencent.com/developers/company/callback_types_v2" target="_blank">回调通知</a>模块。</p>
|
|
11217
11118
|
*/
|
|
11218
11119
|
UserData?: string;
|
|
11219
11120
|
/**
|
|
11220
|
-
*
|
|
11221
|
-
<ul><li> **false**:(默认)有序签署, 本合同多个参与人需要依次签署 </li>
|
|
11222
|
-
<li> **true**:无序签署, 本合同多个参与人没有先后签署限制</li></ul>
|
|
11223
|
-
注:`请和模板中的配置保持一致`
|
|
11121
|
+
* <p>合同流程的签署顺序类型:</p><ul><li> **false**:(默认)有序签署, 本合同多个参与人需要依次签署 </li><li> **true**:无序签署, 本合同多个参与人没有先后签署限制</li></ul>注:<code>请和模板中的配置保持一致</code>
|
|
11224
11122
|
*/
|
|
11225
11123
|
Unordered?: boolean;
|
|
11226
11124
|
/**
|
|
11227
|
-
*
|
|
11228
|
-
<ul><li>{合同名称} </li>
|
|
11229
|
-
<li>{发起方企业} </li>
|
|
11230
|
-
<li>{发起方姓名} </li>
|
|
11231
|
-
<li>{签署方N企业}</li>
|
|
11232
|
-
<li>{签署方N姓名}</li></ul>
|
|
11233
|
-
其中,N表示签署方的编号,从1开始,不能超过签署人的数量。
|
|
11234
|
-
|
|
11235
|
-
例如,如果是腾讯公司张三发给李四名称为“租房合同”的合同,您可以将此字段设置为:`合同名称:{合同名称};发起方: {发起方企业}({发起方姓名});签署方:{签署方1姓名}`,则小程序中列表页展示此合同为以下样子
|
|
11236
|
-
|
|
11237
|
-
合同名称:租房合同
|
|
11238
|
-
发起方:腾讯公司(张三)
|
|
11239
|
-
签署方:李四
|
|
11240
|
-
|
|
11241
|
-

|
|
11242
|
-
|
|
11243
|
-
|
|
11125
|
+
* <p>您可以自定义<strong>腾讯电子签小程序合同列表页</strong>展示的合同内容模板,模板中支持以下变量:</p><ul><li>{合同名称} </li><li>{发起方企业} </li><li>{发起方姓名} </li><li>{签署方N企业}</li><li>{签署方N姓名}</li></ul>其中,N表示签署方的编号,从1开始,不能超过签署人的数量。<p>例如,如果是腾讯公司张三发给李四名称为“租房合同”的合同,您可以将此字段设置为:<code>合同名称:{合同名称};发起方: {发起方企业}({发起方姓名});签署方:{签署方1姓名}</code>,则小程序中列表页展示此合同为以下样子</p><p>合同名称:租房合同<br>发起方:腾讯公司(张三)<br>签署方:李四</p><p><img src="https://qcloudimg.tencent-cloud.cn/raw/628f0928cac15d2e3bfa6088f53f5998.png" alt="image"></p>
|
|
11244
11126
|
*/
|
|
11245
11127
|
CustomShowMap?: string;
|
|
11246
11128
|
/**
|
|
11247
|
-
*
|
|
11248
|
-
<ul><li> **false**:(默认)不需要审批,直接签署。</li>
|
|
11249
|
-
<li> **true**:需要走审批流程。当到对应参与人签署时,会阻塞其签署操作,等待企业内部审批完成。</li></ul>
|
|
11250
|
-
企业可以通过CreateFlowSignReview审批接口通知腾讯电子签平台企业内部审批结果
|
|
11251
|
-
<ul><li> 如果企业通知腾讯电子签平台审核通过,签署方可继续签署动作。</li>
|
|
11252
|
-
<li> 如果企业通知腾讯电子签平台审核未通过,平台将继续阻塞签署方的签署动作,直到企业通知平台审核通过。</li></ul>
|
|
11253
|
-
注:`此功能可用于与企业内部的审批流程进行关联,支持手动、静默签署合同`
|
|
11129
|
+
* <p>发起方企业的签署人进行签署操作前,是否需要企业内部走审批流程,取值如下:</p><ul><li> **false**:(默认)不需要审批,直接签署。</li><li> **true**:需要走审批流程。当到对应参与人签署时,会阻塞其签署操作,等待企业内部审批完成。</li></ul>企业可以通过CreateFlowSignReview审批接口通知腾讯电子签平台企业内部审批结果<ul><li> 如果企业通知腾讯电子签平台审核通过,签署方可继续签署动作。</li><li> 如果企业通知腾讯电子签平台审核未通过,平台将继续阻塞签署方的签署动作,直到企业通知平台审核通过。</li></ul>注:<code>此功能可用于与企业内部的审批流程进行关联,支持手动、静默签署合同</code>
|
|
11254
11130
|
*/
|
|
11255
11131
|
NeedSignReview?: boolean;
|
|
11256
11132
|
/**
|
|
11257
|
-
*
|
|
11258
|
-
在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
|
|
11133
|
+
* <p>代理企业和员工的信息。<br>在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。</p>
|
|
11259
11134
|
*/
|
|
11260
11135
|
Agent?: Agent;
|
|
11261
11136
|
/**
|
|
11262
|
-
*
|
|
11263
|
-
|
|
11264
|
-
<b>注</b>
|
|
11265
|
-
1. 抄送人名单中可以包括自然人以及本企业的员工。
|
|
11266
|
-
2. 请确保抄送人列表中的成员不与任何签署人重复。
|
|
11137
|
+
* <p>合同流程的抄送人列表,最多可支持50个抄送人,抄送人可查看合同内容及签署进度,但无需参与合同签署。</p><p><b>注</b></p><ol><li>抄送人名单中可以包括自然人以及本企业的员工。</li><li>请确保抄送人列表中的成员不与任何签署人重复。</li></ol>
|
|
11267
11138
|
*/
|
|
11268
11139
|
CcInfos?: Array<CcInfo>;
|
|
11269
11140
|
/**
|
|
11270
|
-
*
|
|
11271
|
-
<ul><li> **E_PRESCRIPTION_AUTO_SIGN**:电子处方单(医疗自动签) </li><li> **OTHER** : 通用场景</li></ul>
|
|
11272
|
-
注: `个人自动签名场景是白名单功能,使用前请与对接的客户经理联系沟通。`
|
|
11141
|
+
* <p>个人自动签名的使用场景包括以下, 个人自动签署(即ApproverType设置成个人自动签署时)业务此值必传:</p><ul><li> **E_PRESCRIPTION_AUTO_SIGN**:电子处方单(医疗自动签) </li><li> **OTHER** : 通用场景</li></ul>注: <code>个人自动签名场景是白名单功能,使用前请与对接的客户经理联系沟通。</code>
|
|
11273
11142
|
*/
|
|
11274
11143
|
AutoSignScene?: string;
|
|
11275
11144
|
/**
|
|
11276
|
-
*
|
|
11145
|
+
* <p>暂未开放</p>
|
|
11277
11146
|
* @deprecated
|
|
11278
11147
|
*/
|
|
11279
11148
|
RelatedFlowId?: string;
|
|
11280
11149
|
/**
|
|
11281
|
-
*
|
|
11150
|
+
* <p>暂未开放</p>
|
|
11282
11151
|
* @deprecated
|
|
11283
11152
|
*/
|
|
11284
11153
|
CallbackUrl?: string;
|
|
11285
11154
|
/**
|
|
11286
|
-
*
|
|
11287
|
-
<ul><li> <b>0</b> :合同(默认值)</li> <li> <b>1</b> :文件</li> <li> <b>2</b> :协议</li><li> <b>3</b> :文书</li></ul>
|
|
11288
|
-
|
|
11289
|
-
效果如下:
|
|
11290
|
-

|
|
11155
|
+
* <p>在短信通知、填写、签署流程中,若标题、按钮、合同详情等地方存在“合同”字样时,可根据此配置指定文案,可选文案如下:<br> <ul><li> <b>0</b> :合同(默认值)</li> <li> <b>1</b> :文件</li> <li> <b>2</b> :协议</li><li> <b>3</b> :文书</li></ul></p><p>效果如下:<br><img src="https://qcloudimg.tencent-cloud.cn/raw/e4a2c4d638717cc901d3dbd5137c9bbc.png" alt="FlowDisplayType"></p>
|
|
11291
11156
|
*/
|
|
11292
11157
|
FlowDisplayType?: number;
|
|
11293
11158
|
/**
|
|
11294
|
-
*
|
|
11159
|
+
* <p>是否开启发起合同审批,默认:false(不开启),开启后,发起合同(StartFlow),会提交电子签内置的审批流</p>
|
|
11295
11160
|
*/
|
|
11296
11161
|
Workflow?: boolean;
|
|
11297
11162
|
/**
|
|
11298
|
-
*
|
|
11163
|
+
* <p>发起合同流程时对合同流程的部分操作加以限制的配置。</p>
|
|
11299
11164
|
*/
|
|
11300
11165
|
FlowOperateLimit?: FlowOperateLimit;
|
|
11301
11166
|
}
|
|
@@ -402,17 +402,21 @@ export interface DescribeGlobalAcceleratorsRequest {
|
|
|
402
402
|
*/
|
|
403
403
|
export interface DescribeAccelerateAreasRequest {
|
|
404
404
|
/**
|
|
405
|
-
*
|
|
405
|
+
* <p>全球加速实例ID。</p>
|
|
406
406
|
*/
|
|
407
407
|
GlobalAcceleratorId: string;
|
|
408
408
|
/**
|
|
409
|
-
*
|
|
409
|
+
* <p>偏移量。默认为0。</p>
|
|
410
410
|
*/
|
|
411
411
|
Offset?: number;
|
|
412
412
|
/**
|
|
413
|
-
*
|
|
413
|
+
* <p>符合条件实例数量。默认为20,最大200。</p>
|
|
414
414
|
*/
|
|
415
415
|
Limit?: number;
|
|
416
|
+
/**
|
|
417
|
+
* <p>过滤条件。 accelerate-region- String -(过滤条件)终端节点组地域。</p>
|
|
418
|
+
*/
|
|
419
|
+
Filters?: Array<Filter>;
|
|
416
420
|
}
|
|
417
421
|
/**
|
|
418
422
|
* ModifyAccelerateAreas请求参数结构体
|
|
@@ -1132,11 +1136,11 @@ export interface ListenerSet {
|
|
|
1132
1136
|
*/
|
|
1133
1137
|
export interface DescribeAccelerateAreasResponse {
|
|
1134
1138
|
/**
|
|
1135
|
-
*
|
|
1139
|
+
* <p>加速地域信息。</p>
|
|
1136
1140
|
*/
|
|
1137
1141
|
AccelerateAreaSet?: Array<AcceleratorAreas>;
|
|
1138
1142
|
/**
|
|
1139
|
-
*
|
|
1143
|
+
* <p>实例个数。</p>
|
|
1140
1144
|
*/
|
|
1141
1145
|
TotalCount?: number;
|
|
1142
1146
|
/**
|
|
@@ -22,6 +22,7 @@ export declare class Client extends AbstractClient {
|
|
|
22
22
|
|
|
23
23
|
本接口需与[人员库管理相关接口](https://cloud.tencent.com/document/product/867/45015)结合使用。
|
|
24
24
|
|
|
25
|
+
**注意:**若人员库超过1年未调用,平台将对人员库资源进行删除,以确保用户信息安全。
|
|
25
26
|
>
|
|
26
27
|
- 公共参数中的签名方式请使用V3版本,即配置SignatureMethod参数为TC3-HMAC-SHA256。
|
|
27
28
|
|
|
@@ -84,6 +85,8 @@ export declare class Client extends AbstractClient {
|
|
|
84
85
|
|
|
85
86
|
本接口需与[人员库管理相关接口](https://cloud.tencent.com/document/product/867/45015)结合使用。
|
|
86
87
|
|
|
88
|
+
**注意:**若人员库超过1年未调用,平台将对人员库资源进行删除,以确保用户信息安全。
|
|
89
|
+
|
|
87
90
|
>
|
|
88
91
|
- 公共参数中的签名方式请使用V3版本,即配置SignatureMethod参数为TC3-HMAC-SHA256。
|
|
89
92
|
|
|
@@ -103,7 +106,7 @@ export declare class Client extends AbstractClient {
|
|
|
103
106
|
与[人脸比对](https://cloud.tencent.com/document/product/867/44987)接口不同的是,人脸验证用于判断 “此人是否是此人”,“此人”的信息已存于人员库中,“此人”可能存在多张人脸图片;而[人脸比对](https://cloud.tencent.com/document/product/867/44987)用于判断两张人脸的相似度。
|
|
104
107
|
|
|
105
108
|
与[人员验证](https://cloud.tencent.com/document/product/867/44982)接口不同的是,人脸验证将该人员(Person)下的每个人脸(Face)都作为单独个体进行验证,而[人员验证](https://cloud.tencent.com/document/product/867/44982)会将该人员(Person)下的所有人脸(Face)进行融合特征处理,即若某个 Person下有4张 Face,人员验证接口会将4张 Face 的特征进行融合处理,生成对应这个 Person 的特征,使人员验证(确定待识别的人脸图片是某人员)更加准确。
|
|
106
|
-
|
|
109
|
+
**注意:**若人员库超过1年未调用,平台将对人员库资源进行删除,以确保用户信息安全。
|
|
107
110
|
>
|
|
108
111
|
- 公共参数中的签名方式请使用V3版本,即配置SignatureMethod参数为TC3-HMAC-SHA256。
|
|
109
112
|
*/
|
|
@@ -201,7 +204,7 @@ export declare class Client extends AbstractClient {
|
|
|
201
204
|
本接口会将该人员(Person)下的所有人脸(Face)进行融合特征处理,即若某个Person下有4张 Face,本接口会将4张 Face 的特征进行融合处理,生成对应这个 Person 的特征,使人员验证(确定待识别的人脸图片是某人员)更加准确。
|
|
202
205
|
|
|
203
206
|
和人脸比对相关接口不同的是,人脸验证相关接口用于判断 “此人是否是此人”,“此人”的信息已存于人员库中,“此人”可能存在多张人脸图片;而人脸比对相关接口用于判断两张人脸的相似度。
|
|
204
|
-
|
|
207
|
+
**注意:**若人员库超过1年未调用,平台将对人员库资源进行删除,以确保用户信息安全。
|
|
205
208
|
|
|
206
209
|
>
|
|
207
210
|
- 公共参数中的签名方式请使用V3版本,即配置SignatureMethod参数为TC3-HMAC-SHA256。
|
|
@@ -258,7 +261,7 @@ export declare class Client extends AbstractClient {
|
|
|
258
261
|
单次搜索的人员库人脸总数量和人员库的算法模型版本(FaceModelVersion)相关。算法模型版本为2.0的人员库,单次搜索人员库人脸总数量不得超过 100 万张;算法模型版本为3.0的人员库,单次搜索人员库人脸总数量不得超过 300 万张。
|
|
259
262
|
|
|
260
263
|
本接口会将该人员(Person)下的所有人脸(Face)进行融合特征处理,即若某个 Person 下有4张 Face ,本接口会将4张 Face 的特征进行融合处理,生成对应这个 Person 的特征,使人员搜索(确定待识别的人脸图片是某人)更加准确。而[人脸搜索](https://cloud.tencent.com/document/product/867/44994)及[人脸搜索按库返回接口](https://cloud.tencent.com/document/product/867/44993)将该人员(Person)下的每个人脸(Face)都作为单独个体进行搜索。
|
|
261
|
-
|
|
264
|
+
**注意:**若人员库超过1年未调用,平台将对人员库资源进行删除,以确保用户信息安全。
|
|
262
265
|
>
|
|
263
266
|
- 公共参数中的签名方式请使用V3版本,即配置SignatureMethod参数为TC3-HMAC-SHA256。
|
|
264
267
|
- 仅支持算法模型版本(FaceModelVersion)为3.0的人员库。
|
|
@@ -281,6 +284,7 @@ export declare class Client extends AbstractClient {
|
|
|
281
284
|
单次搜索的人员库人脸总数量和人员库的算法模型版本(FaceModelVersion)相关。算法模型版本为2.0的人员库,单次搜索人员库人脸总数量不得超过 100 万张;算法模型版本为3.0的人员库,单次搜索人员库人脸总数量不得超过 300 万张。
|
|
282
285
|
|
|
283
286
|
本接口会将该人员(Person)下的所有人脸(Face)进行融合特征处理,即若某个 Person 下有4张 Face ,本接口会将4张 Face 的特征进行融合处理,生成对应这个 Person 的特征,使人员搜索(确定待识别的人脸图片是某人)更加准确。而[人脸搜索](https://cloud.tencent.com/document/product/867/44994)及[人脸搜索按库返回接口](https://cloud.tencent.com/document/product/867/44993)将该人员(Person)下的每个人脸(Face)都作为单独个体进行搜索。
|
|
287
|
+
**注意:**若人员库超过1年未调用,平台将对人员库资源进行删除,以确保用户信息安全。
|
|
284
288
|
>
|
|
285
289
|
- 公共参数中的签名方式请使用V3版本,即配置SignatureMethod参数为TC3-HMAC-SHA256。
|
|
286
290
|
- 仅支持算法模型版本(FaceModelVersion)为3.0的人员库。
|