tencentcloud-sdk-nodejs-ess 4.0.618 → 4.0.619

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.
@@ -43,7 +43,6 @@ export interface DescribeFlowEvidenceReportRequest {
43
43
  * 调用方用户信息,userId 必填
44
44
  */
45
45
  Operator: UserInfo
46
-
47
46
  /**
48
47
  * 出证报告编号
49
48
  */
@@ -58,12 +57,10 @@ export interface UpdateIntegrationEmployeesResponse {
58
57
  * 更新成功的用户列表
59
58
  */
60
59
  SuccessEmployeeData?: Array<SuccessUpdateStaffData>
61
-
62
60
  /**
63
61
  * 更新失败的用户列表
64
62
  */
65
63
  FailedEmployeeData?: Array<FailedUpdateStaffData>
66
-
67
64
  /**
68
65
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
69
66
  */
@@ -78,7 +75,6 @@ export interface Department {
78
75
  * 部门id
79
76
  */
80
77
  DepartmentId: string
81
-
82
78
  /**
83
79
  * 部门名称
84
80
  */
@@ -93,77 +89,66 @@ export interface CreatePreparedPersonalEsignRequest {
93
89
  * 个人用户姓名
94
90
  */
95
91
  UserName: string
96
-
97
92
  /**
98
93
  * 身份证件号码
99
94
  */
100
95
  IdCardNumber: string
101
-
102
96
  /**
103
97
  * 印章名称
104
98
  */
105
99
  SealName: string
106
-
107
100
  /**
108
101
  * 调用方用户信息,userId 必填。支持填入集团子公司经办人 userId代发合同。
109
102
  */
110
103
  Operator?: UserInfo
111
-
112
104
  /**
113
- * 身份证件类型:
105
+ * 身份证件类型:
114
106
  ID_CARD 身份证
115
107
  PASSPORT 护照
116
108
  HONGKONG_AND_MACAO 中国香港
117
109
  FOREIGN_ID_CARD 境外身份
118
110
  HONGKONG_MACAO_AND_TAIWAN 中国台湾
119
- */
111
+ */
120
112
  IdCardType?: string
121
-
122
113
  /**
123
- * 印章图片的base64
114
+ * 印章图片的base64
124
115
  注:已废弃
125
116
  请先通过UploadFiles接口上传文件,获取 FileId
126
- */
117
+ */
127
118
  SealImage?: string
128
-
129
119
  /**
130
120
  * 是否开启印章图片压缩处理,默认不开启,如需开启请设置为 true。当印章超过 2M 时建议开启,开启后图片的 hash 将发生变化。
131
121
  */
132
122
  SealImageCompress?: boolean
133
-
134
123
  /**
135
124
  * 手机号码;当需要开通自动签时,该参数必传
136
125
  */
137
126
  Mobile?: string
138
-
139
127
  /**
140
128
  * 是否开通自动签,该功能需联系运营工作人员开通后使用
141
129
  */
142
130
  EnableAutoSign?: boolean
143
-
144
131
  /**
145
- * 印章颜色(参数ProcessSeal=true时生效)
132
+ * 印章颜色(参数ProcessSeal=true时生效)
146
133
  默认值:BLACK黑色
147
134
  取值:
148
135
  BLACK 黑色,
149
136
  RED 红色,
150
137
  BLUE 蓝色。
151
- */
138
+ */
152
139
  SealColor?: string
153
-
154
140
  /**
155
- * 是否处理印章
141
+ * 是否处理印章
156
142
  默认不做印章处理。
157
143
  取值:false:不做任何处理;
158
144
  true:做透明化处理和颜色增强。
159
- */
145
+ */
160
146
  ProcessSeal?: boolean
161
-
162
147
  /**
163
- * 印章图片文件 id
148
+ * 印章图片文件 id
164
149
  取值:
165
150
  填写的FileId通过UploadFiles接口上传文件获取。
166
- */
151
+ */
167
152
  FileId?: string
168
153
  }
169
154
 
@@ -175,7 +160,6 @@ export interface DescribeIntegrationDepartmentsResponse {
175
160
  * 部门列表
176
161
  */
177
162
  Departments?: Array<IntegrationDepartment>
178
-
179
163
  /**
180
164
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
181
165
  */
@@ -190,17 +174,14 @@ export interface FileInfo {
190
174
  * 文件Id
191
175
  */
192
176
  FileId?: string
193
-
194
177
  /**
195
178
  * 文件名
196
179
  */
197
180
  FileName?: string
198
-
199
181
  /**
200
182
  * 文件大小,单位为Byte
201
183
  */
202
184
  FileSize?: number
203
-
204
185
  /**
205
186
  * 文件上传时间,10位时间戳(精确到秒)
206
187
  */
@@ -245,12 +226,10 @@ export interface CreateMultiFlowSignQRCodeResponse {
245
226
  * 签署二维码对象
246
227
  */
247
228
  QrCode?: SignQrCode
248
-
249
229
  /**
250
230
  * 签署链接对象
251
231
  */
252
232
  SignUrls?: SignUrl
253
-
254
233
  /**
255
234
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
256
235
  */
@@ -262,106 +241,89 @@ export interface CreateMultiFlowSignQRCodeResponse {
262
241
  */
263
242
  export interface FlowCreateApprover {
264
243
  /**
265
- * 参与者类型:
244
+ * 参与者类型:
266
245
  0:企业
267
246
  1:个人
268
247
  3:企业静默签署
269
248
  注:类型为3(企业静默签署)时,会默认完成该签署方的签署。静默签署仅进行盖章操作,不能是手写签名。
270
- */
249
+ */
271
250
  ApproverType: number
272
-
273
251
  /**
274
252
  * 如果签署方为企业,需要填入企业全称
275
253
  */
276
254
  OrganizationName?: string
277
-
278
255
  /**
279
256
  * 签署方经办人姓名
280
257
  */
281
258
  ApproverName?: string
282
-
283
259
  /**
284
260
  * 签署方经办人手机号码
285
261
  */
286
262
  ApproverMobile?: string
287
-
288
263
  /**
289
- * 签署方经办人证件类型ID_CARD 身份证
264
+ * 签署方经办人证件类型ID_CARD 身份证
290
265
  HONGKONG_AND_MACAO 港澳居民来往内地通行证
291
266
  HONGKONG_MACAO_AND_TAIWAN 港澳台居民居住证(格式同居民身份证)
292
- */
267
+ */
293
268
  ApproverIdCardType?: string
294
-
295
269
  /**
296
270
  * 签署方经办人证件号码
297
271
  */
298
272
  ApproverIdCardNumber?: string
299
-
300
273
  /**
301
274
  * 签署方经办人在模板中的参与方ID
302
275
  */
303
276
  RecipientId?: string
304
-
305
277
  /**
306
278
  * 签署意愿确认渠道,WEIXINAPP:人脸识别
307
279
  */
308
280
  VerifyChannel?: Array<string>
309
-
310
281
  /**
311
282
  * 是否发送短信,sms--短信通知,none--不通知,默认为sms;发起方=签署方时不发送短信
312
283
  */
313
284
  NotifyType?: string
314
-
315
285
  /**
316
286
  * 合同强制需要阅读全文,无需传此参数
317
287
  */
318
288
  IsFullText?: boolean
319
-
320
289
  /**
321
290
  * 合同的强制预览时间:3~300s,未指定则按合同页数计算
322
291
  */
323
292
  PreReadTime?: number
324
-
325
293
  /**
326
294
  * 签署方经办人的用户ID,和签署方经办人姓名+手机号+证件必须有一个。
327
295
  */
328
296
  UserId?: string
329
-
330
297
  /**
331
298
  * 当前只支持true,默认为true
332
299
  */
333
300
  Required?: boolean
334
-
335
301
  /**
336
302
  * 签署人用户来源,企微侧用户请传入:WEWORKAPP
337
303
  */
338
304
  ApproverSource?: string
339
-
340
305
  /**
341
306
  * 客户自定义签署人标识,64位长度,保证唯一。非企微场景不使用此字段
342
307
  */
343
308
  CustomApproverTag?: string
344
-
345
309
  /**
346
310
  * 快速注册相关信息,目前暂未开放!
347
311
  */
348
312
  RegisterInfo?: RegisterInfo
349
-
350
313
  /**
351
314
  * 签署人个性化能力值
352
315
  */
353
316
  ApproverOption?: ApproverOption
354
-
355
317
  /**
356
318
  * 签署完前端跳转的url,暂未使用
319
+ * @deprecated
357
320
  */
358
321
  JumpUrl?: string
359
-
360
322
  /**
361
- * 签署ID
323
+ * 签署ID
362
324
  - 发起流程时系统自动补充
363
325
  - 创建签署链接时,可以通过查询详情接口获得签署人的SignId,然后可传入此值为该签署人创建签署链接,无需再传姓名、手机号、证件号等其他信息
364
- */
326
+ */
365
327
  SignId?: string
366
328
  }
367
329
 
@@ -373,7 +335,6 @@ export interface DescribeThirdPartyAuthCodeResponse {
373
335
  * 用户是否实名,VERIFIED 为实名,UNVERIFIED 未实名
374
336
  */
375
337
  VerifyStatus: string
376
-
377
338
  /**
378
339
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
379
340
  */
@@ -408,7 +369,6 @@ export interface BindEmployeeUserIdWithClientOpenIdResponse {
408
369
  * 绑定是否成功,1表示成功,0表示失败
409
370
  */
410
371
  Status?: number
411
-
412
372
  /**
413
373
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
414
374
  */
@@ -423,12 +383,10 @@ export interface CreateIntegrationEmployeesRequest {
423
383
  * 操作人信息,userId必填
424
384
  */
425
385
  Operator: UserInfo
426
-
427
386
  /**
428
387
  * 待创建员工的信息,Mobile和DisplayName必填
429
388
  */
430
389
  Employees: Array<Staff>
431
-
432
390
  /**
433
391
  * 代理相关应用信息,如集团主企业代子企业操作的场景中ProxyOrganizationId必填
434
392
  */
@@ -443,25 +401,21 @@ export interface DescribeIntegrationRolesRequest {
443
401
  * 操作人信息
444
402
  */
445
403
  Operator: UserInfo
446
-
447
404
  /**
448
405
  * 返回最大数量,最大为200
449
406
  */
450
407
  Limit: number
451
-
452
408
  /**
453
409
  * 代理相关应用信息,如集团主企业代子企业操作的场景中ProxyOrganizationId必填
454
410
  */
455
411
  Agent?: Agent
456
-
457
412
  /**
458
- * 查询的关键字段:
413
+ * 查询的关键字段:
459
414
  Key:"RoleType",Values:["1"]查询系统角色,Values:["2"]查询自定义角色
460
415
  Key:"RoleStatus",Values:["1"]查询启用角色,Values:["2"]查询禁用角色
461
416
  Key:"IsGroupRole",Values:["0"],查询非集团角色,Values:["1"]表示查询集团角色
462
- */
417
+ */
463
418
  Filters?: Array<Filter>
464
-
465
419
  /**
466
420
  * 偏移量,默认为0,最大为2000
467
421
  */
@@ -476,7 +430,6 @@ export interface CreateFlowEvidenceReportRequest {
476
430
  * 调用方用户信息,userId 必填
477
431
  */
478
432
  Operator: UserInfo
479
-
480
433
  /**
481
434
  * 签署流程编号
482
435
  */
@@ -491,7 +444,6 @@ export interface StartFlowResponse {
491
444
  * 返回描述,START-发起成功, REVIEW-提交审核成功,EXECUTING-已提交发起任务
492
445
  */
493
446
  Status?: string
494
-
495
447
  /**
496
448
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
497
449
  */
@@ -503,15 +455,14 @@ export interface StartFlowResponse {
503
455
  */
504
456
  export interface StaffRole {
505
457
  /**
506
- * 角色id
458
+ * 角色id
507
459
  注意:此字段可能返回 null,表示取不到有效值。
508
- */
460
+ */
509
461
  RoleId: string
510
-
511
462
  /**
512
- * 角色名称
463
+ * 角色名称
513
464
  注意:此字段可能返回 null,表示取不到有效值。
514
- */
465
+ */
515
466
  RoleName: string
516
467
  }
517
468
 
@@ -520,33 +471,29 @@ export interface StaffRole {
520
471
  */
521
472
  export interface FlowApproverUrlInfo {
522
473
  /**
523
- * 签署链接。注意该链接有效期为30分钟,同时需要注意保密,不要外泄给无关用户。
474
+ * 签署链接。注意该链接有效期为30分钟,同时需要注意保密,不要外泄给无关用户。
524
475
  注意:此字段可能返回 null,表示取不到有效值。
525
- */
476
+ */
526
477
  SignUrl?: string
527
-
528
478
  /**
529
- * 签署人类型 1-个人
479
+ * 签署人类型 1-个人
530
480
  注意:此字段可能返回 null,表示取不到有效值。
531
- */
481
+ */
532
482
  ApproverType?: number
533
-
534
483
  /**
535
- * 签署人姓名
484
+ * 签署人姓名
536
485
  注意:此字段可能返回 null,表示取不到有效值。
537
- */
486
+ */
538
487
  ApproverName?: string
539
-
540
488
  /**
541
- * 签署人手机号
489
+ * 签署人手机号
542
490
  注意:此字段可能返回 null,表示取不到有效值。
543
- */
491
+ */
544
492
  ApproverMobile?: string
545
-
546
493
  /**
547
- * 签署长链接。注意该链接有效期为30分钟,同时需要注意保密,不要外泄给无关用户。
494
+ * 签署长链接。注意该链接有效期为30分钟,同时需要注意保密,不要外泄给无关用户。
548
495
  注意:此字段可能返回 null,表示取不到有效值。
549
- */
496
+ */
550
497
  LongUrl?: string
551
498
  }
552
499
 
@@ -568,29 +515,26 @@ export interface CreateConvertTaskApiRequest {
568
515
  * 资源类型 支持doc,docx,html,xls,xlsx,jpg,jpeg,png,bmp文件类型
569
516
  */
570
517
  ResourceType: string
571
-
572
518
  /**
573
519
  * 资源名称,长度限制为256字符
574
520
  */
575
521
  ResourceName: string
576
-
577
522
  /**
578
523
  * 资源Id,通过UploadFiles获取
579
524
  */
580
525
  ResourceId: string
581
-
582
526
  /**
583
527
  * 调用方用户信息,userId 必填
584
528
  */
585
529
  Operator?: UserInfo
586
-
587
530
  /**
588
531
  * 应用号信息
532
+ * @deprecated
589
533
  */
590
534
  Agent?: Agent
591
-
592
535
  /**
593
536
  * 暂未开放
537
+ * @deprecated
594
538
  */
595
539
  Organization?: OrganizationInfo
596
540
  }
@@ -603,7 +547,6 @@ export interface CreateFlowRemindsResponse {
603
547
  * 催办合同详情列表
604
548
  */
605
549
  RemindFlowRecords?: Array<RemindFlowRecords>
606
-
607
550
  /**
608
551
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
609
552
  */
@@ -618,32 +561,26 @@ export interface DescribeOrganizationGroupOrganizationsRequest {
618
561
  * 操作人信息,userId必填
619
562
  */
620
563
  Operator: UserInfo
621
-
622
564
  /**
623
565
  * 单次查询成员企业最大返回数量
624
566
  */
625
567
  Limit: number
626
-
627
568
  /**
628
569
  * 页面偏移量
629
570
  */
630
571
  Offset: number
631
-
632
572
  /**
633
573
  * 查询成员企业的企业名,模糊匹配
634
574
  */
635
575
  Name?: string
636
-
637
576
  /**
638
577
  * 成员企业加入集团的当前状态:1-待授权;2-已授权待激活;3-拒绝授权;4-已解除;5-已加入
639
578
  */
640
579
  Status?: number
641
-
642
580
  /**
643
581
  * 是否导出当前成员企业数据
644
582
  */
645
583
  Export?: boolean
646
-
647
584
  /**
648
585
  * 成员企业id
649
586
  */
@@ -656,21 +593,21 @@ export interface DescribeOrganizationGroupOrganizationsRequest {
656
593
  export interface Agent {
657
594
  /**
658
595
  * 代理机构的应用编号,32位字符串,一般不用传
596
+ * @deprecated
659
597
  */
660
598
  AppId?: string
661
-
662
599
  /**
663
600
  * 被代理机构的应用号,一般不用传
601
+ * @deprecated
664
602
  */
665
603
  ProxyAppId?: string
666
-
667
604
  /**
668
605
  * 被代理机构在电子签平台的机构编号,集团代理下场景必传
669
606
  */
670
607
  ProxyOrganizationId?: string
671
-
672
608
  /**
673
609
  * 被代理机构的经办人,一般不用传
610
+ * @deprecated
674
611
  */
675
612
  ProxyOperator?: string
676
613
  }
@@ -680,18 +617,16 @@ export interface Agent {
680
617
  */
681
618
  export interface FlowApproverDetail {
682
619
  /**
683
- * 签署时的相关信息
620
+ * 签署时的相关信息
684
621
  注意:此字段可能返回 null,表示取不到有效值。
685
- */
622
+ */
686
623
  ApproveMessage?: string
687
-
688
624
  /**
689
625
  * 签署方姓名
690
626
  */
691
627
  ApproveName: string
692
-
693
628
  /**
694
- * 签署方的签署状态
629
+ * 签署方的签署状态
695
630
  0:还没有发起
696
631
  1:流程中 没有开始处理
697
632
  2:待签署
@@ -705,63 +640,53 @@ export interface FlowApproverDetail {
705
640
  10:填写完成
706
641
  15:已解除
707
642
  19:转他人处理
708
- */
643
+ */
709
644
  ApproveStatus: number
710
-
711
645
  /**
712
646
  * 模板配置中的参与方ID,与控件绑定
713
647
  */
714
648
  ReceiptId: string
715
-
716
649
  /**
717
- * 客户自定义的用户ID
650
+ * 客户自定义的用户ID
718
651
  注意:此字段可能返回 null,表示取不到有效值。
719
- */
652
+ */
720
653
  CustomUserId: string
721
-
722
654
  /**
723
655
  * 签署人手机号
724
656
  */
725
657
  Mobile: string
726
-
727
658
  /**
728
659
  * 签署顺序,如果是有序签署,签署顺序从小到大
729
660
  */
730
661
  SignOrder: number
731
-
732
662
  /**
733
663
  * 签署人签署时间,时间戳,单位秒
734
664
  */
735
665
  ApproveTime: number
736
-
737
666
  /**
738
- * 签署方类型,ORGANIZATION-企业员工,PERSON-个人,ENTERPRISESERVER-企业静默签
667
+ * 签署方类型,ORGANIZATION-企业员工,PERSON-个人,ENTERPRISESERVER-企业静默签
739
668
  注意:此字段可能返回 null,表示取不到有效值。
740
- */
669
+ */
741
670
  ApproveType: string
742
-
743
671
  /**
744
- * 签署方侧用户来源,如WEWORKAPP-企业微信等
672
+ * 签署方侧用户来源,如WEWORKAPP-企业微信等
745
673
  注意:此字段可能返回 null,表示取不到有效值。
746
- */
674
+ */
747
675
  ApproverSource: string
748
-
749
676
  /**
750
- * 客户自定义签署方标识
677
+ * 客户自定义签署方标识
751
678
  注意:此字段可能返回 null,表示取不到有效值。
752
- */
679
+ */
753
680
  CustomApproverTag: string
754
-
755
681
  /**
756
- * 签署方企业Id
682
+ * 签署方企业Id
757
683
  注意:此字段可能返回 null,表示取不到有效值。
758
- */
684
+ */
759
685
  OrganizationId: string
760
-
761
686
  /**
762
- * 签署方企业名称
687
+ * 签署方企业名称
763
688
  注意:此字段可能返回 null,表示取不到有效值。
764
- */
689
+ */
765
690
  OrganizationName: string
766
691
  }
767
692
 
@@ -773,53 +698,46 @@ export interface DescribeFlowTemplatesRequest {
773
698
  * 调用方用户信息,userId 必填
774
699
  */
775
700
  Operator: UserInfo
776
-
777
701
  /**
778
702
  * 代理相关应用信息,如集团主企业代子企业操作的场景中ProxyOrganizationId必填
779
703
  */
780
704
  Agent?: Agent
781
-
782
705
  /**
783
706
  * 查询内容:0-模板列表及详情(默认),1-仅模板列表
784
707
  */
785
708
  ContentType?: number
786
-
787
709
  /**
788
710
  * 搜索条件,具体参考Filter结构体。本接口取值:template-id:按照【 **模板唯一标识** 】进行过滤
789
711
  */
790
712
  Filters?: Array<Filter>
791
-
792
713
  /**
793
714
  * 查询偏移位置,默认0
794
715
  */
795
716
  Offset?: number
796
-
797
717
  /**
798
718
  * 查询个数,默认20,最大200
799
719
  */
800
720
  Limit?: number
801
-
802
721
  /**
803
- * 这个参数跟下面的IsChannel参数配合使用。
722
+ * 这个参数跟下面的IsChannel参数配合使用。
804
723
  IsChannel=false时,ApplicationId参数不起任何作用。
805
724
  IsChannel=true时,ApplicationId为空,查询所有第三方应用集成平台企业模板列表;ApplicationId不为空,查询指定应用下的模板列表
806
725
  ApplicationId为空,查询所有应用下的模板列表
807
- */
726
+ */
808
727
  ApplicationId?: string
809
-
810
728
  /**
811
- * 默认为false,查询SaaS模板库列表;
729
+ * 默认为false,查询SaaS模板库列表;
812
730
  为true,查询第三方应用集成平台企业模板库管理列表
813
- */
731
+ */
814
732
  IsChannel?: boolean
815
-
816
733
  /**
817
734
  * 暂未开放
735
+ * @deprecated
818
736
  */
819
737
  Organization?: OrganizationInfo
820
-
821
738
  /**
822
739
  * 暂未开放
740
+ * @deprecated
823
741
  */
824
742
  GenerateSource?: number
825
743
  }
@@ -829,18 +747,16 @@ ApplicationId为空,查询所有应用下的模板列表
829
747
  */
830
748
  export interface DescribeFlowEvidenceReportResponse {
831
749
  /**
832
- * 报告 URL
750
+ * 报告 URL
833
751
  注意:此字段可能返回 null,表示取不到有效值。
834
- */
752
+ */
835
753
  ReportUrl: string
836
-
837
754
  /**
838
- * 执行中:EvidenceStatusExecuting
755
+ * 执行中:EvidenceStatusExecuting
839
756
  成功:EvidenceStatusSuccess
840
757
  失败:EvidenceStatusFailed
841
- */
758
+ */
842
759
  Status: string
843
-
844
760
  /**
845
761
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
846
762
  */
@@ -855,17 +771,15 @@ export interface CallbackInfo {
855
771
  * 回调url
856
772
  */
857
773
  CallbackUrl: string
858
-
859
774
  /**
860
775
  * 回调加密key,已废弃
776
+ * @deprecated
861
777
  */
862
778
  Token?: string
863
-
864
779
  /**
865
780
  * 回调加密key
866
781
  */
867
782
  CallbackKey?: string
868
-
869
783
  /**
870
784
  * 回调验签token
871
785
  */
@@ -880,106 +794,87 @@ export interface TemplateInfo {
880
794
  * 模板ID
881
795
  */
882
796
  TemplateId?: string
883
-
884
797
  /**
885
798
  * 模板名字
886
799
  */
887
800
  TemplateName?: string
888
-
889
801
  /**
890
802
  * 模板描述信息
891
803
  */
892
804
  Description?: string
893
-
894
805
  /**
895
806
  * 模板关联的资源ID列表
896
807
  */
897
808
  DocumentResourceIds?: Array<string>
898
-
899
809
  /**
900
810
  * 返回的文件信息结构
901
811
  */
902
812
  FileInfos?: Array<FileInfo>
903
-
904
813
  /**
905
814
  * 附件关联的资源ID
906
815
  */
907
816
  AttachmentResourceIds?: Array<string>
908
-
909
817
  /**
910
818
  * 签署顺序
911
819
  */
912
820
  SignOrder?: Array<number>
913
-
914
821
  /**
915
822
  * 签署参与者的信息
916
823
  */
917
824
  Recipients?: Array<Recipient>
918
-
919
825
  /**
920
826
  * 模板信息结构
921
827
  */
922
828
  Components?: Array<Component>
923
-
924
829
  /**
925
830
  * 签署区模板信息结构
926
831
  */
927
832
  SignComponents?: Array<Component>
928
-
929
833
  /**
930
834
  * 模板状态(-1:不可用;0:草稿态;1:正式态)
931
835
  */
932
836
  Status?: number
933
-
934
837
  /**
935
838
  * 模板的创建人UserId
936
839
  */
937
840
  Creator?: string
938
-
939
841
  /**
940
842
  * 模板创建的时间戳,单位秒
941
843
  */
942
844
  CreatedOn?: number
943
-
944
845
  /**
945
846
  * 发起人角色信息
946
847
  */
947
848
  Promoter?: Recipient
948
-
949
849
  /**
950
- * 模板类型
850
+ * 模板类型
951
851
  取值:
952
852
  1 静默签,
953
853
  3 普通模板
954
- */
854
+ */
955
855
  TemplateType?: number
956
-
957
856
  /**
958
857
  * 模板可用状态,取值:1启用(默认),2停用
959
858
  */
960
859
  Available?: number
961
-
962
860
  /**
963
861
  * 创建模板的机构id
964
862
  */
965
863
  OrganizationId?: string
966
-
967
864
  /**
968
- * 模板预览链接,有效时间5分钟
865
+ * 模板预览链接,有效时间5分钟
969
866
  注意:此字段可能返回 null,表示取不到有效值。
970
- */
867
+ */
971
868
  PreviewUrl?: string
972
-
973
869
  /**
974
- * 模板版本。默认为空时,全数字字符,初始版本为yyyyMMdd001。
870
+ * 模板版本。默认为空时,全数字字符,初始版本为yyyyMMdd001。
975
871
  注意:此字段可能返回 null,表示取不到有效值。
976
- */
872
+ */
977
873
  TemplateVersion?: string
978
-
979
874
  /**
980
- * 模板是否已发布。true-已发布;false-未发布
875
+ * 模板是否已发布。true-已发布;false-未发布
981
876
  注意:此字段可能返回 null,表示取不到有效值。
982
- */
877
+ */
983
878
  Published?: boolean
984
879
  }
985
880
 
@@ -991,13 +886,11 @@ export interface CreateDocumentResponse {
991
886
  * 签署流程电子文档ID
992
887
  */
993
888
  DocumentId?: string
994
-
995
889
  /**
996
- * 签署流程文件的预览地址, 5分钟内有效。仅当NeedPreview为true 时返回
890
+ * 签署流程文件的预览地址, 5分钟内有效。仅当NeedPreview为true 时返回
997
891
  注意:此字段可能返回 null,表示取不到有效值。
998
- */
892
+ */
999
893
  PreviewFileUrl?: string
1000
-
1001
894
  /**
1002
895
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1003
896
  */
@@ -1012,23 +905,19 @@ export interface DescribeIntegrationEmployeesRequest {
1012
905
  * 操作人信息,userId必填
1013
906
  */
1014
907
  Operator: UserInfo
1015
-
1016
908
  /**
1017
909
  * 返回最大数量,最大为20
1018
910
  */
1019
911
  Limit: number
1020
-
1021
912
  /**
1022
913
  * 代理相关应用信息,如集团主企业代子企业操作的场景中ProxyOrganizationId必填
1023
914
  */
1024
915
  Agent?: Agent
1025
-
1026
916
  /**
1027
- * 查询过滤实名用户,Key为Status,Values为["IsVerified"]
917
+ * 查询过滤实名用户,Key为Status,Values为["IsVerified"]
1028
918
  根据第三方系统openId过滤查询员工时,Key为StaffOpenId,Values为["OpenId","OpenId",...]
1029
- */
919
+ */
1030
920
  Filters?: Array<Filter>
1031
-
1032
921
  /**
1033
922
  * 偏移量,默认为0,最大为20000
1034
923
  */
@@ -1043,7 +932,6 @@ export interface CreateIntegrationUserRolesResponse {
1043
932
  * 绑定角色失败列表信息
1044
933
  */
1045
934
  FailedCreateRoleData?: Array<FailedCreateRoleData>
1046
-
1047
935
  /**
1048
936
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1049
937
  */
@@ -1058,85 +946,72 @@ export interface CreateFlowRequest {
1058
946
  * 调用方用户信息,userId 必填。支持填入集团子公司经办人 userId代发合同。
1059
947
  */
1060
948
  Operator: UserInfo
1061
-
1062
949
  /**
1063
950
  * 签署流程名称,最大长度200个字符
1064
951
  */
1065
952
  FlowName: string
1066
-
1067
953
  /**
1068
954
  * 签署流程参与者信息,最大限制50方
1069
955
  */
1070
956
  Approvers: Array<FlowCreateApprover>
1071
-
1072
957
  /**
1073
958
  * 签署流程的类型(如销售合同/入职合同等),最大长度200个字符
1074
959
  */
1075
960
  FlowType?: string
1076
-
1077
961
  /**
1078
962
  * 客户端Token,保持接口幂等性,最大长度64个字符
1079
963
  */
1080
964
  ClientToken?: string
1081
-
1082
965
  /**
1083
966
  * 暂未开放
967
+ * @deprecated
1084
968
  */
1085
969
  RelatedFlowId?: string
1086
-
1087
970
  /**
1088
- * 签署流程的签署截止时间。
971
+ * 签署流程的签署截止时间。
1089
972
  值为unix时间戳,精确到秒,不传默认为当前时间一年后
1090
- */
973
+ */
1091
974
  DeadLine?: number
1092
-
1093
975
  /**
1094
976
  * 用户自定义字段,回调的时候会进行透传,长度需要小于20480
1095
977
  */
1096
978
  UserData?: string
1097
-
1098
979
  /**
1099
980
  * 签署流程描述,最大长度1000个字符
1100
981
  */
1101
982
  FlowDescription?: string
1102
-
1103
983
  /**
1104
- * 发送类型:
984
+ * 发送类型:
1105
985
  true:无序签
1106
986
  false:有序签
1107
987
  注:默认为false(有序签),请和模板中的配置保持一致
1108
- */
988
+ */
1109
989
  Unordered?: boolean
1110
-
1111
990
  /**
1112
991
  * 合同显示的页卡模板,说明:只支持{合同名称}, {发起方企业}, {发起方姓名}, {签署方N企业}, {签署方N姓名},且N不能超过签署人的数量,N从1开始
1113
992
  */
1114
993
  CustomShowMap?: string
1115
-
1116
994
  /**
1117
- * 发起方企业的签署人进行签署操作是否需要企业内部审批。使用此功能需要发起方企业有参与签署。
995
+ * 发起方企业的签署人进行签署操作是否需要企业内部审批。使用此功能需要发起方企业有参与签署。
1118
996
  若设置为true,审核结果需通过接口 CreateFlowSignReview 通知电子签,审核通过后,发起方企业签署人方可进行签署操作,否则会阻塞其签署操作。
1119
997
 
1120
998
  注:企业可以通过此功能与企业内部的审批流程进行关联,支持手动、静默签署合同。
1121
- */
999
+ */
1122
1000
  NeedSignReview?: boolean
1123
-
1124
1001
  /**
1125
1002
  * 暂未开放
1003
+ * @deprecated
1126
1004
  */
1127
1005
  CallbackUrl?: string
1128
-
1129
1006
  /**
1130
1007
  * 代理相关应用信息,如集团主企业代子企业操作的场景中ProxyOrganizationId必填
1131
1008
  */
1132
1009
  Agent?: Agent
1133
-
1134
1010
  /**
1135
- * 被抄送人的信息列表。
1011
+ * 被抄送人的信息列表。
1136
1012
  注: 此功能为白名单功能,若有需要,请联系电子签客服开白使用。
1137
- */
1013
+ */
1138
1014
  CcInfos?: Array<CcInfo>
1139
-
1140
1015
  /**
1141
1016
  * 个人自动签场景。发起自动签署时,需设置对应自动签署场景,目前仅支持场景:处方单-E_PRESCRIPTION_AUTO_SIGN
1142
1017
  */
@@ -1151,45 +1026,37 @@ export interface CreateSchemeUrlRequest {
1151
1026
  * 调用方用户信息,userId 必填
1152
1027
  */
1153
1028
  Operator: UserInfo
1154
-
1155
1029
  /**
1156
1030
  * 企业名称
1157
1031
  */
1158
1032
  OrganizationName?: string
1159
-
1160
1033
  /**
1161
1034
  * 姓名,最大长度50个字符
1162
1035
  */
1163
1036
  Name?: string
1164
-
1165
1037
  /**
1166
1038
  * 手机号,大陆手机号11位
1167
1039
  */
1168
1040
  Mobile?: string
1169
-
1170
1041
  /**
1171
- * 链接类型
1042
+ * 链接类型
1172
1043
  HTTP:跳转电子签小程序的http_url,
1173
1044
  APP:第三方APP或小程序跳转电子签小程序的path。
1174
1045
  默认为HTTP类型
1175
- */
1046
+ */
1176
1047
  EndPoint?: string
1177
-
1178
1048
  /**
1179
1049
  * 签署流程编号 (PathType=1时必传)
1180
1050
  */
1181
1051
  FlowId?: string
1182
-
1183
1052
  /**
1184
1053
  * 跳转页面 1: 小程序合同详情 2: 小程序合同列表页 0: 不传, 默认主页
1185
1054
  */
1186
1055
  PathType?: number
1187
-
1188
1056
  /**
1189
1057
  * 是否自动回跳 true:是, false:否。该参数只针对"APP" 类型的签署链接有效
1190
1058
  */
1191
1059
  AutoJumpBack?: boolean
1192
-
1193
1060
  /**
1194
1061
  * 代理相关应用信息,如集团主企业代子企业操作的场景中ProxyOrganizationId必填
1195
1062
  */
@@ -1214,27 +1081,22 @@ export interface AutoSignConfig {
1214
1081
  * 自动签开通个人用户的三要素
1215
1082
  */
1216
1083
  UserInfo: UserThreeFactor
1217
-
1218
1084
  /**
1219
1085
  * 接受自动签开启的回调地址。需要保证post返回200
1220
1086
  */
1221
1087
  CallbackUrl: string
1222
-
1223
1088
  /**
1224
1089
  * 是否回调证书信息,默认false-不需要
1225
1090
  */
1226
1091
  CertInfoCallback?: boolean
1227
-
1228
1092
  /**
1229
1093
  * 是否支持用户自定义签名印章,默认false-不需要
1230
1094
  */
1231
1095
  UserDefineSeal?: boolean
1232
-
1233
1096
  /**
1234
1097
  * 是否需要回调的时候返回印章(签名) 图片的 base64,默认false-不需要
1235
1098
  */
1236
1099
  SealImgCallback?: boolean
1237
-
1238
1100
  /**
1239
1101
  * 开通时候的验证方式,取值:WEIXINAPP(微信人脸识别),INSIGHT(慧眼人脸认别),TELECOM(运营商三要素验证)。如果是小程序开通链接,支持传 WEIXINAPP / TELECOM。如果是 H5 开通链接,支持传 INSIGHT / TELECOM。默认值 WEIXINAPP / INSIGHT。
1240
1102
  */
@@ -1259,7 +1121,6 @@ export interface UnbindEmployeeUserIdWithClientOpenIdResponse {
1259
1121
  * 解绑是否成功,1表示成功,0表示失败
1260
1122
  */
1261
1123
  Status?: number
1262
-
1263
1124
  /**
1264
1125
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1265
1126
  */
@@ -1271,11 +1132,10 @@ export interface UnbindEmployeeUserIdWithClientOpenIdResponse {
1271
1132
  */
1272
1133
  export interface CreateReleaseFlowResponse {
1273
1134
  /**
1274
- * 解除协议流程编号
1135
+ * 解除协议流程编号
1275
1136
 
1276
- */
1137
+ */
1277
1138
  FlowId?: string
1278
-
1279
1139
  /**
1280
1140
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1281
1141
  */
@@ -1290,12 +1150,10 @@ export interface BindEmployeeUserIdWithClientOpenIdRequest {
1290
1150
  * 用户信息,OpenId与UserId二选一必填一个,OpenId是第三方客户ID,userId是用户实名后的电子签生成的ID,当传入客户系统openId,传入的openId需与电子签员工userId绑定,且参数Channel必填,Channel值为INTEGRATE;当传入参数UserId,Channel无需指定。(参数参考示例)
1291
1151
  */
1292
1152
  Operator: UserInfo
1293
-
1294
1153
  /**
1295
1154
  * 电子签系统员工UserId
1296
1155
  */
1297
1156
  UserId: string
1298
-
1299
1157
  /**
1300
1158
  * 客户系统OpenId
1301
1159
  */
@@ -1310,17 +1168,14 @@ export interface DescribeIntegrationDepartmentsRequest {
1310
1168
  * 操作人信息,UserId必填且需拥有组织架构管理权限
1311
1169
  */
1312
1170
  Operator: UserInfo
1313
-
1314
1171
  /**
1315
1172
  * 查询类型 0-查询单个部门节点 1-单个部门节点及一级子节点部门列表
1316
1173
  */
1317
1174
  QueryType: number
1318
-
1319
1175
  /**
1320
1176
  * 部门ID,与DeptOpenId二选一,优先DeptId,都为空时获取根节点数据
1321
1177
  */
1322
1178
  DeptId?: string
1323
-
1324
1179
  /**
1325
1180
  * 客户系统部门ID,与DeptId二选一,优先DeptId,都为空时获取根节点数据
1326
1181
  */
@@ -1335,7 +1190,6 @@ export interface CreateIntegrationDepartmentResponse {
1335
1190
  * 电子签部门ID
1336
1191
  */
1337
1192
  DeptId?: string
1338
-
1339
1193
  /**
1340
1194
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1341
1195
  */
@@ -1358,26 +1212,27 @@ export interface DeleteSealPoliciesResponse {
1358
1212
  export interface OrganizationInfo {
1359
1213
  /**
1360
1214
  * 机构在平台的编号,内部字段,暂未开放
1215
+ * @deprecated
1361
1216
  */
1362
1217
  OrganizationId?: string
1363
-
1364
1218
  /**
1365
1219
  * 用户渠道,内部字段,暂未开放
1220
+ * @deprecated
1366
1221
  */
1367
1222
  Channel?: string
1368
-
1369
1223
  /**
1370
1224
  * 用户在渠道的机构编号,内部字段,暂未开放
1225
+ * @deprecated
1371
1226
  */
1372
1227
  OrganizationOpenId?: string
1373
-
1374
1228
  /**
1375
1229
  * 用户真实的IP,内部字段,暂未开放
1230
+ * @deprecated
1376
1231
  */
1377
1232
  ClientIp?: string
1378
-
1379
1233
  /**
1380
1234
  * 机构的代理IP,内部字段,暂未开放
1235
+ * @deprecated
1381
1236
  */
1382
1237
  ProxyIp?: string
1383
1238
  }
@@ -1390,17 +1245,14 @@ export interface DescribeUserAutoSignStatusResponse {
1390
1245
  * 是否已开通自动签
1391
1246
  */
1392
1247
  IsOpen?: boolean
1393
-
1394
1248
  /**
1395
1249
  * 自动签许可生效时间。当且仅当已开通自动签时有值。
1396
1250
  */
1397
1251
  LicenseFrom?: number
1398
-
1399
1252
  /**
1400
1253
  * 自动签许可到期时间。当且仅当已开通自动签时有值。
1401
1254
  */
1402
1255
  LicenseTo?: number
1403
-
1404
1256
  /**
1405
1257
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1406
1258
  */
@@ -1415,17 +1267,15 @@ export interface FillApproverInfo {
1415
1267
  * 对应模板中的参与方ID
1416
1268
  */
1417
1269
  RecipientId: string
1418
-
1419
1270
  /**
1420
- * 签署人来源
1271
+ * 签署人来源
1421
1272
  WEWORKAPP: 企业微信
1422
- */
1273
+ */
1423
1274
  ApproverSource: string
1424
-
1425
1275
  /**
1426
- * 企业自定义账号ID
1276
+ * 企业自定义账号ID
1427
1277
  WEWORKAPP场景下指企业自有应用获取企微明文的userid
1428
- */
1278
+ */
1429
1279
  CustomUserId: string
1430
1280
  }
1431
1281
 
@@ -1437,57 +1287,47 @@ export interface OccupiedSeal {
1437
1287
  * 电子印章编号
1438
1288
  */
1439
1289
  SealId: string
1440
-
1441
1290
  /**
1442
1291
  * 电子印章名称
1443
1292
  */
1444
1293
  SealName: string
1445
-
1446
1294
  /**
1447
1295
  * 电子印章授权时间戳,单位秒
1448
1296
  */
1449
1297
  CreateOn: number
1450
-
1451
1298
  /**
1452
1299
  * 电子印章授权人的UserId
1453
1300
  */
1454
1301
  Creator: string
1455
-
1456
1302
  /**
1457
1303
  * 电子印章策略Id
1458
1304
  */
1459
1305
  SealPolicyId: string
1460
-
1461
1306
  /**
1462
1307
  * 印章状态,有以下六种:CHECKING(审核中)SUCCESS(已启用)FAIL(审核拒绝)CHECKING-SADM(待超管审核)DISABLE(已停用)STOPPED(已终止)
1463
1308
  */
1464
1309
  SealStatus: string
1465
-
1466
1310
  /**
1467
- * 审核失败原因
1311
+ * 审核失败原因
1468
1312
  注意:此字段可能返回 null,表示取不到有效值。
1469
- */
1313
+ */
1470
1314
  FailReason: string
1471
-
1472
1315
  /**
1473
1316
  * 印章图片url,5分钟内有效
1474
1317
  */
1475
1318
  Url: string
1476
-
1477
1319
  /**
1478
1320
  * 印章类型,OFFICIAL-企业公章, CONTRACT-合同专用章,ORGANIZATIONSEAL-企业印章(本地上传印章类型),LEGAL_PERSON_SEAL-法人印章
1479
1321
  */
1480
1322
  SealType: string
1481
-
1482
1323
  /**
1483
1324
  * 用印申请是否为永久授权,true-是,false-否
1484
1325
  */
1485
1326
  IsAllTime: boolean
1486
-
1487
1327
  /**
1488
- * 授权人列表
1328
+ * 授权人列表
1489
1329
  注意:此字段可能返回 null,表示取不到有效值。
1490
- */
1330
+ */
1491
1331
  AuthorizedUsers: Array<AuthorizedUser>
1492
1332
  }
1493
1333
 
@@ -1496,17 +1336,15 @@ export interface OccupiedSeal {
1496
1336
  */
1497
1337
  export interface FailedDeleteStaffData {
1498
1338
  /**
1499
- * 员工在电子签的userId
1339
+ * 员工在电子签的userId
1500
1340
  注意:此字段可能返回 null,表示取不到有效值。
1501
- */
1341
+ */
1502
1342
  UserId: string
1503
-
1504
1343
  /**
1505
- * 员工在第三方平台的openId
1344
+ * 员工在第三方平台的openId
1506
1345
  注意:此字段可能返回 null,表示取不到有效值。
1507
- */
1346
+ */
1508
1347
  OpenId: string
1509
-
1510
1348
  /**
1511
1349
  * 失败原因
1512
1350
  */
@@ -1521,62 +1359,50 @@ export interface PdfVerifyResult {
1521
1359
  * 验签结果。0-签名域未签名;1-验签成功; 3-验签失败;4-未找到签名域:文件内没有签名域;5-签名值格式不正确。
1522
1360
  */
1523
1361
  VerifyResult: number
1524
-
1525
1362
  /**
1526
1363
  * 签署平台,如果文件是在腾讯电子签平台签署,则返回腾讯电子签,如果文件不在腾讯电子签平台签署,则返回其他平台。
1527
1364
  */
1528
1365
  SignPlatform: string
1529
-
1530
1366
  /**
1531
1367
  * 签署人名称
1532
1368
  */
1533
1369
  SignerName: string
1534
-
1535
1370
  /**
1536
1371
  * 签署时间戳,单位秒
1537
1372
  */
1538
1373
  SignTime: number
1539
-
1540
1374
  /**
1541
1375
  * 签名算法
1542
1376
  */
1543
1377
  SignAlgorithm: string
1544
-
1545
1378
  /**
1546
1379
  * 签名证书序列号
1547
1380
  */
1548
1381
  CertSn: string
1549
-
1550
1382
  /**
1551
1383
  * 证书起始时间戳,单位秒
1552
1384
  */
1553
1385
  CertNotBefore: number
1554
-
1555
1386
  /**
1556
1387
  * 证书过期时间戳,单位秒
1557
1388
  */
1558
1389
  CertNotAfter: number
1559
-
1560
1390
  /**
1561
1391
  * 签名域横坐标,单位pt
1562
1392
  */
1563
1393
  ComponentPosX: number
1564
-
1565
1394
  /**
1566
1395
  * 签名域纵坐标,单位pt
1567
1396
  */
1568
1397
  ComponentPosY: number
1569
-
1570
1398
  /**
1571
1399
  * 签名域宽度,单位pt
1572
1400
  */
1573
1401
  ComponentWidth: number
1574
-
1575
1402
  /**
1576
1403
  * 签名域高度,单位pt
1577
1404
  */
1578
1405
  ComponentHeight: number
1579
-
1580
1406
  /**
1581
1407
  * 签名域所在页码,1~N
1582
1408
  */
@@ -1591,17 +1417,14 @@ export interface CreateBatchCancelFlowUrlResponse {
1591
1417
  * 批量撤回签署流程链接
1592
1418
  */
1593
1419
  BatchCancelFlowUrl?: string
1594
-
1595
1420
  /**
1596
1421
  * 签署流程撤回失败信息
1597
1422
  */
1598
1423
  FailMessages?: Array<string>
1599
-
1600
1424
  /**
1601
1425
  * 签署连接过期时间字符串:年月日-时分秒
1602
1426
  */
1603
1427
  UrlExpireOn?: string
1604
-
1605
1428
  /**
1606
1429
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1607
1430
  */
@@ -1616,15 +1439,13 @@ export interface UserThreeFactor {
1616
1439
  * 姓名
1617
1440
  */
1618
1441
  Name: string
1619
-
1620
1442
  /**
1621
- * 证件类型:
1443
+ * 证件类型:
1622
1444
  ID_CARD 身份证
1623
1445
  HONGKONG_AND_MACAO 港澳居民来往内地通行证
1624
1446
  HONGKONG_MACAO_AND_TAIWAN 港澳台居民居住证(格式同居民身份证)
1625
- */
1447
+ */
1626
1448
  IdCardType: string
1627
-
1628
1449
  /**
1629
1450
  * 证件号,如果有 X 请大写
1630
1451
  */
@@ -1639,12 +1460,10 @@ export interface SignQrCode {
1639
1460
  * 二维码id
1640
1461
  */
1641
1462
  QrCodeId: string
1642
-
1643
1463
  /**
1644
1464
  * 二维码url
1645
1465
  */
1646
1466
  QrCodeUrl: string
1647
-
1648
1467
  /**
1649
1468
  * 二维码过期时间戳,单位秒
1650
1469
  */
@@ -1659,7 +1478,6 @@ export interface CreateSealPolicyResponse {
1659
1478
  * 最终授权成功的。其他的跳过的是已经授权了的
1660
1479
  */
1661
1480
  UserIds?: Array<string>
1662
-
1663
1481
  /**
1664
1482
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1665
1483
  */
@@ -1674,13 +1492,11 @@ export interface DisableUserAutoSignRequest {
1674
1492
  * 操作人信息,UserId必填
1675
1493
  */
1676
1494
  Operator: UserInfo
1677
-
1678
1495
  /**
1679
- * 自动签场景:
1496
+ * 自动签场景:
1680
1497
  E_PRESCRIPTION_AUTO_SIGN 电子处方
1681
- */
1498
+ */
1682
1499
  SceneKey: string
1683
-
1684
1500
  /**
1685
1501
  * 关闭自动签的个人的三要素
1686
1502
  */
@@ -1692,27 +1508,23 @@ E_PRESCRIPTION_AUTO_SIGN 电子处方
1692
1508
  */
1693
1509
  export interface DescribeIntegrationEmployeesResponse {
1694
1510
  /**
1695
- * 员工数据列表
1511
+ * 员工数据列表
1696
1512
  注意:此字段可能返回 null,表示取不到有效值。
1697
- */
1513
+ */
1698
1514
  Employees?: Array<Staff>
1699
-
1700
1515
  /**
1701
- * 偏移量,默认为0,最大为20000
1516
+ * 偏移量,默认为0,最大为20000
1702
1517
  注意:此字段可能返回 null,表示取不到有效值。
1703
- */
1518
+ */
1704
1519
  Offset?: number
1705
-
1706
1520
  /**
1707
1521
  * 返回最大数量,最大为20
1708
1522
  */
1709
1523
  Limit?: number
1710
-
1711
1524
  /**
1712
1525
  * 符合条件的员工数量
1713
1526
  */
1714
1527
  TotalCount?: number
1715
-
1716
1528
  /**
1717
1529
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1718
1530
  */
@@ -1727,12 +1539,10 @@ export interface SuccessDeleteStaffData {
1727
1539
  * 员工名
1728
1540
  */
1729
1541
  DisplayName: string
1730
-
1731
1542
  /**
1732
1543
  * 员工手机号
1733
1544
  */
1734
1545
  Mobile: string
1735
-
1736
1546
  /**
1737
1547
  * 员工在电子签平台的id
1738
1548
  */
@@ -1747,7 +1557,6 @@ export interface CreateConvertTaskApiResponse {
1747
1557
  * 转换任务Id
1748
1558
  */
1749
1559
  TaskId?: string
1750
-
1751
1560
  /**
1752
1561
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1753
1562
  */
@@ -1762,25 +1571,21 @@ export interface CreateFlowSignReviewRequest {
1762
1571
  * 调用方用户信息,userId 必填
1763
1572
  */
1764
1573
  Operator: UserInfo
1765
-
1766
1574
  /**
1767
1575
  * 签署流程编号
1768
1576
  */
1769
1577
  FlowId: string
1770
-
1771
1578
  /**
1772
- * 企业内部审核结果
1579
+ * 企业内部审核结果
1773
1580
  PASS: 通过
1774
1581
  REJECT: 拒绝
1775
- */
1582
+ */
1776
1583
  ReviewType: string
1777
-
1778
1584
  /**
1779
- * 审核原因
1585
+ * 审核原因
1780
1586
  当ReviewType 是REJECT 时此字段必填,字符串长度不超过200
1781
- */
1587
+ */
1782
1588
  ReviewMessage?: string
1783
-
1784
1589
  /**
1785
1590
  * 代理相关应用信息,如集团主企业代子企业操作的场景中ProxyOrganizationId必填
1786
1591
  */
@@ -1795,12 +1600,10 @@ export interface UnbindEmployeeUserIdWithClientOpenIdRequest {
1795
1600
  * 用户信息,OpenId与UserId二选一必填一个,OpenId是第三方客户ID,userId是用户实名后的电子签生成的ID,当传入客户系统openId,传入的openId需与电子签员工userId绑定,且参数Channel必填,Channel值为INTEGRATE;当传入参数UserId,Channel无需指定
1796
1601
  */
1797
1602
  Operator: UserInfo
1798
-
1799
1603
  /**
1800
1604
  * 电子签系统员工UserId
1801
1605
  */
1802
1606
  UserId: string
1803
-
1804
1607
  /**
1805
1608
  * 客户系统OpenId
1806
1609
  */
@@ -1815,7 +1618,6 @@ export interface CreateSchemeUrlResponse {
1815
1618
  * 小程序链接地址,有效期5分钟
1816
1619
  */
1817
1620
  SchemeUrl?: string
1818
-
1819
1621
  /**
1820
1622
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1821
1623
  */
@@ -1830,32 +1632,26 @@ export interface CreateUserAutoSignEnableUrlResponse {
1830
1632
  * 跳转短链
1831
1633
  */
1832
1634
  Url?: string
1833
-
1834
1635
  /**
1835
1636
  * 小程序AppId
1836
1637
  */
1837
1638
  AppId?: string
1838
-
1839
1639
  /**
1840
1640
  * 小程序 原始 Id
1841
1641
  */
1842
1642
  AppOriginalId?: string
1843
-
1844
1643
  /**
1845
1644
  * 跳转路径
1846
1645
  */
1847
1646
  Path?: string
1848
-
1849
1647
  /**
1850
1648
  * base64格式跳转二维码
1851
1649
  */
1852
1650
  QrCode?: string
1853
-
1854
1651
  /**
1855
1652
  * 链接类型,空-默认小程序端链接,H5SIGN-h5端链接
1856
1653
  */
1857
1654
  UrlType?: string
1858
-
1859
1655
  /**
1860
1656
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1861
1657
  */
@@ -1870,7 +1666,6 @@ export interface CreateFlowSignUrlResponse {
1870
1666
  * 签署人签署链接信息
1871
1667
  */
1872
1668
  FlowApproverUrlInfos?: Array<FlowApproverUrlInfo>
1873
-
1874
1669
  /**
1875
1670
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1876
1671
  */
@@ -1885,59 +1680,52 @@ export interface DescribeFileUrlsRequest {
1885
1680
  * 调用方用户信息,UserId 必填
1886
1681
  */
1887
1682
  Operator: UserInfo
1888
-
1889
1683
  /**
1890
- * 文件对应的业务类型,目前支持:
1684
+ * 文件对应的业务类型,目前支持:
1891
1685
  - 流程 "FLOW",如需下载合同文件请选择此项
1892
1686
  - 模板 "TEMPLATE"
1893
1687
  - 文档 "DOCUMENT"
1894
1688
  - 印章 “SEAL”
1895
- */
1689
+ */
1896
1690
  BusinessType: string
1897
-
1898
1691
  /**
1899
- * 业务编号的数组,如流程编号、模板编号、文档编号、印章编号。如需下载合同文件请传入FlowId
1692
+ * 业务编号的数组,如流程编号、模板编号、文档编号、印章编号。如需下载合同文件请传入FlowId
1900
1693
  最大支持20个资源
1901
- */
1694
+ */
1902
1695
  BusinessIds: Array<string>
1903
-
1904
1696
  /**
1905
1697
  * 下载后的文件命名,只有FileType为zip的时候生效
1906
1698
  */
1907
1699
  FileName?: string
1908
-
1909
1700
  /**
1910
1701
  * 文件类型,"JPG", "PDF","ZIP"等
1911
1702
  */
1912
1703
  FileType?: string
1913
-
1914
1704
  /**
1915
1705
  * 指定资源起始偏移量,默认0
1916
1706
  */
1917
1707
  Offset?: number
1918
-
1919
1708
  /**
1920
1709
  * 指定资源数量,查询全部资源则传入-1
1921
1710
  */
1922
1711
  Limit?: number
1923
-
1924
1712
  /**
1925
1713
  * 下载url过期时间,单位秒。0: 按默认值5分钟,允许范围:1s~24x60x60s(1天)
1926
1714
  */
1927
1715
  UrlTtl?: number
1928
-
1929
1716
  /**
1930
1717
  * 暂不开放
1718
+ * @deprecated
1931
1719
  */
1932
1720
  CcToken?: string
1933
-
1934
1721
  /**
1935
1722
  * 暂不开放
1723
+ * @deprecated
1936
1724
  */
1937
1725
  Scene?: string
1938
-
1939
1726
  /**
1940
1727
  * 应用相关信息
1728
+ * @deprecated
1941
1729
  */
1942
1730
  Agent?: Agent
1943
1731
  }
@@ -2057,21 +1845,19 @@ content String 表头单元格内容,字数不超过100
2057
1845
  */
2058
1846
  export interface FormField {
2059
1847
  /**
2060
- * 控件填充vaule,ComponentType和传入值类型对应关系:
1848
+ * 控件填充vaule,ComponentType和传入值类型对应关系:
2061
1849
  TEXT - 文本内容
2062
1850
  MULTI_LINE_TEXT - 文本内容
2063
1851
  CHECK_BOX - true/false
2064
1852
  FILL_IMAGE、ATTACHMENT - 附件的FileId,需要通过UploadFiles接口上传获取
2065
1853
  SELECTOR - 选项值
2066
1854
  DYNAMIC_TABLE - 传入json格式的表格内容,具体见数据结构FlowInfo:https://cloud.tencent.com/document/api/1420/61525#FlowInfo
2067
- */
1855
+ */
2068
1856
  ComponentValue: string
2069
-
2070
1857
  /**
2071
1858
  * 控件id,和ComponentName选择一项传入即可
2072
1859
  */
2073
1860
  ComponentId?: string
2074
-
2075
1861
  /**
2076
1862
  * 控件名字,最大长度不超过30字符,和ComponentId选择一项传入即可
2077
1863
  */
@@ -2086,7 +1872,6 @@ export interface CreateChannelSubOrganizationModifyQrCodeRequest {
2086
1872
  * 操作人信息,userId必填
2087
1873
  */
2088
1874
  Operator: UserInfo
2089
-
2090
1875
  /**
2091
1876
  * 应用编号
2092
1877
  */
@@ -2101,24 +1886,24 @@ export interface UserInfo {
2101
1886
  * 用户在平台的编号
2102
1887
  */
2103
1888
  UserId?: string
2104
-
2105
1889
  /**
2106
1890
  * 用户的来源渠道,一般不用传,特定场景根据接口说明传值
1891
+ * @deprecated
2107
1892
  */
2108
1893
  Channel?: string
2109
-
2110
1894
  /**
2111
1895
  * 用户在渠道的编号,一般不用传,特定场景根据接口说明传值
1896
+ * @deprecated
2112
1897
  */
2113
1898
  OpenId?: string
2114
-
2115
1899
  /**
2116
1900
  * 用户真实IP,内部字段,暂未开放
1901
+ * @deprecated
2117
1902
  */
2118
1903
  ClientIp?: string
2119
-
2120
1904
  /**
2121
1905
  * 用户代理IP,内部字段,暂未开放
1906
+ * @deprecated
2122
1907
  */
2123
1908
  ProxyIp?: string
2124
1909
  }
@@ -2131,17 +1916,14 @@ export interface CreateFlowApproversRequest {
2131
1916
  * 调用方用户信息,userId 必填
2132
1917
  */
2133
1918
  Operator: UserInfo
2134
-
2135
1919
  /**
2136
1920
  * 签署流程编号
2137
1921
  */
2138
1922
  FlowId: string
2139
-
2140
1923
  /**
2141
1924
  * 补充签署人信息
2142
1925
  */
2143
1926
  Approvers: Array<FillApproverInfo>
2144
-
2145
1927
  /**
2146
1928
  * 企微消息中的发起人
2147
1929
  */
@@ -2156,68 +1938,56 @@ export interface Staff {
2156
1938
  * 用户在电子签平台的id
2157
1939
  */
2158
1940
  UserId?: string
2159
-
2160
1941
  /**
2161
1942
  * 显示的用户名/昵称
2162
1943
  */
2163
1944
  DisplayName?: string
2164
-
2165
1945
  /**
2166
1946
  * 用户手机号
2167
1947
  */
2168
1948
  Mobile?: string
2169
-
2170
1949
  /**
2171
- * 用户邮箱
1950
+ * 用户邮箱
2172
1951
  注意:此字段可能返回 null,表示取不到有效值。
2173
- */
1952
+ */
2174
1953
  Email?: string
2175
-
2176
1954
  /**
2177
- * 用户在第三方平台id,如需在此接口提醒员工实名,该参数不传
1955
+ * 用户在第三方平台id,如需在此接口提醒员工实名,该参数不传
2178
1956
  注意:此字段可能返回 null,表示取不到有效值。
2179
- */
1957
+ */
2180
1958
  OpenId?: string
2181
-
2182
1959
  /**
2183
- * 员工角色
1960
+ * 员工角色
2184
1961
  注意:此字段可能返回 null,表示取不到有效值。
2185
- */
1962
+ */
2186
1963
  Roles?: Array<StaffRole>
2187
-
2188
1964
  /**
2189
- * 员工部门
1965
+ * 员工部门
2190
1966
  注意:此字段可能返回 null,表示取不到有效值。
2191
- */
1967
+ */
2192
1968
  Department?: Department
2193
-
2194
1969
  /**
2195
1970
  * 员工是否实名
2196
1971
  */
2197
1972
  Verified?: boolean
2198
-
2199
1973
  /**
2200
1974
  * 员工创建时间戳,单位秒
2201
1975
  */
2202
1976
  CreatedOn?: number
2203
-
2204
1977
  /**
2205
- * 员工实名时间戳,单位秒
1978
+ * 员工实名时间戳,单位秒
2206
1979
  注意:此字段可能返回 null,表示取不到有效值。
2207
- */
1980
+ */
2208
1981
  VerifiedOn?: number
2209
-
2210
1982
  /**
2211
- * 员工是否离职:0-未离职,1-离职
1983
+ * 员工是否离职:0-未离职,1-离职
2212
1984
  注意:此字段可能返回 null,表示取不到有效值。
2213
- */
1985
+ */
2214
1986
  QuiteJob?: number
2215
-
2216
1987
  /**
2217
1988
  * 员工离职交接人用户id
2218
1989
  */
2219
1990
  ReceiveUserId?: string
2220
-
2221
1991
  /**
2222
1992
  * 员工离职交接人用户OpenId
2223
1993
  */
@@ -2229,24 +1999,21 @@ export interface Staff {
2229
1999
  */
2230
2000
  export interface CreateFlowEvidenceReportResponse {
2231
2001
  /**
2232
- * 出证报告 ID,用于查询出证报告DescribeFlowEvidenceReport接口时用到
2002
+ * 出证报告 ID,用于查询出证报告DescribeFlowEvidenceReport接口时用到
2233
2003
  注意:此字段可能返回 null,表示取不到有效值。
2234
- */
2004
+ */
2235
2005
  ReportId?: string
2236
-
2237
2006
  /**
2238
- * 执行中:EvidenceStatusExecuting
2007
+ * 执行中:EvidenceStatusExecuting
2239
2008
  成功:EvidenceStatusSuccess
2240
2009
  失败:EvidenceStatusFailed
2241
- */
2010
+ */
2242
2011
  Status?: string
2243
-
2244
2012
  /**
2245
- * 废除,字段无效
2013
+ * 废除,字段无效
2246
2014
  注意:此字段可能返回 null,表示取不到有效值。
2247
- */
2015
+ */
2248
2016
  ReportUrl?: string
2249
-
2250
2017
  /**
2251
2018
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
2252
2019
  */
@@ -2258,16 +2025,14 @@ export interface CreateFlowEvidenceReportResponse {
2258
2025
  */
2259
2026
  export interface DescribeFileUrlsResponse {
2260
2027
  /**
2261
- * 文件URL信息;
2028
+ * 文件URL信息;
2262
2029
  链接不是永久链接,有效期5分钟后链接失效。
2263
- */
2030
+ */
2264
2031
  FileUrls?: Array<FileUrl>
2265
-
2266
2032
  /**
2267
2033
  * URL数量
2268
2034
  */
2269
2035
  TotalCount?: number
2270
-
2271
2036
  /**
2272
2037
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
2273
2038
  */
@@ -2282,27 +2047,22 @@ export interface CreateIntegrationDepartmentRequest {
2282
2047
  * 操作人信息,UserId必填且需拥有组织架构管理权限
2283
2048
  */
2284
2049
  Operator: UserInfo
2285
-
2286
2050
  /**
2287
2051
  * 部门名称,不超过50个字符
2288
2052
  */
2289
2053
  DeptName: string
2290
-
2291
2054
  /**
2292
2055
  * 电子签父部门ID,与ParentDeptOpenId二选一,优先ParentDeptId,都为空时自动填充至根节点下
2293
2056
  */
2294
2057
  ParentDeptId?: string
2295
-
2296
2058
  /**
2297
2059
  * 第三方平台中父部门ID,与ParentDeptId二选一,优先ParentDeptId,都为空时自动填充至根节点下
2298
2060
  */
2299
2061
  ParentDeptOpenId?: string
2300
-
2301
2062
  /**
2302
2063
  * 客户系统部门ID,不超过64个字符
2303
2064
  */
2304
2065
  DeptOpenId?: string
2305
-
2306
2066
  /**
2307
2067
  * 排序号,1~30000范围内
2308
2068
  */
@@ -2314,75 +2074,64 @@ export interface CreateIntegrationDepartmentRequest {
2314
2074
  */
2315
2075
  export interface GroupOrganization {
2316
2076
  /**
2317
- * 成员企业名
2077
+ * 成员企业名
2318
2078
  注意:此字段可能返回 null,表示取不到有效值。
2319
- */
2079
+ */
2320
2080
  Name?: string
2321
-
2322
2081
  /**
2323
- * 成员企业别名
2082
+ * 成员企业别名
2324
2083
  注意:此字段可能返回 null,表示取不到有效值。
2325
- */
2084
+ */
2326
2085
  Alias?: string
2327
-
2328
2086
  /**
2329
- * 成员企业id
2087
+ * 成员企业id
2330
2088
  注意:此字段可能返回 null,表示取不到有效值。
2331
- */
2089
+ */
2332
2090
  OrganizationId?: string
2333
-
2334
2091
  /**
2335
- * 更新时间,时间戳,单位秒
2092
+ * 更新时间,时间戳,单位秒
2336
2093
  注意:此字段可能返回 null,表示取不到有效值。
2337
- */
2094
+ */
2338
2095
  UpdateTime?: number
2339
-
2340
2096
  /**
2341
- * 成员企业加入集团的当前状态:1-待授权;2-已授权待激活;3-拒绝授权;4-已解除;5-已加入
2097
+ * 成员企业加入集团的当前状态:1-待授权;2-已授权待激活;3-拒绝授权;4-已解除;5-已加入
2342
2098
  注意:此字段可能返回 null,表示取不到有效值。
2343
- */
2099
+ */
2344
2100
  Status?: number
2345
-
2346
2101
  /**
2347
- * 是否为集团主企业
2102
+ * 是否为集团主企业
2348
2103
  注意:此字段可能返回 null,表示取不到有效值。
2349
- */
2104
+ */
2350
2105
  IsMainOrganization?: boolean
2351
-
2352
2106
  /**
2353
- * 企业社会信用代码
2107
+ * 企业社会信用代码
2354
2108
  注意:此字段可能返回 null,表示取不到有效值。
2355
- */
2109
+ */
2356
2110
  IdCardNumber?: string
2357
-
2358
2111
  /**
2359
- * 企业超管信息
2112
+ * 企业超管信息
2360
2113
  注意:此字段可能返回 null,表示取不到有效值。
2361
- */
2114
+ */
2362
2115
  AdminInfo?: Admin
2363
-
2364
2116
  /**
2365
- * 企业许可证
2117
+ * 企业许可证
2366
2118
  注意:此字段可能返回 null,表示取不到有效值。
2367
- */
2119
+ */
2368
2120
  License?: string
2369
-
2370
2121
  /**
2371
- * 企业许可证过期时间,时间戳,单位秒
2122
+ * 企业许可证过期时间,时间戳,单位秒
2372
2123
  注意:此字段可能返回 null,表示取不到有效值。
2373
- */
2124
+ */
2374
2125
  LicenseExpireTime?: number
2375
-
2376
2126
  /**
2377
- * 成员企业加入集团时间,时间戳,单位秒
2127
+ * 成员企业加入集团时间,时间戳,单位秒
2378
2128
  注意:此字段可能返回 null,表示取不到有效值。
2379
- */
2129
+ */
2380
2130
  JoinTime?: number
2381
-
2382
2131
  /**
2383
- * 是否使用审批流引擎,true-是,false-否
2132
+ * 是否使用审批流引擎,true-是,false-否
2384
2133
  注意:此字段可能返回 null,表示取不到有效值。
2385
- */
2134
+ */
2386
2135
  FlowEngineEnable?: boolean
2387
2136
  }
2388
2137
 
@@ -2394,7 +2143,6 @@ export interface DeleteIntegrationRoleUsersResponse {
2394
2143
  * 角色id
2395
2144
  */
2396
2145
  RoleId?: string
2397
-
2398
2146
  /**
2399
2147
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
2400
2148
  */
@@ -2409,43 +2157,35 @@ export interface CreateDocumentRequest {
2409
2157
  * 调用方用户信息,userId 必填。支持填入集团子公司经办人 userId代发合同。
2410
2158
  */
2411
2159
  Operator: UserInfo
2412
-
2413
2160
  /**
2414
2161
  * 签署流程编号,由CreateFlow接口返回
2415
2162
  */
2416
2163
  FlowId: string
2417
-
2418
2164
  /**
2419
2165
  * 用户上传的模板ID
2420
2166
  */
2421
2167
  TemplateId: string
2422
-
2423
2168
  /**
2424
2169
  * 文件名列表,单个文件名最大长度200个字符,暂时仅支持单文件发起。设置后流程对应的文件名称当前设置的值。
2425
2170
  */
2426
2171
  FileNames?: Array<string>
2427
-
2428
2172
  /**
2429
2173
  * 内容控件信息数组
2430
2174
  */
2431
2175
  FormFields?: Array<FormField>
2432
-
2433
2176
  /**
2434
- * 是否需要生成预览文件 默认不生成;
2177
+ * 是否需要生成预览文件 默认不生成;
2435
2178
  预览链接有效期300秒;
2436
- */
2179
+ */
2437
2180
  NeedPreview?: boolean
2438
-
2439
2181
  /**
2440
2182
  * 预览链接类型 默认:0-文件流, 1- H5链接 注意:此参数在NeedPreview 为true 时有效,
2441
2183
  */
2442
2184
  PreviewType?: number
2443
-
2444
2185
  /**
2445
2186
  * 代理相关应用信息,如集团主企业代子企业操作的场景中ProxyOrganizationId必填
2446
2187
  */
2447
2188
  Agent?: Agent
2448
-
2449
2189
  /**
2450
2190
  * 客户端Token,保持接口幂等性,最大长度64个字符
2451
2191
  */
@@ -2460,20 +2200,17 @@ export interface FlowDetailInfo {
2460
2200
  * 合同(流程)的ID
2461
2201
  */
2462
2202
  FlowId: string
2463
-
2464
2203
  /**
2465
2204
  * 合同(流程)的名字
2466
2205
  */
2467
2206
  FlowName: string
2468
-
2469
2207
  /**
2470
- * 合同(流程)的类型
2208
+ * 合同(流程)的类型
2471
2209
  注意:此字段可能返回 null,表示取不到有效值。
2472
- */
2210
+ */
2473
2211
  FlowType: string
2474
-
2475
2212
  /**
2476
- * 流程状态
2213
+ * 流程状态
2477
2214
  - 0 还没有发起
2478
2215
  - 1 待签署
2479
2216
  - 2 部分签署
@@ -2486,40 +2223,34 @@ export interface FlowDetailInfo {
2486
2223
  - 9 部分填写
2487
2224
  - 10 拒填
2488
2225
  - 21 已解除
2489
- */
2226
+ */
2490
2227
  FlowStatus: number
2491
-
2492
2228
  /**
2493
- * 合同(流程)的信息
2229
+ * 合同(流程)的信息
2494
2230
  注意:此字段可能返回 null,表示取不到有效值。
2495
- */
2231
+ */
2496
2232
  FlowMessage: string
2497
-
2498
2233
  /**
2499
- * 流程的描述
2234
+ * 流程的描述
2500
2235
  注意:此字段可能返回 null,表示取不到有效值。
2501
- */
2236
+ */
2502
2237
  FlowDescription: string
2503
-
2504
2238
  /**
2505
2239
  * 合同(流程)的创建时间戳,单位秒
2506
2240
  */
2507
2241
  CreatedOn: number
2508
-
2509
2242
  /**
2510
2243
  * 合同(流程)的签署方数组
2511
2244
  */
2512
2245
  FlowApproverInfos: Array<FlowApproverDetail>
2513
-
2514
2246
  /**
2515
2247
  * 合同(流程)的关注方信息列表
2516
2248
  */
2517
2249
  CcInfos?: Array<FlowApproverDetail>
2518
-
2519
2250
  /**
2520
- * 合同发起人UserId
2251
+ * 合同发起人UserId
2521
2252
  注意:此字段可能返回 null,表示取不到有效值。
2522
- */
2253
+ */
2523
2254
  Creator?: string
2524
2255
  }
2525
2256
 
@@ -2531,7 +2262,6 @@ export interface CreatePreparedPersonalEsignResponse {
2531
2262
  * 导入生成的印章ID
2532
2263
  */
2533
2264
  SealId?: string
2534
-
2535
2265
  /**
2536
2266
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
2537
2267
  */
@@ -2546,12 +2276,10 @@ export interface DescribeOrganizationSealsResponse {
2546
2276
  * 在设置了SealId时返回0或1,没有设置时返回公司的总印章数量,可能比返回的印章数组数量多
2547
2277
  */
2548
2278
  TotalCount?: number
2549
-
2550
2279
  /**
2551
2280
  * 查询到的印章结果数组
2552
2281
  */
2553
2282
  Seals?: Array<OccupiedSeal>
2554
-
2555
2283
  /**
2556
2284
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
2557
2285
  */
@@ -2566,12 +2294,10 @@ export interface DeleteIntegrationEmployeesRequest {
2566
2294
  * 操作人信息,userId必填
2567
2295
  */
2568
2296
  Operator: UserInfo
2569
-
2570
2297
  /**
2571
2298
  * 待移除员工的信息,userId和openId二选一,必填一个
2572
2299
  */
2573
2300
  Employees: Array<Staff>
2574
-
2575
2301
  /**
2576
2302
  * 代理相关应用信息,如集团主企业代子企业操作的场景中ProxyOrganizationId需填充子企业Id
2577
2303
  */
@@ -2586,22 +2312,18 @@ export interface FailedUpdateStaffData {
2586
2312
  * 用户传入的名称
2587
2313
  */
2588
2314
  DisplayName?: string
2589
-
2590
2315
  /**
2591
2316
  * 用户传入的手机号
2592
2317
  */
2593
2318
  Mobile?: string
2594
-
2595
2319
  /**
2596
2320
  * 失败原因
2597
2321
  */
2598
2322
  Reason?: string
2599
-
2600
2323
  /**
2601
2324
  * 用户Id
2602
2325
  */
2603
2326
  UserId?: string
2604
-
2605
2327
  /**
2606
2328
  * 员工在第三方平台的openId
2607
2329
  */
@@ -2616,19 +2338,18 @@ export interface GetTaskResultApiRequest {
2616
2338
  * 任务Id,通过CreateConvertTaskApi得到
2617
2339
  */
2618
2340
  TaskId: string
2619
-
2620
2341
  /**
2621
2342
  * 操作人信息,UserId必填
2622
2343
  */
2623
2344
  Operator?: UserInfo
2624
-
2625
2345
  /**
2626
2346
  * 应用号信息
2347
+ * @deprecated
2627
2348
  */
2628
2349
  Agent?: Agent
2629
-
2630
2350
  /**
2631
2351
  * 暂未开放
2352
+ * @deprecated
2632
2353
  */
2633
2354
  Organization?: OrganizationInfo
2634
2355
  }
@@ -2641,7 +2362,6 @@ export interface RegisterInfo {
2641
2362
  * 法人姓名
2642
2363
  */
2643
2364
  LegalName: string
2644
-
2645
2365
  /**
2646
2366
  * 社会统一信用代码
2647
2367
  */
@@ -2656,7 +2376,6 @@ export interface CreateIntegrationEmployeesResponse {
2656
2376
  * 创建员工的结果
2657
2377
  */
2658
2378
  CreateEmployeeResult?: CreateStaffResult
2659
-
2660
2379
  /**
2661
2380
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
2662
2381
  */
@@ -2671,17 +2390,14 @@ export interface DeleteIntegrationRoleUsersRequest {
2671
2390
  * 操作人信息,userId必填
2672
2391
  */
2673
2392
  Operator: UserInfo
2674
-
2675
2393
  /**
2676
2394
  * 角色id
2677
2395
  */
2678
2396
  RoleId: string
2679
-
2680
2397
  /**
2681
2398
  * 用户信息
2682
2399
  */
2683
2400
  Users: Array<UserInfo>
2684
-
2685
2401
  /**
2686
2402
  * 代理相关应用信息,如集团主企业代子企业操作的场景中ProxyOrganizationId必填
2687
2403
  */
@@ -2696,24 +2412,21 @@ export interface CreateFlowSignUrlRequest {
2696
2412
  * 流程编号
2697
2413
  */
2698
2414
  FlowId: string
2699
-
2700
2415
  /**
2701
2416
  * 流程签署人,其中ApproverName,ApproverMobile和ApproverType必传,其他可不传,ApproverType目前只支持个人类型的签署人。还需注意签署人只能有手写签名和时间类型的签署控件,其他类型的填写控件和签署控件暂时都未支持。
2702
2417
  */
2703
2418
  FlowApproverInfos: Array<FlowCreateApprover>
2704
-
2705
2419
  /**
2706
2420
  * 用户信息,此结构体UserId必填
2707
2421
  */
2708
2422
  Operator?: UserInfo
2709
-
2710
2423
  /**
2711
2424
  * 代理相关应用信息,如集团主企业代子企业操作的场景中ProxyOrganizationId必填
2712
2425
  */
2713
2426
  Agent?: Agent
2714
-
2715
2427
  /**
2716
2428
  * 机构信息,暂未开放
2429
+ * @deprecated
2717
2430
  */
2718
2431
  Organization?: OrganizationInfo
2719
2432
  }
@@ -2726,22 +2439,19 @@ export interface CreateReleaseFlowRequest {
2726
2439
  * 调用方用户信息,userId 必填
2727
2440
  */
2728
2441
  Operator: UserInfo
2729
-
2730
2442
  /**
2731
2443
  * 待解除的签署流程编号(即原签署流程的编号)
2732
2444
  */
2733
2445
  NeedRelievedFlowId: string
2734
-
2735
2446
  /**
2736
2447
  * 解除协议内容
2737
2448
  */
2738
2449
  ReliveInfo: RelieveInfo
2739
-
2740
2450
  /**
2741
- * 非必须,解除协议的本企业签署人列表,
2451
+ * 非必须,解除协议的本企业签署人列表,
2742
2452
  默认使用原流程的签署人列表,当解除协议的签署人与原流程的签署人不能相同时(例如原流程签署人离职了),需要指定本企业其他已实名员工来替换原流程中的原签署人,注意需要指明原签署人的编号(ReceiptId,通过DescribeFlowInfo接口获取)来代表需要替换哪一个签署人
2743
2453
  解除协议的签署人数量不能多于原流程的签署人数量
2744
- */
2454
+ */
2745
2455
  ReleasedApprovers?: Array<ReleasedApprover>
2746
2456
  }
2747
2457
 
@@ -2753,17 +2463,14 @@ export interface CreateIntegrationUserRolesRequest {
2753
2463
  * 操作人信息,UserId必填
2754
2464
  */
2755
2465
  Operator: UserInfo
2756
-
2757
2466
  /**
2758
2467
  * 绑定角色的用户id列表
2759
2468
  */
2760
2469
  UserIds: Array<string>
2761
-
2762
2470
  /**
2763
2471
  * 绑定角色的角色id列表
2764
2472
  */
2765
2473
  RoleIds: Array<string>
2766
-
2767
2474
  /**
2768
2475
  * 代理相关应用信息,如集团主企业代子企业操作的场景中ProxyOrganizationId必填
2769
2476
  */
@@ -2778,12 +2485,10 @@ export interface CreateChannelSubOrganizationModifyQrCodeResponse {
2778
2485
  * 二维码下载链接
2779
2486
  */
2780
2487
  QrCodeUrl?: string
2781
-
2782
2488
  /**
2783
2489
  * 二维码失效时间 UNIX 时间戳 精确到秒
2784
2490
  */
2785
2491
  ExpiredTime?: number
2786
-
2787
2492
  /**
2788
2493
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
2789
2494
  */
@@ -2798,12 +2503,10 @@ export interface SuccessUpdateStaffData {
2798
2503
  * 传入的用户名称
2799
2504
  */
2800
2505
  DisplayName?: string
2801
-
2802
2506
  /**
2803
2507
  * 传入的手机号
2804
2508
  */
2805
2509
  Mobile?: string
2806
-
2807
2510
  /**
2808
2511
  * 用户Id
2809
2512
  */
@@ -2815,20 +2518,18 @@ export interface SuccessUpdateStaffData {
2815
2518
  */
2816
2519
  export interface CreateFlowByFilesResponse {
2817
2520
  /**
2818
- * 签署流程编号。
2521
+ * 签署流程编号。
2819
2522
 
2820
2523
  注:如入参 是否需要预览 NeedPreview 设置为 true,不会正式发起合同,此处不会有值返回;如入参 是否需要预览 NeedPreview 设置为 false,此处会正常返回签署流程编号 FlowId。
2821
- */
2524
+ */
2822
2525
  FlowId?: string
2823
-
2824
2526
  /**
2825
- * 合同预览链接。
2527
+ * 合同预览链接。
2826
2528
 
2827
2529
  注:如入参 是否需要预览 NeedPreview 设置为 true,会开启“预览模式”,此处会返回预览链接;如入参 是否需要预览 NeedPreview 设置为 false,此处不会有值返回。
2828
2530
  注意:此字段可能返回 null,表示取不到有效值。
2829
- */
2531
+ */
2830
2532
  PreviewUrl?: string
2831
-
2832
2533
  /**
2833
2534
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
2834
2535
  */
@@ -2843,12 +2544,10 @@ export interface UploadFilesResponse {
2843
2544
  * 文件id数组
2844
2545
  */
2845
2546
  FileIds?: Array<string>
2846
-
2847
2547
  /**
2848
2548
  * 上传成功文件数量
2849
2549
  */
2850
2550
  TotalCount?: number
2851
-
2852
2551
  /**
2853
2552
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
2854
2553
  */
@@ -2863,21 +2562,18 @@ export interface SuccessCreateStaffData {
2863
2562
  * 员工名
2864
2563
  */
2865
2564
  DisplayName: string
2866
-
2867
2565
  /**
2868
2566
  * 员工手机号
2869
2567
  */
2870
2568
  Mobile: string
2871
-
2872
2569
  /**
2873
2570
  * 员工在电子签平台的id
2874
2571
  */
2875
2572
  UserId: string
2876
-
2877
2573
  /**
2878
- * 提示,当创建已存在未实名用户时,改字段有值
2574
+ * 提示,当创建已存在未实名用户时,改字段有值
2879
2575
  注意:此字段可能返回 null,表示取不到有效值。
2880
- */
2576
+ */
2881
2577
  Note?: string
2882
2578
  }
2883
2579
 
@@ -2889,62 +2585,50 @@ export interface Recipient {
2889
2585
  * 签署参与者ID
2890
2586
  */
2891
2587
  RecipientId?: string
2892
-
2893
2588
  /**
2894
2589
  * 参与者类型。默认为空。ENTERPRISE-企业;INDIVIDUAL-个人;PROMOTER-发起方
2895
2590
  */
2896
2591
  RecipientType?: string
2897
-
2898
2592
  /**
2899
2593
  * 描述信息
2900
2594
  */
2901
2595
  Description?: string
2902
-
2903
2596
  /**
2904
2597
  * 角色名称
2905
2598
  */
2906
2599
  RoleName?: string
2907
-
2908
2600
  /**
2909
2601
  * 是否需要验证,默认为false
2910
2602
  */
2911
2603
  RequireValidation?: boolean
2912
-
2913
2604
  /**
2914
2605
  * 是否需要签署,默认为true
2915
2606
  */
2916
2607
  RequireSign?: boolean
2917
-
2918
2608
  /**
2919
2609
  * 添加序列,0~N
2920
2610
  */
2921
2611
  RoutingOrder?: number
2922
-
2923
2612
  /**
2924
2613
  * 是否需要发送,默认为true
2925
2614
  */
2926
2615
  RequireDelivery?: boolean
2927
-
2928
2616
  /**
2929
2617
  * 邮箱地址
2930
2618
  */
2931
2619
  Email?: string
2932
-
2933
2620
  /**
2934
2621
  * 电话号码
2935
2622
  */
2936
2623
  Mobile?: string
2937
-
2938
2624
  /**
2939
2625
  * 关联的用户ID
2940
2626
  */
2941
2627
  UserId?: string
2942
-
2943
2628
  /**
2944
2629
  * 发送方式。默认为EMAIL。EMAIL-邮件;MOBILE-手机短信;WECHAT-微信通知
2945
2630
  */
2946
2631
  DeliveryMethod?: string
2947
-
2948
2632
  /**
2949
2633
  * 附属信息
2950
2634
  */
@@ -2959,7 +2643,6 @@ export interface VerifyPdfRequest {
2959
2643
  * 流程ID
2960
2644
  */
2961
2645
  FlowId: string
2962
-
2963
2646
  /**
2964
2647
  * 调用方用户信息,userId 必填
2965
2648
  */
@@ -2971,15 +2654,14 @@ export interface VerifyPdfRequest {
2971
2654
  */
2972
2655
  export interface FailedCreateRoleData {
2973
2656
  /**
2974
- * 用户userId
2657
+ * 用户userId
2975
2658
  注意:此字段可能返回 null,表示取不到有效值。
2976
- */
2659
+ */
2977
2660
  UserId?: string
2978
-
2979
2661
  /**
2980
- * 角色id列表
2662
+ * 角色id列表
2981
2663
  注意:此字段可能返回 null,表示取不到有效值。
2982
- */
2664
+ */
2983
2665
  RoleIds?: Array<string>
2984
2666
  }
2985
2667
 
@@ -2988,99 +2670,83 @@ export interface FailedCreateRoleData {
2988
2670
  */
2989
2671
  export interface ApproverInfo {
2990
2672
  /**
2991
- * 参与者类型:
2673
+ * 参与者类型:
2992
2674
  0:企业
2993
2675
  1:个人
2994
2676
  3:企业静默签署
2995
2677
  注:类型为3(企业静默签署)时,此接口会默认完成该签署方的签署。静默签署仅进行盖章操作,不能自动签名。
2996
- */
2678
+ */
2997
2679
  ApproverType: number
2998
-
2999
2680
  /**
3000
2681
  * 签署人的姓名
3001
2682
  */
3002
2683
  ApproverName: string
3003
-
3004
2684
  /**
3005
2685
  * 签署人的手机号,11位数字
3006
2686
  */
3007
2687
  ApproverMobile: string
3008
-
3009
2688
  /**
3010
2689
  * 签署人的签署控件列表
3011
2690
  */
3012
2691
  SignComponents: Array<Component>
3013
-
3014
2692
  /**
3015
2693
  * 如果签署方是企业签署方,则为企业名
3016
2694
  */
3017
2695
  OrganizationName?: string
3018
-
3019
2696
  /**
3020
2697
  * 签署人的身份证号
3021
2698
  */
3022
2699
  ApproverIdCardNumber?: string
3023
-
3024
2700
  /**
3025
- * 签署人的身份证件类型
2701
+ * 签署人的身份证件类型
3026
2702
  ID_CARD 身份证
3027
2703
  HONGKONG_AND_MACAO 港澳居民来往内地通行证
3028
2704
  HONGKONG_MACAO_AND_TAIWAN 港澳台居民居住证(格式同居民身份证)
3029
- */
2705
+ */
3030
2706
  ApproverIdCardType?: string
3031
-
3032
2707
  /**
3033
2708
  * 签署通知类型:sms--短信,none--不通知
3034
2709
  */
3035
2710
  NotifyType?: string
3036
-
3037
2711
  /**
3038
2712
  * 签署人角色类型:1--收款人、2--开具人、3--见证人
3039
2713
  */
3040
2714
  ApproverRole?: number
3041
-
3042
2715
  /**
3043
2716
  * 签署意愿确认渠道,默认为WEIXINAPP:人脸识别
3044
2717
  */
3045
2718
  VerifyChannel?: Array<string>
3046
-
3047
2719
  /**
3048
2720
  * 合同的强制预览时间:3~300s,未指定则按合同页数计算
3049
2721
  */
3050
2722
  PreReadTime?: number
3051
-
3052
2723
  /**
3053
2724
  * 签署人userId,传此字段则不用传姓名、手机号
3054
2725
  */
3055
2726
  UserId?: string
3056
-
3057
2727
  /**
3058
2728
  * 签署人用户来源,企微侧用户请传入:WEWORKAPP
3059
2729
  */
3060
2730
  ApproverSource?: string
3061
-
3062
2731
  /**
3063
2732
  * 客户自定义签署人标识,64位长度,保证唯一,非企微场景不使用此字段
3064
2733
  */
3065
2734
  CustomApproverTag?: string
3066
-
3067
2735
  /**
3068
2736
  * 签署人个性化能力值
3069
2737
  */
3070
2738
  ApproverOption?: ApproverOption
3071
-
3072
2739
  /**
3073
- * 签署人查看合同时认证方式,
2740
+ * 签署人查看合同时认证方式,
3074
2741
  1-实名查看 2-短信验证码查看(企业签署方不支持该方式)
3075
2742
  如果不传默认为1
3076
- */
2743
+ */
3077
2744
  ApproverVerifyTypes?: Array<number>
3078
-
3079
2745
  /**
3080
- * 签署人签署合同时的认证方式
2746
+ * 签署人签署合同时的认证方式
3081
2747
  1-人脸认证 2-签署密码 3-运营商三要素(默认为1,2)
3082
2748
  合同签署认证方式的优先级 verifyChannel>approverSignTypes
3083
- */
2749
+ */
3084
2750
  ApproverSignTypes?: Array<number>
3085
2751
  }
3086
2752
 
@@ -3102,27 +2768,22 @@ export interface ModifyIntegrationDepartmentRequest {
3102
2768
  * 操作人信息,UserId必填且需拥有组织架构管理权限
3103
2769
  */
3104
2770
  Operator: UserInfo
3105
-
3106
2771
  /**
3107
2772
  * 电子签部门ID
3108
2773
  */
3109
2774
  DeptId: string
3110
-
3111
2775
  /**
3112
2776
  * 电子签父部门ID
3113
2777
  */
3114
2778
  ParentDeptId?: string
3115
-
3116
2779
  /**
3117
2780
  * 部门名称,不超过50个字符
3118
2781
  */
3119
2782
  DeptName?: string
3120
-
3121
2783
  /**
3122
2784
  * 客户系统部门ID,不超过64个字符
3123
2785
  */
3124
2786
  DeptOpenId?: string
3125
-
3126
2787
  /**
3127
2788
  * 排序号,1~30000范围内
3128
2789
  */
@@ -3137,7 +2798,6 @@ export interface Filter {
3137
2798
  * 查询过滤条件的Key
3138
2799
  */
3139
2800
  Key: string
3140
-
3141
2801
  /**
3142
2802
  * 查询过滤条件的Value列表
3143
2803
  */
@@ -3149,15 +2809,14 @@ export interface Filter {
3149
2809
  */
3150
2810
  export interface CreateStaffResult {
3151
2811
  /**
3152
- * 创建员工的成功列表
2812
+ * 创建员工的成功列表
3153
2813
  注意:此字段可能返回 null,表示取不到有效值。
3154
- */
2814
+ */
3155
2815
  SuccessEmployeeData: Array<SuccessCreateStaffData>
3156
-
3157
2816
  /**
3158
- * 创建员工的失败列表
2817
+ * 创建员工的失败列表
3159
2818
  注意:此字段可能返回 null,表示取不到有效值。
3160
- */
2819
+ */
3161
2820
  FailedEmployeeData: Array<FailedCreateStaffData>
3162
2821
  }
3163
2822
 
@@ -3169,33 +2828,27 @@ export interface CreateUserAutoSignEnableUrlRequest {
3169
2828
  * 操作人信息,UserId必填
3170
2829
  */
3171
2830
  Operator: UserInfo
3172
-
3173
2831
  /**
3174
- * 自动签场景:
2832
+ * 自动签场景:
3175
2833
  E_PRESCRIPTION_AUTO_SIGN 电子处方
3176
- */
2834
+ */
3177
2835
  SceneKey: string
3178
-
3179
2836
  /**
3180
2837
  * 自动签开通,签署相关配置
3181
2838
  */
3182
2839
  AutoSignConfig: AutoSignConfig
3183
-
3184
2840
  /**
3185
2841
  * 链接类型,空-默认小程序端链接,H5SIGN-h5端链接
3186
2842
  */
3187
2843
  UrlType?: string
3188
-
3189
2844
  /**
3190
2845
  * 通知类型,默认不填为不通知开通方,填写 SMS 为短信通知。
3191
2846
  */
3192
2847
  NotifyType?: string
3193
-
3194
2848
  /**
3195
2849
  * 若上方填写为 SMS,则此处为手机号
3196
2850
  */
3197
2851
  NotifyAddress?: string
3198
-
3199
2852
  /**
3200
2853
  * 链接的过期时间,格式为Unix时间戳,不能早于当前时间,且最大为30天。如果不传,默认有效期为7天。
3201
2854
  */
@@ -3207,11 +2860,10 @@ E_PRESCRIPTION_AUTO_SIGN 电子处方
3207
2860
  */
3208
2861
  export interface DescribeIntegrationMainOrganizationUserResponse {
3209
2862
  /**
3210
- * 主企业员工账号信息
2863
+ * 主企业员工账号信息
3211
2864
  注意:此字段可能返回 null,表示取不到有效值。
3212
- */
2865
+ */
3213
2866
  IntegrationMainOrganizationUser?: IntegrationMainOrganizationUser
3214
-
3215
2867
  /**
3216
2868
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
3217
2869
  */
@@ -3226,12 +2878,10 @@ export interface RemindFlowRecords {
3226
2878
  * 是否能够催办,true-是,false-否
3227
2879
  */
3228
2880
  CanRemind: boolean
3229
-
3230
2881
  /**
3231
2882
  * 合同id
3232
2883
  */
3233
2884
  FlowId: string
3234
-
3235
2885
  /**
3236
2886
  * 催办详情信息
3237
2887
  */
@@ -3246,16 +2896,14 @@ export interface CancelUserAutoSignEnableUrlRequest {
3246
2896
  * 操作人信息,UseId必填
3247
2897
  */
3248
2898
  Operator: UserInfo
3249
-
3250
2899
  /**
3251
2900
  * 自动签场景: E_PRESCRIPTION_AUTO_SIGN 电子处方
3252
2901
  */
3253
2902
  SceneKey: string
3254
-
3255
2903
  /**
3256
- * 指定撤销链接的用户指定撤销链接的用户信息,包含姓名、证件类型、证件号码。
2904
+ * 指定撤销链接的用户指定撤销链接的用户信息,包含姓名、证件类型、证件号码。
3257
2905
 
3258
- */
2906
+ */
3259
2907
  UserInfo: UserThreeFactor
3260
2908
  }
3261
2909
 
@@ -3267,12 +2915,10 @@ export interface FailedCreateStaffData {
3267
2915
  * 员工名
3268
2916
  */
3269
2917
  DisplayName: string
3270
-
3271
2918
  /**
3272
2919
  * 员工手机号
3273
2920
  */
3274
2921
  Mobile: string
3275
-
3276
2922
  /**
3277
2923
  * 失败原因
3278
2924
  */
@@ -3287,17 +2933,14 @@ export interface ApproverRestriction {
3287
2933
  * 指定签署人名字
3288
2934
  */
3289
2935
  Name?: string
3290
-
3291
2936
  /**
3292
2937
  * 指定签署人手机号,11位数字
3293
2938
  */
3294
2939
  Mobile?: string
3295
-
3296
2940
  /**
3297
2941
  * 指定签署人证件类型,ID_CARD-身份证
3298
2942
  */
3299
2943
  IdCardType?: string
3300
-
3301
2944
  /**
3302
2945
  * 指定签署人证件号码,字母大写
3303
2946
  */
@@ -3312,22 +2955,18 @@ export interface DeleteSealPoliciesRequest {
3312
2955
  * 调用方用户信息,userId 必填
3313
2956
  */
3314
2957
  Operator: UserInfo
3315
-
3316
2958
  /**
3317
2959
  * 印章授权编码数组。这个参数跟下面的SealId其中一个必填,另外一个可选填
3318
2960
  */
3319
2961
  PolicyIds?: Array<string>
3320
-
3321
2962
  /**
3322
2963
  * 印章ID。这个参数跟上面的PolicyIds其中一个必填,另外一个可选填
3323
2964
  */
3324
2965
  SealId?: string
3325
-
3326
2966
  /**
3327
2967
  * 待授权的员工ID
3328
2968
  */
3329
2969
  UserIds?: Array<string>
3330
-
3331
2970
  /**
3332
2971
  * 代理相关应用信息,如集团主企业代子企业操作的场景中ProxyOrganizationId必填
3333
2972
  */
@@ -3342,111 +2981,92 @@ export interface CreateFlowByFilesRequest {
3342
2981
  * 调用方用户信息,userId 必填。支持填入集团子公司经办人 userId 代发合同
3343
2982
  */
3344
2983
  Operator: UserInfo
3345
-
3346
2984
  /**
3347
2985
  * 签署流程名称,最大长度200个字符
3348
2986
  */
3349
2987
  FlowName: string
3350
-
3351
2988
  /**
3352
2989
  * 签署参与者信息,最大限制50方
3353
2990
  */
3354
2991
  Approvers: Array<ApproverInfo>
3355
-
3356
2992
  /**
3357
2993
  * 签署pdf文件的资源编号列表,通过UploadFiles接口获取,暂时仅支持单文件发起
3358
2994
  */
3359
2995
  FileIds: Array<string>
3360
-
3361
2996
  /**
3362
2997
  * 签署流程的类型(如销售合同/入职合同等),最大长度200个字符
3363
2998
  */
3364
2999
  FlowType?: string
3365
-
3366
3000
  /**
3367
3001
  * 经办人内容控件配置
3368
3002
  */
3369
3003
  Components?: Array<Component>
3370
-
3371
3004
  /**
3372
- * 被抄送人的信息列表。
3005
+ * 被抄送人的信息列表。
3373
3006
  注:此功能为白名单功能,若有需要,请联系电子签客服开白使用
3374
- */
3007
+ */
3375
3008
  CcInfos?: Array<CcInfo>
3376
-
3377
3009
  /**
3378
- * 是否需要预览,true:预览模式,false:非预览(默认);
3010
+ * 是否需要预览,true:预览模式,false:非预览(默认);
3379
3011
  预览链接有效期300秒;
3380
3012
 
3381
3013
  注:如果使用“预览模式”,出参会返回合同预览链接 PreviewUrl,不会正式发起合同,且出参不会返回签署流程编号 FlowId;如果使用“非预览”,则会正常返回签署流程编号 FlowId,不会生成合同预览链接 PreviewUrl。
3382
- */
3014
+ */
3383
3015
  NeedPreview?: boolean
3384
-
3385
3016
  /**
3386
3017
  * 预览链接类型 默认:0-文件流, 1- H5链接 注意:此参数在NeedPreview 为true 时有效,
3387
3018
  */
3388
3019
  PreviewType?: number
3389
-
3390
3020
  /**
3391
- * 签署流程的签署截止时间。
3021
+ * 签署流程的签署截止时间。
3392
3022
  值为unix时间戳,精确到秒,不传默认为当前时间一年后
3393
- */
3023
+ */
3394
3024
  Deadline?: number
3395
-
3396
3025
  /**
3397
- * 发送类型:
3026
+ * 发送类型:
3398
3027
  true:无序签
3399
3028
  false:有序签
3400
3029
  注:默认为false(有序签)
3401
- */
3030
+ */
3402
3031
  Unordered?: boolean
3403
-
3404
3032
  /**
3405
3033
  * 合同显示的页卡模板,说明:只支持{合同名称}, {发起方企业}, {发起方姓名}, {签署方N企业}, {签署方N姓名},且N不能超过签署人的数量,N从1开始
3406
3034
  */
3407
3035
  CustomShowMap?: string
3408
-
3409
3036
  /**
3410
- * 发起方企业的签署人进行签署操作是否需要企业内部审批。使用此功能需要发起方企业有参与签署。
3037
+ * 发起方企业的签署人进行签署操作是否需要企业内部审批。使用此功能需要发起方企业有参与签署。
3411
3038
  若设置为true,审核结果需通过接口 CreateFlowSignReview 通知电子签,审核通过后,发起方企业签署人方可进行签署操作,否则会阻塞其签署操作。
3412
3039
 
3413
3040
  注:企业可以通过此功能与企业内部的审批流程进行关联,支持手动、静默签署合同。
3414
- */
3041
+ */
3415
3042
  NeedSignReview?: boolean
3416
-
3417
3043
  /**
3418
3044
  * 用户自定义字段,回调的时候会进行透传,长度需要小于20480
3419
3045
  */
3420
3046
  UserData?: string
3421
-
3422
3047
  /**
3423
- * 签署人校验方式
3048
+ * 签署人校验方式
3424
3049
  VerifyCheck: 人脸识别(默认)
3425
3050
  MobileCheck:手机号验证
3426
3051
  参数说明:可选人脸识别或手机号验证两种方式,若选择后者,未实名个人签署方在签署合同时,无需经过实名认证和意愿确认两次人脸识别,该能力仅适用于个人签署方。
3427
- */
3052
+ */
3428
3053
  ApproverVerifyType?: string
3429
-
3430
3054
  /**
3431
3055
  * 签署流程描述,最大长度1000个字符
3432
3056
  */
3433
3057
  FlowDescription?: string
3434
-
3435
3058
  /**
3436
3059
  * 标识是否允许发起后添加控件。0为不允许1为允许。如果为1,创建的时候不能有签署控件,只能创建后添加。注意发起后添加控件功能不支持添加骑缝章和签批控件
3437
3060
  */
3438
3061
  SignBeanTag?: number
3439
-
3440
3062
  /**
3441
3063
  * 代理相关应用信息,如集团主企业代子企业操作的场景中ProxyOrganizationId必填
3442
3064
  */
3443
3065
  Agent?: Agent
3444
-
3445
3066
  /**
3446
3067
  * 给关注人发送短信通知的类型,0-合同发起时通知 1-签署完成后通知
3447
3068
  */
3448
3069
  CcNotifyType?: number
3449
-
3450
3070
  /**
3451
3071
  * 个人自动签场景。发起自动签署时,需设置对应自动签署场景,目前仅支持场景:处方单-E_PRESCRIPTION_AUTO_SIGN
3452
3072
  */
@@ -3458,33 +3078,29 @@ MobileCheck:手机号验证
3458
3078
  */
3459
3079
  export interface IntegrateRole {
3460
3080
  /**
3461
- * 角色id
3081
+ * 角色id
3462
3082
  注意:此字段可能返回 null,表示取不到有效值。
3463
- */
3083
+ */
3464
3084
  RoleId?: string
3465
-
3466
3085
  /**
3467
- * 角色名
3086
+ * 角色名
3468
3087
  注意:此字段可能返回 null,表示取不到有效值。
3469
- */
3088
+ */
3470
3089
  RoleName?: string
3471
-
3472
3090
  /**
3473
- * 角色状态,1-启用,2-禁用
3091
+ * 角色状态,1-启用,2-禁用
3474
3092
  注意:此字段可能返回 null,表示取不到有效值。
3475
- */
3093
+ */
3476
3094
  RoleStatus?: number
3477
-
3478
3095
  /**
3479
- * 是否是集团角色,true-是,false-否
3096
+ * 是否是集团角色,true-是,false-否
3480
3097
  注意:此字段可能返回 null,表示取不到有效值。
3481
- */
3098
+ */
3482
3099
  IsGroupRole?: boolean
3483
-
3484
3100
  /**
3485
- * 管辖的子企业列表
3101
+ * 管辖的子企业列表
3486
3102
  注意:此字段可能返回 null,表示取不到有效值。
3487
- */
3103
+ */
3488
3104
  SubOrgIdList?: Array<string>
3489
3105
  }
3490
3106
 
@@ -3496,7 +3112,6 @@ export interface CreatePrepareFlowResponse {
3496
3112
  * 快速发起预览链接,有效期5分钟
3497
3113
  */
3498
3114
  Url?: string
3499
-
3500
3115
  /**
3501
3116
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
3502
3117
  */
@@ -3511,34 +3126,30 @@ export interface GetTaskResultApiResponse {
3511
3126
  * 任务Id
3512
3127
  */
3513
3128
  TaskId?: string
3514
-
3515
3129
  /**
3516
- * 任务状态,需要关注的状态
3130
+ * 任务状态,需要关注的状态
3517
3131
  0 :NeedTranform - 任务已提交
3518
3132
  4 :Processing - 文档转换中
3519
3133
  8 :TaskEnd - 任务处理完成
3520
3134
  -2 :DownloadFailed - 下载失败
3521
3135
  -6 :ProcessFailed - 转换失败
3522
3136
  -13:ProcessTimeout - 转换文件超时
3523
- */
3137
+ */
3524
3138
  TaskStatus?: number
3525
-
3526
3139
  /**
3527
- * 状态描述,需要关注的状态
3140
+ * 状态描述,需要关注的状态
3528
3141
  NeedTranform - 任务已提交
3529
3142
  Processing - 文档转换中
3530
3143
  TaskEnd - 任务处理完成
3531
3144
  DownloadFailed - 下载失败
3532
3145
  ProcessFailed - 转换失败
3533
3146
  ProcessTimeout - 转换文件超时
3534
- */
3147
+ */
3535
3148
  TaskMessage?: string
3536
-
3537
3149
  /**
3538
3150
  * 资源Id,也是FileId,用于文件发起使用
3539
3151
  */
3540
3152
  ResourceId?: string
3541
-
3542
3153
  /**
3543
3154
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
3544
3155
  */
@@ -3553,12 +3164,10 @@ export interface CancelMultiFlowSignQRCodeRequest {
3553
3164
  * 调用方用户信息,userId 必填
3554
3165
  */
3555
3166
  Operator: UserInfo
3556
-
3557
3167
  /**
3558
3168
  * 二维码id
3559
3169
  */
3560
3170
  QrCodeId: string
3561
-
3562
3171
  /**
3563
3172
  * 代理相关应用信息,如集团主企业代子企业操作的场景中ProxyOrganizationId必填
3564
3173
  */
@@ -3573,12 +3182,10 @@ export interface DeleteIntegrationDepartmentRequest {
3573
3182
  * 操作人信息,UserId必填且需拥有组织架构管理权限
3574
3183
  */
3575
3184
  Operator: UserInfo
3576
-
3577
3185
  /**
3578
3186
  * 电子签中的部门id
3579
3187
  */
3580
3188
  DeptId: string
3581
-
3582
3189
  /**
3583
3190
  * 交接部门ID。待删除部门中的合同、印章和模版数据,交接至该部门ID下,未填写交接至公司根部门。
3584
3191
  */
@@ -3593,12 +3200,10 @@ export interface ModifyApplicationCallbackInfoRequest {
3593
3200
  * 调用方用户信息,userId 必填
3594
3201
  */
3595
3202
  Operator: UserInfo
3596
-
3597
3203
  /**
3598
3204
  * 操作类型:1-新增,2-删除
3599
3205
  */
3600
3206
  OperateType: number
3601
-
3602
3207
  /**
3603
3208
  * 回调信息
3604
3209
  */
@@ -3610,21 +3215,19 @@ export interface ModifyApplicationCallbackInfoRequest {
3610
3215
  */
3611
3216
  export interface IntegrationMainOrganizationUser {
3612
3217
  /**
3613
- * 主企业id
3218
+ * 主企业id
3614
3219
  注意:此字段可能返回 null,表示取不到有效值。
3615
- */
3220
+ */
3616
3221
  MainOrganizationId?: string
3617
-
3618
3222
  /**
3619
- * 主企业员工UserId
3223
+ * 主企业员工UserId
3620
3224
  注意:此字段可能返回 null,表示取不到有效值。
3621
- */
3225
+ */
3622
3226
  MainUserId?: string
3623
-
3624
3227
  /**
3625
- * 主企业员工名
3228
+ * 主企业员工名
3626
3229
  注意:此字段可能返回 null,表示取不到有效值。
3627
- */
3230
+ */
3628
3231
  UserName?: string
3629
3232
  }
3630
3233
 
@@ -3636,22 +3239,18 @@ export interface StartFlowRequest {
3636
3239
  * 调用方用户信息,userId 必填。支持填入集团子公司经办人 userId代发合同。
3637
3240
  */
3638
3241
  Operator: UserInfo
3639
-
3640
3242
  /**
3641
3243
  * 签署流程编号,由CreateFlow接口返回
3642
3244
  */
3643
3245
  FlowId: string
3644
-
3645
3246
  /**
3646
3247
  * 客户端Token,保持接口幂等性,最大长度64个字符
3647
3248
  */
3648
3249
  ClientToken?: string
3649
-
3650
3250
  /**
3651
3251
  * 代理相关应用信息,如集团主企业代子企业操作的场景中ProxyOrganizationId必填
3652
3252
  */
3653
3253
  Agent?: Agent
3654
-
3655
3254
  /**
3656
3255
  * 给关注人发送短信通知的类型,0-合同发起时通知 1-签署完成后通知
3657
3256
  */
@@ -3666,38 +3265,31 @@ export interface CreatePrepareFlowRequest {
3666
3265
  * 调用方用户信息,userId 必填
3667
3266
  */
3668
3267
  Operator: UserInfo
3669
-
3670
3268
  /**
3671
3269
  * 资源Id,通过多文件上传(UploadFiles)接口获得
3672
3270
  */
3673
3271
  ResourceId: string
3674
-
3675
3272
  /**
3676
3273
  * 合同名称
3677
3274
  */
3678
3275
  FlowName: string
3679
-
3680
3276
  /**
3681
3277
  * 是否顺序签署(true:无序签,false:顺序签)
3682
3278
  */
3683
3279
  Unordered?: boolean
3684
-
3685
3280
  /**
3686
- * 签署流程的签署截止时间。
3281
+ * 签署流程的签署截止时间。
3687
3282
  值为unix时间戳,精确到秒,不传默认为当前时间一年后
3688
- */
3283
+ */
3689
3284
  Deadline?: number
3690
-
3691
3285
  /**
3692
3286
  * 用户自定义合同类型
3693
3287
  */
3694
3288
  UserFlowTypeId?: string
3695
-
3696
3289
  /**
3697
3290
  * 签署流程参与者信息,最大限制50方
3698
3291
  */
3699
3292
  Approvers?: Array<FlowCreateApprover>
3700
-
3701
3293
  /**
3702
3294
  * 打开智能添加填写区(默认开启,打开:"OPEN" 关闭:"CLOSE")
3703
3295
  */
@@ -3712,7 +3304,6 @@ export interface ApproverOption {
3712
3304
  * 是否可以拒签 false-可以拒签,默认 true-不可以拒签
3713
3305
  */
3714
3306
  NoRefuse?: boolean
3715
-
3716
3307
  /**
3717
3308
  * 是否可以转发 false-可以转发,默认 true-不可以转发
3718
3309
  */
@@ -3727,11 +3318,10 @@ export interface FileUrl {
3727
3318
  * 下载文件的URL,有效期为输入的UrlTtl,默认5分钟
3728
3319
  */
3729
3320
  Url: string
3730
-
3731
3321
  /**
3732
- * 下载文件的附加信息。如果是pdf文件,会返回pdf文件每页的有效高宽
3322
+ * 下载文件的附加信息。如果是pdf文件,会返回pdf文件每页的有效高宽
3733
3323
  注意:此字段可能返回 null,表示取不到有效值。
3734
- */
3324
+ */
3735
3325
  Option: string
3736
3326
  }
3737
3327
 
@@ -3743,32 +3333,26 @@ export interface CreateSealPolicyRequest {
3743
3333
  * 调用方用户信息,userId 必填
3744
3334
  */
3745
3335
  Operator: UserInfo
3746
-
3747
3336
  /**
3748
3337
  * 用户在电子文件签署平台标识信息,具体参考UserInfo结构体。可跟下面的UserIds可叠加起作用
3749
3338
  */
3750
3339
  Users: Array<UserInfo>
3751
-
3752
3340
  /**
3753
3341
  * 印章ID
3754
3342
  */
3755
3343
  SealId: string
3756
-
3757
3344
  /**
3758
3345
  * 授权有效期。时间戳秒级
3759
3346
  */
3760
3347
  Expired: number
3761
-
3762
3348
  /**
3763
3349
  * 需要授权的用户UserId集合。跟上面的SealId参数配合使用。选填,跟上面的Users同时起作用
3764
3350
  */
3765
3351
  UserIds?: Array<string>
3766
-
3767
3352
  /**
3768
3353
  * 印章授权内容
3769
3354
  */
3770
3355
  Policy?: string
3771
-
3772
3356
  /**
3773
3357
  * 代理相关应用信息,如集团主企业代子企业操作的场景中ProxyOrganizationId必填
3774
3358
  */
@@ -3783,38 +3367,32 @@ export interface DescribeOrganizationSealsRequest {
3783
3367
  * 调用方用户信息,userId 必填
3784
3368
  */
3785
3369
  Operator: UserInfo
3786
-
3787
3370
  /**
3788
3371
  * 返回最大数量,最大为100
3789
3372
  */
3790
3373
  Limit: number
3791
-
3792
3374
  /**
3793
3375
  * 偏移量,默认为0,最大为20000
3794
3376
  */
3795
3377
  Offset?: number
3796
-
3797
3378
  /**
3798
3379
  * 查询信息类型,为0时不返回授权用户,为1时返回
3799
3380
  */
3800
3381
  InfoType?: number
3801
-
3802
3382
  /**
3803
3383
  * 印章id(没有输入返回所有)
3804
3384
  */
3805
3385
  SealId?: string
3806
-
3807
3386
  /**
3808
- * 印章类型列表(都是组织机构印章)。
3387
+ * 印章类型列表(都是组织机构印章)。
3809
3388
  为空时查询所有类型的印章。
3810
3389
  目前支持以下类型:
3811
3390
  OFFICIAL:企业公章;
3812
3391
  CONTRACT:合同专用章;
3813
3392
  ORGANIZATION_SEAL:企业印章(图片上传创建);
3814
3393
  LEGAL_PERSON_SEAL:法定代表人章
3815
- */
3394
+ */
3816
3395
  SealTypes?: Array<string>
3817
-
3818
3396
  /**
3819
3397
  * 代理相关应用信息,如集团主企业代子企业操作的场景中ProxyOrganizationId必填
3820
3398
  */
@@ -3829,17 +3407,14 @@ export interface CancelFlowRequest {
3829
3407
  * 调用方用户信息,userId 必填
3830
3408
  */
3831
3409
  Operator: UserInfo
3832
-
3833
3410
  /**
3834
3411
  * 签署流程id
3835
3412
  */
3836
3413
  FlowId: string
3837
-
3838
3414
  /**
3839
3415
  * 撤销原因,最长200个字符;
3840
3416
  */
3841
3417
  CancelMessage: string
3842
-
3843
3418
  /**
3844
3419
  * 代理相关应用信息,如集团主企业代子企业操作的场景中ProxyOrganizationId必填
3845
3420
  */
@@ -3854,7 +3429,6 @@ export interface UploadFile {
3854
3429
  * Base64编码后的文件内容
3855
3430
  */
3856
3431
  FileBody: string
3857
-
3858
3432
  /**
3859
3433
  * 文件名,最大长度不超过200字符
3860
3434
  */
@@ -3866,7 +3440,7 @@ export interface UploadFile {
3866
3440
  */
3867
3441
  export interface Component {
3868
3442
  /**
3869
- * 如果是Component填写控件类型,则可选的字段为:
3443
+ * 如果是Component填写控件类型,则可选的字段为:
3870
3444
  TEXT - 普通文本控件,输入文本字符串;
3871
3445
  MULTI_LINE_TEXT - 多行文本控件,输入文本字符串;
3872
3446
  CHECK_BOX - 勾选框控件,若选中填写ComponentValue 填写 true或者 false 字符串;
@@ -3887,61 +3461,50 @@ SIGN_OPINION - 签署意见控件,用户需要根据配置的签署意见内
3887
3461
  SIGN_LEGAL_PERSON_SEAL - 企业法定代表人控件。
3888
3462
 
3889
3463
  表单域的控件不能作为印章和签名控件
3890
- */
3464
+ */
3891
3465
  ComponentType: string
3892
-
3893
3466
  /**
3894
3467
  * 控件所属文件的序号(取值为:0-N)。目前单文件的情况下,值是0
3895
3468
  */
3896
3469
  FileIndex: number
3897
-
3898
3470
  /**
3899
3471
  * 参数控件高度,单位pt
3900
3472
  */
3901
3473
  ComponentHeight: number
3902
-
3903
3474
  /**
3904
3475
  * 参数控件宽度,单位pt
3905
3476
  */
3906
3477
  ComponentWidth: number
3907
-
3908
3478
  /**
3909
3479
  * 参数控件所在页码,取值为:1-N
3910
3480
  */
3911
3481
  ComponentPage: number
3912
-
3913
3482
  /**
3914
3483
  * 参数控件X位置,单位pt
3915
3484
  */
3916
3485
  ComponentPosX: number
3917
-
3918
3486
  /**
3919
3487
  * 参数控件Y位置,单位pt
3920
3488
  */
3921
3489
  ComponentPosY: number
3922
-
3923
3490
  /**
3924
3491
  * 查询时返回控件唯一Id。使用文件发起合同时用于GenerateMode==KEYWORD 指定关键字
3925
3492
  */
3926
3493
  ComponentId?: string
3927
-
3928
3494
  /**
3929
3495
  * 查询时返回控件名。使用文件发起合同时用于GenerateMode==FIELD 指定表单域名称
3930
3496
  */
3931
3497
  ComponentName?: string
3932
-
3933
3498
  /**
3934
3499
  * 是否必选,默认为false
3935
3500
  */
3936
3501
  ComponentRequired?: boolean
3937
-
3938
3502
  /**
3939
3503
  * 控件关联的签署人ID
3940
3504
  */
3941
3505
  ComponentRecipientId?: string
3942
-
3943
3506
  /**
3944
- * 扩展参数:
3507
+ * 扩展参数:
3945
3508
  为JSON格式。
3946
3509
 
3947
3510
  ComponentType为FILL_IMAGE时,支持以下参数:
@@ -3967,16 +3530,14 @@ ComponentType为SIGN_DATE时,支持以下参数:
3967
3530
  如果extra参数为空,默认为”yyyy年m月d日”格式的居中日期
3968
3531
  特别地,如果extra中Format字段为空或无法被识别,则extra参数会被当作默认值处理(Font,FontSize,Gaps和FontAlign都不会起效)
3969
3532
  参数样例: "ComponentExtra": "{\"Format\":“yyyy m d”,\"FontSize\":12,\"Gaps\":\"2,2\", \"FontAlign\":\"Right\"}",
3970
- */
3533
+ */
3971
3534
  ComponentExtra?: string
3972
-
3973
3535
  /**
3974
3536
  * 是否是表单域类型,默认不false-不是
3975
3537
  */
3976
3538
  IsFormType?: boolean
3977
-
3978
3539
  /**
3979
- * 控件填充vaule,ComponentType和传入值类型对应关系:
3540
+ * 控件填充vaule,ComponentType和传入值类型对应关系:
3980
3541
  TEXT - 文本内容
3981
3542
  MULTI_LINE_TEXT - 文本内容
3982
3543
  CHECK_BOX - true/false
@@ -4052,57 +3613,47 @@ SIGN_PAGING_SEAL - 可以指定印章ID,于控制台查询获取
4052
3613
 
4053
3614
  学历控件:
4054
3615
  同单行文本控件约束,填写选择值中的字符串
4055
- */
3616
+ */
4056
3617
  ComponentValue?: string
4057
-
4058
3618
  /**
4059
- * NORMAL 正常模式,使用坐标制定签署控件位置
3619
+ * NORMAL 正常模式,使用坐标制定签署控件位置
4060
3620
  FIELD 表单域,需使用ComponentName指定表单域名称
4061
3621
  KEYWORD 关键字,使用ComponentId指定关键字
4062
- */
3622
+ */
4063
3623
  GenerateMode?: string
4064
-
4065
3624
  /**
4066
3625
  * 日期签署控件的字号,默认为 12
4067
3626
  */
4068
3627
  ComponentDateFontSize?: number
4069
-
4070
3628
  /**
4071
3629
  * 第三方应用集成平台模板控件 id 标识
4072
3630
  */
4073
3631
  ChannelComponentId?: string
4074
-
4075
3632
  /**
4076
3633
  * 指定关键字时横坐标偏移量,单位pt
4077
3634
  */
4078
3635
  OffsetX?: number
4079
-
4080
3636
  /**
4081
3637
  * 指定关键字时纵坐标偏移量,单位pt
4082
3638
  */
4083
3639
  OffsetY?: number
4084
-
4085
3640
  /**
4086
3641
  * 第三方应用集成中子客企业控件来源。0-平台指定;1-用户自定义
4087
3642
  */
4088
3643
  ChannelComponentSource?: number
4089
-
4090
3644
  /**
4091
- * 指定关键字排序规则,Positive-正序,Reverse-倒序。传入Positive时会根据关键字在PDF文件内的顺序进行排列。在指定KeywordIndexes时,0代表在PDF内查找内容时,查找到的第一个关键字。
3645
+ * 指定关键字排序规则,Positive-正序,Reverse-倒序。传入Positive时会根据关键字在PDF文件内的顺序进行排列。在指定KeywordIndexes时,0代表在PDF内查找内容时,查找到的第一个关键字。
4092
3646
  传入Reverse时会根据关键字在PDF文件内的反序进行排列。在指定KeywordIndexes时,0代表在PDF内查找内容时,查找到的最后一个关键字。
4093
- */
3647
+ */
4094
3648
  KeywordOrder?: string
4095
-
4096
3649
  /**
4097
3650
  * 指定关键字页码,可选参数,指定页码后,将只在指定的页码内查找关键字,非该页码的关键字将不会查询出来
4098
3651
  */
4099
3652
  KeywordPage?: number
4100
-
4101
3653
  /**
4102
3654
  * 关键字位置模式,Middle-居中,Below-正下方,Right-正右方,LowerRight-右上角,UpperRight-右下角。示例:如果设置Middle的关键字盖章,则印章的中心会和关键字的中心重合,如果设置Below,则印章在关键字的正下方
4103
3655
  */
4104
3656
  RelativeLocation?: string
4105
-
4106
3657
  /**
4107
3658
  * 关键字索引,可选参数,如果一个关键字在PDF文件中存在多个,可以通过关键字索引指定使用第几个关键字作为最后的结果,可指定多个索引。示例:[0,2],说明使用PDF文件内第1个和第3个关键字位置。
4108
3659
  */
@@ -4114,33 +3665,29 @@ KEYWORD 关键字,使用ComponentId指定关键字
4114
3665
  */
4115
3666
  export interface IntegrationDepartment {
4116
3667
  /**
4117
- * 部门ID
3668
+ * 部门ID
4118
3669
  注意:此字段可能返回 null,表示取不到有效值。
4119
- */
3670
+ */
4120
3671
  DeptId?: string
4121
-
4122
3672
  /**
4123
- * 部门名
3673
+ * 部门名
4124
3674
  注意:此字段可能返回 null,表示取不到有效值。
4125
- */
3675
+ */
4126
3676
  DeptName?: string
4127
-
4128
3677
  /**
4129
- * 父部门ID
3678
+ * 父部门ID
4130
3679
  注意:此字段可能返回 null,表示取不到有效值。
4131
- */
3680
+ */
4132
3681
  ParentDeptId?: string
4133
-
4134
3682
  /**
4135
- * 客户系统部门ID
3683
+ * 客户系统部门ID
4136
3684
  注意:此字段可能返回 null,表示取不到有效值。
4137
- */
3685
+ */
4138
3686
  DeptOpenId?: string
4139
-
4140
3687
  /**
4141
- * 序列号
3688
+ * 序列号
4142
3689
  注意:此字段可能返回 null,表示取不到有效值。
4143
- */
3690
+ */
4144
3691
  OrderNo?: number
4145
3692
  }
4146
3693
 
@@ -4152,22 +3699,18 @@ export interface DescribeIntegrationRolesResponse {
4152
3699
  * 偏移量,默认为0,最大为2000
4153
3700
  */
4154
3701
  Offset?: number
4155
-
4156
3702
  /**
4157
3703
  * 返回最大数量,最大为200
4158
3704
  */
4159
3705
  Limit?: number
4160
-
4161
3706
  /**
4162
3707
  * 符合查询条件的总的角色数
4163
3708
  */
4164
3709
  TotalCount?: number
4165
-
4166
3710
  /**
4167
3711
  * 企业角色信息列表
4168
3712
  */
4169
3713
  IntegrateRoles?: Array<IntegrateRole>
4170
-
4171
3714
  /**
4172
3715
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
4173
3716
  */
@@ -4182,7 +3725,6 @@ export interface CreateFlowRemindsRequest {
4182
3725
  * 调用方用户信息,userId 必填
4183
3726
  */
4184
3727
  Operator: UserInfo
4185
-
4186
3728
  /**
4187
3729
  * 需要执行催办的签署流程id数组,最多100个
4188
3730
  */
@@ -4197,12 +3739,10 @@ export interface UpdateIntegrationEmployeesRequest {
4197
3739
  * 操作人信息
4198
3740
  */
4199
3741
  Operator: UserInfo
4200
-
4201
3742
  /**
4202
3743
  * 员工信息
4203
3744
  */
4204
3745
  Employees: Array<Staff>
4205
-
4206
3746
  /**
4207
3747
  * 代理相关应用信息,如集团主企业代子企业操作的场景中ProxyOrganizationId需填充子企业Id
4208
3748
  */
@@ -4217,12 +3757,10 @@ export interface DescribeFlowBriefsRequest {
4217
3757
  * 调用方用户信息,userId 必填
4218
3758
  */
4219
3759
  Operator: UserInfo
4220
-
4221
3760
  /**
4222
3761
  * 需要查询的流程ID列表,限制最大100个
4223
3762
  */
4224
3763
  FlowIds: Array<string>
4225
-
4226
3764
  /**
4227
3765
  * 代理相关应用信息,如集团主企业代子企业操作的场景中ProxyOrganizationId必填
4228
3766
  */
@@ -4237,7 +3775,6 @@ export interface DeleteIntegrationEmployeesResponse {
4237
3775
  * 员工删除数据
4238
3776
  */
4239
3777
  DeleteEmployeeResult?: DeleteStaffsResult
4240
-
4241
3778
  /**
4242
3779
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
4243
3780
  */
@@ -4252,12 +3789,10 @@ export interface SignUrl {
4252
3789
  * 小程序签署链接
4253
3790
  */
4254
3791
  AppSignUrl: string
4255
-
4256
3792
  /**
4257
3793
  * 签署链接有效时间
4258
3794
  */
4259
3795
  EffectiveTime: string
4260
-
4261
3796
  /**
4262
3797
  * 移动端签署链接
4263
3798
  */
@@ -4272,17 +3807,14 @@ export interface VerifyPdfResponse {
4272
3807
  * 验签结果,1-文件未被篡改,全部签名在腾讯电子签完成; 2-文件未被篡改,部分签名在腾讯电子签完成;3-文件被篡改;4-异常:文件内没有签名域;5-异常:文件签名格式错误
4273
3808
  */
4274
3809
  VerifyResult?: number
4275
-
4276
3810
  /**
4277
3811
  * 验签结果详情,内部状态1-验签成功,在电子签签署;2-验签成功,在其他平台签署;3-验签失败;4-pdf文件没有签名域;5-文件签名格式错误
4278
3812
  */
4279
3813
  PdfVerifyResults?: Array<PdfVerifyResult>
4280
-
4281
3814
  /**
4282
3815
  * 验签序列号
4283
3816
  */
4284
3817
  VerifySerialNo?: string
4285
-
4286
3818
  /**
4287
3819
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
4288
3820
  */
@@ -4294,15 +3826,14 @@ export interface VerifyPdfResponse {
4294
3826
  */
4295
3827
  export interface DeleteStaffsResult {
4296
3828
  /**
4297
- * 删除员工的成功数据
3829
+ * 删除员工的成功数据
4298
3830
  注意:此字段可能返回 null,表示取不到有效值。
4299
- */
3831
+ */
4300
3832
  SuccessEmployeeData: Array<SuccessDeleteStaffData>
4301
-
4302
3833
  /**
4303
- * 删除员工的失败数据
3834
+ * 删除员工的失败数据
4304
3835
  注意:此字段可能返回 null,表示取不到有效值。
4305
- */
3836
+ */
4306
3837
  FailedEmployeeData: Array<FailedDeleteStaffData>
4307
3838
  }
4308
3839
 
@@ -4314,7 +3845,6 @@ export interface DescribeFlowBriefsResponse {
4314
3845
  * 流程列表
4315
3846
  */
4316
3847
  FlowBriefs?: Array<FlowBrief>
4317
-
4318
3848
  /**
4319
3849
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
4320
3850
  */
@@ -4326,15 +3856,14 @@ export interface DescribeFlowBriefsResponse {
4326
3856
  */
4327
3857
  export interface Admin {
4328
3858
  /**
4329
- * 超管名
3859
+ * 超管名
4330
3860
  注意:此字段可能返回 null,表示取不到有效值。
4331
- */
3861
+ */
4332
3862
  Name?: string
4333
-
4334
3863
  /**
4335
- * 超管手机号
3864
+ * 超管手机号
4336
3865
  注意:此字段可能返回 null,表示取不到有效值。
4337
- */
3866
+ */
4338
3867
  Mobile?: string
4339
3868
  }
4340
3869
 
@@ -4344,21 +3873,21 @@ export interface Admin {
4344
3873
  export interface Caller {
4345
3874
  /**
4346
3875
  * 应用号
3876
+ * @deprecated
4347
3877
  */
4348
3878
  ApplicationId?: string
4349
-
4350
3879
  /**
4351
3880
  * 主机构ID
3881
+ * @deprecated
4352
3882
  */
4353
3883
  OrganizationId?: string
4354
-
4355
3884
  /**
4356
3885
  * 经办人的用户ID,同UserId
4357
3886
  */
4358
3887
  OperatorId?: string
4359
-
4360
3888
  /**
4361
3889
  * 下属机构ID
3890
+ * @deprecated
4362
3891
  */
4363
3892
  SubOrganizationId?: string
4364
3893
  }
@@ -4371,12 +3900,10 @@ export interface DescribeFlowTemplatesResponse {
4371
3900
  * 模板详情列表
4372
3901
  */
4373
3902
  Templates?: Array<TemplateInfo>
4374
-
4375
3903
  /**
4376
3904
  * 查询到的总数
4377
3905
  */
4378
3906
  TotalCount?: number
4379
-
4380
3907
  /**
4381
3908
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
4382
3909
  */
@@ -4388,43 +3915,38 @@ export interface DescribeFlowTemplatesResponse {
4388
3915
  */
4389
3916
  export interface UploadFilesRequest {
4390
3917
  /**
4391
- * 文件对应业务类型
3918
+ * 文件对应业务类型
4392
3919
  1. TEMPLATE - 模板; 文件类型:.pdf/.doc/.docx/.html
4393
3920
  2. DOCUMENT - 签署过程及签署后的合同文档/图片控件 文件类型:.pdf/.doc/.docx/.jpg/.png/.xls.xlsx/.html
4394
3921
  3. SEAL - 印章; 文件类型:.jpg/.jpeg/.png
4395
- */
3922
+ */
4396
3923
  BusinessType: string
4397
-
4398
3924
  /**
4399
3925
  * 调用方信息,其中OperatorId为必填字段,即用户的UserId
4400
3926
  */
4401
3927
  Caller?: Caller
4402
-
4403
3928
  /**
4404
3929
  * 上传文件内容数组,最多支持20个文件
4405
3930
  */
4406
3931
  FileInfos?: Array<UploadFile>
4407
-
4408
3932
  /**
4409
- * 文件类型, 默认通过文件内容解析得到文件类型,客户可以显示的说明上传文件的类型。
3933
+ * 文件类型, 默认通过文件内容解析得到文件类型,客户可以显示的说明上传文件的类型。
4410
3934
  如:PDF 表示上传的文件 xxx.pdf的文件类型是 PDF
4411
- */
3935
+ */
4412
3936
  FileType?: string
4413
-
4414
3937
  /**
4415
- * 此参数只对 PDF 文件有效。是否将pdf灰色矩阵置白
3938
+ * 此参数只对 PDF 文件有效。是否将pdf灰色矩阵置白
4416
3939
  true--是,处理置白
4417
3940
  默认为false--否,不处理
4418
- */
3941
+ */
4419
3942
  CoverRect?: boolean
4420
-
4421
3943
  /**
4422
3944
  * 用户自定义ID数组,与上传文件一一对应
4423
3945
  */
4424
3946
  CustomIds?: Array<string>
4425
-
4426
3947
  /**
4427
3948
  * 不再使用,上传文件链接数组,最多支持20个URL
3949
+ * @deprecated
4428
3950
  */
4429
3951
  FileUrls?: string
4430
3952
  }
@@ -4437,29 +3959,25 @@ export interface RelieveInfo {
4437
3959
  * 解除理由,最大支持200个字
4438
3960
  */
4439
3961
  Reason: string
4440
-
4441
3962
  /**
4442
- * 解除后仍然有效的条款,保留条款,最大支持200个字
3963
+ * 解除后仍然有效的条款,保留条款,最大支持200个字
4443
3964
 
4444
- */
3965
+ */
4445
3966
  RemainInForceItem?: string
4446
-
4447
3967
  /**
4448
- * 原合同事项处理-费用结算,最大支持200个字
3968
+ * 原合同事项处理-费用结算,最大支持200个字
4449
3969
 
4450
- */
3970
+ */
4451
3971
  OriginalExpenseSettlement?: string
4452
-
4453
3972
  /**
4454
- * 原合同事项处理-其他事项,最大支持200个字
3973
+ * 原合同事项处理-其他事项,最大支持200个字
4455
3974
 
4456
- */
3975
+ */
4457
3976
  OriginalOtherSettlement?: string
4458
-
4459
3977
  /**
4460
- * 其他约定,最大支持200个字
3978
+ * 其他约定,最大支持200个字
4461
3979
 
4462
- */
3980
+ */
4463
3981
  OtherDeals?: string
4464
3982
  }
4465
3983
 
@@ -4471,7 +3989,6 @@ export interface CreateBatchCancelFlowUrlRequest {
4471
3989
  * 调用方用户信息,userId 必填
4472
3990
  */
4473
3991
  Operator: UserInfo
4474
-
4475
3992
  /**
4476
3993
  * 需要执行撤回的签署流程id数组,最多100个
4477
3994
  */
@@ -4486,57 +4003,49 @@ export interface CreateMultiFlowSignQRCodeRequest {
4486
4003
  * 用户信息,其中UserId为必填参数
4487
4004
  */
4488
4005
  Operator: UserInfo
4489
-
4490
4006
  /**
4491
4007
  * 模板ID
4492
4008
  */
4493
4009
  TemplateId: string
4494
-
4495
4010
  /**
4496
4011
  * 签署流程名称,最大长度不超过200字符
4497
4012
  */
4498
4013
  FlowName: string
4499
-
4500
4014
  /**
4501
- * 最大可发起签署流程份数,默认5份
4015
+ * 最大可发起签署流程份数,默认5份
4502
4016
  发起流程数量超过此上限后二维码自动失效
4503
- */
4017
+ */
4504
4018
  MaxFlowNum?: number
4505
-
4506
4019
  /**
4507
4020
  * 签署流程有效天数 默认7天 最高设置不超过30天
4508
4021
  */
4509
4022
  FlowEffectiveDay?: number
4510
-
4511
4023
  /**
4512
4024
  * 二维码有效天数 默认7天 最高设置不超过90天
4513
4025
  */
4514
4026
  QrEffectiveDay?: number
4515
-
4516
4027
  /**
4517
4028
  * 限制二维码用户条件
4518
4029
  */
4519
4030
  Restrictions?: Array<ApproverRestriction>
4520
-
4521
4031
  /**
4522
4032
  * 用户自定义字段,回调的时候会进行透传,长度需要小于20480
4523
4033
  */
4524
4034
  UserData?: string
4525
-
4526
4035
  /**
4527
- * 回调地址,最大长度1000字符串
4036
+ * 回调地址,最大长度1000字符串
4528
4037
  回调时机:
4529
4038
  用户通过签署二维码发起签署流程时,企业额度不足导致失败
4530
- */
4039
+ */
4531
4040
  CallbackUrl?: string
4532
-
4533
4041
  /**
4534
4042
  * 应用信息
4043
+ * @deprecated
4535
4044
  */
4536
4045
  Agent?: Agent
4537
-
4538
4046
  /**
4539
4047
  * 限制二维码用户条件(已弃用)
4048
+ * @deprecated
4540
4049
  */
4541
4050
  ApproverRestrictions?: ApproverRestriction
4542
4051
  }
@@ -4549,12 +4058,10 @@ export interface DescribeFlowInfoRequest {
4549
4058
  * 需要查询的流程ID列表,限制最大100个
4550
4059
  */
4551
4060
  FlowIds: Array<string>
4552
-
4553
4061
  /**
4554
4062
  * 调用方用户信息,userId 必填
4555
4063
  */
4556
4064
  Operator?: UserInfo
4557
-
4558
4065
  /**
4559
4066
  * 代理相关应用信息,如集团主企业代子企业操作的场景中ProxyOrganizationId必填
4560
4067
  */
@@ -4569,7 +4076,6 @@ export interface DescribeFlowInfoResponse {
4569
4076
  * 签署流程信息
4570
4077
  */
4571
4078
  FlowDetailInfos?: Array<FlowDetailInfo>
4572
-
4573
4079
  /**
4574
4080
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
4575
4081
  */
@@ -4594,7 +4100,6 @@ export interface CreateFlowResponse {
4594
4100
  * 签署流程编号
4595
4101
  */
4596
4102
  FlowId?: string
4597
-
4598
4103
  /**
4599
4104
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
4600
4105
  */
@@ -4609,13 +4114,11 @@ export interface DescribeUserAutoSignStatusRequest {
4609
4114
  * 操作人信息,UserId必填
4610
4115
  */
4611
4116
  Operator: UserInfo
4612
-
4613
4117
  /**
4614
- * 自动签场景:
4118
+ * 自动签场景:
4615
4119
  E_PRESCRIPTION_AUTO_SIGN 电子处方
4616
- */
4120
+ */
4617
4121
  SceneKey: string
4618
-
4619
4122
  /**
4620
4123
  * 查询开启状态的用户信息
4621
4124
  */
@@ -4628,26 +4131,23 @@ E_PRESCRIPTION_AUTO_SIGN 电子处方
4628
4131
  */
4629
4132
  export interface ReleasedApprover {
4630
4133
  /**
4631
- * 签署人姓名,最大长度50个字符
4134
+ * 签署人姓名,最大长度50个字符
4632
4135
 
4633
- */
4136
+ */
4634
4137
  Name: string
4635
-
4636
4138
  /**
4637
4139
  * 签署人手机号
4638
4140
  */
4639
4141
  Mobile: string
4640
-
4641
4142
  /**
4642
4143
  * 要替换的参与人在原合同参与人列表中的签署人编号,通过DescribeFlowInfo 接口获取(即FlowDetailInfos. FlowApproverInfos 结构中的ReceiptId )
4643
4144
  */
4644
4145
  RelievedApproverReceiptId: string
4645
-
4646
4146
  /**
4647
- * 指定签署人类型,目前仅支持
4147
+ * 指定签署人类型,目前仅支持
4648
4148
  ORGANIZATION-企业
4649
4149
  ENTERPRISESERVER-企业静默签
4650
- */
4150
+ */
4651
4151
  ApproverType?: string
4652
4152
  }
4653
4153
 
@@ -4659,25 +4159,21 @@ export interface FlowBrief {
4659
4159
  * 流程的编号ID
4660
4160
  */
4661
4161
  FlowId: string
4662
-
4663
4162
  /**
4664
4163
  * 流程的名称
4665
4164
  */
4666
4165
  FlowName: string
4667
-
4668
4166
  /**
4669
- * 流程的描述信息
4167
+ * 流程的描述信息
4670
4168
  注意:此字段可能返回 null,表示取不到有效值。
4671
- */
4169
+ */
4672
4170
  FlowDescription: string
4673
-
4674
4171
  /**
4675
4172
  * 流程的类型
4676
4173
  */
4677
4174
  FlowType: string
4678
-
4679
4175
  /**
4680
- * 流程状态
4176
+ * 流程状态
4681
4177
  - 0 还没有发起
4682
4178
  - 1 待签署
4683
4179
  - 2 部分签署
@@ -4691,31 +4187,27 @@ export interface FlowBrief {
4691
4187
  - 10 拒填
4692
4188
  - 21 已解除
4693
4189
  注意:此字段可能返回 null,表示取不到有效值。
4694
- */
4190
+ */
4695
4191
  FlowStatus: number
4696
-
4697
4192
  /**
4698
- * 流程创建的时间戳,单位秒
4193
+ * 流程创建的时间戳,单位秒
4699
4194
  注意:此字段可能返回 null,表示取不到有效值。
4700
- */
4195
+ */
4701
4196
  CreatedOn: number
4702
-
4703
4197
  /**
4704
- * 拒签或者取消的原因描述
4198
+ * 拒签或者取消的原因描述
4705
4199
  注意:此字段可能返回 null,表示取不到有效值。
4706
- */
4200
+ */
4707
4201
  FlowMessage: string
4708
-
4709
4202
  /**
4710
- * 合同发起人userId
4203
+ * 合同发起人userId
4711
4204
  注意:此字段可能返回 null,表示取不到有效值。
4712
- */
4205
+ */
4713
4206
  Creator?: string
4714
-
4715
4207
  /**
4716
- * 合同过期时间,时间戳,单位秒
4208
+ * 合同过期时间,时间戳,单位秒
4717
4209
  注意:此字段可能返回 null,表示取不到有效值。
4718
- */
4210
+ */
4719
4211
  Deadline?: number
4720
4212
  }
4721
4213
 
@@ -4724,35 +4216,30 @@ export interface FlowBrief {
4724
4216
  */
4725
4217
  export interface DescribeOrganizationGroupOrganizationsResponse {
4726
4218
  /**
4727
- * 查询到的符合条件的成员企业总数量
4219
+ * 查询到的符合条件的成员企业总数量
4728
4220
  注意:此字段可能返回 null,表示取不到有效值。
4729
- */
4221
+ */
4730
4222
  Total?: number
4731
-
4732
4223
  /**
4733
- * 已授权待激活的企业数量
4224
+ * 已授权待激活的企业数量
4734
4225
  注意:此字段可能返回 null,表示取不到有效值。
4735
- */
4226
+ */
4736
4227
  JoinedTotal?: number
4737
-
4738
4228
  /**
4739
- * 已加入的企业数量
4229
+ * 已加入的企业数量
4740
4230
  注意:此字段可能返回 null,表示取不到有效值。
4741
- */
4231
+ */
4742
4232
  ActivedTotal?: number
4743
-
4744
4233
  /**
4745
- * 导出文件的url
4234
+ * 导出文件的url
4746
4235
  注意:此字段可能返回 null,表示取不到有效值。
4747
- */
4236
+ */
4748
4237
  ExportUrl?: string
4749
-
4750
4238
  /**
4751
- * 成员企业信息列表
4239
+ * 成员企业信息列表
4752
4240
  注意:此字段可能返回 null,表示取不到有效值。
4753
- */
4241
+ */
4754
4242
  List?: Array<GroupOrganization>
4755
-
4756
4243
  /**
4757
4244
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
4758
4245
  */
@@ -4767,23 +4254,20 @@ export interface CcInfo {
4767
4254
  * 被抄送人手机号,11位数字
4768
4255
  */
4769
4256
  Mobile?: string
4770
-
4771
4257
  /**
4772
4258
  * 被抄送人姓名
4773
4259
  */
4774
4260
  Name?: string
4775
-
4776
4261
  /**
4777
- * 被抄送人类型,
4262
+ * 被抄送人类型,
4778
4263
  0--个人
4779
4264
  1--员工
4780
- */
4265
+ */
4781
4266
  CcType?: number
4782
-
4783
4267
  /**
4784
- * 被抄送人权限
4268
+ * 被抄送人权限
4785
4269
  0--可查看
4786
4270
  1--可查看也可下载
4787
- */
4271
+ */
4788
4272
  CcPermission?: number
4789
4273
  }