tencentcloud-sdk-nodejs-ess 4.0.682 → 4.0.684
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 +337 -0
- package/SERVICE_CHANGELOG.md +369 -166
- package/package.json +1 -1
- package/products.md +17 -17
- package/src/services/ess/v20201111/ess_client.ts +64 -30
- package/src/services/ess/v20201111/ess_models.ts +381 -214
- package/tencentcloud/services/ess/v20201111/ess_client.d.ts +64 -30
- package/tencentcloud/services/ess/v20201111/ess_client.js +64 -30
- package/tencentcloud/services/ess/v20201111/ess_models.d.ts +381 -214
|
@@ -131,16 +131,17 @@ export interface CancelFlowResponse {
|
|
|
131
131
|
*/
|
|
132
132
|
export interface DescribeFlowEvidenceReportRequest {
|
|
133
133
|
/**
|
|
134
|
-
*
|
|
134
|
+
* 执行本接口操作的员工信息。
|
|
135
|
+
注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
|
|
135
136
|
*/
|
|
136
137
|
Operator: UserInfo
|
|
137
138
|
/**
|
|
138
|
-
*
|
|
139
|
+
* 签署报告编号
|
|
139
140
|
*/
|
|
140
141
|
ReportId: string
|
|
141
142
|
/**
|
|
142
|
-
*
|
|
143
|
-
|
|
143
|
+
* 代理企业和员工的信息。
|
|
144
|
+
在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
|
|
144
145
|
*/
|
|
145
146
|
Agent?: Agent
|
|
146
147
|
}
|
|
@@ -355,12 +356,16 @@ export interface CreateMultiFlowSignQRCodeResponse {
|
|
|
355
356
|
*/
|
|
356
357
|
export interface FlowApproverUrlInfo {
|
|
357
358
|
/**
|
|
358
|
-
*
|
|
359
|
+
* 签署链接(短链形式呈现)。请注意保密,不要将其外泄给无关用户。
|
|
360
|
+
注: `注意该链接有效期为30分钟`
|
|
359
361
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
360
362
|
*/
|
|
361
363
|
SignUrl?: string
|
|
362
364
|
/**
|
|
363
|
-
*
|
|
365
|
+
* 签署参与人类型
|
|
366
|
+
<ul><li> **1** :个人参与方</li></ul>
|
|
367
|
+
|
|
368
|
+
注: `现在仅支持个人参与方`
|
|
364
369
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
365
370
|
*/
|
|
366
371
|
ApproverType?: number
|
|
@@ -375,7 +380,8 @@ export interface FlowApproverUrlInfo {
|
|
|
375
380
|
*/
|
|
376
381
|
ApproverMobile?: string
|
|
377
382
|
/**
|
|
378
|
-
*
|
|
383
|
+
* 签署链接(长链形式呈现)。请注意保密,不要将其外泄给无关用户。
|
|
384
|
+
注: `注意该链接有效期为30分钟`
|
|
379
385
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
380
386
|
*/
|
|
381
387
|
LongUrl?: string
|
|
@@ -549,39 +555,39 @@ export interface CreateFlowOption {
|
|
|
549
555
|
}
|
|
550
556
|
|
|
551
557
|
/**
|
|
552
|
-
*
|
|
553
|
-
|
|
554
|
-
|
|
555
|
-
|
|
558
|
+
* 解除协议的签署人,如不指定,默认使用原流程中的签署人。<br/>
|
|
559
|
+
`注意:不支持更换C端(个人身份类型)签署人,如果原流程中含有C端签署人,默认使用原流程中的该C端签署人。`<br/>
|
|
560
|
+
`注意:目前不支持替换C端(个人身份类型)签署人,但是可以指定C端签署人的签署方自定义控件别名,具体见参数ApproverSignRole描述。`<br/>
|
|
561
|
+
`注意:当指定C端签署人的签署方自定义控件别名不空时,除RelievedApproverReceiptId参数外,可以只参数ApproverSignRole。`<br/>
|
|
556
562
|
*/
|
|
557
563
|
export interface ReleasedApprover {
|
|
558
564
|
/**
|
|
559
|
-
* 签署人姓名,最大长度50
|
|
565
|
+
* 签署人姓名,最大长度50个字。
|
|
560
566
|
|
|
561
567
|
*/
|
|
562
568
|
Name: string
|
|
563
569
|
/**
|
|
564
|
-
*
|
|
570
|
+
* 签署人手机号。
|
|
565
571
|
*/
|
|
566
572
|
Mobile: string
|
|
567
573
|
/**
|
|
568
|
-
*
|
|
574
|
+
* 要更换的原合同参与人RecipientId编号。(可通过接口<a href="https://qian.tencent.com/developers/companyApis/queryFlows/DescribeFlowInfo/">DescribeFlowInfo</a>查询签署人的RecipientId编号)<br/>
|
|
569
575
|
*/
|
|
570
576
|
RelievedApproverReceiptId: string
|
|
571
577
|
/**
|
|
572
578
|
* 指定签署人类型,目前仅支持
|
|
573
|
-
ORGANIZATION
|
|
574
|
-
ENTERPRISESERVER
|
|
579
|
+
<ul><li> **ORGANIZATION**:企业(默认值)</li>
|
|
580
|
+
<li> **ENTERPRISESERVER**:企业静默签</li></ul>
|
|
575
581
|
*/
|
|
576
582
|
ApproverType?: string
|
|
577
583
|
/**
|
|
578
|
-
*
|
|
579
|
-
|
|
580
|
-
|
|
584
|
+
* 签署控件类型,支持自定义企业签署方的签署控件类型
|
|
585
|
+
<ul><li> **SIGN_SEAL**:默认为印章控件类型(默认值)</li>
|
|
586
|
+
<li> **SIGN_SIGNATURE**:手写签名控件类型</li></ul>
|
|
581
587
|
*/
|
|
582
588
|
ApproverSignComponentType?: string
|
|
583
589
|
/**
|
|
584
|
-
* 参与方在合同中的角色是按照创建合同的时候来排序的;
|
|
590
|
+
* 参与方在合同中的角色是按照创建合同的时候来排序的; 解除协议默认会将第一个参与人叫甲方, 第二个叫乙方,第三个叫丙方,以此类推。如果您需要改动参与人的角色名字, 可以设置此签署方自定义控件别名字段,最大20个字。
|
|
585
591
|
*/
|
|
586
592
|
ApproverSignRole?: string
|
|
587
593
|
}
|
|
@@ -643,9 +649,9 @@ export interface CreateFlowEvidenceReportRequest {
|
|
|
643
649
|
export interface StartFlowResponse {
|
|
644
650
|
/**
|
|
645
651
|
* 发起成功后返回的状态,根据合同流程的不同,返回不同状态:
|
|
646
|
-
START
|
|
647
|
-
REVIEW
|
|
648
|
-
EXECUTING
|
|
652
|
+
<ul><li> **START** : 发起成功, 合同进入签署环节</li>
|
|
653
|
+
<li> **REVIEW** : 提交审核成功, 合同需要发起审核, 发起方企业通过接口审核通过后合同才进入签署环境 `白名单功能,使用前请联系对接的客户经理沟通。`</li>
|
|
654
|
+
<li> **EXECUTING** : 已提交发起任务且PDF合同正在合成中, 等PDF合同合成成功后进入签署环节</li></ul>
|
|
649
655
|
*/
|
|
650
656
|
Status?: string
|
|
651
657
|
/**
|
|
@@ -748,23 +754,39 @@ export interface AuthorizedUser {
|
|
|
748
754
|
*/
|
|
749
755
|
export interface CreateConvertTaskApiRequest {
|
|
750
756
|
/**
|
|
751
|
-
*
|
|
757
|
+
* 需要进行转换的资源文件类型
|
|
758
|
+
支持的文件类型如下:
|
|
759
|
+
<ul><li>doc</li>
|
|
760
|
+
<li>docx</li>
|
|
761
|
+
<li>xls</li>
|
|
762
|
+
<li>xlsx</li>
|
|
763
|
+
<li>jpg</li>
|
|
764
|
+
<li>jpeg</li>
|
|
765
|
+
<li>png</li>
|
|
766
|
+
<li>bmp</li>
|
|
767
|
+
<li>txt</li></ul>
|
|
752
768
|
*/
|
|
753
769
|
ResourceType: string
|
|
754
770
|
/**
|
|
755
|
-
*
|
|
771
|
+
* 需要进行转换操作的文件资源名称,带资源后缀名。
|
|
772
|
+
|
|
773
|
+
注: `资源名称长度限制为256个字符`
|
|
756
774
|
*/
|
|
757
775
|
ResourceName: string
|
|
758
776
|
/**
|
|
759
|
-
*
|
|
777
|
+
* 需要进行转换操作的文件资源Id,通过<a href="https://qian.tencent.com/developers/companyApis/templatesAndFiles/UploadFiles" target="_blank">UploadFiles</a>接口获取文件资源Id。
|
|
778
|
+
|
|
779
|
+
注: `目前,此接口仅支持单个文件进行转换。`
|
|
760
780
|
*/
|
|
761
781
|
ResourceId: string
|
|
762
782
|
/**
|
|
763
|
-
*
|
|
783
|
+
* 执行本接口操作的员工信息。
|
|
784
|
+
注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。
|
|
764
785
|
*/
|
|
765
786
|
Operator?: UserInfo
|
|
766
787
|
/**
|
|
767
|
-
* 代理企业和员工的信息。
|
|
788
|
+
* 代理企业和员工的信息。
|
|
789
|
+
在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
|
|
768
790
|
*/
|
|
769
791
|
Agent?: Agent
|
|
770
792
|
/**
|
|
@@ -995,11 +1017,12 @@ export interface DescribeFlowEvidenceReportResponse {
|
|
|
995
1017
|
*/
|
|
996
1018
|
ReportUrl?: string
|
|
997
1019
|
/**
|
|
998
|
-
*
|
|
999
|
-
|
|
1000
|
-
EvidenceStatusExecuting
|
|
1001
|
-
EvidenceStatusSuccess
|
|
1002
|
-
EvidenceStatusFailed
|
|
1020
|
+
* 签署报告出证任务的状态
|
|
1021
|
+
<ul>
|
|
1022
|
+
<li>EvidenceStatusExecuting : 出证任务在执行中</li>
|
|
1023
|
+
<li>EvidenceStatusSuccess : 出证任务执行成功</li>
|
|
1024
|
+
<li>EvidenceStatusFailed : 出证任务执行失败</li>
|
|
1025
|
+
</ul>
|
|
1003
1026
|
*/
|
|
1004
1027
|
Status?: string
|
|
1005
1028
|
/**
|
|
@@ -1176,11 +1199,16 @@ false-未发布
|
|
|
1176
1199
|
*/
|
|
1177
1200
|
export interface CreateDocumentResponse {
|
|
1178
1201
|
/**
|
|
1179
|
-
*
|
|
1202
|
+
* 合同流程的底层电子文档ID,为32位字符串。
|
|
1203
|
+
|
|
1204
|
+
注:
|
|
1205
|
+
后续需用同样的FlowId再次调用<a href="https://qian.tencent.com/developers/companyApis/startFlows/StartFlow" target="_blank">发起签署流程</a>,合同才能进入签署环节
|
|
1180
1206
|
*/
|
|
1181
1207
|
DocumentId?: string
|
|
1182
1208
|
/**
|
|
1183
|
-
*
|
|
1209
|
+
* 合同预览链接URL。
|
|
1210
|
+
|
|
1211
|
+
注:如果是预览模式(即NeedPreview设置为true)时, 才会有此预览链接URL
|
|
1184
1212
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
1185
1213
|
*/
|
|
1186
1214
|
PreviewFileUrl?: string
|
|
@@ -1250,73 +1278,103 @@ export interface CreateIntegrationUserRolesResponse {
|
|
|
1250
1278
|
*/
|
|
1251
1279
|
export interface CreateFlowRequest {
|
|
1252
1280
|
/**
|
|
1253
|
-
*
|
|
1281
|
+
* 执行本接口操作的员工信息。使用此接口时,必须填写userId。
|
|
1282
|
+
支持填入集团子公司经办人 userId 代发合同。
|
|
1283
|
+
|
|
1284
|
+
注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
|
|
1254
1285
|
*/
|
|
1255
1286
|
Operator: UserInfo
|
|
1256
1287
|
/**
|
|
1257
|
-
*
|
|
1288
|
+
* 合同流程的名称(可自定义此名称),长度不能超过200,只能由中文、字母、数字和下划线组成。
|
|
1289
|
+
|
|
1290
|
+
该名称还将用于合同签署完成后的下载文件名。
|
|
1258
1291
|
*/
|
|
1259
1292
|
FlowName: string
|
|
1260
1293
|
/**
|
|
1261
|
-
*
|
|
1262
|
-
|
|
1294
|
+
* 合同流程的参与方列表,最多可支持50个参与方,可在列表中指定企业B端签署方和个人C端签署方的联系和认证方式等信息,具体定义可以参考开发者中心的ApproverInfo结构体。
|
|
1295
|
+
|
|
1296
|
+
注: `approver中的顺序需要和模板中的顺序保持一致, 否则会导致模板中配置的信息无效`
|
|
1263
1297
|
*/
|
|
1264
1298
|
Approvers: Array<FlowCreateApprover>
|
|
1265
1299
|
/**
|
|
1266
|
-
*
|
|
1300
|
+
* 合同流程描述信息(可自定义此描述),最大长度1000个字符。
|
|
1267
1301
|
*/
|
|
1268
1302
|
FlowDescription?: string
|
|
1269
1303
|
/**
|
|
1270
|
-
*
|
|
1304
|
+
* 合同流程的类别分类(可自定义名称,如销售合同/入职合同等),最大长度为200个字符,仅限中文、字母、数字和下划线组成。
|
|
1271
1305
|
*/
|
|
1272
1306
|
FlowType?: string
|
|
1273
1307
|
/**
|
|
1274
|
-
*
|
|
1308
|
+
* 已经废弃字段,客户端Token,保持接口幂等性,最大长度64个字符
|
|
1275
1309
|
*/
|
|
1276
1310
|
ClientToken?: string
|
|
1277
1311
|
/**
|
|
1278
|
-
*
|
|
1279
|
-
|
|
1280
|
-
值为unix时间戳,精确到秒,不传默认为当前时间一年后
|
|
1312
|
+
* 合同流程的签署截止时间,格式为Unix标准时间戳(秒),如果未设置签署截止时间,则默认为合同流程创建后的365天时截止。
|
|
1313
|
+
如果在签署截止时间前未完成签署,则合同状态会变为已过期,导致合同作废。
|
|
1281
1314
|
*/
|
|
1282
1315
|
DeadLine?: number
|
|
1283
1316
|
/**
|
|
1284
|
-
*
|
|
1317
|
+
* 合同到期提醒时间,为Unix标准时间戳(秒)格式,支持的范围是从发起时间开始到后10年内。
|
|
1318
|
+
|
|
1319
|
+
到达提醒时间后,腾讯电子签会短信通知发起方企业合同提醒,可用于处理合同到期事务,如合同续签等事宜。
|
|
1285
1320
|
*/
|
|
1286
1321
|
RemindedOn?: number
|
|
1287
1322
|
/**
|
|
1288
|
-
*
|
|
1323
|
+
* 调用方自定义的个性化字段(可自定义此名称),并以base64方式编码,支持的最大数据大小为 20480长度。
|
|
1324
|
+
|
|
1325
|
+
在合同状态变更的回调信息等场景中,该字段的信息将原封不动地透传给贵方。回调的相关说明可参考开发者中心的<a href="https://qian.tencent.com/developers/company/callback_types_v2" target="_blank">回调通知</a>模块。
|
|
1289
1326
|
*/
|
|
1290
1327
|
UserData?: string
|
|
1291
1328
|
/**
|
|
1292
|
-
*
|
|
1293
|
-
|
|
1294
|
-
|
|
1295
|
-
|
|
1329
|
+
* 合同流程的签署顺序类型:
|
|
1330
|
+
<ul><li> **false**:(默认)有序签署, 本合同多个参与人需要依次签署 </li>
|
|
1331
|
+
<li> **true**:无序签署, 本合同多个参与人没有先后签署限制</li></ul>
|
|
1332
|
+
注:`请和模板中的配置保持一致`
|
|
1296
1333
|
*/
|
|
1297
1334
|
Unordered?: boolean
|
|
1298
1335
|
/**
|
|
1299
|
-
*
|
|
1336
|
+
* 您可以自定义腾讯电子签小程序合同列表页展示的合同内容模板,模板中支持以下变量:
|
|
1337
|
+
<ul><li>{合同名称} </li>
|
|
1338
|
+
<li>{发起方企业} </li>
|
|
1339
|
+
<li>{发起方姓名} </li>
|
|
1340
|
+
<li>{签署方N企业}</li>
|
|
1341
|
+
<li>{签署方N姓名}</li></ul>
|
|
1342
|
+
其中,N表示签署方的编号,从1开始,不能超过签署人的数量。
|
|
1343
|
+
|
|
1344
|
+
例如,如果是腾讯公司张三发给李四名称为“租房合同”的合同,您可以将此字段设置为:`合同名称:{合同名称};发起方: {发起方企业}({发起方姓名});签署方:{签署方1姓名}`,则小程序中列表页展示此合同为以下样子
|
|
1345
|
+
|
|
1346
|
+
合同名称:租房合同
|
|
1347
|
+
发起方:腾讯公司(张三)
|
|
1348
|
+
签署方:李四
|
|
1349
|
+
|
|
1350
|
+
|
|
1300
1351
|
*/
|
|
1301
1352
|
CustomShowMap?: string
|
|
1302
1353
|
/**
|
|
1303
|
-
*
|
|
1304
|
-
|
|
1305
|
-
|
|
1306
|
-
|
|
1354
|
+
* 发起方企业的签署人进行签署操作前,是否需要企业内部走审批流程,取值如下:
|
|
1355
|
+
<ul><li> **false**:(默认)不需要审批,直接签署。</li>
|
|
1356
|
+
<li> **true**:需要走审批流程。当到对应参与人签署时,会阻塞其签署操作,等待企业内部审批完成。</li></ul>
|
|
1357
|
+
企业可以通过CreateFlowSignReview审批接口通知腾讯电子签平台企业内部审批结果
|
|
1358
|
+
<ul><li> 如果企业通知腾讯电子签平台审核通过,签署方可继续签署动作。</li>
|
|
1359
|
+
<li> 如果企业通知腾讯电子签平台审核未通过,平台将继续阻塞签署方的签署动作,直到企业通知平台审核通过。</li></ul>
|
|
1360
|
+
注:`此功能可用于与企业内部的审批流程进行关联,支持手动、静默签署合同`
|
|
1307
1361
|
*/
|
|
1308
1362
|
NeedSignReview?: boolean
|
|
1309
1363
|
/**
|
|
1310
|
-
*
|
|
1364
|
+
* 代理企业和员工的信息。
|
|
1365
|
+
在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
|
|
1311
1366
|
*/
|
|
1312
1367
|
Agent?: Agent
|
|
1313
1368
|
/**
|
|
1314
|
-
*
|
|
1315
|
-
|
|
1369
|
+
* 合同流程的抄送人列表,最多可支持50个抄送人,抄送人可查看合同内容及签署进度,但无需参与合同签署。
|
|
1370
|
+
|
|
1371
|
+
注:`此功能为白名单功能,使用前请联系对接的客户经理沟通。`
|
|
1316
1372
|
*/
|
|
1317
1373
|
CcInfos?: Array<CcInfo>
|
|
1318
1374
|
/**
|
|
1319
|
-
*
|
|
1375
|
+
* 个人自动签名的使用场景包括以下, 个人自动签署(即ApproverType设置成个人自动签署时)业务此值必传:
|
|
1376
|
+
<ul><li> **E_PRESCRIPTION_AUTO_SIGN**:处方单(医疗自动签) </li></ul>
|
|
1377
|
+
注: `个人自动签名场景是白名单功能,使用前请与对接的客户经理联系沟通。`
|
|
1320
1378
|
*/
|
|
1321
1379
|
AutoSignScene?: string
|
|
1322
1380
|
/**
|
|
@@ -1418,50 +1476,49 @@ export interface DeleteIntegrationDepartmentResponse {
|
|
|
1418
1476
|
*/
|
|
1419
1477
|
export interface AutoSignConfig {
|
|
1420
1478
|
/**
|
|
1421
|
-
*
|
|
1479
|
+
* 自动签开通个人用户信息, 包括名字,身份证等
|
|
1422
1480
|
*/
|
|
1423
1481
|
UserInfo: UserThreeFactor
|
|
1424
1482
|
/**
|
|
1425
|
-
*
|
|
1426
|
-
|
|
1427
|
-
|
|
1428
|
-
*/
|
|
1429
|
-
CallbackUrl: string
|
|
1430
|
-
/**
|
|
1431
|
-
* 是否回调证书信息
|
|
1432
|
-
false-不需要 (默认值)
|
|
1433
|
-
true-需要
|
|
1483
|
+
* 是否回调证书信息:
|
|
1484
|
+
<ul><li>**false**: 不需要(默认)</li>
|
|
1485
|
+
<li>**true**:需要</li></ul>
|
|
1434
1486
|
*/
|
|
1435
1487
|
CertInfoCallback?: boolean
|
|
1436
1488
|
/**
|
|
1437
|
-
*
|
|
1438
|
-
false
|
|
1439
|
-
true
|
|
1489
|
+
* 是否支持用户自定义签名印章:
|
|
1490
|
+
<ul><li>**false**: 不能自己定义(默认)</li>
|
|
1491
|
+
<li>**true**: 可以自己定义</li></ul>
|
|
1440
1492
|
*/
|
|
1441
1493
|
UserDefineSeal?: boolean
|
|
1442
1494
|
/**
|
|
1443
|
-
*
|
|
1444
|
-
|
|
1445
|
-
|
|
1446
|
-
true-需要
|
|
1495
|
+
* 回调中是否需要自动签将要使用的印章(签名) 图片的 base64:
|
|
1496
|
+
<ul><li>**false**: 不需要(默认)</li>
|
|
1497
|
+
<li>**true**: 需要</li></ul>
|
|
1447
1498
|
*/
|
|
1448
1499
|
SealImgCallback?: boolean
|
|
1449
1500
|
/**
|
|
1450
|
-
*
|
|
1451
|
-
|
|
1452
|
-
|
|
1453
|
-
|
|
1454
|
-
|
|
1455
|
-
|
|
1456
|
-
|
|
1457
|
-
|
|
1458
|
-
|
|
1501
|
+
* 执行结果的回调URL,该URL仅支持HTTP或HTTPS协议,建议采用HTTPS协议以保证数据传输的安全性。
|
|
1502
|
+
腾讯电子签服务器将通过POST方式,application/json格式通知执行结果,请确保外网可以正常访问该URL。
|
|
1503
|
+
回调的相关说明可参考开发者中心的<a href="https://qian.tencent.com/developers/company/callback_types_v2" target="_blank">回调通知</a>模块。
|
|
1504
|
+
* @deprecated
|
|
1505
|
+
*/
|
|
1506
|
+
CallbackUrl?: string
|
|
1507
|
+
/**
|
|
1508
|
+
* 开通时候的身份验证方式, 取值为:
|
|
1509
|
+
<ul><li>**WEIXINAPP** : 微信人脸识别</li>
|
|
1510
|
+
<li>**INSIGHT** : 慧眼人脸认别</li>
|
|
1511
|
+
<li>**TELECOM** : 运营商三要素验证</li></ul>
|
|
1512
|
+
注:
|
|
1513
|
+
<ul><li>如果是小程序开通链接,支持传 WEIXINAPP / TELECOM。为空默认 WEIXINAPP</li>
|
|
1514
|
+
<li>如果是 H5 开通链接,支持传 INSIGHT / TELECOM。为空默认 INSIGHT </li>
|
|
1459
1515
|
*/
|
|
1460
1516
|
VerifyChannels?: Array<string>
|
|
1461
1517
|
/**
|
|
1462
|
-
*
|
|
1463
|
-
|
|
1464
|
-
1
|
|
1518
|
+
* 设置用户开通自动签时是否绑定个人自动签账号许可。
|
|
1519
|
+
|
|
1520
|
+
<ul><li>**0**: (默认) 使用个人自动签账号许可进行开通,个人自动签账号许可有效期1年,注: `不可解绑释放更换他人`</li>
|
|
1521
|
+
<li>**1**: 不使用个人自动签账号许可进行开通</li></ul>
|
|
1465
1522
|
|
|
1466
1523
|
*/
|
|
1467
1524
|
LicenseType?: number
|
|
@@ -1501,6 +1558,7 @@ export interface DescribeIntegrationMainOrganizationUserRequest {
|
|
|
1501
1558
|
export interface CreateReleaseFlowResponse {
|
|
1502
1559
|
/**
|
|
1503
1560
|
* 解除协议流程编号
|
|
1561
|
+
`注意:这里的流程编号对应的合同是本次发起的解除协议。`
|
|
1504
1562
|
|
|
1505
1563
|
*/
|
|
1506
1564
|
FlowId?: string
|
|
@@ -1754,20 +1812,23 @@ export interface DescribeUserAutoSignStatusResponse {
|
|
|
1754
1812
|
*/
|
|
1755
1813
|
IsOpen?: boolean
|
|
1756
1814
|
/**
|
|
1757
|
-
*
|
|
1815
|
+
* 自动签许可生效时间。当且仅当已通过许可开通自动签时有值。
|
|
1758
1816
|
|
|
1759
1817
|
值为unix时间戳,单位为秒。
|
|
1760
1818
|
*/
|
|
1761
1819
|
LicenseFrom?: number
|
|
1762
1820
|
/**
|
|
1763
|
-
*
|
|
1821
|
+
* 自动签许可到期时间。当且仅当已通过许可开通自动签时有值。
|
|
1822
|
+
|
|
1764
1823
|
值为unix时间戳,单位为秒。
|
|
1765
1824
|
*/
|
|
1766
1825
|
LicenseTo?: number
|
|
1767
1826
|
/**
|
|
1768
|
-
*
|
|
1769
|
-
|
|
1770
|
-
1
|
|
1827
|
+
* 设置用户开通自动签时是否绑定个人自动签账号许可。
|
|
1828
|
+
|
|
1829
|
+
<ul><li>**0**: 使用个人自动签账号许可进行开通,个人自动签账号许可有效期1年,注: `不可解绑释放更换他人`</li>
|
|
1830
|
+
<li>**1**: 不使用个人自动签账号许可进行开通</li></ul>
|
|
1831
|
+
|
|
1771
1832
|
*/
|
|
1772
1833
|
LicenseType?: number
|
|
1773
1834
|
/**
|
|
@@ -2002,18 +2063,22 @@ export interface CreateBatchCancelFlowUrlResponse {
|
|
|
2002
2063
|
*/
|
|
2003
2064
|
export interface UserThreeFactor {
|
|
2004
2065
|
/**
|
|
2005
|
-
*
|
|
2066
|
+
* 签署方经办人的姓名。
|
|
2067
|
+
经办人的姓名将用于身份认证和电子签名,请确保填写的姓名为签署方的真实姓名,而非昵称等代名。
|
|
2006
2068
|
*/
|
|
2007
2069
|
Name: string
|
|
2008
2070
|
/**
|
|
2009
|
-
*
|
|
2010
|
-
ID_CARD
|
|
2011
|
-
HONGKONG_AND_MACAO
|
|
2012
|
-
HONGKONG_MACAO_AND_TAIWAN 港澳台居民居住证(格式同居民身份证)
|
|
2071
|
+
* 证件类型,支持以下类型
|
|
2072
|
+
<ul><li>ID_CARD : 居民身份证 (默认值)</li>
|
|
2073
|
+
<li>HONGKONG_AND_MACAO : 港澳居民来往内地通行证</li>
|
|
2074
|
+
<li>HONGKONG_MACAO_AND_TAIWAN : 港澳台居民居住证(格式同居民身份证)</li></ul>
|
|
2013
2075
|
*/
|
|
2014
2076
|
IdCardType: string
|
|
2015
2077
|
/**
|
|
2016
|
-
*
|
|
2078
|
+
* 证件号码,应符合以下规则
|
|
2079
|
+
<ul><li>居民身份证号码应为18位字符串,由数字和大写字母X组成(如存在X,请大写)。</li>
|
|
2080
|
+
<li>港澳居民来往内地通行证号码应为9位字符串,第1位为“C”,第2位为英文字母(但“I”、“O”除外),后7位为阿拉伯数字。</li>
|
|
2081
|
+
<li>港澳台居民居住证号码编码规则与中国大陆身份证相同,应为18位字符串。</li></ul>
|
|
2017
2082
|
*/
|
|
2018
2083
|
IdCardNumber: string
|
|
2019
2084
|
}
|
|
@@ -2056,20 +2121,22 @@ export interface CreateSealPolicyResponse {
|
|
|
2056
2121
|
*/
|
|
2057
2122
|
export interface DisableUserAutoSignRequest {
|
|
2058
2123
|
/**
|
|
2059
|
-
*
|
|
2124
|
+
* 执行本接口操作的员工信息。
|
|
2125
|
+
注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
|
|
2060
2126
|
*/
|
|
2061
2127
|
Operator: UserInfo
|
|
2062
2128
|
/**
|
|
2063
|
-
*
|
|
2064
|
-
E_PRESCRIPTION_AUTO_SIGN
|
|
2129
|
+
* 自动签使用的场景值, 可以选择的场景值如下:
|
|
2130
|
+
<ul><li> **E_PRESCRIPTION_AUTO_SIGN** 电子处方</li></ul>
|
|
2065
2131
|
*/
|
|
2066
2132
|
SceneKey: string
|
|
2067
2133
|
/**
|
|
2068
|
-
*
|
|
2134
|
+
* 需要关闭自动签的个人的信息,如姓名,证件信息等。
|
|
2069
2135
|
*/
|
|
2070
2136
|
UserInfo: UserThreeFactor
|
|
2071
2137
|
/**
|
|
2072
|
-
*
|
|
2138
|
+
* 代理企业和员工的信息。
|
|
2139
|
+
在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
|
|
2073
2140
|
*/
|
|
2074
2141
|
Agent?: Agent
|
|
2075
2142
|
}
|
|
@@ -2125,7 +2192,7 @@ export interface SuccessDeleteStaffData {
|
|
|
2125
2192
|
*/
|
|
2126
2193
|
export interface CreateConvertTaskApiResponse {
|
|
2127
2194
|
/**
|
|
2128
|
-
*
|
|
2195
|
+
* 接口返回的文件转换任务Id,可以调用接口<a href="https://qian.tencent.com/developers/companyApis/templatesAndFiles/GetTaskResultApi" target="_blank">查询转换任务状态</a>获取转换任务的状态和转换后的文件资源Id。
|
|
2129
2196
|
*/
|
|
2130
2197
|
TaskId?: string
|
|
2131
2198
|
/**
|
|
@@ -2224,27 +2291,37 @@ export interface CreateSchemeUrlResponse {
|
|
|
2224
2291
|
*/
|
|
2225
2292
|
export interface CreateUserAutoSignEnableUrlResponse {
|
|
2226
2293
|
/**
|
|
2227
|
-
*
|
|
2294
|
+
* 个人用户自动签的开通链接, 短链形式
|
|
2228
2295
|
*/
|
|
2229
2296
|
Url?: string
|
|
2230
2297
|
/**
|
|
2231
|
-
*
|
|
2298
|
+
* 腾讯电子签小程序的 AppID,用于其他小程序/APP等应用跳转至腾讯电子签小程序使用
|
|
2299
|
+
|
|
2300
|
+
注: `如果获取的是H5链接, 则不会返回此值`
|
|
2232
2301
|
*/
|
|
2233
2302
|
AppId?: string
|
|
2234
2303
|
/**
|
|
2235
|
-
*
|
|
2304
|
+
* 腾讯电子签小程序的原始 Id, ,用于其他小程序/APP等应用跳转至腾讯电子签小程序使用
|
|
2305
|
+
|
|
2306
|
+
注: `如果获取的是H5链接, 则不会返回此值`
|
|
2236
2307
|
*/
|
|
2237
2308
|
AppOriginalId?: string
|
|
2238
2309
|
/**
|
|
2239
|
-
*
|
|
2310
|
+
* 腾讯电子签小程序的跳转路径,用于其他小程序/APP等应用跳转至腾讯电子签小程序使用
|
|
2311
|
+
|
|
2312
|
+
注: `如果获取的是H5链接, 则不会返回此值`
|
|
2240
2313
|
*/
|
|
2241
2314
|
Path?: string
|
|
2242
2315
|
/**
|
|
2243
|
-
* base64
|
|
2316
|
+
* base64 格式的跳转二维码图片,可通过微信扫描后跳转到腾讯电子签小程序的开通界面。
|
|
2317
|
+
|
|
2318
|
+
注: `如果获取的是H5链接, 则不会返回此二维码图片`
|
|
2244
2319
|
*/
|
|
2245
2320
|
QrCode?: string
|
|
2246
2321
|
/**
|
|
2247
|
-
*
|
|
2322
|
+
* 返回的链接类型
|
|
2323
|
+
<ul><li> 空: 默认小程序端链接</li>
|
|
2324
|
+
<li> **H5SIGN** : h5端链接</li></ul>
|
|
2248
2325
|
*/
|
|
2249
2326
|
UrlType?: string
|
|
2250
2327
|
/**
|
|
@@ -2691,46 +2768,52 @@ export interface ModifyIntegrationRoleResponse {
|
|
|
2691
2768
|
*/
|
|
2692
2769
|
export interface FlowCreateApprover {
|
|
2693
2770
|
/**
|
|
2694
|
-
*
|
|
2771
|
+
* 在指定签署方时,可选择企业B端或个人C端等不同的参与者类型,可选类型如下:
|
|
2695
2772
|
0:企业
|
|
2696
2773
|
1:个人
|
|
2697
|
-
3
|
|
2698
|
-
注:类型为3
|
|
2699
|
-
自动签署仅进行盖章操作,不能是手写签名。
|
|
2700
|
-
本方企业自动签署的签署人会默认是当前的发起人
|
|
2701
|
-
他方企业自动签署的签署人是自动签模板的他方企业授权人
|
|
2774
|
+
3:企业静默签署
|
|
2775
|
+
注:类型为3(企业静默签署)时,此接口会默认完成该签署方的签署。静默签署仅进行盖章操作,不能自动签名。
|
|
2702
2776
|
7: 个人自动签署,适用于个人自动签场景。
|
|
2703
|
-
注:
|
|
2777
|
+
注: 个人自动签场景为白名单功能,使用前请联系对接的客户经理沟通。
|
|
2704
2778
|
*/
|
|
2705
2779
|
ApproverType: number
|
|
2706
2780
|
/**
|
|
2707
|
-
*
|
|
2708
|
-
|
|
2781
|
+
* 组织机构名称。
|
|
2782
|
+
请确认该名称与企业营业执照中注册的名称一致。
|
|
2783
|
+
如果名称中包含英文括号(),请使用中文括号()代替。
|
|
2784
|
+
|
|
2785
|
+
注: `当approverType=0(企业签署方) 或 approverType=3(企业静默签署)时,必须指定`
|
|
2709
2786
|
|
|
2710
2787
|
|
|
2711
2788
|
*/
|
|
2712
2789
|
OrganizationName?: string
|
|
2713
2790
|
/**
|
|
2714
|
-
*
|
|
2715
|
-
|
|
2791
|
+
* 签署方经办人的姓名。
|
|
2792
|
+
经办人的姓名将用于身份认证和电子签名,请确保填写的姓名为签署方的真实姓名,而非昵称等代名。
|
|
2793
|
+
|
|
2794
|
+
在未指定签署人电子签UserId情况下,为必填参数
|
|
2716
2795
|
*/
|
|
2717
2796
|
ApproverName?: string
|
|
2718
2797
|
/**
|
|
2719
|
-
*
|
|
2720
|
-
|
|
2798
|
+
* 签署方经办人手机号码, 支持国内手机号11位数字(无需加+86前缀或其他字符)。
|
|
2799
|
+
请确认手机号所有方为此合同签署方。
|
|
2800
|
+
|
|
2801
|
+
在未指定签署人电子签UserId情况下,为必填参数
|
|
2721
2802
|
|
|
2722
2803
|
*/
|
|
2723
2804
|
ApproverMobile?: string
|
|
2724
2805
|
/**
|
|
2725
|
-
*
|
|
2726
|
-
ID_CARD
|
|
2727
|
-
HONGKONG_AND_MACAO
|
|
2728
|
-
HONGKONG_MACAO_AND_TAIWAN 港澳台居民居住证(格式同居民身份证)
|
|
2729
|
-
OTHER_CARD_TYPE 其他(需要使用该类型请先联系运营经理)
|
|
2806
|
+
* 证件类型,支持以下类型
|
|
2807
|
+
<ul><li>ID_CARD : 居民身份证 (默认值)</li>
|
|
2808
|
+
<li>HONGKONG_AND_MACAO : 港澳居民来往内地通行证</li>
|
|
2809
|
+
<li>HONGKONG_MACAO_AND_TAIWAN : 港澳台居民居住证(格式同居民身份证)</li></ul>
|
|
2730
2810
|
*/
|
|
2731
2811
|
ApproverIdCardType?: string
|
|
2732
2812
|
/**
|
|
2733
|
-
*
|
|
2813
|
+
* 证件号码,应符合以下规则
|
|
2814
|
+
<ul><li>居民身份证号码应为18位字符串,由数字和大写字母X组成(如存在X,请大写)。</li>
|
|
2815
|
+
<li>港澳居民来往内地通行证号码应为9位字符串,第1位为“C”,第2位为英文字母(但“I”、“O”除外),后7位为阿拉伯数字。</li>
|
|
2816
|
+
<li>港澳台居民居住证号码编码规则与中国大陆身份证相同,应为18位字符串。</li></ul>
|
|
2734
2817
|
*/
|
|
2735
2818
|
ApproverIdCardNumber?: string
|
|
2736
2819
|
/**
|
|
@@ -2741,15 +2824,17 @@ OTHER_CARD_TYPE 其他(需要使用该类型请先联系运营经理)
|
|
|
2741
2824
|
*/
|
|
2742
2825
|
RecipientId?: string
|
|
2743
2826
|
/**
|
|
2744
|
-
*
|
|
2827
|
+
* 签署意愿确认渠道,默认为WEIXINAPP:人脸识别
|
|
2828
|
+
|
|
2829
|
+
注: 将要废弃, 用ApproverSignTypes签署人签署合同时的认证方式代替, 新客户可请用ApproverSignTypes来设置
|
|
2745
2830
|
*/
|
|
2746
2831
|
VerifyChannel?: Array<string>
|
|
2747
2832
|
/**
|
|
2748
|
-
*
|
|
2749
|
-
<
|
|
2750
|
-
<
|
|
2751
|
-
|
|
2752
|
-
|
|
2833
|
+
* 通知签署方经办人的方式, 有以下途径:
|
|
2834
|
+
<ul><li> **sms** : (默认)短信</li>
|
|
2835
|
+
<li> **none** : 不通知</li></ul>
|
|
2836
|
+
|
|
2837
|
+
注: `发起方也是签署方时不给此签署方发送短信`
|
|
2753
2838
|
*/
|
|
2754
2839
|
NotifyType?: string
|
|
2755
2840
|
/**
|
|
@@ -2763,32 +2848,30 @@ OTHER_CARD_TYPE 其他(需要使用该类型请先联系运营经理)
|
|
|
2763
2848
|
/**
|
|
2764
2849
|
* 签署人userId,仅支持本企业的员工userid, 可在控制台组织管理处获得
|
|
2765
2850
|
|
|
2766
|
-
|
|
2851
|
+
注: `若传此字段 则以userid的信息为主,会覆盖传递过来的签署人基本信息, 包括姓名,手机号,证件类型等信息`
|
|
2767
2852
|
*/
|
|
2768
2853
|
UserId?: string
|
|
2769
2854
|
/**
|
|
2770
|
-
*
|
|
2855
|
+
* 字段已经废弃,当前只支持true,默认为true
|
|
2771
2856
|
*/
|
|
2772
2857
|
Required?: boolean
|
|
2773
2858
|
/**
|
|
2774
|
-
*
|
|
2775
|
-
|
|
2776
|
-
企微侧用户请传入:WEWORKAPP
|
|
2859
|
+
* 在企微场景下使用,需设置参数为**WEWORKAPP**,以表明合同来源于企微。
|
|
2777
2860
|
*/
|
|
2778
2861
|
ApproverSource?: string
|
|
2779
2862
|
/**
|
|
2780
|
-
*
|
|
2781
|
-
|
|
2782
|
-
|
|
2783
|
-
|
|
2863
|
+
* 在企业微信场景下,表明该合同流程为或签,其最大长度为64位字符串。
|
|
2864
|
+
所有参与或签的人员均需具备该标识。
|
|
2865
|
+
注意,在合同中,不同的或签参与人必须保证其CustomApproverTag唯一。
|
|
2866
|
+
如果或签签署人为本方企业微信参与人,则需要指定ApproverSource参数为WEWORKAPP。
|
|
2784
2867
|
*/
|
|
2785
2868
|
CustomApproverTag?: string
|
|
2786
2869
|
/**
|
|
2787
|
-
*
|
|
2870
|
+
* 已经废弃, 快速注册相关信息
|
|
2788
2871
|
*/
|
|
2789
2872
|
RegisterInfo?: RegisterInfo
|
|
2790
2873
|
/**
|
|
2791
|
-
*
|
|
2874
|
+
* 签署人个性化能力值,如是否可以转发他人处理、是否可以拒签等功能开关。
|
|
2792
2875
|
*/
|
|
2793
2876
|
ApproverOption?: ApproverOption
|
|
2794
2877
|
/**
|
|
@@ -2803,20 +2886,39 @@ OTHER_CARD_TYPE 其他(需要使用该类型请先联系运营经理)
|
|
|
2803
2886
|
*/
|
|
2804
2887
|
SignId?: string
|
|
2805
2888
|
/**
|
|
2806
|
-
*
|
|
2807
|
-
<
|
|
2808
|
-
<
|
|
2809
|
-
|
|
2889
|
+
* 发起方企业的签署人进行签署操作前,是否需要企业内部走审批流程,取值如下:
|
|
2890
|
+
<ul><li>**false**:(默认)不需要审批,直接签署。</li>
|
|
2891
|
+
<li>**true**:需要走审批流程。当到对应参与人签署时,会阻塞其签署操作,等待企业内部审批完成。</li></ul>
|
|
2892
|
+
企业可以通过CreateFlowSignReview审批接口通知腾讯电子签平台企业内部审批结果
|
|
2893
|
+
<ul><li>如果企业通知腾讯电子签平台审核通过,签署方可继续签署动作。</li>
|
|
2894
|
+
<li>如果企业通知腾讯电子签平台审核未通过,平台将继续阻塞签署方的签署动作,直到企业通知平台审核通过。</li></ul>
|
|
2895
|
+
|
|
2896
|
+
注:`此功能可用于与企业内部的审批流程进行关联,支持手动、静默签署合同`
|
|
2810
2897
|
*/
|
|
2811
2898
|
ApproverNeedSignReview?: boolean
|
|
2812
2899
|
/**
|
|
2813
2900
|
* 签署人签署控件, 此参数仅针对文件发起(CreateFlowByFiles)生效
|
|
2814
|
-
|
|
2901
|
+
|
|
2902
|
+
合同中的签署控件列表,列表中可支持下列多种签署控件,控件的详细定义参考开发者中心的Component结构体
|
|
2903
|
+
<ul><li> 个人签名/印章</li>
|
|
2904
|
+
<li> 企业印章</li>
|
|
2905
|
+
<li> 骑缝章等签署控件</li></ul>
|
|
2906
|
+
|
|
2907
|
+
`此参数仅针对文件发起设置生效,模板发起合同签署流程, 请以模板配置为主`
|
|
2815
2908
|
*/
|
|
2816
2909
|
SignComponents?: Array<Component>
|
|
2817
2910
|
/**
|
|
2818
2911
|
* 签署人填写控件 此参数仅针对文件发起(CreateFlowByFiles)生效
|
|
2819
|
-
|
|
2912
|
+
|
|
2913
|
+
合同中的填写控件列表,列表中可支持下列多种填写控件,控件的详细定义参考开发者中心的Component结构体
|
|
2914
|
+
<ul><li>单行文本控件</li>
|
|
2915
|
+
<li>多行文本控件</li>
|
|
2916
|
+
<li>勾选框控件</li>
|
|
2917
|
+
<li>数字控件</li>
|
|
2918
|
+
<li>图片控件</li>
|
|
2919
|
+
<li>动态表格等填写控件</li></ul>
|
|
2920
|
+
|
|
2921
|
+
`此参数仅针对文件发起设置生效,模板发起合同签署流程, 请以模板配置为主`
|
|
2820
2922
|
*/
|
|
2821
2923
|
Components?: Array<Component>
|
|
2822
2924
|
/**
|
|
@@ -2828,15 +2930,30 @@ OTHER_CARD_TYPE 其他(需要使用该类型请先联系运营经理)
|
|
|
2828
2930
|
*/
|
|
2829
2931
|
ComponentLimitType?: Array<string>
|
|
2830
2932
|
/**
|
|
2831
|
-
*
|
|
2933
|
+
* 指定个人签署方查看合同的校验方式,可以传值如下:
|
|
2934
|
+
<ul><li> **1** : (默认)人脸识别,人脸识别后才能合同内容</li>
|
|
2935
|
+
<li> **2** : 手机号验证, 用户手机号和参与方手机号(ApproverMobile)相同即可查看合同内容(当手写签名方式为OCR_ESIGN时,该校验方式无效,因为这种签名方式依赖实名认证)
|
|
2936
|
+
</li></ul>
|
|
2937
|
+
注:
|
|
2938
|
+
<ul><li>如果合同流程设置ApproverVerifyType查看合同的校验方式, 则忽略此签署人的查看合同的校验方式</li>
|
|
2939
|
+
<li>此字段不可传多个校验方式</li></ul>
|
|
2940
|
+
|
|
2941
|
+
`此参数仅针对文件发起设置生效,模板发起合同签署流程, 请以模板配置为主`
|
|
2832
2942
|
|
|
2833
|
-
|
|
2943
|
+
.
|
|
2834
2944
|
*/
|
|
2835
2945
|
ApproverVerifyTypes?: Array<number | bigint>
|
|
2836
2946
|
/**
|
|
2837
|
-
*
|
|
2947
|
+
* 您可以指定签署方签署合同的认证校验方式,可传递以下值:
|
|
2948
|
+
<ul><li>**1**:人脸认证,需进行人脸识别成功后才能签署合同;</li>
|
|
2949
|
+
<li>**2**:签署密码,需输入与用户在腾讯电子签设置的密码一致才能校验成功进行合同签署;</li>
|
|
2950
|
+
<li>**3**:运营商三要素,需到运营商处比对手机号实名信息(名字、手机号、证件号)校验一致才能成功进行合同签署。</li></ul>
|
|
2951
|
+
注:
|
|
2952
|
+
<ul><li>默认情况下,认证校验方式为人脸认证和签署密码两种形式;</li>
|
|
2953
|
+
<li>您可以传递多种值,表示可用多种认证校验方式。</li></ul>
|
|
2838
2954
|
|
|
2839
|
-
|
|
2955
|
+
注:
|
|
2956
|
+
`此参数仅针对文件发起设置生效,模板发起合同签署流程, 请以模板配置为主`
|
|
2840
2957
|
*/
|
|
2841
2958
|
ApproverSignTypes?: Array<number | bigint>
|
|
2842
2959
|
}
|
|
@@ -3134,11 +3251,13 @@ export interface CreateDocumentRequest {
|
|
|
3134
3251
|
*/
|
|
3135
3252
|
Operator: UserInfo
|
|
3136
3253
|
/**
|
|
3137
|
-
*
|
|
3254
|
+
* 合同流程ID,为32位字符串。
|
|
3255
|
+
此接口的合同流程ID需要由<a href="https://qian.tencent.com/developers/companyApis/startFlows/CreateFlow" target="_blank">创建签署流程</a>接口创建得到。
|
|
3138
3256
|
*/
|
|
3139
3257
|
FlowId: string
|
|
3140
3258
|
/**
|
|
3141
|
-
*
|
|
3259
|
+
* 用户配置的合同模板ID,会基于此模板创建合同文档,为32位字符串。
|
|
3260
|
+
可登录腾讯电子签控制台,在 "模板"->"模板中心"->"列表展示设置"选中模板 ID 中查看某个模板的TemplateId(在页面中展示为模板ID)。
|
|
3142
3261
|
*/
|
|
3143
3262
|
TemplateId: string
|
|
3144
3263
|
/**
|
|
@@ -3146,24 +3265,30 @@ export interface CreateDocumentRequest {
|
|
|
3146
3265
|
*/
|
|
3147
3266
|
FileNames?: Array<string>
|
|
3148
3267
|
/**
|
|
3149
|
-
*
|
|
3268
|
+
* 电子文档的填写控件的填充内容。具体方式可以参考<a href="https://qian.tencent.com/developers/companyApis/dataTypes/#formfield" target="_blank">FormField</a>结构体的定义。
|
|
3150
3269
|
*/
|
|
3151
3270
|
FormFields?: Array<FormField>
|
|
3152
3271
|
/**
|
|
3153
|
-
*
|
|
3154
|
-
|
|
3272
|
+
* 是否为预览模式,取值如下:
|
|
3273
|
+
<ul><li> **false**:非预览模式(默认),会产生合同流程并返回合同流程编号FlowId。</li>
|
|
3274
|
+
<li> **true**:预览模式,不产生合同流程,不返回合同流程编号FlowId,而是返回预览链接PreviewUrl,有效期为300秒,用于查看真实发起后合同的样子。</li></ul>
|
|
3155
3275
|
*/
|
|
3156
3276
|
NeedPreview?: boolean
|
|
3157
3277
|
/**
|
|
3158
|
-
*
|
|
3278
|
+
* 预览模式下产生的预览链接类型
|
|
3279
|
+
<ul><li> **0** :(默认) 文件流 ,点开后后下载预览的合同PDF文件 </li>
|
|
3280
|
+
<li> **1** :H5链接 ,点开后在浏览器中展示合同的样子</li></ul>
|
|
3281
|
+
注: `此参数在NeedPreview 为true时有效`
|
|
3282
|
+
|
|
3159
3283
|
*/
|
|
3160
3284
|
PreviewType?: number
|
|
3161
3285
|
/**
|
|
3162
|
-
*
|
|
3286
|
+
* 代理企业和员工的信息。
|
|
3287
|
+
在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
|
|
3163
3288
|
*/
|
|
3164
3289
|
Agent?: Agent
|
|
3165
3290
|
/**
|
|
3166
|
-
*
|
|
3291
|
+
* 已废弃字段,客户端Token,保持接口幂等性,最大长度64个字符
|
|
3167
3292
|
*/
|
|
3168
3293
|
ClientToken?: string
|
|
3169
3294
|
}
|
|
@@ -3643,21 +3768,27 @@ export interface CreateFlowByFilesRequest {
|
|
|
3643
3768
|
*/
|
|
3644
3769
|
export interface CreateFlowSignUrlRequest {
|
|
3645
3770
|
/**
|
|
3646
|
-
*
|
|
3771
|
+
* 合同流程ID,为32位字符串。
|
|
3772
|
+
建议开发者妥善保存此流程ID,以便于顺利进行后续操作。
|
|
3773
|
+
可登录腾讯电子签控制台,在 "合同"->"合同中心" 中查看某个合同的FlowId(在页面中展示为合同ID)。
|
|
3647
3774
|
*/
|
|
3648
3775
|
FlowId: string
|
|
3649
3776
|
/**
|
|
3650
|
-
* 流程签署人列表,其中结构体的ApproverName,ApproverMobile和ApproverType必传,其他可不传,
|
|
3777
|
+
* 流程签署人列表,其中结构体的ApproverName,ApproverMobile和ApproverType必传,其他可不传,
|
|
3651
3778
|
|
|
3652
|
-
|
|
3779
|
+
注:
|
|
3780
|
+
`1. ApproverType目前只支持个人类型的签署人。`
|
|
3781
|
+
`2. 签署人只能有手写签名和时间类型的签署控件,其他类型的填写控件和签署控件暂时都未支持。`
|
|
3653
3782
|
*/
|
|
3654
3783
|
FlowApproverInfos: Array<FlowCreateApprover>
|
|
3655
3784
|
/**
|
|
3656
|
-
*
|
|
3785
|
+
* 执行本接口操作的员工信息。
|
|
3786
|
+
注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
|
|
3657
3787
|
*/
|
|
3658
3788
|
Operator?: UserInfo
|
|
3659
3789
|
/**
|
|
3660
|
-
*
|
|
3790
|
+
* 代理企业和员工的信息。
|
|
3791
|
+
在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
|
|
3661
3792
|
*/
|
|
3662
3793
|
Agent?: Agent
|
|
3663
3794
|
/**
|
|
@@ -3666,7 +3797,7 @@ export interface CreateFlowSignUrlRequest {
|
|
|
3666
3797
|
*/
|
|
3667
3798
|
Organization?: OrganizationInfo
|
|
3668
3799
|
/**
|
|
3669
|
-
* 签署完之后的H5
|
|
3800
|
+
* 签署完之后的H5页面的跳转链接,此链接及支持http://和https://,最大长度1000个字符。(建议https协议)
|
|
3670
3801
|
*/
|
|
3671
3802
|
JumpUrl?: string
|
|
3672
3803
|
}
|
|
@@ -3676,31 +3807,44 @@ export interface CreateFlowSignUrlRequest {
|
|
|
3676
3807
|
*/
|
|
3677
3808
|
export interface CreateReleaseFlowRequest {
|
|
3678
3809
|
/**
|
|
3679
|
-
*
|
|
3810
|
+
* 执行本接口操作的员工信息。
|
|
3811
|
+
注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
|
|
3680
3812
|
*/
|
|
3681
3813
|
Operator: UserInfo
|
|
3682
3814
|
/**
|
|
3683
|
-
*
|
|
3815
|
+
* 待解除的签署流程编号(即原签署流程的编号)。
|
|
3684
3816
|
*/
|
|
3685
3817
|
NeedRelievedFlowId: string
|
|
3686
3818
|
/**
|
|
3687
|
-
*
|
|
3819
|
+
* 解除协议内容。
|
|
3688
3820
|
*/
|
|
3689
3821
|
ReliveInfo: RelieveInfo
|
|
3690
3822
|
/**
|
|
3691
|
-
*
|
|
3692
|
-
|
|
3693
|
-
|
|
3823
|
+
* 关于渠道应用的相关信息,包括子客企业及应用编、号等详细内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
|
|
3824
|
+
*/
|
|
3825
|
+
Agent?: Agent
|
|
3826
|
+
/**
|
|
3827
|
+
* 解除协议的签署人列表(如不指定该参数,默认使用原流程的签署人列表)。 <br/>
|
|
3828
|
+
如需更换原合同中的签署人,可通过指定该签署人的RecipientId编号更换此签署人。(可通过接口<a href="https://qian.tencent.com/developers/companyApis/queryFlows/DescribeFlowInfo/">DescribeFlowInfo</a>查询签署人的RecipientId编号)<br/>
|
|
3829
|
+
解除协议的签署人数量不能多于原流程的签署人数量。<br/>
|
|
3830
|
+
|
|
3831
|
+
`注意:只能更换同企业的签署人。`<br/>
|
|
3832
|
+
`注意:不支持更换个人类型的签署人。`<br/>
|
|
3694
3833
|
*/
|
|
3695
3834
|
ReleasedApprovers?: Array<ReleasedApprover>
|
|
3696
3835
|
/**
|
|
3697
|
-
*
|
|
3836
|
+
* 合同流程的签署截止时间,格式为Unix标准时间戳(秒),如果未设置签署截止时间,则默认为合同流程创建后的7天时截止。
|
|
3837
|
+
如果在签署截止时间前未完成签署,则合同状态会变为已过期,导致合同作废。
|
|
3698
3838
|
*/
|
|
3699
3839
|
Deadline?: number
|
|
3700
3840
|
/**
|
|
3701
|
-
*
|
|
3841
|
+
* 调用方自定义的个性化字段,该字段的值可以是字符串JSON或其他字符串形式,客户可以根据自身需求自定义数据格式并在需要时进行解析。该字段的信息将以Base64编码的形式传输,支持的最大数据大小为20480长度。
|
|
3842
|
+
|
|
3843
|
+
在合同状态变更的回调信息等场景中,该字段的信息将原封不动地透传给贵方。
|
|
3844
|
+
|
|
3845
|
+
回调的相关说明可参考开发者中心的<a href="https://qian.tencent.com/developers/company/callback_types_v2" target="_blank">回调通知</a>模块。
|
|
3702
3846
|
*/
|
|
3703
|
-
|
|
3847
|
+
UserData?: string
|
|
3704
3848
|
}
|
|
3705
3849
|
|
|
3706
3850
|
/**
|
|
@@ -4181,29 +4325,31 @@ export interface CreateStaffResult {
|
|
|
4181
4325
|
*/
|
|
4182
4326
|
export interface CreateUserAutoSignEnableUrlRequest {
|
|
4183
4327
|
/**
|
|
4184
|
-
*
|
|
4328
|
+
* 执行本接口操作的员工信息。
|
|
4329
|
+
注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
|
|
4185
4330
|
*/
|
|
4186
4331
|
Operator: UserInfo
|
|
4187
4332
|
/**
|
|
4188
|
-
*
|
|
4189
|
-
E_PRESCRIPTION_AUTO_SIGN
|
|
4333
|
+
* 自动签使用的场景值, 可以选择的场景值如下:
|
|
4334
|
+
<ul><li> **E_PRESCRIPTION_AUTO_SIGN** : 电子处方场景</li></ul>
|
|
4335
|
+
|
|
4336
|
+
注: `现在仅支持电子处方场景`
|
|
4190
4337
|
*/
|
|
4191
4338
|
SceneKey: string
|
|
4192
4339
|
/**
|
|
4193
|
-
*
|
|
4340
|
+
* 自动签开通配置信息, 包括开通的人员的信息等
|
|
4194
4341
|
*/
|
|
4195
4342
|
AutoSignConfig: AutoSignConfig
|
|
4196
4343
|
/**
|
|
4197
|
-
*
|
|
4198
|
-
|
|
4199
|
-
H5SIGN
|
|
4344
|
+
* 生成的链接类型:
|
|
4345
|
+
<ul><li> 不传(即为空值) 则会生成小程序端开通链接(默认)</li>
|
|
4346
|
+
<li> **H5SIGN** : 生成H5端开通链接</li><ul>
|
|
4200
4347
|
*/
|
|
4201
4348
|
UrlType?: string
|
|
4202
4349
|
/**
|
|
4203
|
-
*
|
|
4204
|
-
|
|
4205
|
-
|
|
4206
|
-
SMS 为短信通知 , 此种方式需要NotifyAddress填写手机号。
|
|
4350
|
+
* 是否通知开通方,通知类型:
|
|
4351
|
+
<ul><li>默认不设置为不通知开通方</li>
|
|
4352
|
+
<li>**SMS** : 短信通知 ,如果需要短信通知则NotifyAddress填写对方的手机号</li><ul>
|
|
4207
4353
|
*/
|
|
4208
4354
|
NotifyType?: string
|
|
4209
4355
|
/**
|
|
@@ -4211,11 +4357,12 @@ SMS 为短信通知 , 此种方式需要NotifyAddress填写手机号。
|
|
|
4211
4357
|
*/
|
|
4212
4358
|
NotifyAddress?: string
|
|
4213
4359
|
/**
|
|
4214
|
-
* 链接的过期时间,格式为Unix
|
|
4360
|
+
* 链接的过期时间,格式为Unix时间戳,不能早于当前时间,且最大为当前时间往后30天。`如果不传,默认过期时间为当前时间往后7天。`
|
|
4215
4361
|
*/
|
|
4216
4362
|
ExpiredTime?: number
|
|
4217
4363
|
/**
|
|
4218
|
-
*
|
|
4364
|
+
* 代理企业和员工的信息。
|
|
4365
|
+
在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
|
|
4219
4366
|
*/
|
|
4220
4367
|
Agent?: Agent
|
|
4221
4368
|
}
|
|
@@ -4278,18 +4425,27 @@ true - 可以,false - 不可以。
|
|
|
4278
4425
|
*/
|
|
4279
4426
|
export interface CancelUserAutoSignEnableUrlRequest {
|
|
4280
4427
|
/**
|
|
4281
|
-
*
|
|
4428
|
+
* 执行本接口操作的员工信息。
|
|
4429
|
+
注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
|
|
4282
4430
|
*/
|
|
4283
4431
|
Operator: UserInfo
|
|
4284
4432
|
/**
|
|
4285
|
-
*
|
|
4433
|
+
* 自动签使用的场景值, 可以选择的场景值如下:
|
|
4434
|
+
<ul><li> **E_PRESCRIPTION_AUTO_SIGN** : 电子处方场景</li></ul>
|
|
4435
|
+
|
|
4436
|
+
注: `现在仅支持电子处方场景`
|
|
4286
4437
|
*/
|
|
4287
4438
|
SceneKey: string
|
|
4288
4439
|
/**
|
|
4289
|
-
*
|
|
4440
|
+
* 预撤销链接的用户信息,包含姓名、证件类型、证件号码等信息。
|
|
4290
4441
|
|
|
4291
4442
|
*/
|
|
4292
4443
|
UserInfo: UserThreeFactor
|
|
4444
|
+
/**
|
|
4445
|
+
* 代理企业和员工的信息。
|
|
4446
|
+
在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
|
|
4447
|
+
*/
|
|
4448
|
+
Agent?: Agent
|
|
4293
4449
|
}
|
|
4294
4450
|
|
|
4295
4451
|
/**
|
|
@@ -4509,15 +4665,17 @@ ProcessTimeout - 转换文件超时
|
|
|
4509
4665
|
*/
|
|
4510
4666
|
export interface CancelMultiFlowSignQRCodeRequest {
|
|
4511
4667
|
/**
|
|
4512
|
-
*
|
|
4668
|
+
* 执行本接口操作的员工信息。
|
|
4669
|
+
注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。
|
|
4513
4670
|
*/
|
|
4514
4671
|
Operator: UserInfo
|
|
4515
4672
|
/**
|
|
4516
|
-
* 二维码
|
|
4673
|
+
* 二维码ID,为32位字符串。
|
|
4517
4674
|
*/
|
|
4518
4675
|
QrCodeId: string
|
|
4519
4676
|
/**
|
|
4520
|
-
*
|
|
4677
|
+
* 代理企业和员工的信息。
|
|
4678
|
+
在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
|
|
4521
4679
|
*/
|
|
4522
4680
|
Agent?: Agent
|
|
4523
4681
|
}
|
|
@@ -4637,8 +4795,8 @@ export interface StartFlowRequest {
|
|
|
4637
4795
|
Agent?: Agent
|
|
4638
4796
|
/**
|
|
4639
4797
|
* 若在创建签署流程时指定了关注人CcInfos,此参数可设定向关注人发送短信通知的类型:
|
|
4640
|
-
0
|
|
4641
|
-
1
|
|
4798
|
+
<ul><li> **0** :合同发起时通知通知对方来查看合同(默认)</li>
|
|
4799
|
+
<li> **1** : 签署完成后通知对方来查看合同</li></ul>
|
|
4642
4800
|
*/
|
|
4643
4801
|
CcNotifyType?: number
|
|
4644
4802
|
}
|
|
@@ -4908,19 +5066,22 @@ export interface PermissionGroup {
|
|
|
4908
5066
|
*/
|
|
4909
5067
|
export interface CancelFlowRequest {
|
|
4910
5068
|
/**
|
|
4911
|
-
*
|
|
5069
|
+
* 执行本接口操作的员工信息。
|
|
5070
|
+
注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
|
|
4912
5071
|
*/
|
|
4913
5072
|
Operator: UserInfo
|
|
4914
5073
|
/**
|
|
4915
|
-
*
|
|
5074
|
+
* 合同流程ID, 为32位字符串。
|
|
5075
|
+
建议开发者保存此流程ID方便后续其他操作。
|
|
4916
5076
|
*/
|
|
4917
5077
|
FlowId: string
|
|
4918
5078
|
/**
|
|
4919
|
-
*
|
|
5079
|
+
* 撤销此合同(流程)的原因,最长200个字。
|
|
4920
5080
|
*/
|
|
4921
5081
|
CancelMessage: string
|
|
4922
5082
|
/**
|
|
4923
|
-
*
|
|
5083
|
+
* 代理企业和员工的信息。
|
|
5084
|
+
在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
|
|
4924
5085
|
*/
|
|
4925
5086
|
Agent?: Agent
|
|
4926
5087
|
}
|
|
@@ -5777,11 +5938,13 @@ export interface CancelMultiFlowSignQRCodeResponse {
|
|
|
5777
5938
|
*/
|
|
5778
5939
|
export interface CreateFlowResponse {
|
|
5779
5940
|
/**
|
|
5780
|
-
*
|
|
5941
|
+
* 合同流程ID,为32位字符串。
|
|
5942
|
+
建议开发者妥善保存此流程ID,以便于顺利进行后续操作。
|
|
5943
|
+
|
|
5944
|
+
注:
|
|
5945
|
+
此返回的合同流程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>接口将合同开始后,合同才能进入签署环节
|
|
5781
5946
|
|
|
5782
|
-
返回的流程编号,需要在CreateDocument,StartFlow中使用,
|
|
5783
5947
|
|
|
5784
|
-
注意:这三个接口(CreateFlow,CreateDocument,StartFlow)要一并调用,才算发起成功
|
|
5785
5948
|
*/
|
|
5786
5949
|
FlowId?: string
|
|
5787
5950
|
/**
|
|
@@ -5795,20 +5958,24 @@ export interface CreateFlowResponse {
|
|
|
5795
5958
|
*/
|
|
5796
5959
|
export interface DescribeUserAutoSignStatusRequest {
|
|
5797
5960
|
/**
|
|
5798
|
-
*
|
|
5961
|
+
* 执行本接口操作的员工信息。
|
|
5962
|
+
注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
|
|
5799
5963
|
*/
|
|
5800
5964
|
Operator: UserInfo
|
|
5801
5965
|
/**
|
|
5802
|
-
*
|
|
5803
|
-
E_PRESCRIPTION_AUTO_SIGN
|
|
5966
|
+
* 自动签使用的场景值, 可以选择的场景值如下:
|
|
5967
|
+
<ul><li> **E_PRESCRIPTION_AUTO_SIGN** : 电子处方场景</li></ul>
|
|
5968
|
+
|
|
5969
|
+
注: `现在仅支持电子处方场景`
|
|
5804
5970
|
*/
|
|
5805
5971
|
SceneKey: string
|
|
5806
5972
|
/**
|
|
5807
|
-
*
|
|
5973
|
+
* 要查询状态的用户信息, 包括名字,身份证等
|
|
5808
5974
|
*/
|
|
5809
5975
|
UserInfo: UserThreeFactor
|
|
5810
5976
|
/**
|
|
5811
|
-
*
|
|
5977
|
+
* 代理企业和员工的信息。
|
|
5978
|
+
在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
|
|
5812
5979
|
*/
|
|
5813
5980
|
Agent?: Agent
|
|
5814
5981
|
}
|