tencentcloud-sdk-nodejs-essbasic 4.0.551 → 4.0.554
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 +516 -0
- package/SERVICE_CHANGELOG.md +467 -77
- package/package.json +1 -1
- package/products.md +35 -35
- package/src/services/essbasic/v20210526/essbasic_client.ts +29 -13
- package/src/services/essbasic/v20210526/essbasic_models.ts +317 -70
- package/tencentcloud/services/essbasic/v20210526/essbasic_client.d.ts +16 -12
- package/tencentcloud/services/essbasic/v20210526/essbasic_client.js +17 -11
- package/tencentcloud/services/essbasic/v20210526/essbasic_models.d.ts +279 -70
|
@@ -101,7 +101,7 @@ export interface ChannelBatchCancelFlowsResponse {
|
|
|
101
101
|
}
|
|
102
102
|
|
|
103
103
|
/**
|
|
104
|
-
*
|
|
104
|
+
* 第三方应用集成员工部门信息
|
|
105
105
|
*/
|
|
106
106
|
export interface Department {
|
|
107
107
|
/**
|
|
@@ -117,6 +117,17 @@ export interface Department {
|
|
|
117
117
|
DepartmentName: string
|
|
118
118
|
}
|
|
119
119
|
|
|
120
|
+
/**
|
|
121
|
+
* 签署人配置信息
|
|
122
|
+
*/
|
|
123
|
+
export interface CommonApproverOption {
|
|
124
|
+
/**
|
|
125
|
+
* 是否允许修改签署人信息
|
|
126
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
127
|
+
*/
|
|
128
|
+
CanEditApprover?: boolean
|
|
129
|
+
}
|
|
130
|
+
|
|
120
131
|
/**
|
|
121
132
|
* ChannelCreateFlowSignReview请求参数结构体
|
|
122
133
|
*/
|
|
@@ -278,13 +289,18 @@ export interface ChannelCreateFlowSignUrlResponse {
|
|
|
278
289
|
}
|
|
279
290
|
|
|
280
291
|
/**
|
|
281
|
-
*
|
|
292
|
+
* ChannelCreatePrepareFlow返回参数结构体
|
|
282
293
|
*/
|
|
283
|
-
export interface
|
|
294
|
+
export interface ChannelCreatePrepareFlowResponse {
|
|
284
295
|
/**
|
|
285
|
-
*
|
|
296
|
+
* 预发起的合同链接
|
|
286
297
|
*/
|
|
287
|
-
|
|
298
|
+
PrepareFlowUrl?: string
|
|
299
|
+
|
|
300
|
+
/**
|
|
301
|
+
* 合同发起后预览链接
|
|
302
|
+
*/
|
|
303
|
+
PreviewFlowUrl?: string
|
|
288
304
|
|
|
289
305
|
/**
|
|
290
306
|
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
@@ -297,13 +313,13 @@ export interface CreateSealByImageResponse {
|
|
|
297
313
|
*/
|
|
298
314
|
export interface OperateChannelTemplateResponse {
|
|
299
315
|
/**
|
|
300
|
-
*
|
|
316
|
+
* 腾讯电子签颁发给第三方应用平台的应用ID
|
|
301
317
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
302
318
|
*/
|
|
303
319
|
AppId?: string
|
|
304
320
|
|
|
305
321
|
/**
|
|
306
|
-
*
|
|
322
|
+
* 第三方应用平台模板库模板唯一标识
|
|
307
323
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
308
324
|
*/
|
|
309
325
|
TemplateId?: string
|
|
@@ -378,7 +394,7 @@ export interface FlowFileInfo {
|
|
|
378
394
|
CallbackUrl?: string
|
|
379
395
|
|
|
380
396
|
/**
|
|
381
|
-
*
|
|
397
|
+
* 第三方应用的业务信息,最大长度1000个字符。发起自动签署时,需设置对应自动签署场景,目前仅支持场景:处方单-E_PRESCRIPTION_AUTO_SIGN
|
|
382
398
|
*/
|
|
383
399
|
CustomerData?: string
|
|
384
400
|
|
|
@@ -398,6 +414,70 @@ export interface FlowFileInfo {
|
|
|
398
414
|
NeedSignReview?: boolean
|
|
399
415
|
}
|
|
400
416
|
|
|
417
|
+
/**
|
|
418
|
+
* 创建合同配置信息
|
|
419
|
+
*/
|
|
420
|
+
export interface CreateFlowOption {
|
|
421
|
+
/**
|
|
422
|
+
* 是否允许修改合同信息
|
|
423
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
424
|
+
*/
|
|
425
|
+
CanEditFlow?: boolean
|
|
426
|
+
}
|
|
427
|
+
|
|
428
|
+
/**
|
|
429
|
+
* 基础流程信息
|
|
430
|
+
*/
|
|
431
|
+
export interface BaseFlowInfo {
|
|
432
|
+
/**
|
|
433
|
+
* 合同流程名称
|
|
434
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
435
|
+
*/
|
|
436
|
+
FlowName: string
|
|
437
|
+
|
|
438
|
+
/**
|
|
439
|
+
* 合同流程类型
|
|
440
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
441
|
+
*/
|
|
442
|
+
FlowType: string
|
|
443
|
+
|
|
444
|
+
/**
|
|
445
|
+
* 合同流程描述信息
|
|
446
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
447
|
+
*/
|
|
448
|
+
FlowDescription: string
|
|
449
|
+
|
|
450
|
+
/**
|
|
451
|
+
* 合同流程截止时间,unix时间戳
|
|
452
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
453
|
+
*/
|
|
454
|
+
Deadline: number
|
|
455
|
+
|
|
456
|
+
/**
|
|
457
|
+
* 是否顺序签署(true:无序签,false:顺序签)
|
|
458
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
459
|
+
*/
|
|
460
|
+
Unordered?: boolean
|
|
461
|
+
|
|
462
|
+
/**
|
|
463
|
+
* 打开智能添加填写区(默认开启,打开:"OPEN" 关闭:"CLOSE")
|
|
464
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
465
|
+
*/
|
|
466
|
+
IntelligentStatus?: string
|
|
467
|
+
|
|
468
|
+
/**
|
|
469
|
+
* 填写控件内容
|
|
470
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
471
|
+
*/
|
|
472
|
+
FormFields?: Array<FormField>
|
|
473
|
+
|
|
474
|
+
/**
|
|
475
|
+
* 本企业(发起方企业)是否需要签署审批,true:开启本企业签署审批
|
|
476
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
477
|
+
*/
|
|
478
|
+
NeedSignReview?: boolean
|
|
479
|
+
}
|
|
480
|
+
|
|
401
481
|
/**
|
|
402
482
|
* CreateConsoleLoginUrl返回参数结构体
|
|
403
483
|
*/
|
|
@@ -439,7 +519,7 @@ export interface SyncProxyOrganizationRequest {
|
|
|
439
519
|
Agent: Agent
|
|
440
520
|
|
|
441
521
|
/**
|
|
442
|
-
*
|
|
522
|
+
* 第三方平台子客企业名称,最大长度64个字符
|
|
443
523
|
*/
|
|
444
524
|
ProxyOrganizationName: string
|
|
445
525
|
|
|
@@ -449,12 +529,12 @@ export interface SyncProxyOrganizationRequest {
|
|
|
449
529
|
BusinessLicense?: string
|
|
450
530
|
|
|
451
531
|
/**
|
|
452
|
-
*
|
|
532
|
+
* 第三方平台子客企业统一社会信用代码,最大长度200个字符
|
|
453
533
|
*/
|
|
454
534
|
UniformSocialCreditCode?: string
|
|
455
535
|
|
|
456
536
|
/**
|
|
457
|
-
*
|
|
537
|
+
* 第三方平台子客企业法人/负责人姓名
|
|
458
538
|
*/
|
|
459
539
|
ProxyLegalName?: string
|
|
460
540
|
|
|
@@ -465,26 +545,56 @@ export interface SyncProxyOrganizationRequest {
|
|
|
465
545
|
}
|
|
466
546
|
|
|
467
547
|
/**
|
|
468
|
-
*
|
|
548
|
+
* ChannelCreatePrepareFlow请求参数结构体
|
|
469
549
|
*/
|
|
470
|
-
export interface
|
|
550
|
+
export interface ChannelCreatePrepareFlowRequest {
|
|
471
551
|
/**
|
|
472
|
-
*
|
|
552
|
+
* 资源id,与ResourceType对应
|
|
473
553
|
*/
|
|
474
|
-
|
|
554
|
+
ResourceId: string
|
|
475
555
|
|
|
476
556
|
/**
|
|
477
|
-
*
|
|
557
|
+
* 资源类型,1:模版,目前仅支持模版,与ResourceId对应
|
|
478
558
|
*/
|
|
479
|
-
|
|
559
|
+
ResourceType: number
|
|
480
560
|
|
|
481
561
|
/**
|
|
482
|
-
*
|
|
562
|
+
* 合同流程基础信息
|
|
483
563
|
*/
|
|
484
|
-
|
|
564
|
+
FlowInfo: BaseFlowInfo
|
|
485
565
|
|
|
486
566
|
/**
|
|
487
|
-
*
|
|
567
|
+
* 合同签署人信息
|
|
568
|
+
*/
|
|
569
|
+
FlowApproverList: Array<CommonFlowApprover>
|
|
570
|
+
|
|
571
|
+
/**
|
|
572
|
+
* 应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 均必填
|
|
573
|
+
*/
|
|
574
|
+
Agent?: Agent
|
|
575
|
+
|
|
576
|
+
/**
|
|
577
|
+
* 合同流程配置信息
|
|
578
|
+
*/
|
|
579
|
+
FlowOption?: CreateFlowOption
|
|
580
|
+
|
|
581
|
+
/**
|
|
582
|
+
* 该参数不可用,请通过获取 web 可嵌入接口获取合同流程预览 URL
|
|
583
|
+
*/
|
|
584
|
+
FlowId?: string
|
|
585
|
+
|
|
586
|
+
/**
|
|
587
|
+
* 该参数不可用,请通过获取 web 可嵌入接口获取合同流程预览 URL
|
|
588
|
+
*/
|
|
589
|
+
NeedPreview?: boolean
|
|
590
|
+
|
|
591
|
+
/**
|
|
592
|
+
* 企业机构信息,不用传
|
|
593
|
+
*/
|
|
594
|
+
Organization?: OrganizationInfo
|
|
595
|
+
|
|
596
|
+
/**
|
|
597
|
+
* 操作人(用户)信息,不用传
|
|
488
598
|
*/
|
|
489
599
|
Operator?: UserInfo
|
|
490
600
|
}
|
|
@@ -664,7 +774,7 @@ export interface ChannelCreateFlowByFilesRequest {
|
|
|
664
774
|
CustomShowMap?: string
|
|
665
775
|
|
|
666
776
|
/**
|
|
667
|
-
*
|
|
777
|
+
* 业务信息,最大长度1000个字符。发起自动签署时,需设置对应自动签署场景,目前仅支持场景:处方单-E_PRESCRIPTION_AUTO_SIGN
|
|
668
778
|
*/
|
|
669
779
|
CustomerData?: string
|
|
670
780
|
|
|
@@ -702,17 +812,17 @@ export interface Agent {
|
|
|
702
812
|
AppId: string
|
|
703
813
|
|
|
704
814
|
/**
|
|
705
|
-
*
|
|
815
|
+
* 第三方应用平台自定义,对应第三方平台子客企业的唯一标识。一个第三方平台子客企业主体与子客企业ProxyOrganizationOpenId是一一对应的,不可更改,不可重复使用。(例如,可以使用企业名称的hash值,或者社会统一信用代码的hash值,或者随机hash值,需要第三方应用平台保存),最大64位字符串
|
|
706
816
|
*/
|
|
707
817
|
ProxyOrganizationOpenId?: string
|
|
708
818
|
|
|
709
819
|
/**
|
|
710
|
-
*
|
|
820
|
+
* 第三方平台子客企业中的员工/经办人,通过第三方应用平台进入电子签完成实名、且被赋予相关权限后,可以参与到企业资源的管理或签署流程中。
|
|
711
821
|
*/
|
|
712
822
|
ProxyOperator?: UserInfo
|
|
713
823
|
|
|
714
824
|
/**
|
|
715
|
-
*
|
|
825
|
+
* 在第三方平台子客企业开通电子签后,会生成唯一的子客应用Id(ProxyAppId)用于代理调用时的鉴权,在子客开通的回调中获取。
|
|
716
826
|
*/
|
|
717
827
|
ProxyAppId?: string
|
|
718
828
|
|
|
@@ -732,18 +842,18 @@ export interface FlowApproverDetail {
|
|
|
732
842
|
ReceiptId: string
|
|
733
843
|
|
|
734
844
|
/**
|
|
735
|
-
*
|
|
845
|
+
* 平台企业的第三方id
|
|
736
846
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
737
847
|
*/
|
|
738
848
|
ProxyOrganizationOpenId: string
|
|
739
849
|
|
|
740
850
|
/**
|
|
741
|
-
*
|
|
851
|
+
* 平台企业操作人的第三方id
|
|
742
852
|
*/
|
|
743
853
|
ProxyOperatorOpenId: string
|
|
744
854
|
|
|
745
855
|
/**
|
|
746
|
-
*
|
|
856
|
+
* 平台企业名称
|
|
747
857
|
*/
|
|
748
858
|
ProxyOrganizationName: string
|
|
749
859
|
|
|
@@ -855,12 +965,12 @@ MobileCheck:手机号验证
|
|
|
855
965
|
*/
|
|
856
966
|
export interface DescribeFlowDetailInfoResponse {
|
|
857
967
|
/**
|
|
858
|
-
*
|
|
968
|
+
* 第三方平台应用号Id
|
|
859
969
|
*/
|
|
860
970
|
ApplicationId?: string
|
|
861
971
|
|
|
862
972
|
/**
|
|
863
|
-
*
|
|
973
|
+
* 第三方平台子客企业OpenId
|
|
864
974
|
*/
|
|
865
975
|
ProxyOrganizationOpenId?: string
|
|
866
976
|
|
|
@@ -917,9 +1027,9 @@ export interface ResourceUrlInfo {
|
|
|
917
1027
|
其中签署方FlowApproverInfo需要传递的参数
|
|
918
1028
|
非单C、单B、B2C合同,ApproverType、RecipientId(模板发起合同时)必传,建议都传。其他身份标识
|
|
919
1029
|
1-个人:Name、Mobile必传
|
|
920
|
-
2
|
|
921
|
-
3
|
|
922
|
-
4
|
|
1030
|
+
2-第三方平台子客企业指定经办人:OpenId必传,OrgName必传、OrgOpenId必传;
|
|
1031
|
+
3-第三方平台子客企业不指定经办人:OrgName必传、OrgOpenId必传;
|
|
1032
|
+
4-非第三方平台子客企业:Name、Mobile必传,OrgName必传,且NotChannelOrganization=True。
|
|
923
1033
|
|
|
924
1034
|
RecipientId参数:
|
|
925
1035
|
从DescribeTemplates接口中,可以得到模板下的签署方Recipient列表,根据模板自定义的Rolename在此结构体中确定其RecipientId
|
|
@@ -954,19 +1064,19 @@ export interface FlowApproverInfo {
|
|
|
954
1064
|
OrganizationName?: string
|
|
955
1065
|
|
|
956
1066
|
/**
|
|
957
|
-
*
|
|
958
|
-
默认为false
|
|
1067
|
+
* 指定签署人非第三方平台子客企业下员工,在ApproverType为ORGANIZATION时指定。
|
|
1068
|
+
默认为false,即签署人位于同一个第三方平台应用号下;默认为false,即签署人位于同一个第三方应用号下;
|
|
959
1069
|
*/
|
|
960
1070
|
NotChannelOrganization?: boolean
|
|
961
1071
|
|
|
962
1072
|
/**
|
|
963
1073
|
* 用户侧第三方id,最大长度64个字符
|
|
964
|
-
|
|
1074
|
+
当签署方为同一第三方平台下的员工时,该字段若不指定,则发起【待领取】的流程
|
|
965
1075
|
*/
|
|
966
1076
|
OpenId?: string
|
|
967
1077
|
|
|
968
1078
|
/**
|
|
969
|
-
*
|
|
1079
|
+
* 企业签署方在同一第三方平台应用下的其他合作企业OpenId,签署方为非发起方企业场景下必传,最大长度64个字符;
|
|
970
1080
|
*/
|
|
971
1081
|
OrganizationOpenId?: string
|
|
972
1082
|
|
|
@@ -1102,24 +1212,24 @@ export interface TemplateInfo {
|
|
|
1102
1212
|
PreviewUrl: string
|
|
1103
1213
|
|
|
1104
1214
|
/**
|
|
1105
|
-
*
|
|
1215
|
+
* 第三方应用集成-模板PDF文件链接
|
|
1106
1216
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
1107
1217
|
*/
|
|
1108
1218
|
PdfUrl: string
|
|
1109
1219
|
|
|
1110
1220
|
/**
|
|
1111
|
-
*
|
|
1221
|
+
* 关联的平台企业模板ID
|
|
1112
1222
|
*/
|
|
1113
1223
|
ChannelTemplateId: string
|
|
1114
1224
|
|
|
1115
1225
|
/**
|
|
1116
|
-
*
|
|
1226
|
+
* 关联的平台企业模板名称
|
|
1117
1227
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
1118
1228
|
*/
|
|
1119
1229
|
ChannelTemplateName: string
|
|
1120
1230
|
|
|
1121
1231
|
/**
|
|
1122
|
-
* 0
|
|
1232
|
+
* 0-需要子客企业手动领取平台企业的模板(默认); 1-平台自动设置子客模板
|
|
1123
1233
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
1124
1234
|
*/
|
|
1125
1235
|
ChannelAutoSave: number
|
|
@@ -1227,7 +1337,7 @@ export interface DescribeTemplatesResponse {
|
|
|
1227
1337
|
}
|
|
1228
1338
|
|
|
1229
1339
|
/**
|
|
1230
|
-
*
|
|
1340
|
+
* 第三方应用集成员工角色信息
|
|
1231
1341
|
*/
|
|
1232
1342
|
export interface StaffRole {
|
|
1233
1343
|
/**
|
|
@@ -1395,6 +1505,95 @@ export interface OrganizationInfo {
|
|
|
1395
1505
|
Channel?: string
|
|
1396
1506
|
}
|
|
1397
1507
|
|
|
1508
|
+
/**
|
|
1509
|
+
* 通用签署人信息
|
|
1510
|
+
*/
|
|
1511
|
+
export interface CommonFlowApprover {
|
|
1512
|
+
/**
|
|
1513
|
+
* 指定当前签署人为第三方应用集成子客,默认false:当前签署人为第三方应用集成子客,true:当前签署人为saas企业用户
|
|
1514
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
1515
|
+
*/
|
|
1516
|
+
NotChannelOrganization: boolean
|
|
1517
|
+
|
|
1518
|
+
/**
|
|
1519
|
+
* 签署人类型,目前支持:0-企业签署人,1-个人签署人,3-企业静默签署人
|
|
1520
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
1521
|
+
*/
|
|
1522
|
+
ApproverType?: number
|
|
1523
|
+
|
|
1524
|
+
/**
|
|
1525
|
+
* 企业id
|
|
1526
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
1527
|
+
*/
|
|
1528
|
+
OrganizationId?: string
|
|
1529
|
+
|
|
1530
|
+
/**
|
|
1531
|
+
* 企业OpenId,第三方应用集成非静默签子客企业签署人发起合同毕传
|
|
1532
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
1533
|
+
*/
|
|
1534
|
+
OrganizationOpenId?: string
|
|
1535
|
+
|
|
1536
|
+
/**
|
|
1537
|
+
* 企业名称,第三方应用集成非静默签子客企业签署人必传,saas企业签署人必传
|
|
1538
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
1539
|
+
*/
|
|
1540
|
+
OrganizationName?: string
|
|
1541
|
+
|
|
1542
|
+
/**
|
|
1543
|
+
* 用户id
|
|
1544
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
1545
|
+
*/
|
|
1546
|
+
UserId?: string
|
|
1547
|
+
|
|
1548
|
+
/**
|
|
1549
|
+
* 用户openId,第三方应用集成非静默签子客企业签署人必传
|
|
1550
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
1551
|
+
*/
|
|
1552
|
+
OpenId?: string
|
|
1553
|
+
|
|
1554
|
+
/**
|
|
1555
|
+
* 签署人名称,saas企业签署人,个人签署人必传
|
|
1556
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
1557
|
+
*/
|
|
1558
|
+
ApproverName?: string
|
|
1559
|
+
|
|
1560
|
+
/**
|
|
1561
|
+
* 签署人手机号,saas企业签署人,个人签署人必传
|
|
1562
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
1563
|
+
*/
|
|
1564
|
+
ApproverMobile?: string
|
|
1565
|
+
|
|
1566
|
+
/**
|
|
1567
|
+
* 签署人Id,使用模版发起是,对应模版配置中的签署人RecipientId
|
|
1568
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
1569
|
+
*/
|
|
1570
|
+
RecipientId?: string
|
|
1571
|
+
|
|
1572
|
+
/**
|
|
1573
|
+
* 签署前置条件:阅读时长限制,不传默认10s,最大300s,最小3s
|
|
1574
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
1575
|
+
*/
|
|
1576
|
+
PreReadTime?: number
|
|
1577
|
+
|
|
1578
|
+
/**
|
|
1579
|
+
* 签署前置条件:阅读全文限制
|
|
1580
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
1581
|
+
*/
|
|
1582
|
+
IsFullText?: boolean
|
|
1583
|
+
|
|
1584
|
+
/**
|
|
1585
|
+
* 通知类型:SMS(短信) NONE(不做通知), 不传 默认SMS
|
|
1586
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
1587
|
+
*/
|
|
1588
|
+
NotifyType?: string
|
|
1589
|
+
|
|
1590
|
+
/**
|
|
1591
|
+
* 签署人配置
|
|
1592
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
1593
|
+
*/
|
|
1594
|
+
ApproverOption?: CommonApproverOption
|
|
1595
|
+
}
|
|
1596
|
+
|
|
1398
1597
|
/**
|
|
1399
1598
|
* 合同文件验签单个结果结构体
|
|
1400
1599
|
*/
|
|
@@ -1495,7 +1694,7 @@ export interface ChannelCancelMultiFlowSignQRCodeRequest {
|
|
|
1495
1694
|
*/
|
|
1496
1695
|
export interface UploadFilesRequest {
|
|
1497
1696
|
/**
|
|
1498
|
-
*
|
|
1697
|
+
* 应用相关信息,若是第三方应用集成调用 appid 和proxyappid 必填
|
|
1499
1698
|
*/
|
|
1500
1699
|
Agent: Agent
|
|
1501
1700
|
|
|
@@ -1580,8 +1779,8 @@ export interface DescribeUsageRequest {
|
|
|
1580
1779
|
|
|
1581
1780
|
/**
|
|
1582
1781
|
* 是否汇总数据,默认不汇总。
|
|
1583
|
-
|
|
1584
|
-
|
|
1782
|
+
不汇总:返回在统计区间内第三方平台下所有企业的每日明细,即每个企业N条数据,N为统计天数;
|
|
1783
|
+
汇总:返回在统计区间内第三方平台下所有企业的汇总后数据,即每个企业一条数据;
|
|
1585
1784
|
*/
|
|
1586
1785
|
NeedAggregate?: boolean
|
|
1587
1786
|
|
|
@@ -1648,7 +1847,7 @@ CreateFlowsByTemplates 接口不使用此字段。
|
|
|
1648
1847
|
* 此结构体 (FlowInfo) 用于描述签署流程信息。
|
|
1649
1848
|
|
|
1650
1849
|
【数据表格传参说明】
|
|
1651
|
-
当模板的 ComponentType='DYNAMIC_TABLE'
|
|
1850
|
+
当模板的 ComponentType='DYNAMIC_TABLE'时( 第三方应用集成或集成版),FormField.ComponentValue需要传递json格式的字符串参数,用于确定表头&填充数据表格(支持内容的单元格合并)
|
|
1652
1851
|
输入示例1:
|
|
1653
1852
|
|
|
1654
1853
|
```
|
|
@@ -1759,7 +1958,6 @@ CreateFlowsByTemplates 接口不使用此字段。
|
|
|
1759
1958
|
| ------------------- | ------- | ------------------------------------------------- |
|
|
1760
1959
|
| widthPercent | Integer | 表头单元格列占总表头的比例,例如1:30表示 此列占表头的30%,不填写时列宽度平均拆分;例如2:总2列,某一列填写40,剩余列可以为空,按照60计算。;例如3:总3列,某一列填写30,剩余2列可以为空,分别为(100-30)/2=35 |
|
|
1761
1960
|
| content | String | 表头单元格内容,字数不超过100 |
|
|
1762
|
-
|
|
1763
1961
|
*/
|
|
1764
1962
|
export interface FlowInfo {
|
|
1765
1963
|
/**
|
|
@@ -1803,7 +2001,7 @@ export interface FlowInfo {
|
|
|
1803
2001
|
FlowDescription?: string
|
|
1804
2002
|
|
|
1805
2003
|
/**
|
|
1806
|
-
*
|
|
2004
|
+
* 第三方应用平台的业务信息,最大长度1000个字符。发起自动签署时,需设置对应自动签署场景,目前仅支持场景:处方单-E_PRESCRIPTION_AUTO_SIGN
|
|
1807
2005
|
*/
|
|
1808
2006
|
CustomerData?: string
|
|
1809
2007
|
|
|
@@ -1831,7 +2029,7 @@ export interface FlowInfo {
|
|
|
1831
2029
|
*/
|
|
1832
2030
|
export interface UserInfo {
|
|
1833
2031
|
/**
|
|
1834
|
-
*
|
|
2032
|
+
* 第三方应用平台自定义,对应第三方平台子客企业员的唯一标识。一个OpenId在一个子客企业内唯一对应一个真实员工,不可在其他子客企业内重复使用。(例如,可以使用经办人企业名+员工身份证的hash值,需要第三方应用平台保存),最大64位字符串
|
|
1835
2033
|
*/
|
|
1836
2034
|
OpenId?: string
|
|
1837
2035
|
|
|
@@ -2094,15 +2292,15 @@ export interface CreateSignUrlsRequest {
|
|
|
2094
2292
|
/**
|
|
2095
2293
|
* 签署链接生成类型,默认是 "ALL";
|
|
2096
2294
|
"ALL":全部签署方签署链接,此时不会给自动签署的签署方创建签署链接;
|
|
2097
|
-
"CHANNEL"
|
|
2098
|
-
"NOT_CHANNEL"
|
|
2295
|
+
"CHANNEL":第三方平台子客企业企业;
|
|
2296
|
+
"NOT_CHANNEL":非第三方平台子客企业企业;
|
|
2099
2297
|
"PERSON":个人;
|
|
2100
2298
|
"FOLLOWER":关注方,目前是合同抄送方;
|
|
2101
2299
|
*/
|
|
2102
2300
|
GenerateType?: string
|
|
2103
2301
|
|
|
2104
2302
|
/**
|
|
2105
|
-
*
|
|
2303
|
+
* 非第三方平台子客企业参与方的企业名称,GenerateType为"NOT_CHANNEL"时必填
|
|
2106
2304
|
*/
|
|
2107
2305
|
OrganizationName?: string
|
|
2108
2306
|
|
|
@@ -2118,12 +2316,12 @@ GenerateType为"PERSON"或"FOLLOWER"时必填
|
|
|
2118
2316
|
Mobile?: string
|
|
2119
2317
|
|
|
2120
2318
|
/**
|
|
2121
|
-
*
|
|
2319
|
+
* 第三方平台子客企业的企业OpenId,GenerateType为"CHANNEL"时必填
|
|
2122
2320
|
*/
|
|
2123
2321
|
OrganizationOpenId?: string
|
|
2124
2322
|
|
|
2125
2323
|
/**
|
|
2126
|
-
*
|
|
2324
|
+
* 第三方平台子客企业参与人OpenId,GenerateType为"CHANNEL"时可用,指定到具体参与人, 仅展示已经实名的经办人信息
|
|
2127
2325
|
*/
|
|
2128
2326
|
OpenId?: string
|
|
2129
2327
|
|
|
@@ -2185,7 +2383,7 @@ export interface ChannelCreateMultiFlowSignQRCodeRequest {
|
|
|
2185
2383
|
|
|
2186
2384
|
/**
|
|
2187
2385
|
* 回调地址,最大长度1000个字符
|
|
2188
|
-
|
|
2386
|
+
不传默认使用第三方应用号配置的回调地址
|
|
2189
2387
|
回调时机:用户通过签署二维码发起合同时,企业额度不足导致失败
|
|
2190
2388
|
*/
|
|
2191
2389
|
CallbackUrl?: string
|
|
@@ -2306,7 +2504,7 @@ export interface CreateFlowsByTemplatesResponse {
|
|
|
2306
2504
|
FlowIds?: Array<string>
|
|
2307
2505
|
|
|
2308
2506
|
/**
|
|
2309
|
-
*
|
|
2507
|
+
* 业务信息,限制1024字符
|
|
2310
2508
|
*/
|
|
2311
2509
|
CustomerData?: Array<string>
|
|
2312
2510
|
|
|
@@ -2555,8 +2753,8 @@ export interface Filter {
|
|
|
2555
2753
|
如果需要指定B端(机构身份类型)签署人,其中ReleasedApprover需要传递的参数如下:
|
|
2556
2754
|
ApproverNumber, OrganizationName, ApproverType必传。
|
|
2557
2755
|
对于其他身份标识
|
|
2558
|
-
-
|
|
2559
|
-
-
|
|
2756
|
+
- 子客企业指定经办人:OpenId必传,OrganizationOpenId必传;
|
|
2757
|
+
- 非子客企业:Name、Mobile必传。
|
|
2560
2758
|
*/
|
|
2561
2759
|
export interface ReleasedApprover {
|
|
2562
2760
|
/**
|
|
@@ -2599,13 +2797,13 @@ ORGANIZATION-企业
|
|
|
2599
2797
|
Mobile?: string
|
|
2600
2798
|
|
|
2601
2799
|
/**
|
|
2602
|
-
*
|
|
2800
|
+
* 企业签署方在同一第三方应用下的其他合作企业OpenId,签署方为非发起方企业场景下必传,最大长度64个字符
|
|
2603
2801
|
*/
|
|
2604
2802
|
OrganizationOpenId?: string
|
|
2605
2803
|
|
|
2606
2804
|
/**
|
|
2607
2805
|
* 用户侧第三方id,最大长度64个字符
|
|
2608
|
-
|
|
2806
|
+
当签署方为同一第三方应用下的员工时,该字必传
|
|
2609
2807
|
*/
|
|
2610
2808
|
OpenId?: string
|
|
2611
2809
|
}
|
|
@@ -2637,17 +2835,17 @@ export interface UploadFilesResponse {
|
|
|
2637
2835
|
/**
|
|
2638
2836
|
* 文件id数组,有效期一个小时;有效期内此文件id可以反复使用
|
|
2639
2837
|
*/
|
|
2640
|
-
FileIds
|
|
2838
|
+
FileIds?: Array<string>
|
|
2641
2839
|
|
|
2642
2840
|
/**
|
|
2643
2841
|
* 上传成功文件数量
|
|
2644
2842
|
*/
|
|
2645
|
-
TotalCount
|
|
2843
|
+
TotalCount?: number
|
|
2646
2844
|
|
|
2647
2845
|
/**
|
|
2648
2846
|
* 文件Url
|
|
2649
2847
|
*/
|
|
2650
|
-
FileUrls
|
|
2848
|
+
FileUrls?: Array<string>
|
|
2651
2849
|
|
|
2652
2850
|
/**
|
|
2653
2851
|
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
@@ -2771,6 +2969,21 @@ export interface ChannelDescribeOrganizationSealsResponse {
|
|
|
2771
2969
|
RequestId?: string
|
|
2772
2970
|
}
|
|
2773
2971
|
|
|
2972
|
+
/**
|
|
2973
|
+
* CreateSealByImage返回参数结构体
|
|
2974
|
+
*/
|
|
2975
|
+
export interface CreateSealByImageResponse {
|
|
2976
|
+
/**
|
|
2977
|
+
* 印章id
|
|
2978
|
+
*/
|
|
2979
|
+
SealId?: string
|
|
2980
|
+
|
|
2981
|
+
/**
|
|
2982
|
+
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
2983
|
+
*/
|
|
2984
|
+
RequestId?: string
|
|
2985
|
+
}
|
|
2986
|
+
|
|
2774
2987
|
/**
|
|
2775
2988
|
* ChannelCancelMultiFlowSignQRCode返回参数结构体
|
|
2776
2989
|
*/
|
|
@@ -2888,7 +3101,7 @@ export interface ChannelCreateBoundFlowsResponse {
|
|
|
2888
3101
|
*/
|
|
2889
3102
|
export interface ProxyOrganizationOperator {
|
|
2890
3103
|
/**
|
|
2891
|
-
* 对应Agent-ProxyOperator-OpenId
|
|
3104
|
+
* 对应Agent-ProxyOperator-OpenId。第三方应用平台自定义,对子客企业员的唯一标识。一个OpenId在一个子客企业内唯一对应一个真实员工,不可在其他子客企业内重复使用。(例如,可以使用经办人企业名+员工身份证的hash值,需要第三方应用平台保存),最大64位字符串
|
|
2892
3105
|
*/
|
|
2893
3106
|
Id: string
|
|
2894
3107
|
|
|
@@ -2914,6 +3127,15 @@ export interface ProxyOrganizationOperator {
|
|
|
2914
3127
|
* 经办人手机号,大陆手机号输入11位,暂不支持海外手机号。
|
|
2915
3128
|
*/
|
|
2916
3129
|
Mobile?: string
|
|
3130
|
+
|
|
3131
|
+
/**
|
|
3132
|
+
* 默认角色,值为以下三个对应的英文:
|
|
3133
|
+
业务管理员:admin
|
|
3134
|
+
经办人:channel-normal-operator
|
|
3135
|
+
业务员:channel-sales-man
|
|
3136
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
3137
|
+
*/
|
|
3138
|
+
DefaultRole?: string
|
|
2917
3139
|
}
|
|
2918
3140
|
|
|
2919
3141
|
/**
|
|
@@ -3234,8 +3456,8 @@ SIGN_PAGING_SEAL - 可以指定印章ID
|
|
|
3234
3456
|
OffsetY?: number
|
|
3235
3457
|
|
|
3236
3458
|
/**
|
|
3237
|
-
*
|
|
3238
|
-
|
|
3459
|
+
* 平台企业控件ID。
|
|
3460
|
+
如果不为空,属于平台企业预设控件;
|
|
3239
3461
|
*/
|
|
3240
3462
|
ChannelComponentId?: string
|
|
3241
3463
|
|
|
@@ -3449,12 +3671,12 @@ export interface DescribeTemplatesRequest {
|
|
|
3449
3671
|
WithPreviewUrl?: boolean
|
|
3450
3672
|
|
|
3451
3673
|
/**
|
|
3452
|
-
* 是否获取模板的PDF
|
|
3674
|
+
* 是否获取模板的PDF文件链接- 第三方应用集成需要开启白名单时才能使用。
|
|
3453
3675
|
*/
|
|
3454
3676
|
WithPdfUrl?: boolean
|
|
3455
3677
|
|
|
3456
3678
|
/**
|
|
3457
|
-
*
|
|
3679
|
+
* 模板ID
|
|
3458
3680
|
*/
|
|
3459
3681
|
ChannelTemplateId?: string
|
|
3460
3682
|
}
|
|
@@ -3587,12 +3809,12 @@ export interface CreateFlowsByTemplatesRequest {
|
|
|
3587
3809
|
*/
|
|
3588
3810
|
export interface UsageDetail {
|
|
3589
3811
|
/**
|
|
3590
|
-
*
|
|
3812
|
+
* 子客企业唯一标识
|
|
3591
3813
|
*/
|
|
3592
3814
|
ProxyOrganizationOpenId: string
|
|
3593
3815
|
|
|
3594
3816
|
/**
|
|
3595
|
-
*
|
|
3817
|
+
* 子客企业名
|
|
3596
3818
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
3597
3819
|
*/
|
|
3598
3820
|
ProxyOrganizationName: string
|
|
@@ -3661,7 +3883,7 @@ export interface OperateChannelTemplateRequest {
|
|
|
3661
3883
|
OperateType: string
|
|
3662
3884
|
|
|
3663
3885
|
/**
|
|
3664
|
-
*
|
|
3886
|
+
* 第三方应用平台模板库模板唯一标识
|
|
3665
3887
|
*/
|
|
3666
3888
|
TemplateId: string
|
|
3667
3889
|
|
|
@@ -3797,6 +4019,31 @@ export interface DescribeChannelFlowEvidenceReportResponse {
|
|
|
3797
4019
|
RequestId?: string
|
|
3798
4020
|
}
|
|
3799
4021
|
|
|
4022
|
+
/**
|
|
4023
|
+
* CreateSealByImage请求参数结构体
|
|
4024
|
+
*/
|
|
4025
|
+
export interface CreateSealByImageRequest {
|
|
4026
|
+
/**
|
|
4027
|
+
* 应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 均必填。
|
|
4028
|
+
*/
|
|
4029
|
+
Agent: Agent
|
|
4030
|
+
|
|
4031
|
+
/**
|
|
4032
|
+
* 印章名称,最大长度不超过50字符
|
|
4033
|
+
*/
|
|
4034
|
+
SealName: string
|
|
4035
|
+
|
|
4036
|
+
/**
|
|
4037
|
+
* 印章图片base64,大小不超过10M(原始图片不超过7.6M)
|
|
4038
|
+
*/
|
|
4039
|
+
SealImage: string
|
|
4040
|
+
|
|
4041
|
+
/**
|
|
4042
|
+
* 操作者的信息
|
|
4043
|
+
*/
|
|
4044
|
+
Operator?: UserInfo
|
|
4045
|
+
}
|
|
4046
|
+
|
|
3800
4047
|
/**
|
|
3801
4048
|
* ChannelUpdateSealStatus返回参数结构体
|
|
3802
4049
|
*/
|