tencentcloud-sdk-nodejs-essbasic 4.0.617 → 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.
@@ -33,7 +33,6 @@ export interface ChannelCreateConvertTaskApiResponse {
33
33
  * 任务id
34
34
  */
35
35
  TaskId?: string
36
-
37
36
  /**
38
37
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
39
38
  */
@@ -48,7 +47,6 @@ export interface ChannelCreateFlowRemindsResponse {
48
47
  * 合同催办详情信息
49
48
  */
50
49
  RemindFlowRecords?: Array<RemindFlowRecords>
51
-
52
50
  /**
53
51
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
54
52
  */
@@ -63,25 +61,23 @@ export interface ChannelDeleteSealPoliciesRequest {
63
61
  * 应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 均必填。
64
62
  */
65
63
  Agent: Agent
66
-
67
64
  /**
68
65
  * 指定印章ID
69
66
  */
70
67
  SealId: string
71
-
72
68
  /**
73
- * 指定用户ID数组,电子签系统用户ID
69
+ * 指定用户ID数组,电子签系统用户ID
74
70
  可以填写OpenId,系统会通过组织+渠道+OpenId查询得到UserId进行授权取消。
75
- */
71
+ */
76
72
  UserIds: Array<string>
77
-
78
73
  /**
79
74
  * 组织机构信息,不用传
75
+ * @deprecated
80
76
  */
81
77
  Organization?: OrganizationInfo
82
-
83
78
  /**
84
79
  * 操作人(用户)信息,不用传
80
+ * @deprecated
85
81
  */
86
82
  Operator?: UserInfo
87
83
  }
@@ -94,7 +90,6 @@ export interface ChannelBatchCancelFlowsResponse {
94
90
  * 签署流程批量撤销失败原因,错误信息与流程Id一一对应,成功为“”,失败则对应失败消息
95
91
  */
96
92
  FailMessages?: Array<string>
97
-
98
93
  /**
99
94
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
100
95
  */
@@ -106,15 +101,14 @@ export interface ChannelBatchCancelFlowsResponse {
106
101
  */
107
102
  export interface Department {
108
103
  /**
109
- * 部门id
104
+ * 部门id
110
105
  注意:此字段可能返回 null,表示取不到有效值。
111
- */
106
+ */
112
107
  DepartmentId: string
113
-
114
108
  /**
115
- * 部门名称
109
+ * 部门名称
116
110
  注意:此字段可能返回 null,表示取不到有效值。
117
- */
111
+ */
118
112
  DepartmentName: string
119
113
  }
120
114
 
@@ -136,37 +130,32 @@ export interface ChannelCreateFlowSignReviewRequest {
136
130
  * 应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 均必填。
137
131
  */
138
132
  Agent: Agent
139
-
140
133
  /**
141
134
  * 签署流程编号
142
135
  */
143
136
  FlowId: string
144
-
145
137
  /**
146
- * 企业内部审核结果
138
+ * 企业内部审核结果
147
139
  PASS: 通过
148
140
  REJECT: 拒绝
149
141
  SIGN_REJECT:拒签(流程结束)
150
- */
142
+ */
151
143
  ReviewType: string
152
-
153
144
  /**
154
- * 审核原因
145
+ * 审核原因
155
146
  当ReviewType 是REJECT 时此字段必填,字符串长度不超过200
156
- */
147
+ */
157
148
  ReviewMessage?: string
158
-
159
149
  /**
160
150
  * 签署节点审核时需要指定
161
151
  */
162
152
  RecipientId?: string
163
-
164
153
  /**
165
- * 操作类型,默认:SignReview;SignReview:签署审核,CreateReview:发起审核
154
+ * 操作类型,默认:SignReview;SignReview:签署审核,CreateReview:发起审核
166
155
  注:接口通过该字段区分操作类型
167
156
  该字段不传或者为空,则默认为SignReview签署审核,走签署审核流程
168
157
  若想使用发起审核,请指定该字段为:CreateReview
169
- */
158
+ */
170
159
  OperateType?: string
171
160
  }
172
161
 
@@ -178,7 +167,6 @@ export interface AuthFailMessage {
178
167
  * 第三方应用平台的子客企业OpenId
179
168
  */
180
169
  ProxyOrganizationOpenId: string
181
-
182
170
  /**
183
171
  * 错误信息
184
172
  */
@@ -193,20 +181,18 @@ export interface DescribeFlowDetailInfoRequest {
193
181
  * 应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 均必填。
194
182
  */
195
183
  Agent: Agent
196
-
197
184
  /**
198
- * 合同(流程)编号数组,最多支持100个。
185
+ * 合同(流程)编号数组,最多支持100个。
199
186
  (备注:该参数和合同组编号必须二选一)
200
- */
187
+ */
201
188
  FlowIds?: Array<string>
202
-
203
189
  /**
204
190
  * 合同组编号(备注:该参数和合同(流程)编号数组必须二选一)
205
191
  */
206
192
  FlowGroupId?: string
207
-
208
193
  /**
209
194
  * 暂未开放
195
+ * @deprecated
210
196
  */
211
197
  Operator?: UserInfo
212
198
  }
@@ -216,27 +202,25 @@ export interface DescribeFlowDetailInfoRequest {
216
202
  */
217
203
  export interface ModifyExtendedServiceRequest {
218
204
  /**
219
- * 应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 均必填。
205
+ * 应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 均必填。
220
206
 
221
207
  注: 此接口 参数Agent. ProxyOperator.OpenId 需要传递超管或者法人的OpenId
222
- */
208
+ */
223
209
  Agent: Agent
224
-
225
210
  /**
226
- * 扩展服务类型
211
+ * 扩展服务类型
227
212
  AUTO_SIGN 企业静默签(自动签署)
228
213
  OVERSEA_SIGN 企业与港澳台居民*签署合同
229
214
  MOBILE_CHECK_APPROVER 使用手机号验证签署方身份
230
215
  PAGING_SEAL 骑缝章
231
216
  DOWNLOAD_FLOW 授权渠道下载合同
232
- */
217
+ */
233
218
  ServiceType: string
234
-
235
219
  /**
236
- * 操作类型
220
+ * 操作类型
237
221
  OPEN:开通
238
222
  CLOSE:关闭
239
- */
223
+ */
240
224
  Operate: string
241
225
  }
242
226
 
@@ -245,18 +229,17 @@ CLOSE:关闭
245
229
  */
246
230
  export interface DescribeResourceUrlsByFlowsRequest {
247
231
  /**
248
- * 应用相关信息。
232
+ * 应用相关信息。
249
233
  此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 均必填。
250
- */
234
+ */
251
235
  Agent: Agent
252
-
253
236
  /**
254
237
  * 查询资源所对应的签署流程Id,最多支持50个
255
238
  */
256
239
  FlowIds?: Array<string>
257
-
258
240
  /**
259
241
  * 操作者的信息,不用传
242
+ * @deprecated
260
243
  */
261
244
  Operator?: UserInfo
262
245
  }
@@ -269,12 +252,10 @@ export interface RemindFlowRecords {
269
252
  * 是否能够催办,true-是,false-否
270
253
  */
271
254
  CanRemind: boolean
272
-
273
255
  /**
274
256
  * 合同id
275
257
  */
276
258
  FlowId: string
277
-
278
259
  /**
279
260
  * 催办详情信息
280
261
  */
@@ -289,7 +270,6 @@ export interface ChannelCreateFlowSignUrlResponse {
289
270
  * 签署人签署链接信息
290
271
  */
291
272
  FlowApproverUrlInfos?: Array<FlowApproverUrlInfo>
292
-
293
273
  /**
294
274
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
295
275
  */
@@ -304,7 +284,6 @@ export interface CreateSealByImageResponse {
304
284
  * 印章id
305
285
  */
306
286
  SealId?: string
307
-
308
287
  /**
309
288
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
310
289
  */
@@ -316,41 +295,35 @@ export interface CreateSealByImageResponse {
316
295
  */
317
296
  export interface OperateChannelTemplateResponse {
318
297
  /**
319
- * 腾讯电子签颁发给第三方应用平台的应用ID
298
+ * 腾讯电子签颁发给第三方应用平台的应用ID
320
299
  注意:此字段可能返回 null,表示取不到有效值。
321
- */
300
+ */
322
301
  AppId?: string
323
-
324
302
  /**
325
- * 第三方应用平台模板库模板唯一标识
303
+ * 第三方应用平台模板库模板唯一标识
326
304
  注意:此字段可能返回 null,表示取不到有效值。
327
- */
305
+ */
328
306
  TemplateId?: string
329
-
330
307
  /**
331
- * 全部成功-"all-success",部分成功-"part-success", 全部失败-"fail"失败的会在FailMessageList中展示
308
+ * 全部成功-"all-success",部分成功-"part-success", 全部失败-"fail"失败的会在FailMessageList中展示
332
309
  注意:此字段可能返回 null,表示取不到有效值。
333
- */
310
+ */
334
311
  OperateResult?: string
335
-
336
312
  /**
337
- * 模板可见性, 全部可见-"all", 部分可见-"part"
313
+ * 模板可见性, 全部可见-"all", 部分可见-"part"
338
314
  注意:此字段可能返回 null,表示取不到有效值。
339
- */
315
+ */
340
316
  AuthTag?: string
341
-
342
317
  /**
343
- * 合作企业方第三方机构唯一标识数据
318
+ * 合作企业方第三方机构唯一标识数据
344
319
  注意:此字段可能返回 null,表示取不到有效值。
345
- */
320
+ */
346
321
  ProxyOrganizationOpenIds?: Array<string>
347
-
348
322
  /**
349
- * 操作失败信息数组
323
+ * 操作失败信息数组
350
324
  注意:此字段可能返回 null,表示取不到有效值。
351
- */
325
+ */
352
326
  FailMessageList?: Array<AuthFailMessage>
353
-
354
327
  /**
355
328
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
356
329
  */
@@ -365,52 +338,42 @@ export interface FlowFileInfo {
365
338
  * 签署文件资源Id列表,目前仅支持单个文件
366
339
  */
367
340
  FileIds: Array<string>
368
-
369
341
  /**
370
342
  * 签署流程名称,长度不超过200个字符
371
343
  */
372
344
  FlowName: string
373
-
374
345
  /**
375
346
  * 签署流程签约方列表,最多不超过5个参与方
376
347
  */
377
348
  FlowApprovers: Array<FlowApproverInfo>
378
-
379
349
  /**
380
350
  * 签署流程截止时间,十位数时间戳,最大值为33162419560,即3020年
381
351
  */
382
352
  Deadline?: number
383
-
384
353
  /**
385
354
  * 签署流程的描述,长度不超过1000个字符
386
355
  */
387
356
  FlowDescription?: string
388
-
389
357
  /**
390
358
  * 签署流程的类型,长度不超过255个字符
391
359
  */
392
360
  FlowType?: string
393
-
394
361
  /**
395
362
  * 签署流程回调地址,长度不超过255个字符
396
363
  */
397
364
  CallbackUrl?: string
398
-
399
365
  /**
400
366
  * 第三方应用的业务信息,最大长度1000个字符。发起自动签署时,需设置对应自动签署场景,目前仅支持场景:处方单-E_PRESCRIPTION_AUTO_SIGN
401
367
  */
402
368
  CustomerData?: string
403
-
404
369
  /**
405
370
  * 合同签署顺序类型(无序签,顺序签),默认为false,即有序签署
406
371
  */
407
372
  Unordered?: boolean
408
-
409
373
  /**
410
374
  * 合同显示的页卡模板,说明:只支持{合同名称}, {发起方企业}, {发起方姓名}, {签署方N企业}, {签署方N姓名},且N不能超过签署人的数量,N从1开始
411
375
  */
412
376
  CustomShowMap?: string
413
-
414
377
  /**
415
378
  * 本企业(发起方企业)是否需要签署审批
416
379
  */
@@ -435,52 +398,42 @@ export interface BaseFlowInfo {
435
398
  * 合同流程名称
436
399
  */
437
400
  FlowName: string
438
-
439
401
  /**
440
402
  * 合同流程类型
441
403
  */
442
404
  FlowType: string
443
-
444
405
  /**
445
406
  * 合同流程描述信息
446
407
  */
447
408
  FlowDescription: string
448
-
449
409
  /**
450
410
  * 合同流程截止时间,unix时间戳,单位秒
451
411
  */
452
412
  Deadline: number
453
-
454
413
  /**
455
414
  * 是否顺序签署(true:无序签,false:顺序签)
456
415
  */
457
416
  Unordered?: boolean
458
-
459
417
  /**
460
418
  * 是否打开智能添加填写区(默认开启,打开:"OPEN" 关闭:"CLOSE")
461
419
  */
462
420
  IntelligentStatus?: string
463
-
464
421
  /**
465
422
  * 填写控件内容
466
423
  */
467
424
  FormFields?: Array<FormField>
468
-
469
425
  /**
470
426
  * 本企业(发起方企业)是否需要签署审批,true:开启本企业签署审批。使用ChannelCreateFlowSignReview接口提交审批结果,才能继续完成签署
471
427
  */
472
428
  NeedSignReview?: boolean
473
-
474
429
  /**
475
430
  * 用户流程自定义数据参数
476
431
  */
477
432
  UserData?: string
478
-
479
433
  /**
480
434
  * 抄送人信息
481
435
  */
482
436
  CcInfos?: Array<CcInfo>
483
-
484
437
  /**
485
438
  * 是否需要发起前审核,当指定NeedCreateReview=true,则发起后,需要使用接口:ChannelCreateFlowSignReview,来完成发起前审核,审核通过后,可以继续查看,签署合同
486
439
  */
@@ -492,25 +445,22 @@ export interface BaseFlowInfo {
492
445
  */
493
446
  export interface CreateConsoleLoginUrlResponse {
494
447
  /**
495
- * 子客企业Web控制台url注意事项:
448
+ * 子客企业Web控制台url注意事项:
496
449
  1. 所有类型的链接在企业未认证/员工未认证完成时,只要在有效期内(一年)都可以访问
497
450
  2. 若企业认证完成且员工认证完成后,重新获取pc端的链接5分钟之内有效,且只能访问一次
498
451
  3. 若企业认证完成且员工认证完成后,重新获取H5/APP的链接只要在有效期内(一年)都可以访问
499
452
  4. 此链接仅单次有效,使用后需要再次创建新的链接(部分聊天软件,如企业微信默认会对链接进行解析,此时需要使用类似“代码片段”的方式或者放到txt文件里发送链接)
500
453
  5. 创建的链接应避免被转义,如:&被转义为\u0026;如使用Postman请求后,请选择响应类型为 JSON,否则链接将被转义
501
- */
454
+ */
502
455
  ConsoleUrl?: string
503
-
504
456
  /**
505
457
  * 子客企业是否已开通腾讯电子签,true-是,false-否
506
458
  */
507
459
  IsActivated?: boolean
508
-
509
460
  /**
510
461
  * 当前经办人是否已认证(false:未认证 true:已认证)
511
462
  */
512
463
  ProxyOperatorIsVerified?: boolean
513
-
514
464
  /**
515
465
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
516
466
  */
@@ -525,21 +475,23 @@ export interface ChannelDeleteRoleUsersRequest {
525
475
  * 代理信息
526
476
  */
527
477
  Agent: Agent
528
-
529
478
  /**
530
479
  * 角色Id(非超管或法人角色Id)
531
480
  */
532
481
  RoleId: string
533
-
534
482
  /**
535
- * 用户列表,电子签系统的UserId
483
+ * 电子签用户ID列表,与OpenIds参数二选一,优先UserIds参数
536
484
  */
537
- UserIds: Array<string>
538
-
485
+ UserIds?: Array<string>
539
486
  /**
540
487
  * 操作人信息
488
+ * @deprecated
541
489
  */
542
490
  Operator?: UserInfo
491
+ /**
492
+ * 客户系统用户ID列表,与UserIds参数二选一,优先UserIds参数
493
+ */
494
+ OpenIds?: Array<string>
543
495
  }
544
496
 
545
497
  /**
@@ -550,7 +502,6 @@ export interface ChannelCreateUserRolesResponse {
550
502
  * 绑定失败的用户角色列表
551
503
  */
552
504
  FailedCreateRoleData?: Array<FailedCreateRoleData>
553
-
554
505
  /**
555
506
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
556
507
  */
@@ -562,33 +513,29 @@ export interface ChannelCreateUserRolesResponse {
562
513
  */
563
514
  export interface SyncProxyOrganizationRequest {
564
515
  /**
565
- * 应用信息
516
+ * 应用信息
566
517
  此接口Agent.AppId、Agent.ProxyOrganizationOpenId必填
567
- */
518
+ */
568
519
  Agent: Agent
569
-
570
520
  /**
571
521
  * 第三方平台子客企业名称,最大长度64个字符
572
522
  */
573
523
  ProxyOrganizationName: string
574
-
575
524
  /**
576
525
  * 营业执照正面照(PNG或JPG) base64格式, 大小不超过5M
577
526
  */
578
527
  BusinessLicense?: string
579
-
580
528
  /**
581
529
  * 第三方平台子客企业统一社会信用代码,最大长度200个字符
582
530
  */
583
531
  UniformSocialCreditCode?: string
584
-
585
532
  /**
586
533
  * 第三方平台子客企业法人/负责人姓名
587
534
  */
588
535
  ProxyLegalName?: string
589
-
590
536
  /**
591
537
  * 暂未开放
538
+ * @deprecated
592
539
  */
593
540
  Operator?: UserInfo
594
541
  }
@@ -601,49 +548,42 @@ export interface ChannelCreatePrepareFlowRequest {
601
548
  * 资源id,与ResourceType对应
602
549
  */
603
550
  ResourceId: string
604
-
605
551
  /**
606
552
  * 资源类型,1:模板,目前仅支持模板,与ResourceId对应
607
553
  */
608
554
  ResourceType: number
609
-
610
555
  /**
611
556
  * 合同流程基础信息
612
557
  */
613
558
  FlowInfo: BaseFlowInfo
614
-
615
559
  /**
616
560
  * 合同签署人信息
617
561
  */
618
562
  FlowApproverList: Array<CommonFlowApprover>
619
-
620
563
  /**
621
564
  * 应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 均必填
622
565
  */
623
566
  Agent?: Agent
624
-
625
567
  /**
626
568
  * 合同流程配置信息
627
569
  */
628
570
  FlowOption?: CreateFlowOption
629
-
630
571
  /**
631
572
  * 通过flowid快速获得之前成功通过页面发起的合同生成链接
632
573
  */
633
574
  FlowId?: string
634
-
635
575
  /**
636
576
  * 该参数不可用,请通过获取 web 可嵌入接口获取合同流程预览 URL
637
577
  */
638
578
  NeedPreview?: boolean
639
-
640
579
  /**
641
580
  * 企业机构信息,不用传
581
+ * @deprecated
642
582
  */
643
583
  Organization?: OrganizationInfo
644
-
645
584
  /**
646
585
  * 操作人(用户)信息,不用传
586
+ * @deprecated
647
587
  */
648
588
  Operator?: UserInfo
649
589
  }
@@ -656,7 +596,6 @@ export interface ChannelCreateFlowRemindsRequest {
656
596
  * 应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 均必填。
657
597
  */
658
598
  Agent: Agent
659
-
660
599
  /**
661
600
  * 签署流程Id数组,最多100个,超过100不处理
662
601
  */
@@ -668,11 +607,10 @@ export interface ChannelCreateFlowRemindsRequest {
668
607
  */
669
608
  export interface ChannelCreateSealPolicyResponse {
670
609
  /**
671
- * 最终授权成功的电子签系统用户ID数组。其他的跳过的是已经授权了的。
610
+ * 最终授权成功的电子签系统用户ID数组。其他的跳过的是已经授权了的。
672
611
  请求参数填写OpenId时,返回授权成功的 Openid。
673
- */
612
+ */
674
613
  UserIds?: Array<string>
675
-
676
614
  /**
677
615
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
678
616
  */
@@ -697,7 +635,6 @@ export interface DownloadFlowInfo {
697
635
  * 文件夹名称
698
636
  */
699
637
  FileName: string
700
-
701
638
  /**
702
639
  * 签署流程的标识数组
703
640
  */
@@ -712,26 +649,22 @@ export interface FlowApproverUrlInfo {
712
649
  * 签署链接。注意该链接有效期为30分钟,同时需要注意保密,不要外泄给无关用户。
713
650
  */
714
651
  SignUrl: string
715
-
716
652
  /**
717
653
  * 签署人类型 PERSON-个人
718
654
  */
719
655
  ApproverType: string
720
-
721
656
  /**
722
657
  * 签署人姓名
723
658
  */
724
659
  Name: string
725
-
726
660
  /**
727
661
  * 签署人手机号
728
662
  */
729
663
  Mobile: string
730
-
731
664
  /**
732
- * 签署长链接。注意该链接有效期为30分钟,同时需要注意保密,不要外泄给无关用户。
665
+ * 签署长链接。注意该链接有效期为30分钟,同时需要注意保密,不要外泄给无关用户。
733
666
  注意:此字段可能返回 null,表示取不到有效值。
734
- */
667
+ */
735
668
  LongUrl?: string
736
669
  }
737
670
 
@@ -743,29 +676,26 @@ export interface ChannelCreateConvertTaskApiRequest {
743
676
  * 应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 均必填。
744
677
  */
745
678
  Agent: Agent
746
-
747
679
  /**
748
- * 资源类型 取值范围doc,docx,html,xls,xlsx之一
680
+ * 资源类型 支持doc,docx,html,xls,xlsx,jpg,jpeg,png,bmp文件类型
749
681
  */
750
682
  ResourceType: string
751
-
752
683
  /**
753
684
  * 资源名称,长度限制为256字符
754
685
  */
755
686
  ResourceName: string
756
-
757
687
  /**
758
688
  * 资源Id,通过UploadFiles获取
759
689
  */
760
690
  ResourceId: string
761
-
762
691
  /**
763
692
  * 调用方用户信息,不用传
693
+ * @deprecated
764
694
  */
765
695
  Operator?: UserInfo
766
-
767
696
  /**
768
697
  * 暂未开放
698
+ * @deprecated
769
699
  */
770
700
  Organization?: OrganizationInfo
771
701
  }
@@ -778,97 +708,80 @@ export interface ChannelCreateFlowByFilesRequest {
778
708
  * 应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 均必填。
779
709
  */
780
710
  Agent?: Agent
781
-
782
711
  /**
783
712
  * 签署流程名称,长度不超过200个字符
784
713
  */
785
714
  FlowName?: string
786
-
787
715
  /**
788
716
  * 签署流程签约方列表,最多不超过50个参与方
789
717
  */
790
718
  FlowApprovers?: Array<FlowApproverInfo>
791
-
792
719
  /**
793
720
  * 签署文件资源Id列表,目前仅支持单个文件
794
721
  */
795
722
  FileIds?: Array<string>
796
-
797
723
  /**
798
724
  * 签署文件中的发起方的填写控件,需要在发起的时候进行填充
799
725
  */
800
726
  Components?: Array<Component>
801
-
802
727
  /**
803
728
  * 签署流程截止时间,十位数时间戳,最大值为33162419560,即3020年
804
729
  */
805
730
  Deadline?: number
806
-
807
731
  /**
808
732
  * 签署流程回调地址,长度不超过255个字符
809
733
  */
810
734
  CallbackUrl?: string
811
-
812
735
  /**
813
736
  * 合同签署顺序类型(无序签,顺序签),默认为false,即有序签署。有序签署时以传入FlowApprovers数组的顺序作为签署顺序
814
737
  */
815
738
  Unordered?: boolean
816
-
817
739
  /**
818
740
  * 签署流程的类型,长度不超过255个字符
819
741
  */
820
742
  FlowType?: string
821
-
822
743
  /**
823
744
  * 签署流程的描述,长度不超过1000个字符
824
745
  */
825
746
  FlowDescription?: string
826
-
827
747
  /**
828
748
  * 合同显示的页卡模板,说明:只支持{合同名称}, {发起方企业}, {发起方姓名}, {签署方N企业}, {签署方N姓名},且N不能超过签署人的数量,N从1开始
829
749
  */
830
750
  CustomShowMap?: string
831
-
832
751
  /**
833
752
  * 业务信息,最大长度1000个字符。
834
753
  */
835
754
  CustomerData?: string
836
-
837
755
  /**
838
756
  * 发起方企业的签署人进行签署操作是否需要企业内部审批。 若设置为true,审核结果需通过接口 ChannelCreateFlowSignReview 通知电子签,审核通过后,发起方企业签署人方可进行签署操作,否则会阻塞其签署操作。 注:企业可以通过此功能与企业内部的审批流程进行关联,支持手动、静默签署合同。
839
757
  */
840
758
  NeedSignReview?: boolean
841
-
842
759
  /**
843
- * 签署人校验方式
760
+ * 签署人校验方式
844
761
  VerifyCheck: 人脸识别(默认)
845
762
  MobileCheck:手机号验证
846
763
  参数说明:可选人脸识别或手机号验证两种方式,若选择后者,未实名个人签署方在签署合同时,无需经过实名认证和意愿确认两次人脸识别,该能力仅适用于个人签署方。
847
- */
764
+ */
848
765
  ApproverVerifyType?: string
849
-
850
766
  /**
851
767
  * 标识是否允许发起后添加控件。0为不允许1为允许。如果为1,创建的时候不能有签署控件,只能创建后添加。注意发起后添加控件功能不支持添加骑缝章和签批控件
852
768
  */
853
769
  SignBeanTag?: number
854
-
855
770
  /**
856
771
  * 被抄送人信息列表
857
772
  */
858
773
  CcInfos?: Array<CcInfo>
859
-
860
774
  /**
861
775
  * 给关注人发送短信通知的类型,0-合同发起时通知 1-签署完成后通知
862
776
  */
863
777
  CcNotifyType?: number
864
-
865
778
  /**
866
779
  * 个人自动签场景。发起自动签署时,需设置对应自动签署场景,目前仅支持场景:处方单-E_PRESCRIPTION_AUTO_SIGN
867
780
  */
868
781
  AutoSignScene?: string
869
-
870
782
  /**
871
783
  * 操作者的信息,不用传
784
+ * @deprecated
872
785
  */
873
786
  Operator?: UserInfo
874
787
  }
@@ -878,21 +791,19 @@ MobileCheck:手机号验证
878
791
  */
879
792
  export interface ChannelRole {
880
793
  /**
881
- * 角色id
794
+ * 角色id
882
795
  注意:此字段可能返回 null,表示取不到有效值。
883
- */
796
+ */
884
797
  RoleId?: string
885
-
886
798
  /**
887
- * 角色名
799
+ * 角色名
888
800
  注意:此字段可能返回 null,表示取不到有效值。
889
- */
801
+ */
890
802
  RoleName?: string
891
-
892
803
  /**
893
- * 角色状态:1-启用;2-禁用
804
+ * 角色状态:1-启用;2-禁用
894
805
  注意:此字段可能返回 null,表示取不到有效值。
895
- */
806
+ */
896
807
  RoleStatus?: number
897
808
  }
898
809
 
@@ -904,41 +815,34 @@ export interface FlowApproverDetail {
904
815
  * 模板配置时候的签署人id,与控件绑定
905
816
  */
906
817
  ReceiptId: string
907
-
908
818
  /**
909
- * 平台企业的第三方id
819
+ * 平台企业的第三方id
910
820
  注意:此字段可能返回 null,表示取不到有效值。
911
- */
821
+ */
912
822
  ProxyOrganizationOpenId: string
913
-
914
823
  /**
915
824
  * 平台企业操作人的第三方id
916
825
  */
917
826
  ProxyOperatorOpenId: string
918
-
919
827
  /**
920
828
  * 平台企业名称
921
829
  */
922
830
  ProxyOrganizationName: string
923
-
924
831
  /**
925
832
  * 签署人手机号
926
833
  */
927
834
  Mobile: string
928
-
929
835
  /**
930
836
  * 签署人签署顺序
931
837
  */
932
838
  SignOrder: number
933
-
934
839
  /**
935
- * 签署人姓名
840
+ * 签署人姓名
936
841
  注意:此字段可能返回 null,表示取不到有效值。
937
- */
842
+ */
938
843
  ApproveName: string
939
-
940
844
  /**
941
- * 当前签署人的状态, 状态如下
845
+ * 当前签署人的状态, 状态如下
942
846
 
943
847
  PENDING 流程等待中
944
848
  FILLPENDING 待填写状态
@@ -954,24 +858,21 @@ STOP 流程因为其他原因终止
954
858
  RELIEVED 已经解除
955
859
 
956
860
  注意:此字段可能返回 null,表示取不到有效值。
957
- */
861
+ */
958
862
  ApproveStatus: string
959
-
960
863
  /**
961
- * 签署人信息
864
+ * 签署人信息
962
865
  注意:此字段可能返回 null,表示取不到有效值。
963
- */
866
+ */
964
867
  ApproveMessage: string
965
-
966
868
  /**
967
869
  * 签署人签署时间戳,单位秒
968
870
  */
969
871
  ApproveTime: number
970
-
971
872
  /**
972
- * 参与者类型 (ORGANIZATION企业/PERSON个人)
873
+ * 参与者类型 (ORGANIZATION企业/PERSON个人)
973
874
  注意:此字段可能返回 null,表示取不到有效值。
974
- */
875
+ */
975
876
  ApproveType: string
976
877
  }
977
878
 
@@ -983,13 +884,11 @@ export interface DescribeResourceUrlsByFlowsResponse {
983
884
  * 签署流程资源对应链接信息
984
885
  */
985
886
  FlowResourceUrlInfos?: Array<FlowResourceUrlInfo>
986
-
987
887
  /**
988
- * 创建消息,对应多个合同ID,
888
+ * 创建消息,对应多个合同ID,
989
889
  成功为“”,创建失败则对应失败消息
990
- */
890
+ */
991
891
  ErrorMessages?: Array<string>
992
-
993
892
  /**
994
893
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
995
894
  */
@@ -1004,27 +903,24 @@ export interface ChannelCreateFlowGroupByFilesRequest {
1004
903
  * 每个子合同的发起所需的信息,数量限制2-100
1005
904
  */
1006
905
  FlowFileInfos: Array<FlowFileInfo>
1007
-
1008
906
  /**
1009
907
  * 合同组名称,长度不超过200个字符
1010
908
  */
1011
909
  FlowGroupName: string
1012
-
1013
910
  /**
1014
911
  * 应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 均必填。
1015
912
  */
1016
913
  Agent?: Agent
1017
-
1018
914
  /**
1019
- * 签署人校验方式
915
+ * 签署人校验方式
1020
916
  VerifyCheck: 人脸识别(默认)
1021
917
  MobileCheck:手机号验证
1022
918
  参数说明:若选择后者,未实名的个人签署方查看合同时,无需进行人脸识别实名认证(但签署合同时仍然需要人脸实名),该能力仅适用于个人签署方。
1023
- */
919
+ */
1024
920
  ApproverVerifyType?: string
1025
-
1026
921
  /**
1027
922
  * 操作者的信息,此参数不用传
923
+ * @deprecated
1028
924
  */
1029
925
  Operator?: UserInfo
1030
926
  }
@@ -1037,30 +933,25 @@ export interface DescribeFlowDetailInfoResponse {
1037
933
  * 第三方平台应用号Id
1038
934
  */
1039
935
  ApplicationId?: string
1040
-
1041
936
  /**
1042
937
  * 第三方平台子客企业OpenId
1043
938
  */
1044
939
  ProxyOrganizationOpenId?: string
1045
-
1046
940
  /**
1047
- * 合同(签署流程)的具体详细描述信息
941
+ * 合同(签署流程)的具体详细描述信息
1048
942
  注意:此字段可能返回 null,表示取不到有效值。
1049
- */
943
+ */
1050
944
  FlowInfo?: Array<FlowDetailInfo>
1051
-
1052
945
  /**
1053
- * 合同组编号
946
+ * 合同组编号
1054
947
  注意:此字段可能返回 null,表示取不到有效值。
1055
- */
948
+ */
1056
949
  FlowGroupId?: string
1057
-
1058
950
  /**
1059
- * 合同组名称
951
+ * 合同组名称
1060
952
  注意:此字段可能返回 null,表示取不到有效值。
1061
- */
953
+ */
1062
954
  FlowGroupName?: string
1063
-
1064
955
  /**
1065
956
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1066
957
  */
@@ -1072,21 +963,19 @@ export interface DescribeFlowDetailInfoResponse {
1072
963
  */
1073
964
  export interface ResourceUrlInfo {
1074
965
  /**
1075
- * 资源链接地址,过期时间5分钟
966
+ * 资源链接地址,过期时间5分钟
1076
967
  注意:此字段可能返回 null,表示取不到有效值。
1077
- */
968
+ */
1078
969
  Url: string
1079
-
1080
970
  /**
1081
- * 资源名称
971
+ * 资源名称
1082
972
  注意:此字段可能返回 null,表示取不到有效值。
1083
- */
973
+ */
1084
974
  Name: string
1085
-
1086
975
  /**
1087
- * 资源类型
976
+ * 资源类型
1088
977
  注意:此字段可能返回 null,表示取不到有效值。
1089
- */
978
+ */
1090
979
  Type: string
1091
980
  }
1092
981
 
@@ -1098,26 +987,23 @@ export interface ChannelDescribeRolesRequest {
1098
987
  * 应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 必填。
1099
988
  */
1100
989
  Agent: Agent
1101
-
1102
990
  /**
1103
991
  * 查询起始偏移,最大2000
1104
992
  */
1105
993
  Offset: number
1106
-
1107
994
  /**
1108
995
  * 查询数量,最大200
1109
996
  */
1110
997
  Limit: string
1111
-
1112
998
  /**
1113
- * 查询的关键字段:
999
+ * 查询的关键字段:
1114
1000
  Key:"RoleType",Values:["1"]查询系统角色,Values:["2"]查询自定义角色
1115
1001
  Key:"RoleStatus",Values:["1"]查询启用角色,Values:["2"]查询禁用角色
1116
- */
1002
+ */
1117
1003
  Filters?: Array<Filter>
1118
-
1119
1004
  /**
1120
1005
  * 操作人信息
1006
+ * @deprecated
1121
1007
  */
1122
1008
  Operator?: UserInfo
1123
1009
  }
@@ -1130,7 +1016,6 @@ export interface PrepareFlowsResponse {
1130
1016
  * 待发起文件确认页
1131
1017
  */
1132
1018
  ConfirmUrl?: string
1133
-
1134
1019
  /**
1135
1020
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1136
1021
  */
@@ -1145,91 +1030,76 @@ export interface TemplateInfo {
1145
1030
  * 模板ID
1146
1031
  */
1147
1032
  TemplateId: string
1148
-
1149
1033
  /**
1150
1034
  * 模板名字
1151
1035
  */
1152
1036
  TemplateName: string
1153
-
1154
1037
  /**
1155
1038
  * 模板描述信息
1156
1039
  */
1157
1040
  Description: string
1158
-
1159
1041
  /**
1160
1042
  * 模板的填充控件信息结构
1161
1043
  */
1162
1044
  Components: Array<Component>
1163
-
1164
1045
  /**
1165
1046
  * 模板中的流程参与人信息
1166
1047
  */
1167
1048
  Recipients: Array<Recipient>
1168
-
1169
1049
  /**
1170
1050
  * 模板中的签署控件信息结构
1171
1051
  */
1172
1052
  SignComponents: Array<Component>
1173
-
1174
1053
  /**
1175
1054
  * 模板类型:1-静默签;3-普通模板
1176
1055
  */
1177
1056
  TemplateType: number
1178
-
1179
1057
  /**
1180
1058
  * 是否是发起人 ,已弃用
1059
+ * @deprecated
1181
1060
  */
1182
1061
  IsPromoter?: boolean
1183
-
1184
1062
  /**
1185
1063
  * 模板的创建者信息,电子签系统用户ID
1186
1064
  */
1187
1065
  Creator: string
1188
-
1189
1066
  /**
1190
1067
  * 模板创建的时间戳,单位秒
1191
1068
  */
1192
1069
  CreatedOn: number
1193
-
1194
1070
  /**
1195
- * 模板的H5预览链接,可以通过浏览器打开此链接预览模板,或者嵌入到iframe中预览模板。请求参数WithPreviewUrl=true时返回,有效期5分钟。
1071
+ * 模板的H5预览链接,可以通过浏览器打开此链接预览模板,或者嵌入到iframe中预览模板。请求参数WithPreviewUrl=true时返回,有效期5分钟。
1196
1072
  注意:此字段可能返回 null,表示取不到有效值。
1197
- */
1073
+ */
1198
1074
  PreviewUrl: string
1199
-
1200
1075
  /**
1201
- * 第三方应用集成-模板PDF文件链接。请求参数WithPdfUrl=true时返回(此功能开放需要联系客户经理),有效期5分钟。
1076
+ * 第三方应用集成-模板PDF文件链接。请求参数WithPdfUrl=true时返回(此功能开放需要联系客户经理),有效期5分钟。
1202
1077
  注意:此字段可能返回 null,表示取不到有效值。
1203
- */
1078
+ */
1204
1079
  PdfUrl: string
1205
-
1206
1080
  /**
1207
1081
  * 关联的第三方应用平台企业模板ID
1208
1082
  */
1209
1083
  ChannelTemplateId: string
1210
-
1211
1084
  /**
1212
- * 关联的三方应用平台平台企业模板名称
1085
+ * 关联的三方应用平台平台企业模板名称
1213
1086
  注意:此字段可能返回 null,表示取不到有效值。
1214
- */
1087
+ */
1215
1088
  ChannelTemplateName: string
1216
-
1217
1089
  /**
1218
- * 0-需要子客企业手动领取平台企业的模板(默认); 1-平台自动设置子客模板
1090
+ * 0-需要子客企业手动领取平台企业的模板(默认); 1-平台自动设置子客模板
1219
1091
  注意:此字段可能返回 null,表示取不到有效值。
1220
- */
1092
+ */
1221
1093
  ChannelAutoSave: number
1222
-
1223
1094
  /**
1224
- * 模板版本,全数字字符。默认为空,初始版本为yyyyMMdd001。
1095
+ * 模板版本,全数字字符。默认为空,初始版本为yyyyMMdd001。
1225
1096
  注意:此字段可能返回 null,表示取不到有效值。
1226
- */
1097
+ */
1227
1098
  TemplateVersion: string
1228
-
1229
1099
  /**
1230
- * 模板可用状态,取值:1启用(默认),2停用
1100
+ * 模板可用状态,取值:1启用(默认),2停用
1231
1101
  注意:此字段可能返回 null,表示取不到有效值。
1232
- */
1102
+ */
1233
1103
  Available?: number
1234
1104
  }
1235
1105
 
@@ -1241,7 +1111,6 @@ export interface GetDownloadFlowUrlResponse {
1241
1111
  * 合同(流程)下载地址
1242
1112
  */
1243
1113
  DownLoadUrl?: string
1244
-
1245
1114
  /**
1246
1115
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1247
1116
  */
@@ -1256,24 +1125,21 @@ export interface Agent {
1256
1125
  * 应用的唯一标识。不同的业务系统可以采用不同的AppId,不同AppId下的数据是隔离的。可以由控制台开发者中心-应用集成自主生成。
1257
1126
  */
1258
1127
  AppId: string
1259
-
1260
1128
  /**
1261
1129
  * 第三方应用平台自定义,对应第三方平台子客企业的唯一标识。一个第三方平台子客企业主体与子客企业ProxyOrganizationOpenId是一一对应的,不可更改,不可重复使用。(例如,可以使用企业名称的hash值,或者社会统一信用代码的hash值,或者随机hash值,需要第三方应用平台保存),最大64位字符串
1262
1130
  */
1263
1131
  ProxyOrganizationOpenId?: string
1264
-
1265
1132
  /**
1266
1133
  * 第三方平台子客企业中的员工/经办人,通过第三方应用平台进入电子签完成实名、且被赋予相关权限后,可以参与到企业资源的管理或签署流程中。
1267
1134
  */
1268
1135
  ProxyOperator?: UserInfo
1269
-
1270
1136
  /**
1271
1137
  * 在第三方平台子客企业开通电子签后,会生成唯一的子客应用Id(ProxyAppId)用于代理调用时的鉴权,在子客开通的回调中获取。
1272
1138
  */
1273
1139
  ProxyAppId?: string
1274
-
1275
1140
  /**
1276
1141
  * 内部参数,暂未开放使用
1142
+ * @deprecated
1277
1143
  */
1278
1144
  ProxyOrganizationId?: string
1279
1145
  }
@@ -1286,42 +1152,34 @@ export interface Recipient {
1286
1152
  * 签署人唯一标识,在通过模板发起合同的时候对应签署方Id
1287
1153
  */
1288
1154
  RecipientId?: string
1289
-
1290
1155
  /**
1291
1156
  * 参与者类型。默认为空。ENTERPRISE-企业;INDIVIDUAL-个人;PROMOTER-发起方
1292
1157
  */
1293
1158
  RecipientType?: string
1294
-
1295
1159
  /**
1296
1160
  * 描述
1297
1161
  */
1298
1162
  Description?: string
1299
-
1300
1163
  /**
1301
1164
  * 签署方备注角色名
1302
1165
  */
1303
1166
  RoleName?: string
1304
-
1305
1167
  /**
1306
1168
  * 是否需要校验,true-是,false-否
1307
1169
  */
1308
1170
  RequireValidation?: boolean
1309
-
1310
1171
  /**
1311
1172
  * 是否必须填写,true-是,false-否
1312
1173
  */
1313
1174
  RequireSign?: boolean
1314
-
1315
1175
  /**
1316
1176
  * 签署类型
1317
1177
  */
1318
1178
  SignType?: number
1319
-
1320
1179
  /**
1321
1180
  * 签署顺序:数字越小优先级越高
1322
1181
  */
1323
1182
  RoutingOrder?: number
1324
-
1325
1183
  /**
1326
1184
  * 是否是发起方
1327
1185
  */
@@ -1336,22 +1194,18 @@ export interface DescribeTemplatesResponse {
1336
1194
  * 模板详情
1337
1195
  */
1338
1196
  Templates?: Array<TemplateInfo>
1339
-
1340
1197
  /**
1341
1198
  * 查询总数
1342
1199
  */
1343
1200
  TotalCount?: number
1344
-
1345
1201
  /**
1346
1202
  * 查询数量
1347
1203
  */
1348
1204
  Limit?: number
1349
-
1350
1205
  /**
1351
1206
  * 查询起始偏移
1352
1207
  */
1353
1208
  Offset?: number
1354
-
1355
1209
  /**
1356
1210
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1357
1211
  */
@@ -1363,15 +1217,14 @@ export interface DescribeTemplatesResponse {
1363
1217
  */
1364
1218
  export interface StaffRole {
1365
1219
  /**
1366
- * 角色id
1220
+ * 角色id
1367
1221
  注意:此字段可能返回 null,表示取不到有效值。
1368
- */
1222
+ */
1369
1223
  RoleId: string
1370
-
1371
1224
  /**
1372
- * 角色名称
1225
+ * 角色名称
1373
1226
  注意:此字段可能返回 null,表示取不到有效值。
1374
- */
1227
+ */
1375
1228
  RoleName: string
1376
1229
  }
1377
1230
 
@@ -1383,14 +1236,13 @@ export interface ChannelVerifyPdfRequest {
1383
1236
  * 流程ID
1384
1237
  */
1385
1238
  FlowId: string
1386
-
1387
1239
  /**
1388
1240
  * 应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 均必填。
1389
1241
  */
1390
1242
  Agent?: Agent
1391
-
1392
1243
  /**
1393
1244
  * 暂未开放
1245
+ * @deprecated
1394
1246
  */
1395
1247
  Operator?: UserInfo
1396
1248
  }
@@ -1403,14 +1255,13 @@ export interface CreateChannelFlowEvidenceReportRequest {
1403
1255
  * 应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 均必填
1404
1256
  */
1405
1257
  Agent: Agent
1406
-
1407
1258
  /**
1408
1259
  * 签署流程编号
1409
1260
  */
1410
1261
  FlowId: string
1411
-
1412
1262
  /**
1413
1263
  * 暂未开放
1264
+ * @deprecated
1414
1265
  */
1415
1266
  Operator?: UserInfo
1416
1267
  }
@@ -1423,12 +1274,10 @@ export interface ChannelVerifyPdfResponse {
1423
1274
  * 验签结果,1-文件未被篡改,全部签名在腾讯电子签完成; 2-文件未被篡改,部分签名在腾讯电子签完成;3-文件被篡改;4-异常:文件内没有签名域;5-异常:文件签名格式错误
1424
1275
  */
1425
1276
  VerifyResult?: number
1426
-
1427
1277
  /**
1428
1278
  * 验签结果详情,内部状态1-验签成功,在电子签签署;2-验签成功,在其他平台签署;3-验签失败;4-pdf文件没有签名域;5-文件签名格式错误
1429
1279
  */
1430
1280
  PdfVerifyResults?: Array<PdfVerifyResult>
1431
-
1432
1281
  /**
1433
1282
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1434
1283
  */
@@ -1440,58 +1289,49 @@ export interface ChannelVerifyPdfResponse {
1440
1289
  */
1441
1290
  export interface CreateConsoleLoginUrlRequest {
1442
1291
  /**
1443
- * 应用信息
1292
+ * 应用信息
1444
1293
  此接口Agent.AppId、Agent.ProxyOrganizationOpenId 和 Agent. ProxyOperator.OpenId 必填
1445
- */
1294
+ */
1446
1295
  Agent: Agent
1447
-
1448
1296
  /**
1449
1297
  * 子客企业名称,最大长度64个字符
1450
1298
  */
1451
1299
  ProxyOrganizationName: string
1452
-
1453
1300
  /**
1454
1301
  * 子客企业经办人的姓名,最大长度50个字符
1455
1302
  */
1456
1303
  ProxyOperatorName?: string
1457
-
1458
1304
  /**
1459
1305
  * PC控制台指定模块,文件/合同管理:"DOCUMENT",模板管理:"TEMPLATE",印章管理:"SEAL",组织架构/人员:"OPERATOR",空字符串:"账号信息"。 EndPoint为"CHANNEL"/"APP"只支持"SEAL"-印章管理
1460
1306
  */
1461
1307
  Module?: string
1462
-
1463
1308
  /**
1464
1309
  * 控制台指定模块Id
1465
1310
  */
1466
1311
  ModuleId?: string
1467
-
1468
1312
  /**
1469
1313
  * 子客企业统一社会信用代码,最大长度200个字符
1470
1314
  */
1471
1315
  UniformSocialCreditCode?: string
1472
-
1473
1316
  /**
1474
1317
  * 是否展示左侧菜单栏 是:ENABLE(默认) 否:DISABLE
1475
1318
  */
1476
1319
  MenuStatus?: string
1477
-
1478
1320
  /**
1479
1321
  * 链接跳转类型:"PC"-PC控制台,“CHANNEL”-H5跳转到电子签小程序;“APP”-第三方APP或小程序跳转电子签小程序,默认为PC控制台
1480
1322
  */
1481
1323
  Endpoint?: string
1482
-
1483
1324
  /**
1484
1325
  * 触发自动跳转事件,仅对App类型有效,"VERIFIED":企业认证完成/员工认证完成后跳回原App/小程序
1485
1326
  */
1486
1327
  AutoJumpBackEvent?: string
1487
-
1488
1328
  /**
1489
1329
  * 支持的授权方式,授权方式: "1" - 上传授权书认证 "2" - 法定代表人认证
1490
1330
  */
1491
1331
  AuthorizationTypes?: Array<number>
1492
-
1493
1332
  /**
1494
1333
  * 暂未开放
1334
+ * @deprecated
1495
1335
  */
1496
1336
  Operator?: UserInfo
1497
1337
  }
@@ -1504,24 +1344,22 @@ export interface OrganizationInfo {
1504
1344
  * 用户在渠道的机构编号
1505
1345
  */
1506
1346
  OrganizationOpenId: string
1507
-
1508
1347
  /**
1509
1348
  * 机构在平台的编号
1510
1349
  */
1511
1350
  OrganizationId?: string
1512
-
1513
1351
  /**
1514
1352
  * 用户渠道
1515
1353
  */
1516
1354
  Channel?: string
1517
-
1518
1355
  /**
1519
1356
  * 用户真实的IP
1357
+ * @deprecated
1520
1358
  */
1521
1359
  ClientIp?: string
1522
-
1523
1360
  /**
1524
1361
  * 机构的代理IP
1362
+ * @deprecated
1525
1363
  */
1526
1364
  ProxyIp?: string
1527
1365
  }
@@ -1531,83 +1369,72 @@ export interface OrganizationInfo {
1531
1369
  */
1532
1370
  export interface SignUrlInfo {
1533
1371
  /**
1534
- * 签署链接,过期时间为30天
1372
+ * 签署链接,过期时间为30天
1535
1373
  注意:此字段可能返回 null,表示取不到有效值。
1536
- */
1374
+ */
1537
1375
  SignUrl: string
1538
-
1539
1376
  /**
1540
- * 合同过期时间戳,单位秒
1377
+ * 合同过期时间戳,单位秒
1541
1378
  注意:此字段可能返回 null,表示取不到有效值。
1542
- */
1379
+ */
1543
1380
  Deadline: number
1544
-
1545
1381
  /**
1546
- * 当流程为顺序签署此参数有效时,数字越小优先级越高,暂不支持并行签署 可选
1382
+ * 当流程为顺序签署此参数有效时,数字越小优先级越高,暂不支持并行签署 可选
1547
1383
  注意:此字段可能返回 null,表示取不到有效值。
1548
- */
1384
+ */
1549
1385
  SignOrder: number
1550
-
1551
1386
  /**
1552
- * 签署人编号
1387
+ * 签署人编号
1553
1388
  注意:此字段可能返回 null,表示取不到有效值。
1554
- */
1389
+ */
1555
1390
  SignId: string
1556
-
1557
1391
  /**
1558
- * 自定义用户编号
1392
+ * 自定义用户编号
1559
1393
  注意:此字段可能返回 null,表示取不到有效值。
1560
- */
1394
+ * @deprecated
1395
+ */
1561
1396
  CustomUserId?: string
1562
-
1563
1397
  /**
1564
- * 用户姓名
1398
+ * 用户姓名
1565
1399
  注意:此字段可能返回 null,表示取不到有效值。
1566
- */
1400
+ */
1567
1401
  Name: string
1568
-
1569
1402
  /**
1570
- * 用户手机号码
1403
+ * 用户手机号码
1571
1404
  注意:此字段可能返回 null,表示取不到有效值。
1572
- */
1405
+ */
1573
1406
  Mobile: string
1574
-
1575
1407
  /**
1576
- * 签署参与者机构名字
1408
+ * 签署参与者机构名字
1577
1409
  注意:此字段可能返回 null,表示取不到有效值。
1578
- */
1410
+ */
1579
1411
  OrganizationName: string
1580
-
1581
1412
  /**
1582
- * 参与者类型:
1413
+ * 参与者类型:
1583
1414
  ORGANIZATION 企业经办人
1584
1415
  PERSON 自然人
1585
1416
  注意:此字段可能返回 null,表示取不到有效值。
1586
- */
1417
+ */
1587
1418
  ApproverType: string
1588
-
1589
1419
  /**
1590
- * 经办人身份证号
1420
+ * 经办人身份证号
1591
1421
  注意:此字段可能返回 null,表示取不到有效值。
1592
- */
1422
+ */
1593
1423
  IdCardNumber: string
1594
-
1595
1424
  /**
1596
- * 签署链接对应流程Id
1425
+ * 签署链接对应流程Id
1597
1426
  注意:此字段可能返回 null,表示取不到有效值。
1598
- */
1427
+ */
1599
1428
  FlowId: string
1600
-
1601
1429
  /**
1602
- * 企业经办人 用户在渠道的编号
1430
+ * 企业经办人 用户在渠道的编号
1603
1431
  注意:此字段可能返回 null,表示取不到有效值。
1604
- */
1432
+ */
1605
1433
  OpenId: string
1606
-
1607
1434
  /**
1608
- * 合同组签署链接对应的合同组id
1435
+ * 合同组签署链接对应的合同组id
1609
1436
  注意:此字段可能返回 null,表示取不到有效值。
1610
- */
1437
+ */
1611
1438
  FlowGroupId: string
1612
1439
  }
1613
1440
 
@@ -1619,68 +1446,55 @@ export interface CommonFlowApprover {
1619
1446
  * 指定当前签署人为第三方应用集成子客,默认false:当前签署人为第三方应用集成子客,true:当前签署人为saas企业用户
1620
1447
  */
1621
1448
  NotChannelOrganization: boolean
1622
-
1623
1449
  /**
1624
1450
  * 签署人类型,目前支持:0-企业签署人,1-个人签署人,3-企业静默签署人
1625
1451
  */
1626
1452
  ApproverType?: number
1627
-
1628
1453
  /**
1629
1454
  * 企业id
1630
1455
  */
1631
1456
  OrganizationId?: string
1632
-
1633
1457
  /**
1634
1458
  * 企业OpenId,第三方应用集成非静默签子客企业签署人发起合同必传
1635
1459
  */
1636
1460
  OrganizationOpenId?: string
1637
-
1638
1461
  /**
1639
1462
  * 企业名称,第三方应用集成非静默签子客企业签署人必传,saas企业签署人必传
1640
1463
  */
1641
1464
  OrganizationName?: string
1642
-
1643
1465
  /**
1644
1466
  * 用户id
1645
1467
  */
1646
1468
  UserId?: string
1647
-
1648
1469
  /**
1649
1470
  * 用户openId,第三方应用集成非静默签子客企业签署人必传
1650
1471
  */
1651
1472
  OpenId?: string
1652
-
1653
1473
  /**
1654
1474
  * 签署人名称,saas企业签署人,个人签署人必传
1655
1475
  */
1656
1476
  ApproverName?: string
1657
-
1658
1477
  /**
1659
1478
  * 签署人手机号,saas企业签署人,个人签署人必传
1660
1479
  */
1661
1480
  ApproverMobile?: string
1662
-
1663
1481
  /**
1664
- * 签署人Id,使用模板发起是,对应模板配置中的签署人RecipientId
1482
+ * 签署人Id,使用模板发起是,对应模板配置中的签署人RecipientId
1665
1483
  注意:模板发起时该字段必填
1666
- */
1484
+ */
1667
1485
  RecipientId?: string
1668
-
1669
1486
  /**
1670
1487
  * 签署前置条件:阅读时长限制,不传默认10s,最大300s,最小3s
1671
1488
  */
1672
1489
  PreReadTime?: number
1673
-
1674
1490
  /**
1675
1491
  * 签署前置条件:阅读全文限制
1676
1492
  */
1677
1493
  IsFullText?: boolean
1678
-
1679
1494
  /**
1680
1495
  * 通知类型:SMS(短信) NONE(不做通知), 不传 默认SMS
1681
1496
  */
1682
1497
  NotifyType?: string
1683
-
1684
1498
  /**
1685
1499
  * 签署人配置
1686
1500
  */
@@ -1695,67 +1509,54 @@ export interface PdfVerifyResult {
1695
1509
  * 验签结果。0-签名域未签名;1-验签成功; 3-验签失败;4-未找到签名域:文件内没有签名域;5-签名值格式不正确。
1696
1510
  */
1697
1511
  VerifyResult: number
1698
-
1699
1512
  /**
1700
1513
  * 签署平台,如果文件是在腾讯电子签平台签署,则返回腾讯电子签,如果文件不在腾讯电子签平台签署,则返回其他平台。
1701
1514
  */
1702
1515
  SignPlatform: string
1703
-
1704
1516
  /**
1705
1517
  * 签署人名称
1706
1518
  */
1707
1519
  SignerName: string
1708
-
1709
1520
  /**
1710
1521
  * 签署时间戳,单位秒
1711
1522
  */
1712
1523
  SignTime: number
1713
-
1714
1524
  /**
1715
1525
  * 签名算法
1716
1526
  */
1717
1527
  SignAlgorithm: string
1718
-
1719
1528
  /**
1720
1529
  * 签名证书序列号
1721
1530
  */
1722
1531
  CertSn: string
1723
-
1724
1532
  /**
1725
1533
  * 证书起始时间戳,单位秒
1726
1534
  */
1727
1535
  CertNotBefore: number
1728
-
1729
1536
  /**
1730
1537
  * 证书过期时间戳,单位秒
1731
1538
  */
1732
1539
  CertNotAfter: number
1733
-
1734
1540
  /**
1735
1541
  * 签名类型
1736
1542
  */
1737
1543
  SignType: number
1738
-
1739
1544
  /**
1740
1545
  * 签名域横坐标,单位px
1741
1546
  */
1742
1547
  ComponentPosX: number
1743
-
1744
1548
  /**
1745
1549
  * 签名域纵坐标,单位px
1746
1550
  */
1747
1551
  ComponentPosY: number
1748
-
1749
1552
  /**
1750
1553
  * 签名域宽度,单位px
1751
1554
  */
1752
1555
  ComponentWidth: number
1753
-
1754
1556
  /**
1755
1557
  * 签名域高度,单位px
1756
1558
  */
1757
1559
  ComponentHeight: number
1758
-
1759
1560
  /**
1760
1561
  * 签名域所在页码,1~N
1761
1562
  */
@@ -1770,14 +1571,13 @@ export interface ChannelCancelMultiFlowSignQRCodeRequest {
1770
1571
  * 应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 均必填。
1771
1572
  */
1772
1573
  Agent: Agent
1773
-
1774
1574
  /**
1775
1575
  * 二维码id
1776
1576
  */
1777
1577
  QrCodeId: string
1778
-
1779
1578
  /**
1780
1579
  * 暂未开放
1580
+ * @deprecated
1781
1581
  */
1782
1582
  Operator?: UserInfo
1783
1583
  }
@@ -1790,21 +1590,19 @@ export interface UploadFilesRequest {
1790
1590
  * 应用相关信息,若是第三方应用集成调用 appid 和proxyappid 必填
1791
1591
  */
1792
1592
  Agent: Agent
1793
-
1794
1593
  /**
1795
- * 文件对应业务类型
1594
+ * 文件对应业务类型
1796
1595
  1. TEMPLATE - 模板; 文件类型:.pdf/.doc/.docx/.html
1797
1596
  2. DOCUMENT - 签署过程及签署后的合同文档/图片控件 文件类型:.pdf/.doc/.docx/.jpg/.png/.xls.xlsx/.html
1798
- */
1597
+ */
1799
1598
  BusinessType: string
1800
-
1801
1599
  /**
1802
1600
  * 上传文件内容数组,最多支持20个文件
1803
1601
  */
1804
1602
  FileInfos?: Array<UploadFile>
1805
-
1806
1603
  /**
1807
1604
  * 操作者的信息
1605
+ * @deprecated
1808
1606
  */
1809
1607
  Operator?: UserInfo
1810
1608
  }
@@ -1817,36 +1615,31 @@ export interface ChannelDescribeOrganizationSealsRequest {
1817
1615
  * 应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 均必填。
1818
1616
  */
1819
1617
  Agent: Agent
1820
-
1821
1618
  /**
1822
1619
  * 返回最大数量,最大为100
1823
1620
  */
1824
1621
  Limit: number
1825
-
1826
1622
  /**
1827
1623
  * 偏移量,默认为0,最大为20000
1828
1624
  */
1829
1625
  Offset?: number
1830
-
1831
1626
  /**
1832
1627
  * 查询信息类型,为1时返回授权用户,为其他值时不返回
1833
1628
  */
1834
1629
  InfoType?: number
1835
-
1836
1630
  /**
1837
1631
  * 印章id(没有输入返回所有)
1838
1632
  */
1839
1633
  SealId?: string
1840
-
1841
1634
  /**
1842
- * 印章类型列表(都是组织机构印章)。
1635
+ * 印章类型列表(都是组织机构印章)。
1843
1636
  为空时查询所有类型的印章。
1844
1637
  目前支持以下类型:
1845
1638
  OFFICIAL:企业公章;
1846
1639
  CONTRACT:合同专用章;
1847
1640
  ORGANIZATION_SEAL:企业印章(图片上传创建);
1848
1641
  LEGAL_PERSON_SEAL:法定代表人章
1849
- */
1642
+ */
1850
1643
  SealTypes?: Array<string>
1851
1644
  }
1852
1645
 
@@ -1858,37 +1651,32 @@ export interface DescribeUsageRequest {
1858
1651
  * 应用信息,此接口Agent.AppId必填
1859
1652
  */
1860
1653
  Agent: Agent
1861
-
1862
1654
  /**
1863
1655
  * 开始时间,例如:2021-03-21
1864
1656
  */
1865
1657
  StartDate: string
1866
-
1867
1658
  /**
1868
- * 结束时间,例如:2021-06-21;
1659
+ * 结束时间,例如:2021-06-21;
1869
1660
  开始时间到结束时间的区间长度小于等于90天。
1870
- */
1661
+ */
1871
1662
  EndDate: string
1872
-
1873
1663
  /**
1874
- * 是否汇总数据,默认不汇总。
1664
+ * 是否汇总数据,默认不汇总。
1875
1665
  不汇总:返回在统计区间内第三方平台下所有企业的每日明细,即每个企业N条数据,N为统计天数;
1876
1666
  汇总:返回在统计区间内第三方平台下所有企业的汇总后数据,即每个企业一条数据;
1877
- */
1667
+ */
1878
1668
  NeedAggregate?: boolean
1879
-
1880
1669
  /**
1881
1670
  * 单次返回的最多条目数量。默认为1000,且不能超过1000。
1882
1671
  */
1883
1672
  Limit?: number
1884
-
1885
1673
  /**
1886
1674
  * 偏移量,默认是0。
1887
1675
  */
1888
1676
  Offset?: number
1889
-
1890
1677
  /**
1891
1678
  * 暂未开放
1679
+ * @deprecated
1892
1680
  */
1893
1681
  Operator?: UserInfo
1894
1682
  }
@@ -1898,11 +1686,11 @@ export interface DescribeUsageRequest {
1898
1686
  */
1899
1687
  export interface DescribeExtendedServiceAuthInfoRequest {
1900
1688
  /**
1901
- * 应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 均必填
1689
+ * 应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 均必填
1902
1690
 
1903
1691
  注: 此接口 参数Agent. ProxyOperator.OpenId 需要传递超管或者法人的OpenId
1904
1692
 
1905
- */
1693
+ */
1906
1694
  Agent: Agent
1907
1695
  }
1908
1696
 
@@ -1911,27 +1699,25 @@ export interface DescribeExtendedServiceAuthInfoRequest {
1911
1699
  */
1912
1700
  export interface FormField {
1913
1701
  /**
1914
- * 控件填充vaule,ComponentType和传入值类型对应关系:
1702
+ * 控件填充vaule,ComponentType和传入值类型对应关系:
1915
1703
  TEXT - 文本内容
1916
1704
  MULTI_LINE_TEXT - 文本内容
1917
1705
  CHECK_BOX - true/false
1918
1706
  FILL_IMAGE、ATTACHMENT - 附件的FileId,需要通过UploadFiles接口上传获取
1919
1707
  SELECTOR - 选项值
1920
1708
  DYNAMIC_TABLE - 传入json格式的表格内容,具体见数据结构FlowInfo
1921
- */
1709
+ */
1922
1710
  ComponentValue: string
1923
-
1924
1711
  /**
1925
- * 表单域或控件的ID,跟ComponentName二选一,不能全为空;
1712
+ * 表单域或控件的ID,跟ComponentName二选一,不能全为空;
1926
1713
  CreateFlowsByTemplates 接口不使用此字段。
1927
1714
  注意:此字段可能返回 null,表示取不到有效值。
1928
- */
1715
+ */
1929
1716
  ComponentId?: string
1930
-
1931
1717
  /**
1932
- * 控件的名字,跟ComponentId二选一,不能全为空
1718
+ * 控件的名字,跟ComponentId二选一,不能全为空
1933
1719
  注意:此字段可能返回 null,表示取不到有效值。
1934
- */
1720
+ */
1935
1721
  ComponentName?: string
1936
1722
  }
1937
1723
 
@@ -2056,70 +1842,57 @@ export interface FlowInfo {
2056
1842
  * 合同名字,最大长度200个字符
2057
1843
  */
2058
1844
  FlowName: string
2059
-
2060
1845
  /**
2061
1846
  * 签署截止时间戳,超过有效签署时间则该签署流程失败,默认一年
2062
1847
  */
2063
1848
  Deadline: number
2064
-
2065
1849
  /**
2066
1850
  * 模板ID
2067
1851
  */
2068
1852
  TemplateId?: string
2069
-
2070
1853
  /**
2071
1854
  * 多个签署人信息,最大支持50个签署方
2072
1855
  */
2073
1856
  FlowApprovers?: Array<FlowApproverInfo>
2074
-
2075
1857
  /**
2076
1858
  * 表单K-V对列表
2077
1859
  */
2078
1860
  FormFields?: Array<FormField>
2079
-
2080
1861
  /**
2081
1862
  * 回调地址,最大长度1000个字符
2082
1863
  */
2083
1864
  CallbackUrl?: string
2084
-
2085
1865
  /**
2086
1866
  * 合同类型,如:1. “劳务”;2. “销售”;3. “租赁”;4. “其他”,最大长度200个字符
2087
1867
  */
2088
1868
  FlowType?: string
2089
-
2090
1869
  /**
2091
1870
  * 合同描述,最大长度1000个字符
2092
1871
  */
2093
1872
  FlowDescription?: string
2094
-
2095
1873
  /**
2096
1874
  * 第三方应用平台的业务信息,最大长度1000个字符。
2097
1875
  */
2098
1876
  CustomerData?: string
2099
-
2100
1877
  /**
2101
1878
  * 合同显示的页卡模板,说明:只支持{合同名称}, {发起方企业}, {发起方姓名}, {签署方N企业}, {签署方N姓名},且N不能超过签署人的数量,N从1开始
2102
1879
  */
2103
1880
  CustomShowMap?: string
2104
-
2105
1881
  /**
2106
1882
  * 被抄送人的信息列表,抄送功能暂不开放
2107
1883
  */
2108
1884
  CcInfos?: Array<CcInfo>
2109
-
2110
1885
  /**
2111
- * 发起方企业的签署人进行签署操作是否需要企业内部审批。
1886
+ * 发起方企业的签署人进行签署操作是否需要企业内部审批。
2112
1887
  若设置为true,审核结果需通过接口 ChannelCreateFlowSignReview 通知电子签,审核通过后,发起方企业签署人方可进行签署操作,否则会阻塞其签署操作。
2113
1888
 
2114
1889
  注:企业可以通过此功能与企业内部的审批流程进行关联,支持手动、静默签署合同。
2115
- */
1890
+ */
2116
1891
  NeedSignReview?: boolean
2117
-
2118
1892
  /**
2119
1893
  * 给关注人发送短信通知的类型,0-合同发起时通知 1-签署完成后通知
2120
1894
  */
2121
1895
  CcNotifyType?: number
2122
-
2123
1896
  /**
2124
1897
  * 个人自动签场景。发起自动签署时,需设置对应自动签署场景,目前仅支持场景:处方单-E_PRESCRIPTION_AUTO_SIGN
2125
1898
  */
@@ -2134,24 +1907,24 @@ export interface UserInfo {
2134
1907
  * 第三方应用平台自定义,对应第三方平台子客企业员的唯一标识。一个OpenId在一个子客企业内唯一对应一个真实员工,不可在其他子客企业内重复使用。(例如,可以使用经办人企业名+员工身份证的hash值,需要第三方应用平台保存),最大64位字符串
2135
1908
  */
2136
1909
  OpenId?: string
2137
-
2138
1910
  /**
2139
1911
  * 内部参数,暂未开放使用
1912
+ * @deprecated
2140
1913
  */
2141
1914
  Channel?: string
2142
-
2143
1915
  /**
2144
1916
  * 内部参数,暂未开放使用
1917
+ * @deprecated
2145
1918
  */
2146
1919
  CustomUserId?: string
2147
-
2148
1920
  /**
2149
1921
  * 内部参数,暂未开放使用
1922
+ * @deprecated
2150
1923
  */
2151
1924
  ClientIp?: string
2152
-
2153
1925
  /**
2154
1926
  * 内部参数,暂未开放使用
1927
+ * @deprecated
2155
1928
  */
2156
1929
  ProxyIp?: string
2157
1930
  }
@@ -2161,15 +1934,14 @@ export interface UserInfo {
2161
1934
  */
2162
1935
  export interface TaskInfo {
2163
1936
  /**
2164
- * 合成任务Id,可以通过 ChannelGetTaskResultApi 接口获取任务信息
1937
+ * 合成任务Id,可以通过 ChannelGetTaskResultApi 接口获取任务信息
2165
1938
  注意:此字段可能返回 null,表示取不到有效值。
2166
- */
1939
+ */
2167
1940
  TaskId: string
2168
-
2169
1941
  /**
2170
- * 任务状态:READY - 任务已完成;NOTREADY - 任务未完成;
1942
+ * 任务状态:READY - 任务已完成;NOTREADY - 任务未完成;
2171
1943
  注意:此字段可能返回 null,表示取不到有效值。
2172
- */
1944
+ */
2173
1945
  TaskStatus: string
2174
1946
  }
2175
1947
 
@@ -2181,13 +1953,11 @@ export interface DescribeUsageResponse {
2181
1953
  * 用量明细条数
2182
1954
  */
2183
1955
  Total?: number
2184
-
2185
1956
  /**
2186
- * 用量明细
1957
+ * 用量明细
2187
1958
  注意:此字段可能返回 null,表示取不到有效值。
2188
- */
1959
+ */
2189
1960
  Details?: Array<UsageDetail>
2190
-
2191
1961
  /**
2192
1962
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
2193
1963
  */
@@ -2202,56 +1972,46 @@ export interface Staff {
2202
1972
  * 员工在电子签平台的用户ID
2203
1973
  */
2204
1974
  UserId: string
2205
-
2206
1975
  /**
2207
1976
  * 显示的员工名
2208
1977
  */
2209
1978
  DisplayName: string
2210
-
2211
1979
  /**
2212
1980
  * 员工手机号
2213
1981
  */
2214
1982
  Mobile: string
2215
-
2216
1983
  /**
2217
- * 员工邮箱
1984
+ * 员工邮箱
2218
1985
  注意:此字段可能返回 null,表示取不到有效值。
2219
- */
1986
+ */
2220
1987
  Email: string
2221
-
2222
1988
  /**
2223
- * 员工在第三方应用平台的用户ID
1989
+ * 员工在第三方应用平台的用户ID
2224
1990
  注意:此字段可能返回 null,表示取不到有效值。
2225
- */
1991
+ */
2226
1992
  OpenId: string
2227
-
2228
1993
  /**
2229
- * 员工角色
1994
+ * 员工角色
2230
1995
  注意:此字段可能返回 null,表示取不到有效值。
2231
- */
1996
+ */
2232
1997
  Roles: Array<StaffRole>
2233
-
2234
1998
  /**
2235
- * 员工部门
1999
+ * 员工部门
2236
2000
  注意:此字段可能返回 null,表示取不到有效值。
2237
- */
2001
+ */
2238
2002
  Department: Department
2239
-
2240
2003
  /**
2241
2004
  * 员工是否实名
2242
2005
  */
2243
2006
  Verified: boolean
2244
-
2245
2007
  /**
2246
2008
  * 员工创建时间戳,单位秒
2247
2009
  */
2248
2010
  CreatedOn: number
2249
-
2250
2011
  /**
2251
2012
  * 员工实名时间戳,单位秒
2252
2013
  */
2253
2014
  VerifiedOn: number
2254
-
2255
2015
  /**
2256
2016
  * 员工是否离职:0-未离职,1-离职
2257
2017
  */
@@ -2263,18 +2023,17 @@ export interface Staff {
2263
2023
  */
2264
2024
  export interface ChannelCreateBoundFlowsRequest {
2265
2025
  /**
2266
- * 应用信息
2026
+ * 应用信息
2267
2027
  此接口Agent.AppId、Agent.ProxyOrganizationOpenId 和 Agent. ProxyOperator.OpenId 必填
2268
- */
2028
+ */
2269
2029
  Agent: Agent
2270
-
2271
2030
  /**
2272
2031
  * 领取的合同id列表
2273
2032
  */
2274
2033
  FlowIds?: Array<string>
2275
-
2276
2034
  /**
2277
2035
  * 暂未开放
2036
+ * @deprecated
2278
2037
  */
2279
2038
  Operator?: UserInfo
2280
2039
  }
@@ -2287,26 +2046,23 @@ export interface ChannelDescribeEmployeesRequest {
2287
2046
  * 返回最大数量,最大为20
2288
2047
  */
2289
2048
  Limit: number
2290
-
2291
2049
  /**
2292
2050
  * 应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 均必填。
2293
2051
  */
2294
2052
  Agent?: Agent
2295
-
2296
2053
  /**
2297
- * 查询过滤实名用户,Key为Status,Values为["IsVerified"]
2054
+ * 查询过滤实名用户,Key为Status,Values为["IsVerified"]
2298
2055
  根据第三方系统openId过滤查询员工时,Key为StaffOpenId,Values为["OpenId","OpenId",...]
2299
2056
  查询离职员工时,Key为Status,Values为["QuiteJob"]
2300
- */
2057
+ */
2301
2058
  Filters?: Array<Filter>
2302
-
2303
2059
  /**
2304
2060
  * 偏移量,默认为0,最大为20000
2305
2061
  */
2306
2062
  Offset?: number
2307
-
2308
2063
  /**
2309
2064
  * 暂未开放
2065
+ * @deprecated
2310
2066
  */
2311
2067
  Operator?: UserInfo
2312
2068
  }
@@ -2329,7 +2085,6 @@ export interface ChannelDeleteRoleUsersResponse {
2329
2085
  * 角色id
2330
2086
  */
2331
2087
  RoleId?: string
2332
-
2333
2088
  /**
2334
2089
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
2335
2090
  */
@@ -2344,19 +2099,17 @@ export interface SyncProxyOrganizationOperatorsRequest {
2344
2099
  * 应用相关信息。 此接口Agent.AppId 和 Agent.ProxyOrganizationOpenId必填。
2345
2100
  */
2346
2101
  Agent: Agent
2347
-
2348
2102
  /**
2349
2103
  * 操作类型,新增:"CREATE",修改:"UPDATE",离职:"RESIGN"
2350
2104
  */
2351
2105
  OperatorType: string
2352
-
2353
2106
  /**
2354
2107
  * 经办人信息列表,最大长度200
2355
2108
  */
2356
2109
  ProxyOrganizationOperators: Array<ProxyOrganizationOperator>
2357
-
2358
2110
  /**
2359
2111
  * 暂未开放
2112
+ * @deprecated
2360
2113
  */
2361
2114
  Operator?: UserInfo
2362
2115
  }
@@ -2369,70 +2122,59 @@ export interface CreateSignUrlsRequest {
2369
2122
  * 应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 均必填。
2370
2123
  */
2371
2124
  Agent: Agent
2372
-
2373
2125
  /**
2374
2126
  * 签署流程编号数组,最多支持100个。(备注:该参数和合同组编号必须二选一)
2375
2127
  */
2376
2128
  FlowIds?: Array<string>
2377
-
2378
2129
  /**
2379
2130
  * 合同组编号(备注:该参数和合同(流程)编号数组必须二选一)
2380
2131
  */
2381
2132
  FlowGroupId?: string
2382
-
2383
2133
  /**
2384
2134
  * 签署链接类型:“WEIXINAPP”-短链直接跳小程序;“CHANNEL”-跳转H5页面;“APP”-第三方APP或小程序跳转电子签小程序;"LONGURL2WEIXINAPP"-长链接跳转小程序;默认“WEIXINAPP”类型,即跳转至小程序;
2385
2135
  */
2386
2136
  Endpoint?: string
2387
-
2388
2137
  /**
2389
- * 签署链接生成类型,默认是 "ALL";
2138
+ * 签署链接生成类型,默认是 "ALL";
2390
2139
  "ALL":全部签署方签署链接,此时不会给自动签署的签署方创建签署链接;
2391
2140
  "CHANNEL":第三方平台子客企业企业;
2392
2141
  "NOT_CHANNEL":非第三方平台子客企业企业;
2393
2142
  "PERSON":个人;
2394
2143
  "FOLLOWER":关注方,目前是合同抄送方;
2395
- */
2144
+ */
2396
2145
  GenerateType?: string
2397
-
2398
2146
  /**
2399
2147
  * 非第三方平台子客企业参与方的企业名称,GenerateType为"NOT_CHANNEL"时必填
2400
2148
  */
2401
2149
  OrganizationName?: string
2402
-
2403
2150
  /**
2404
2151
  * 参与人姓名,GenerateType为"PERSON"时必填
2405
2152
  */
2406
2153
  Name?: string
2407
-
2408
2154
  /**
2409
- * 参与人手机号;
2155
+ * 参与人手机号;
2410
2156
  GenerateType为"PERSON"或"FOLLOWER"时必填
2411
- */
2157
+ */
2412
2158
  Mobile?: string
2413
-
2414
2159
  /**
2415
2160
  * 第三方平台子客企业的企业OpenId,GenerateType为"CHANNEL"时必填
2416
2161
  */
2417
2162
  OrganizationOpenId?: string
2418
-
2419
2163
  /**
2420
2164
  * 第三方平台子客企业参与人OpenId,GenerateType为"CHANNEL"时可用,指定到具体参与人, 仅展示已经实名的经办人信息
2421
2165
  */
2422
2166
  OpenId?: string
2423
-
2424
2167
  /**
2425
2168
  * Endpoint为"APP" 类型的签署链接,可以设置此值;支持调用方小程序打开签署链接,在电子签小程序完成签署后自动回跳至调用方小程序
2426
2169
  */
2427
2170
  AutoJumpBack?: boolean
2428
-
2429
2171
  /**
2430
2172
  * 签署完之后的H5页面的跳转链接,针对Endpoint为CHANNEL时有效,最大长度1000个字符。
2431
2173
  */
2432
2174
  JumpUrl?: string
2433
-
2434
2175
  /**
2435
2176
  * 暂未开放
2177
+ * @deprecated
2436
2178
  */
2437
2179
  Operator?: UserInfo
2438
2180
  }
@@ -2442,55 +2184,48 @@ GenerateType为"PERSON"或"FOLLOWER"时必填
2442
2184
  */
2443
2185
  export interface ChannelCreateMultiFlowSignQRCodeRequest {
2444
2186
  /**
2445
- * 应用相关信息。
2187
+ * 应用相关信息。
2446
2188
  此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 必填。
2447
- */
2189
+ */
2448
2190
  Agent: Agent
2449
-
2450
2191
  /**
2451
2192
  * 模版ID
2452
2193
  */
2453
2194
  TemplateId: string
2454
-
2455
2195
  /**
2456
2196
  * 签署流程名称,最大长度200个字符。
2457
2197
  */
2458
2198
  FlowName: string
2459
-
2460
2199
  /**
2461
2200
  * 最大可发起签署流程份数,默认5份;发起签署流程数量超过此上限后,二维码自动失效。
2462
2201
  */
2463
2202
  MaxFlowNum?: number
2464
-
2465
2203
  /**
2466
2204
  * 签署流程有效天数 默认7天 最高设置不超过30天
2467
2205
  */
2468
2206
  FlowEffectiveDay?: number
2469
-
2470
2207
  /**
2471
2208
  * 二维码有效天数 默认7天 最高设置不超过90天
2472
2209
  */
2473
2210
  QrEffectiveDay?: number
2474
-
2475
2211
  /**
2476
2212
  * 限制二维码用户条件
2477
2213
  */
2478
2214
  Restrictions?: Array<ApproverRestriction>
2479
-
2480
2215
  /**
2481
- * 回调地址,最大长度1000个字符
2216
+ * 回调地址,最大长度1000个字符
2482
2217
  不传默认使用第三方应用号配置的回调地址
2483
2218
  回调时机:用户通过签署二维码发起合同时,企业额度不足导致失败
2484
- */
2219
+ */
2485
2220
  CallbackUrl?: string
2486
-
2487
2221
  /**
2488
2222
  * 限制二维码用户条件(已弃用)
2223
+ * @deprecated
2489
2224
  */
2490
2225
  ApproverRestrictions?: ApproverRestriction
2491
-
2492
2226
  /**
2493
2227
  * 暂未开放
2228
+ * @deprecated
2494
2229
  */
2495
2230
  Operator?: UserInfo
2496
2231
  }
@@ -2503,12 +2238,10 @@ export interface SignQrCode {
2503
2238
  * 二维码id
2504
2239
  */
2505
2240
  QrCodeId: string
2506
-
2507
2241
  /**
2508
2242
  * 二维码url
2509
2243
  */
2510
2244
  QrCodeUrl: string
2511
-
2512
2245
  /**
2513
2246
  * 二维码过期时间
2514
2247
  */
@@ -2533,119 +2266,100 @@ export interface FlowApproverInfo {
2533
2266
  * 签署人姓名,最大长度50个字符
2534
2267
  */
2535
2268
  Name?: string
2536
-
2537
2269
  /**
2538
- * 签署人身份证件类型
2270
+ * 签署人身份证件类型
2539
2271
  1.ID_CARD 居民身份证
2540
2272
  2.HONGKONG_MACAO_AND_TAIWAN 港澳台居民居住证
2541
2273
  3.HONGKONG_AND_MACAO 港澳居民来往内地通行证
2542
- */
2274
+ */
2543
2275
  IdCardType?: string
2544
-
2545
2276
  /**
2546
2277
  * 签署人证件号
2547
2278
  */
2548
2279
  IdCardNumber?: string
2549
-
2550
2280
  /**
2551
2281
  * 签署人手机号,脱敏显示。大陆手机号为11位,暂不支持海外手机号。
2552
2282
  */
2553
2283
  Mobile?: string
2554
-
2555
2284
  /**
2556
2285
  * 企业签署方工商营业执照上的企业名称,签署方为非发起方企业场景下必传,最大长度64个字符;
2557
2286
  */
2558
2287
  OrganizationName?: string
2559
-
2560
2288
  /**
2561
- * 指定签署人非第三方平台子客企业下员工,在ApproverType为ORGANIZATION时指定。
2289
+ * 指定签署人非第三方平台子客企业下员工,在ApproverType为ORGANIZATION时指定。
2562
2290
  默认为false,即签署人位于同一个第三方平台应用号下;默认为false,即签署人位于同一个第三方应用号下;
2563
- */
2291
+ */
2564
2292
  NotChannelOrganization?: boolean
2565
-
2566
2293
  /**
2567
- * 用户侧第三方id,最大长度64个字符
2294
+ * 用户侧第三方id,最大长度64个字符
2568
2295
  当签署方为同一第三方平台下的员工时,该字段若不指定,则发起【待领取】的流程
2569
- */
2296
+ */
2570
2297
  OpenId?: string
2571
-
2572
2298
  /**
2573
2299
  * 企业签署方在同一第三方平台应用下的其他合作企业OpenId,签署方为非发起方企业场景下必传,最大长度64个字符;
2574
2300
  */
2575
2301
  OrganizationOpenId?: string
2576
-
2577
2302
  /**
2578
- * 签署人类型
2303
+ * 签署人类型
2579
2304
  PERSON-个人/自然人;
2580
2305
  PERSON_AUTO_SIGN-个人自动签(定制化场景下使用);
2581
2306
  ORGANIZATION-企业(企业签署方或模板发起时的企业静默签);
2582
2307
  ENTERPRISESERVER-企业静默签(文件发起时的企业静默签字)。
2583
- */
2308
+ */
2584
2309
  ApproverType?: string
2585
-
2586
2310
  /**
2587
2311
  * 签署流程签署人在模板中对应的签署人Id;在非单方签署、以及非B2C签署的场景下必传,用于指定当前签署方在签署流程中的位置;
2588
2312
  */
2589
2313
  RecipientId?: string
2590
-
2591
2314
  /**
2592
2315
  * 签署截止时间戳,默认一年
2593
2316
  */
2594
2317
  Deadline?: number
2595
-
2596
2318
  /**
2597
2319
  * 签署完回调url,最大长度1000个字符
2320
+ * @deprecated
2598
2321
  */
2599
2322
  CallbackUrl?: string
2600
-
2601
2323
  /**
2602
2324
  * 使用PDF文件直接发起合同时,签署人指定的签署控件
2603
2325
  */
2604
2326
  SignComponents?: Array<Component>
2605
-
2606
2327
  /**
2607
- * 个人签署方指定签署控件类型,目前支持:OCR_ESIGN -AI智慧手写签名
2328
+ * 个人签署方指定签署控件类型,目前支持:OCR_ESIGN -AI智慧手写签名
2608
2329
  HANDWRITE -手写签名
2609
- */
2330
+ */
2610
2331
  ComponentLimitType?: Array<string>
2611
-
2612
2332
  /**
2613
2333
  * 合同的强制预览时间:3~300s,未指定则按合同页数计算
2614
2334
  */
2615
2335
  PreReadTime?: number
2616
-
2617
2336
  /**
2618
2337
  * 签署完前端跳转的url,此字段的用法场景请联系客户经理确认
2619
2338
  */
2620
2339
  JumpUrl?: string
2621
-
2622
2340
  /**
2623
2341
  * 签署人个性化能力值
2624
2342
  */
2625
2343
  ApproverOption?: ApproverOption
2626
-
2627
2344
  /**
2628
2345
  * 当前签署方进行签署操作是否需要企业内部审批,true 则为需要
2629
2346
  */
2630
2347
  ApproverNeedSignReview?: boolean
2631
-
2632
2348
  /**
2633
- * 签署人查看合同时认证方式, 1-实名查看 2-短信验证码查看(企业签署方不支持该方式) 如果不传默认为1
2349
+ * 签署人查看合同时认证方式, 1-实名查看 2-短信验证码查看(企业签署方不支持该方式) 如果不传默认为1
2634
2350
  查看合同的认证方式 Flow层级的优先于approver层级的
2635
- */
2351
+ */
2636
2352
  ApproverVerifyTypes?: Array<number>
2637
-
2638
2353
  /**
2639
- * 签署人签署合同时的认证方式
2354
+ * 签署人签署合同时的认证方式
2640
2355
  1-人脸认证 2-签署密码 3-运营商三要素(默认为1,2)
2641
- */
2356
+ */
2642
2357
  ApproverSignTypes?: Array<number>
2643
-
2644
2358
  /**
2645
- * 签署ID
2359
+ * 签署ID
2646
2360
  - 发起流程时系统自动补充
2647
2361
  - 创建签署链接时,可以通过查询详情接口获得签署人的SignId,然后可传入此值为该签署人创建签署链接,无需再传姓名、手机号、证件号等其他信息
2648
- */
2362
+ */
2649
2363
  SignId?: string
2650
2364
  }
2651
2365
 
@@ -2657,19 +2371,18 @@ export interface ChannelGetTaskResultApiRequest {
2657
2371
  * 应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 均必填。
2658
2372
  */
2659
2373
  Agent: Agent
2660
-
2661
2374
  /**
2662
2375
  * 任务Id,通过ChannelCreateConvertTaskApi接口获得
2663
2376
  */
2664
2377
  TaskId: string
2665
-
2666
2378
  /**
2667
2379
  * 操作者的信息,不用传
2380
+ * @deprecated
2668
2381
  */
2669
2382
  Operator?: UserInfo
2670
-
2671
2383
  /**
2672
2384
  * 暂未开放
2385
+ * @deprecated
2673
2386
  */
2674
2387
  Organization?: OrganizationInfo
2675
2388
  }
@@ -2682,19 +2395,16 @@ export interface FlowDetailInfo {
2682
2395
  * 合同(流程)的Id
2683
2396
  */
2684
2397
  FlowId: string
2685
-
2686
2398
  /**
2687
2399
  * 合同(流程)的名字
2688
2400
  */
2689
2401
  FlowName: string
2690
-
2691
2402
  /**
2692
2403
  * 合同(流程)的类型
2693
2404
  */
2694
2405
  FlowType: string
2695
-
2696
2406
  /**
2697
- * 合同(流程)的状态, 状态如下
2407
+ * 合同(流程)的状态, 状态如下
2698
2408
 
2699
2409
  INIT 还没发起
2700
2410
  PART 部分签署
@@ -2704,39 +2414,32 @@ DEADLINE 流签
2704
2414
  CANCEL 取消
2705
2415
  RELIEVED 解除
2706
2416
 
2707
- */
2417
+ */
2708
2418
  FlowStatus: string
2709
-
2710
2419
  /**
2711
2420
  * 合同(流程)的信息
2712
2421
  */
2713
2422
  FlowMessage: string
2714
-
2715
2423
  /**
2716
2424
  * 合同(流程)的创建时间戳,单位秒
2717
2425
  */
2718
2426
  CreateOn: number
2719
-
2720
2427
  /**
2721
2428
  * 合同(流程)的签署截止时间戳,单位秒
2722
2429
  */
2723
2430
  DeadLine: number
2724
-
2725
2431
  /**
2726
2432
  * 用户自定义数据
2727
2433
  */
2728
2434
  CustomData: string
2729
-
2730
2435
  /**
2731
2436
  * 合同(流程)的签署人数组
2732
2437
  */
2733
2438
  FlowApproverInfos: Array<FlowApproverDetail>
2734
-
2735
2439
  /**
2736
2440
  * 合同(流程)关注方信息列表
2737
2441
  */
2738
2442
  CcInfos?: Array<FlowApproverDetail>
2739
-
2740
2443
  /**
2741
2444
  * 是否需要发起前审批,当NeedCreateReview为true,表明当前流程是需要发起前审核的合同,可能无法进行查看,签署操作,需要等审核完成后,才可以继续后续流程
2742
2445
  */
@@ -2751,29 +2454,24 @@ export interface CreateFlowsByTemplatesResponse {
2751
2454
  * 多个合同ID
2752
2455
  */
2753
2456
  FlowIds?: Array<string>
2754
-
2755
2457
  /**
2756
2458
  * 业务信息,限制1024字符
2757
2459
  */
2758
2460
  CustomerData?: Array<string>
2759
-
2760
2461
  /**
2761
- * 创建消息,对应多个合同ID,
2462
+ * 创建消息,对应多个合同ID,
2762
2463
  成功为“”,创建失败则对应失败消息
2763
- */
2464
+ */
2764
2465
  ErrorMessages?: Array<string>
2765
-
2766
2466
  /**
2767
2467
  * 预览模式下返回的预览文件url数组
2768
2468
  */
2769
2469
  PreviewUrls?: Array<string>
2770
-
2771
2470
  /**
2772
- * 复杂文档合成任务(如,包含动态表格的预览任务)的任务信息数组;
2471
+ * 复杂文档合成任务(如,包含动态表格的预览任务)的任务信息数组;
2773
2472
  如果文档需要异步合成,此字段会返回该异步任务的任务信息,后续可以通过ChannelGetTaskResultApi接口查询任务详情;
2774
- */
2473
+ */
2775
2474
  TaskInfos?: Array<TaskInfo>
2776
-
2777
2475
  /**
2778
2476
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
2779
2477
  */
@@ -2788,14 +2486,13 @@ export interface DescribeChannelFlowEvidenceReportRequest {
2788
2486
  * 应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 均必填
2789
2487
  */
2790
2488
  Agent: Agent
2791
-
2792
2489
  /**
2793
2490
  * 出证报告编号
2794
2491
  */
2795
2492
  ReportId: string
2796
-
2797
2493
  /**
2798
2494
  * 暂未开放
2495
+ * @deprecated
2799
2496
  */
2800
2497
  Operator?: UserInfo
2801
2498
  }
@@ -2805,19 +2502,17 @@ export interface DescribeChannelFlowEvidenceReportRequest {
2805
2502
  */
2806
2503
  export interface SyncProxyOrganizationOperatorsResponse {
2807
2504
  /**
2808
- * Status 同步状态,全部同步失败接口会直接报错
2505
+ * Status 同步状态,全部同步失败接口会直接报错
2809
2506
  1-成功
2810
2507
  2-部分成功
2811
2508
  注意:此字段可能返回 null,表示取不到有效值。
2812
- */
2509
+ */
2813
2510
  Status?: number
2814
-
2815
2511
  /**
2816
- * 同步失败经办人及其失败原因
2512
+ * 同步失败经办人及其失败原因
2817
2513
  注意:此字段可能返回 null,表示取不到有效值。
2818
- */
2514
+ */
2819
2515
  FailedList?: Array<SyncFailReason>
2820
-
2821
2516
  /**
2822
2517
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
2823
2518
  */
@@ -2829,15 +2524,14 @@ export interface SyncProxyOrganizationOperatorsResponse {
2829
2524
  */
2830
2525
  export interface FailedCreateRoleData {
2831
2526
  /**
2832
- * 用户userId
2527
+ * 用户userId
2833
2528
  注意:此字段可能返回 null,表示取不到有效值。
2834
- */
2529
+ */
2835
2530
  UserId?: string
2836
-
2837
2531
  /**
2838
- * 角色RoleId列表
2532
+ * 角色RoleId列表
2839
2533
  注意:此字段可能返回 null,表示取不到有效值。
2840
- */
2534
+ */
2841
2535
  RoleIds?: Array<string>
2842
2536
  }
2843
2537
 
@@ -2846,15 +2540,14 @@ export interface FailedCreateRoleData {
2846
2540
  */
2847
2541
  export interface FlowResourceUrlInfo {
2848
2542
  /**
2849
- * 流程对应Id
2543
+ * 流程对应Id
2850
2544
  注意:此字段可能返回 null,表示取不到有效值。
2851
- */
2545
+ */
2852
2546
  FlowId: string
2853
-
2854
2547
  /**
2855
- * 流程对应资源链接信息数组
2548
+ * 流程对应资源链接信息数组
2856
2549
  注意:此字段可能返回 null,表示取不到有效值。
2857
- */
2550
+ */
2858
2551
  ResourceUrlInfos: Array<ResourceUrlInfo>
2859
2552
  }
2860
2553
 
@@ -2866,7 +2559,6 @@ export interface UploadFile {
2866
2559
  * Base64编码后的文件内容
2867
2560
  */
2868
2561
  FileBody: string
2869
-
2870
2562
  /**
2871
2563
  * 文件名
2872
2564
  */
@@ -2878,37 +2570,33 @@ export interface UploadFile {
2878
2570
  */
2879
2571
  export interface ExtentServiceAuthInfo {
2880
2572
  /**
2881
- * 扩展服务类型
2573
+ * 扩展服务类型
2882
2574
  AUTO_SIGN 企业静默签(自动签署)
2883
2575
  OVERSEA_SIGN 企业与港澳台居民*签署合同
2884
2576
  MOBILE_CHECK_APPROVER 使用手机号验证签署方身份
2885
2577
  PAGING_SEAL 骑缝章
2886
2578
  DOWNLOAD_FLOW 授权平台企业下载合同
2887
- */
2579
+ */
2888
2580
  Type?: string
2889
-
2890
2581
  /**
2891
2582
  * 扩展服务名称
2892
2583
  */
2893
2584
  Name?: string
2894
-
2895
2585
  /**
2896
- * 服务状态
2586
+ * 服务状态
2897
2587
  ENABLE 开启
2898
2588
  DISABLE 关闭
2899
- */
2589
+ */
2900
2590
  Status?: string
2901
-
2902
2591
  /**
2903
- * 最近操作人第三方应用平台的用户openid
2592
+ * 最近操作人第三方应用平台的用户openid
2904
2593
  注意:此字段可能返回 null,表示取不到有效值。
2905
- */
2594
+ */
2906
2595
  OperatorOpenId?: string
2907
-
2908
2596
  /**
2909
- * 最近操作时间戳,单位秒
2597
+ * 最近操作时间戳,单位秒
2910
2598
  注意:此字段可能返回 null,表示取不到有效值。
2911
- */
2599
+ */
2912
2600
  OperateOn?: number
2913
2601
  }
2914
2602
 
@@ -2920,7 +2608,6 @@ export interface Filter {
2920
2608
  * 查询过滤条件的Key
2921
2609
  */
2922
2610
  Key: string
2923
-
2924
2611
  /**
2925
2612
  * 查询过滤条件的Value列表
2926
2613
  */
@@ -2942,51 +2629,43 @@ export interface ReleasedApprover {
2942
2629
  * 企业签署方工商营业执照上的企业名称,签署方为非发起方企业场景下必传,最大长度64个字符
2943
2630
  */
2944
2631
  OrganizationName: string
2945
-
2946
2632
  /**
2947
2633
  * 签署人在原流程中的签署人列表中的顺序序号(从0开始,按顺序依次递增),如果不清楚原流程中的签署人列表,可以通过DescribeFlows接口查看
2948
2634
  */
2949
2635
  ApproverNumber: number
2950
-
2951
2636
  /**
2952
- * 签署人类型,目前仅支持
2637
+ * 签署人类型,目前仅支持
2953
2638
  ORGANIZATION-企业
2954
2639
  ENTERPRISESERVER-企业静默签
2955
- */
2640
+ */
2956
2641
  ApproverType: string
2957
-
2958
2642
  /**
2959
2643
  * 签署人姓名,最大长度50个字符
2960
2644
  */
2961
2645
  Name?: string
2962
-
2963
2646
  /**
2964
- * 签署人身份证件类型
2647
+ * 签署人身份证件类型
2965
2648
  1.ID_CARD 居民身份证
2966
2649
  2.HONGKONG_MACAO_AND_TAIWAN 港澳台居民居住证
2967
2650
  3.HONGKONG_AND_MACAO 港澳居民来往内地通行证
2968
- */
2651
+ */
2969
2652
  IdCardType?: string
2970
-
2971
2653
  /**
2972
2654
  * 签署人证件号
2973
2655
  */
2974
2656
  IdCardNumber?: string
2975
-
2976
2657
  /**
2977
2658
  * 签署人手机号,脱敏显示。大陆手机号为11位,暂不支持海外手机号
2978
2659
  */
2979
2660
  Mobile?: string
2980
-
2981
2661
  /**
2982
2662
  * 企业签署方在同一第三方应用下的其他合作企业OpenId,签署方为非发起方企业场景下必传,最大长度64个字符
2983
2663
  */
2984
2664
  OrganizationOpenId?: string
2985
-
2986
2665
  /**
2987
- * 用户侧第三方id,最大长度64个字符
2666
+ * 用户侧第三方id,最大长度64个字符
2988
2667
  当签署方为同一第三方应用下的员工时,该字必传
2989
- */
2668
+ */
2990
2669
  OpenId?: string
2991
2670
  }
2992
2671
 
@@ -2998,12 +2677,10 @@ export interface CreateSignUrlsResponse {
2998
2677
  * 签署参与者签署H5链接信息数组
2999
2678
  */
3000
2679
  SignUrlInfos?: Array<SignUrlInfo>
3001
-
3002
2680
  /**
3003
2681
  * 生成失败时的错误信息,成功返回”“,顺序和出参SignUrlInfos保持一致
3004
2682
  */
3005
2683
  ErrorMessages?: Array<string>
3006
-
3007
2684
  /**
3008
2685
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
3009
2686
  */
@@ -3018,17 +2695,14 @@ export interface UploadFilesResponse {
3018
2695
  * 文件id数组,有效期一个小时;有效期内此文件id可以反复使用
3019
2696
  */
3020
2697
  FileIds?: Array<string>
3021
-
3022
2698
  /**
3023
2699
  * 上传成功文件数量
3024
2700
  */
3025
2701
  TotalCount?: number
3026
-
3027
2702
  /**
3028
2703
  * 文件Url
3029
2704
  */
3030
2705
  FileUrls?: Array<string>
3031
-
3032
2706
  /**
3033
2707
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
3034
2708
  */
@@ -3043,14 +2717,13 @@ export interface ChannelCreateBatchCancelFlowUrlRequest {
3043
2717
  * 应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 均必填。
3044
2718
  */
3045
2719
  Agent: Agent
3046
-
3047
2720
  /**
3048
2721
  * 签署流程Id数组
3049
2722
  */
3050
2723
  FlowIds: Array<string>
3051
-
3052
2724
  /**
3053
2725
  * 暂未开放
2726
+ * @deprecated
3054
2727
  */
3055
2728
  Operator?: UserInfo
3056
2729
  }
@@ -3063,17 +2736,14 @@ export interface ApproverRestriction {
3063
2736
  * 指定签署人姓名
3064
2737
  */
3065
2738
  Name?: string
3066
-
3067
2739
  /**
3068
2740
  * 指定签署人手机号,11位数字
3069
2741
  */
3070
2742
  Mobile?: string
3071
-
3072
2743
  /**
3073
2744
  * 指定签署人证件类型,ID_CARD-身份证,HONGKONG_AND_MACAO-港澳居民来往内地通行证,HONGKONG_MACAO_AND_TAIWAN-港澳台居民居住证
3074
2745
  */
3075
2746
  IdCardType?: string
3076
-
3077
2747
  /**
3078
2748
  * 指定签署人证件号码,其中字母大写
3079
2749
  */
@@ -3088,19 +2758,17 @@ export interface PrepareFlowsRequest {
3088
2758
  * 应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 均必填。
3089
2759
  */
3090
2760
  Agent: Agent
3091
-
3092
2761
  /**
3093
2762
  * 多个合同(签署流程)信息,最大支持20个签署流程。
3094
2763
  */
3095
2764
  FlowInfos: Array<FlowInfo>
3096
-
3097
2765
  /**
3098
2766
  * 操作完成后的跳转地址,最大长度200
3099
2767
  */
3100
2768
  JumpUrl: string
3101
-
3102
2769
  /**
3103
2770
  * 暂未开放
2771
+ * @deprecated
3104
2772
  */
3105
2773
  Operator?: UserInfo
3106
2774
  }
@@ -3110,11 +2778,10 @@ export interface PrepareFlowsRequest {
3110
2778
  */
3111
2779
  export interface ChannelCreateFlowByFilesResponse {
3112
2780
  /**
3113
- * 合同签署流程ID
2781
+ * 合同签署流程ID
3114
2782
  注意:此字段可能返回 null,表示取不到有效值。
3115
- */
2783
+ */
3116
2784
  FlowId?: string
3117
-
3118
2785
  /**
3119
2786
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
3120
2787
  */
@@ -3139,12 +2806,10 @@ export interface ChannelDescribeOrganizationSealsResponse {
3139
2806
  * 在设置了SealId时返回0或1,没有设置时返回公司的总印章数量,可能比返回的印章数组数量多
3140
2807
  */
3141
2808
  TotalCount?: number
3142
-
3143
2809
  /**
3144
2810
  * 查询到的印章结果数组
3145
2811
  */
3146
2812
  Seals?: Array<OccupiedSeal>
3147
-
3148
2813
  /**
3149
2814
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
3150
2815
  */
@@ -3159,12 +2824,10 @@ export interface ChannelCreatePrepareFlowResponse {
3159
2824
  * 预发起的合同链接
3160
2825
  */
3161
2826
  PrepareFlowUrl?: string
3162
-
3163
2827
  /**
3164
2828
  * 合同发起后预览链接
3165
2829
  */
3166
2830
  PreviewFlowUrl?: string
3167
-
3168
2831
  /**
3169
2832
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
3170
2833
  */
@@ -3189,23 +2852,19 @@ export interface ChannelDescribeRolesResponse {
3189
2852
  * 页面偏移量,最大2000
3190
2853
  */
3191
2854
  Offset?: number
3192
-
3193
2855
  /**
3194
2856
  * 查询数量,最大200
3195
2857
  */
3196
2858
  Limit?: number
3197
-
3198
2859
  /**
3199
2860
  * 查询角色的总数量
3200
2861
  */
3201
2862
  TotalCount?: number
3202
-
3203
2863
  /**
3204
- * 角色信息
2864
+ * 角色信息
3205
2865
  注意:此字段可能返回 null,表示取不到有效值。
3206
- */
2866
+ */
3207
2867
  ChannelRoles?: Array<ChannelRole>
3208
-
3209
2868
  /**
3210
2869
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
3211
2870
  */
@@ -3220,34 +2879,30 @@ export interface ChannelCreateReleaseFlowRequest {
3220
2879
  * 应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 均必填。
3221
2880
  */
3222
2881
  Agent: Agent
3223
-
3224
2882
  /**
3225
2883
  * 待解除的流程编号(即原流程的编号)
3226
2884
  */
3227
2885
  NeedRelievedFlowId: string
3228
-
3229
2886
  /**
3230
2887
  * 解除协议内容
3231
2888
  */
3232
2889
  ReliveInfo: RelieveInfo
3233
-
3234
2890
  /**
3235
2891
  * 非必须,解除协议的本企业签署人列表,默认使用原流程的签署人列表;当解除协议的签署人与原流程的签署人不能相同时(例如原流程签署人离职了),需要指定本企业的其他签署人来替换原流程中的原签署人,注意需要指明ApproverNumber来代表需要替换哪一个签署人,解除协议的签署人数量不能多于原流程的签署人数量
3236
2892
  */
3237
2893
  ReleasedApprovers?: Array<ReleasedApprover>
3238
-
3239
2894
  /**
3240
2895
  * 签署完回调url,最大长度1000个字符
3241
2896
  */
3242
2897
  CallbackUrl?: string
3243
-
3244
2898
  /**
3245
2899
  * 暂未开放
2900
+ * @deprecated
3246
2901
  */
3247
2902
  Organization?: OrganizationInfo
3248
-
3249
2903
  /**
3250
2904
  * 暂未开放
2905
+ * @deprecated
3251
2906
  */
3252
2907
  Operator?: UserInfo
3253
2908
  }
@@ -3257,17 +2912,15 @@ export interface ChannelCreateReleaseFlowRequest {
3257
2912
  */
3258
2913
  export interface ChannelCreateFlowGroupByFilesResponse {
3259
2914
  /**
3260
- * 合同组ID
2915
+ * 合同组ID
3261
2916
  注意:此字段可能返回 null,表示取不到有效值。
3262
- */
2917
+ */
3263
2918
  FlowGroupId?: string
3264
-
3265
2919
  /**
3266
- * 子合同ID列表
2920
+ * 子合同ID列表
3267
2921
  注意:此字段可能返回 null,表示取不到有效值。
3268
- */
2922
+ */
3269
2923
  FlowIds?: Array<string>
3270
-
3271
2924
  /**
3272
2925
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
3273
2926
  */
@@ -3282,12 +2935,10 @@ export interface ChannelCreateMultiFlowSignQRCodeResponse {
3282
2935
  * 签署二维码对象
3283
2936
  */
3284
2937
  QrCode?: SignQrCode
3285
-
3286
2938
  /**
3287
2939
  * 签署链接对象
3288
2940
  */
3289
2941
  SignUrls?: SignUrl
3290
-
3291
2942
  /**
3292
2943
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
3293
2944
  */
@@ -3322,36 +2973,31 @@ export interface ProxyOrganizationOperator {
3322
2973
  * 对应Agent-ProxyOperator-OpenId。第三方应用平台自定义,对子客企业员的唯一标识。一个OpenId在一个子客企业内唯一对应一个真实员工,不可在其他子客企业内重复使用。(例如,可以使用经办人企业名+员工身份证的hash值,需要第三方应用平台保存),最大64位字符串
3323
2974
  */
3324
2975
  Id: string
3325
-
3326
2976
  /**
3327
2977
  * 经办人姓名,最大长度50个字符
3328
2978
  */
3329
2979
  Name?: string
3330
-
3331
2980
  /**
3332
- * 经办人身份证件类型
2981
+ * 经办人身份证件类型
3333
2982
  1.ID_CARD 居民身份证
3334
2983
  2.HONGKONG_MACAO_AND_TAIWAN 港澳台居民居住证
3335
2984
  3.HONGKONG_AND_MACAO 港澳居民来往内地通行证
3336
- */
2985
+ */
3337
2986
  IdCardType?: string
3338
-
3339
2987
  /**
3340
2988
  * 经办人证件号
3341
2989
  */
3342
2990
  IdCardNumber?: string
3343
-
3344
2991
  /**
3345
2992
  * 经办人手机号,大陆手机号输入11位,暂不支持海外手机号。
3346
2993
  */
3347
2994
  Mobile?: string
3348
-
3349
2995
  /**
3350
- * 默认角色,值为以下三个对应的英文:
2996
+ * 默认角色,值为以下三个对应的英文:
3351
2997
  业务管理员:admin
3352
2998
  经办人:channel-normal-operator
3353
2999
  业务员:channel-sales-man
3354
- */
3000
+ */
3355
3001
  DefaultRole?: string
3356
3002
  }
3357
3003
 
@@ -3360,14 +3006,13 @@ export interface ProxyOrganizationOperator {
3360
3006
  */
3361
3007
  export interface ModifyExtendedServiceResponse {
3362
3008
  /**
3363
- * 操作跳转链接,有效期24小时
3009
+ * 操作跳转链接,有效期24小时
3364
3010
  若操作时没有返回跳转链接,表示无需跳转操作,此时会直接开通/关闭服务。
3365
3011
 
3366
3012
  当操作类型是 OPEN 且 扩展服务类型是 AUTO_SIGN 或 DOWNLOAD_FLOW 或者 OVERSEA_SIGN 时返回操作链接,
3367
3013
  返回的链接需要平台方自行触达超管或法人,超管或法人点击链接完成服务开通操作。
3368
- */
3014
+ */
3369
3015
  OperateUrl?: string
3370
-
3371
3016
  /**
3372
3017
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
3373
3018
  */
@@ -3382,19 +3027,21 @@ export interface ChannelCreateUserRolesRequest {
3382
3027
  * 应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 必填。
3383
3028
  */
3384
3029
  Agent: Agent
3385
-
3386
- /**
3387
- * 绑定角色的员工id列表,电子签的UserId
3388
- */
3389
- UserIds: Array<string>
3390
-
3391
3030
  /**
3392
3031
  * 绑定角色的角色id列表
3393
3032
  */
3394
3033
  RoleIds: Array<string>
3395
-
3034
+ /**
3035
+ * 电子签用户ID列表,与OpenIds参数二选一,优先UserIds参数
3036
+ */
3037
+ UserIds?: Array<string>
3038
+ /**
3039
+ * 客户系统用户ID列表,与UserIds参数二选一,优先UserIds参数
3040
+ */
3041
+ OpenIds?: Array<string>
3396
3042
  /**
3397
3043
  * 操作者信息
3044
+ * @deprecated
3398
3045
  */
3399
3046
  Operator?: UserInfo
3400
3047
  }
@@ -3407,41 +3054,37 @@ export interface ChannelGetTaskResultApiResponse {
3407
3054
  * 任务Id
3408
3055
  */
3409
3056
  TaskId?: string
3410
-
3411
3057
  /**
3412
- * 任务状态,需要关注的状态
3058
+ * 任务状态,需要关注的状态
3413
3059
  0 :NeedTranform - 任务已提交
3414
3060
  4 :Processing - 文档转换中
3415
3061
  8 :TaskEnd - 任务处理完成
3416
3062
  -2 :DownloadFailed - 下载失败
3417
3063
  -6 :ProcessFailed - 转换失败
3418
3064
  -13:ProcessTimeout - 转换文件超时
3419
- */
3065
+ */
3420
3066
  TaskStatus?: number
3421
-
3422
3067
  /**
3423
- * 状态描述,需要关注的状态
3068
+ * 状态描述,需要关注的状态
3424
3069
  NeedTranform - 任务已提交
3425
3070
  Processing - 文档转换中
3426
3071
  TaskEnd - 任务处理完成
3427
3072
  DownloadFailed - 下载失败
3428
3073
  ProcessFailed - 转换失败
3429
3074
  ProcessTimeout - 转换文件超时
3430
- */
3075
+ */
3431
3076
  TaskMessage?: string
3432
-
3433
3077
  /**
3434
3078
  * 资源Id,也是FileId,用于文件发起使用
3435
3079
  */
3436
3080
  ResourceId?: string
3437
-
3438
3081
  /**
3439
- * 预览文件Url,有效期30分钟
3082
+ * 预览文件Url,有效期30分钟
3440
3083
  当前字段返回为空,发起的时候,将ResourceId 放入发起即可
3441
3084
  注意:此字段可能返回 null,表示取不到有效值。
3442
- */
3085
+ * @deprecated
3086
+ */
3443
3087
  PreviewUrl?: string
3444
-
3445
3088
  /**
3446
3089
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
3447
3090
  */
@@ -3470,7 +3113,7 @@ https://cloud.tencent.com/document/product/1323/78346#component-.E4.B8.89.E7.A7.
3470
3113
  */
3471
3114
  export interface Component {
3472
3115
  /**
3473
- * 控件编号
3116
+ * 控件编号
3474
3117
 
3475
3118
  CreateFlowByTemplates发起合同时优先以ComponentId(不为空)填充;否则以ComponentName填充
3476
3119
 
@@ -3482,11 +3125,10 @@ CreateFlowByTemplates发起合同时优先以ComponentId(不为空)填充;
3482
3125
 
3483
3126
  创建控件时,此值为空
3484
3127
  查询时返回完整结构
3485
- */
3128
+ */
3486
3129
  ComponentId?: string
3487
-
3488
3130
  /**
3489
- * 如果是Component控件类型,则可选的字段为:
3131
+ * 如果是Component控件类型,则可选的字段为:
3490
3132
  TEXT - 普通文本控件,输入文本字符串;
3491
3133
  MULTI_LINE_TEXT - 多行文本控件,输入文本字符串;
3492
3134
  CHECK_BOX - 勾选框控件,若选中填写ComponentValue 填写 true或者 false 字符串;
@@ -3507,66 +3149,55 @@ SIGN_OPINION - 签署意见控件,用户需要根据配置的签署意见内
3507
3149
  SIGN_LEGAL_PERSON_SEAL - 企业法定代表人控件。
3508
3150
 
3509
3151
  表单域的控件不能作为印章和签名控件
3510
- */
3152
+ */
3511
3153
  ComponentType?: string
3512
-
3513
3154
  /**
3514
3155
  * 控件简称,不能超过30个字符
3515
3156
  */
3516
3157
  ComponentName?: string
3517
-
3518
3158
  /**
3519
3159
  * 定义控件是否为必填项,默认为false
3520
3160
  */
3521
3161
  ComponentRequired?: boolean
3522
-
3523
3162
  /**
3524
3163
  * 控件关联的签署方id
3525
3164
  */
3526
3165
  ComponentRecipientId?: string
3527
-
3528
3166
  /**
3529
3167
  * 控件所属文件的序号 (文档中文件的排列序号,从0开始)
3530
3168
  */
3531
3169
  FileIndex?: number
3532
-
3533
3170
  /**
3534
- * 控件生成的方式:
3171
+ * 控件生成的方式:
3535
3172
  NORMAL - 普通控件
3536
3173
  FIELD - 表单域
3537
3174
  KEYWORD - 关键字
3538
- */
3175
+ */
3539
3176
  GenerateMode?: string
3540
-
3541
3177
  /**
3542
- * 参数控件宽度,默认100,单位px
3178
+ * 参数控件宽度,默认100,单位px
3543
3179
  表单域和关键字转换控件不用填
3544
- */
3180
+ */
3545
3181
  ComponentWidth?: number
3546
-
3547
3182
  /**
3548
- * 参数控件高度,默认100,单位px
3183
+ * 参数控件高度,默认100,单位px
3549
3184
  表单域和关键字转换控件不用填
3550
- */
3185
+ */
3551
3186
  ComponentHeight?: number
3552
-
3553
3187
  /**
3554
3188
  * 参数控件所在页码,从1开始
3555
3189
  */
3556
3190
  ComponentPage?: number
3557
-
3558
3191
  /**
3559
3192
  * 参数控件X位置,单位px
3560
3193
  */
3561
3194
  ComponentPosX?: number
3562
-
3563
3195
  /**
3564
3196
  * 参数控件Y位置,单位px
3565
3197
  */
3566
3198
  ComponentPosY?: number
3567
-
3568
3199
  /**
3569
- * 参数控件样式,json格式表述
3200
+ * 参数控件样式,json格式表述
3570
3201
 
3571
3202
  不同类型的控件会有部分非通用参数
3572
3203
 
@@ -3599,11 +3230,10 @@ ComponentType为SIGN_DATE时,支持以下参数:
3599
3230
  如果extra参数为空,默认为”yyyy年m月d日”格式的居中日期
3600
3231
  特别地,如果extra中Format字段为空或无法被识别,则extra参数会被当作默认值处理(Font,FontSize,Gaps和FontAlign都不会起效)
3601
3232
  参数样例: "ComponentExtra": "{\"Format\":“yyyy m d”,\"FontSize\":12,\"Gaps\":\"2,2\", \"FontAlign\":\"Right\"}",
3602
- */
3233
+ */
3603
3234
  ComponentExtra?: string
3604
-
3605
3235
  /**
3606
- * 控件填充vaule,ComponentType和传入值类型对应关系:
3236
+ * 控件填充vaule,ComponentType和传入值类型对应关系:
3607
3237
  TEXT - 文本内容
3608
3238
  MULTI_LINE_TEXT - 文本内容
3609
3239
  CHECK_BOX - true/false
@@ -3679,67 +3309,56 @@ SIGN_PAGING_SEAL - 可以指定印章ID
3679
3309
 
3680
3310
  学历控件:
3681
3311
  同单行文本控件约束,填写选择值中的字符串
3682
- */
3312
+ */
3683
3313
  ComponentValue?: string
3684
-
3685
3314
  /**
3686
- * 日期签署控件的字号,默认为 12
3315
+ * 日期签署控件的字号,默认为 12
3687
3316
 
3688
3317
  签署区日期控件会转换成图片格式并带存证,需要通过字体决定图片大小
3689
- */
3318
+ */
3690
3319
  ComponentDateFontSize?: number
3691
-
3692
3320
  /**
3693
3321
  * 控件所属文档的Id, 模块相关接口为空值
3694
3322
  */
3695
3323
  DocumentId?: string
3696
-
3697
3324
  /**
3698
3325
  * 控件描述,不能超过30个字符
3699
3326
  */
3700
3327
  ComponentDescription?: string
3701
-
3702
3328
  /**
3703
3329
  * 指定关键字时横坐标偏移量,单位pt
3704
3330
  */
3705
3331
  OffsetX?: number
3706
-
3707
3332
  /**
3708
3333
  * 指定关键字时纵坐标偏移量,单位pt
3709
3334
  */
3710
3335
  OffsetY?: number
3711
-
3712
3336
  /**
3713
- * 平台企业控件ID。
3337
+ * 平台企业控件ID。
3714
3338
  如果不为空,属于平台企业预设控件;
3715
- */
3339
+ */
3716
3340
  ChannelComponentId?: string
3717
-
3718
3341
  /**
3719
- * 指定关键字排序规则,Positive-正序,Reverse-倒序。传入Positive时会根据关键字在PDF文件内的顺序进行排列。在指定KeywordIndexes时,0代表在PDF内查找内容时,查找到的第一个关键字。
3342
+ * 指定关键字排序规则,Positive-正序,Reverse-倒序。传入Positive时会根据关键字在PDF文件内的顺序进行排列。在指定KeywordIndexes时,0代表在PDF内查找内容时,查找到的第一个关键字。
3720
3343
  传入Reverse时会根据关键字在PDF文件内的反序进行排列。在指定KeywordIndexes时,0代表在PDF内查找内容时,查找到的最后一个关键字。
3721
- */
3344
+ */
3722
3345
  KeywordOrder?: string
3723
-
3724
3346
  /**
3725
3347
  * 指定关键字页码,可选参数,指定页码后,将只在指定的页码内查找关键字,非该页码的关键字将不会查询出来
3726
3348
  */
3727
3349
  KeywordPage?: number
3728
-
3729
3350
  /**
3730
3351
  * 关键字位置模式,Middle-居中,Below-正下方,Right-正右方,LowerRight-右上角,UpperRight-右下角。示例:如果设置Middle的关键字盖章,则印章的中心会和关键字的中心重合,如果设置Below,则印章在关键字的正下方
3731
3352
  */
3732
3353
  RelativeLocation?: string
3733
-
3734
3354
  /**
3735
3355
  * 关键字索引,可选参数,如果一个关键字在PDF文件中存在多个,可以通过关键字索引指定使用第几个关键字作为最后的结果,可指定多个索引。示例[0,2],说明使用PDF文件内第1个和第3个关键字位置。
3736
3356
  */
3737
3357
  KeywordIndexes?: Array<number>
3738
-
3739
3358
  /**
3740
- * 填写提示的内容
3359
+ * 填写提示的内容
3741
3360
  注意:此字段可能返回 null,表示取不到有效值。
3742
- */
3361
+ */
3743
3362
  Placeholder?: string
3744
3363
  }
3745
3364
 
@@ -3751,14 +3370,13 @@ export interface GetDownloadFlowUrlRequest {
3751
3370
  * 应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 均必填。
3752
3371
  */
3753
3372
  Agent: Agent
3754
-
3755
3373
  /**
3756
3374
  * 文件夹数组,签署流程总数不能超过50个,一个文件夹下,不能超过20个签署流程
3757
3375
  */
3758
3376
  DownLoadFlows?: Array<DownloadFlowInfo>
3759
-
3760
3377
  /**
3761
3378
  * 操作者的信息,不用传
3379
+ * @deprecated
3762
3380
  */
3763
3381
  Operator?: UserInfo
3764
3382
  }
@@ -3771,7 +3389,6 @@ export interface ChannelCreateEmbedWebUrlResponse {
3771
3389
  * 嵌入的web链接
3772
3390
  */
3773
3391
  WebUrl?: string
3774
-
3775
3392
  /**
3776
3393
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
3777
3394
  */
@@ -3786,28 +3403,25 @@ export interface ChannelBatchCancelFlowsRequest {
3786
3403
  * 应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 均必填。
3787
3404
  */
3788
3405
  Agent: Agent
3789
-
3790
3406
  /**
3791
3407
  * 签署流程Id数组,最多100个,超过100不处理
3792
3408
  */
3793
3409
  FlowIds: Array<string>
3794
-
3795
3410
  /**
3796
3411
  * 撤销理由,不超过200个字符
3797
3412
  */
3798
3413
  CancelMessage?: string
3799
-
3800
3414
  /**
3801
- * 撤销理由自定义格式;选项:
3415
+ * 撤销理由自定义格式;选项:
3802
3416
  0 默认格式
3803
3417
  1 只保留身份信息:展示为【发起方】
3804
3418
  2 保留身份信息+企业名称:展示为【发起方xxx公司】
3805
3419
  3 保留身份信息+企业名称+经办人名称:展示为【发起方xxxx公司-经办人姓名】
3806
- */
3420
+ */
3807
3421
  CancelMessageFormat?: number
3808
-
3809
3422
  /**
3810
3423
  * 暂未开放
3424
+ * @deprecated
3811
3425
  */
3812
3426
  Operator?: UserInfo
3813
3427
  }
@@ -3820,24 +3434,21 @@ export interface ChannelUpdateSealStatusRequest {
3820
3434
  * 应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 均必填。
3821
3435
  */
3822
3436
  Agent: Agent
3823
-
3824
3437
  /**
3825
3438
  * 操作的印章状态,DISABLE-停用印章
3826
3439
  */
3827
3440
  Status: string
3828
-
3829
3441
  /**
3830
3442
  * 印章ID
3831
3443
  */
3832
3444
  SealId: string
3833
-
3834
3445
  /**
3835
3446
  * 更新印章状态原因说明
3836
3447
  */
3837
3448
  Reason?: string
3838
-
3839
3449
  /**
3840
3450
  * 操作者的信息
3451
+ * @deprecated
3841
3452
  */
3842
3453
  Operator?: UserInfo
3843
3454
  }
@@ -3850,12 +3461,10 @@ export interface SignUrl {
3850
3461
  * 小程序签署链接
3851
3462
  */
3852
3463
  AppSignUrl: string
3853
-
3854
3464
  /**
3855
3465
  * 签署链接有效时间
3856
3466
  */
3857
3467
  EffectiveTime: string
3858
-
3859
3468
  /**
3860
3469
  * 移动端签署链接
3861
3470
  */
@@ -3870,28 +3479,25 @@ export interface ChannelCancelFlowRequest {
3870
3479
  * 签署流程编号
3871
3480
  */
3872
3481
  FlowId: string
3873
-
3874
3482
  /**
3875
3483
  * 应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 均必填。
3876
3484
  */
3877
3485
  Agent?: Agent
3878
-
3879
3486
  /**
3880
3487
  * 撤回原因,最大不超过200字符
3881
3488
  */
3882
3489
  CancelMessage?: string
3883
-
3884
3490
  /**
3885
- * 撤销理由自定义格式;选项:
3491
+ * 撤销理由自定义格式;选项:
3886
3492
  0 默认格式
3887
3493
  1 只保留身份信息:展示为【发起方】
3888
3494
  2 保留身份信息+企业名称:展示为【发起方xxx公司】
3889
3495
  3 保留身份信息+企业名称+经办人名称:展示为【发起方xxxx公司-经办人姓名】
3890
- */
3496
+ */
3891
3497
  CancelMessageFormat?: number
3892
-
3893
3498
  /**
3894
3499
  * 暂未开放
3500
+ * @deprecated
3895
3501
  */
3896
3502
  Operator?: UserInfo
3897
3503
  }
@@ -3904,54 +3510,45 @@ export interface DescribeTemplatesRequest {
3904
3510
  * 应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 均必填。
3905
3511
  */
3906
3512
  Agent: Agent
3907
-
3908
3513
  /**
3909
3514
  * 模板唯一标识,查询单个模板时使用
3910
3515
  */
3911
3516
  TemplateId?: string
3912
-
3913
3517
  /**
3914
3518
  * 查询内容:0-模板列表及详情(默认),1-仅模板列表
3915
3519
  */
3916
3520
  ContentType?: number
3917
-
3918
3521
  /**
3919
3522
  * 查询个数,默认20,最大100;在查询列表的时候有效
3920
3523
  */
3921
3524
  Limit?: number
3922
-
3923
3525
  /**
3924
3526
  * 查询偏移位置,默认0;在查询列表的时候有效
3925
3527
  */
3926
3528
  Offset?: number
3927
-
3928
3529
  /**
3929
3530
  * 是否返回所有组件信息。默认false,只返回发起方控件;true,返回所有签署方控件
3930
3531
  */
3931
3532
  QueryAllComponents?: boolean
3932
-
3933
3533
  /**
3934
3534
  * 模糊搜索模板名称,最大长度200
3935
3535
  */
3936
3536
  TemplateName?: string
3937
-
3938
3537
  /**
3939
3538
  * 是否获取模板预览链接
3940
3539
  */
3941
3540
  WithPreviewUrl?: boolean
3942
-
3943
3541
  /**
3944
3542
  * 是否获取模板的PDF文件链接- 第三方应用集成需要开启白名单时才能使用。
3945
3543
  */
3946
3544
  WithPdfUrl?: boolean
3947
-
3948
3545
  /**
3949
3546
  * 对应第三方应用平台企业的模板ID
3950
3547
  */
3951
3548
  ChannelTemplateId?: string
3952
-
3953
3549
  /**
3954
3550
  * 操作者的信息
3551
+ * @deprecated
3955
3552
  */
3956
3553
  Operator?: UserInfo
3957
3554
  }
@@ -3964,22 +3561,18 @@ export interface RelieveInfo {
3964
3561
  * 解除理由,最大支持200个字
3965
3562
  */
3966
3563
  Reason: string
3967
-
3968
3564
  /**
3969
3565
  * 解除后仍然有效的条款,保留条款,最大支持200个字
3970
3566
  */
3971
3567
  RemainInForceItem?: string
3972
-
3973
3568
  /**
3974
3569
  * 原合同事项处理-费用结算,最大支持200个字
3975
3570
  */
3976
3571
  OriginalExpenseSettlement?: string
3977
-
3978
3572
  /**
3979
3573
  * 原合同事项处理-其他事项,最大支持200个字
3980
3574
  */
3981
3575
  OriginalOtherSettlement?: string
3982
-
3983
3576
  /**
3984
3577
  * 其他约定,最大支持200个字
3985
3578
  */
@@ -3994,25 +3587,23 @@ export interface ChannelCreateSealPolicyRequest {
3994
3587
  * 应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 均必填。
3995
3588
  */
3996
3589
  Agent: Agent
3997
-
3998
3590
  /**
3999
3591
  * 指定印章ID
4000
3592
  */
4001
3593
  SealId: string
4002
-
4003
3594
  /**
4004
- * 指定待授权的用户ID数组,电子签的用户ID
3595
+ * 指定待授权的用户ID数组,电子签的用户ID
4005
3596
  可以填写OpenId,系统会通过组织+渠道+OpenId查询得到UserId进行授权。
4006
- */
3597
+ */
4007
3598
  UserIds: Array<string>
4008
-
4009
3599
  /**
4010
3600
  * 操作人(用户)信息,不用传
3601
+ * @deprecated
4011
3602
  */
4012
3603
  Operator?: UserInfo
4013
-
4014
3604
  /**
4015
3605
  * 企业机构信息,不用传
3606
+ * @deprecated
4016
3607
  */
4017
3608
  Organization?: OrganizationInfo
4018
3609
  }
@@ -4025,53 +3616,43 @@ export interface OccupiedSeal {
4025
3616
  * 电子印章编号
4026
3617
  */
4027
3618
  SealId: string
4028
-
4029
3619
  /**
4030
3620
  * 电子印章名称
4031
3621
  */
4032
3622
  SealName: string
4033
-
4034
3623
  /**
4035
3624
  * 电子印章授权时间戳,单位秒
4036
3625
  */
4037
3626
  CreateOn: number
4038
-
4039
3627
  /**
4040
3628
  * 电子印章授权人,电子签的UserId
4041
3629
  */
4042
3630
  Creator: string
4043
-
4044
3631
  /**
4045
3632
  * 电子印章策略Id
4046
3633
  */
4047
3634
  SealPolicyId: string
4048
-
4049
3635
  /**
4050
3636
  * 印章状态,有以下六种:CHECKING(审核中)SUCCESS(已启用)FAIL(审核拒绝)CHECKING-SADM(待超管审核)DISABLE(已停用)STOPPED(已终止)
4051
3637
  */
4052
3638
  SealStatus: string
4053
-
4054
3639
  /**
4055
- * 审核失败原因
3640
+ * 审核失败原因
4056
3641
  注意:此字段可能返回 null,表示取不到有效值。
4057
- */
3642
+ */
4058
3643
  FailReason: string
4059
-
4060
3644
  /**
4061
3645
  * 印章图片url,5分钟内有效
4062
3646
  */
4063
3647
  Url: string
4064
-
4065
3648
  /**
4066
3649
  * 印章类型,OFFICIAL-企业公章,CONTRACT-合同专用章,LEGAL_PERSON_SEAL-法人章
4067
3650
  */
4068
3651
  SealType: string
4069
-
4070
3652
  /**
4071
3653
  * 用印申请是否为永久授权
4072
3654
  */
4073
3655
  IsAllTime: boolean
4074
-
4075
3656
  /**
4076
3657
  * 授权人列表
4077
3658
  */
@@ -4086,26 +3667,23 @@ export interface CreateFlowsByTemplatesRequest {
4086
3667
  * 应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 均必填。
4087
3668
  */
4088
3669
  Agent: Agent
4089
-
4090
3670
  /**
4091
3671
  * 多个合同(签署流程)信息,最多支持20个
4092
3672
  */
4093
3673
  FlowInfos: Array<FlowInfo>
4094
-
4095
3674
  /**
4096
- * 是否为预览模式;默认为false,即非预览模式,此时发起合同并返回FlowIds;若为预览模式,不会发起合同,会返回PreviewUrls;
3675
+ * 是否为预览模式;默认为false,即非预览模式,此时发起合同并返回FlowIds;若为预览模式,不会发起合同,会返回PreviewUrls;
4097
3676
  预览链接有效期300秒;
4098
3677
  同时,如果预览的文件中指定了动态表格控件,需要进行异步合成;此时此接口返回的是合成前的文档预览链接,而合成完成后的文档预览链接会通过:回调通知的方式、或使用返回的TaskInfo中的TaskId通过ChannelGetTaskResultApi接口查询;
4099
- */
3678
+ */
4100
3679
  NeedPreview?: boolean
4101
-
4102
3680
  /**
4103
3681
  * 预览链接类型 默认:0-文件流, 1- H5链接 注意:此参数在NeedPreview 为true 时有效,
4104
3682
  */
4105
3683
  PreviewType?: number
4106
-
4107
3684
  /**
4108
3685
  * 操作者的信息,不用传
3686
+ * @deprecated
4109
3687
  */
4110
3688
  Operator?: UserInfo
4111
3689
  }
@@ -4118,34 +3696,29 @@ export interface UsageDetail {
4118
3696
  * 子客企业唯一标识
4119
3697
  */
4120
3698
  ProxyOrganizationOpenId: string
4121
-
4122
3699
  /**
4123
- * 子客企业名
3700
+ * 子客企业名
4124
3701
  注意:此字段可能返回 null,表示取不到有效值。
4125
- */
3702
+ */
4126
3703
  ProxyOrganizationName: string
4127
-
4128
3704
  /**
4129
- * 日期,当需要汇总数据时日期为空
3705
+ * 日期,当需要汇总数据时日期为空
4130
3706
  注意:此字段可能返回 null,表示取不到有效值。
4131
- */
3707
+ */
4132
3708
  Date: string
4133
-
4134
3709
  /**
4135
3710
  * 消耗数量
4136
3711
  */
4137
3712
  Usage: number
4138
-
4139
3713
  /**
4140
- * 撤回数量
3714
+ * 撤回数量
4141
3715
  注意:此字段可能返回 null,表示取不到有效值。
4142
- */
3716
+ */
4143
3717
  Cancel: number
4144
-
4145
3718
  /**
4146
- * 消耗渠道
3719
+ * 消耗渠道
4147
3720
  注意:此字段可能返回 null,表示取不到有效值。
4148
- */
3721
+ */
4149
3722
  FlowChannel: string
4150
3723
  }
4151
3724
 
@@ -4157,17 +3730,14 @@ export interface ChannelCreateBatchCancelFlowUrlResponse {
4157
3730
  * 批量撤销url
4158
3731
  */
4159
3732
  BatchCancelFlowUrl?: string
4160
-
4161
3733
  /**
4162
3734
  * 签署流程批量撤销失败原因
4163
3735
  */
4164
3736
  FailMessages?: Array<string>
4165
-
4166
3737
  /**
4167
3738
  * 签署撤销url过期时间-年月日-时分秒
4168
3739
  */
4169
3740
  UrlExpireOn?: string
4170
-
4171
3741
  /**
4172
3742
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
4173
3743
  */
@@ -4182,29 +3752,25 @@ export interface OperateChannelTemplateRequest {
4182
3752
  * 应用相关信息。 此接口Agent.AppId必填。
4183
3753
  */
4184
3754
  Agent: Agent
4185
-
4186
3755
  /**
4187
3756
  * 操作类型,查询:"SELECT",删除:"DELETE",更新:"UPDATE"
4188
3757
  */
4189
3758
  OperateType: string
4190
-
4191
3759
  /**
4192
3760
  * 第三方应用平台模板库模板唯一标识
4193
3761
  */
4194
3762
  TemplateId: string
4195
-
4196
3763
  /**
4197
3764
  * 合作企业方第三方机构唯一标识数据,支持多个, 用","进行分隔
4198
3765
  */
4199
3766
  ProxyOrganizationOpenIds?: string
4200
-
4201
3767
  /**
4202
3768
  * 模板可见性, 全部可见-"all", 部分可见-"part"
4203
3769
  */
4204
3770
  AuthTag?: string
4205
-
4206
3771
  /**
4207
3772
  * 暂未开放
3773
+ * @deprecated
4208
3774
  */
4209
3775
  Operator?: UserInfo
4210
3776
  }
@@ -4214,24 +3780,21 @@ export interface OperateChannelTemplateRequest {
4214
3780
  */
4215
3781
  export interface CreateChannelFlowEvidenceReportResponse {
4216
3782
  /**
4217
- * 出证报告 ID,用于查询出证报告接口DescribeChannelFlowEvidenceReport时用到
3783
+ * 出证报告 ID,用于查询出证报告接口DescribeChannelFlowEvidenceReport时用到
4218
3784
  注意:此字段可能返回 null,表示取不到有效值。
4219
- */
3785
+ */
4220
3786
  ReportId?: string
4221
-
4222
3787
  /**
4223
- * 执行中:EvidenceStatusExecuting
3788
+ * 执行中:EvidenceStatusExecuting
4224
3789
  成功:EvidenceStatusSuccess
4225
3790
  失败:EvidenceStatusFailed
4226
- */
3791
+ */
4227
3792
  Status?: string
4228
-
4229
3793
  /**
4230
- * 废除,字段无效
3794
+ * 废除,字段无效
4231
3795
  注意:此字段可能返回 null,表示取不到有效值。
4232
- */
3796
+ */
4233
3797
  ReportUrl?: string
4234
-
4235
3798
  /**
4236
3799
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
4237
3800
  */
@@ -4246,12 +3809,11 @@ export interface SyncFailReason {
4246
3809
  * 对应Agent-ProxyOperator-OpenId。第三方应用平台自定义,对子客企业员的唯一标识。一个OpenId在一个子客企业内唯一对应一个真实员工,不可在其他子客企业内重复使用。(例如,可以使用经办人企业名+员工身份证的hash值,需要第三方应用平台保存),最大64位字符串
4247
3810
  */
4248
3811
  Id: string
4249
-
4250
3812
  /**
4251
- * 失败原因
3813
+ * 失败原因
4252
3814
  例如:Id不符合规范、证件号码不合法等
4253
3815
  注意:此字段可能返回 null,表示取不到有效值。
4254
- */
3816
+ */
4255
3817
  Message: string
4256
3818
  }
4257
3819
 
@@ -4260,27 +3822,23 @@ export interface SyncFailReason {
4260
3822
  */
4261
3823
  export interface ChannelDescribeEmployeesResponse {
4262
3824
  /**
4263
- * 员工数据列表
3825
+ * 员工数据列表
4264
3826
  注意:此字段可能返回 null,表示取不到有效值。
4265
- */
3827
+ */
4266
3828
  Employees?: Array<Staff>
4267
-
4268
3829
  /**
4269
- * 偏移量,默认为0,最大为20000
3830
+ * 偏移量,默认为0,最大为20000
4270
3831
  注意:此字段可能返回 null,表示取不到有效值。
4271
- */
3832
+ */
4272
3833
  Offset?: number
4273
-
4274
3834
  /**
4275
3835
  * 返回最大数量,最大为20
4276
3836
  */
4277
3837
  Limit?: number
4278
-
4279
3838
  /**
4280
3839
  * 符合条件的员工数量
4281
3840
  */
4282
3841
  TotalCount?: number
4283
-
4284
3842
  /**
4285
3843
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
4286
3844
  */
@@ -4295,7 +3853,6 @@ export interface ChannelCreateReleaseFlowResponse {
4295
3853
  * 解除协议流程编号
4296
3854
  */
4297
3855
  FlowId?: string
4298
-
4299
3856
  /**
4300
3857
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
4301
3858
  */
@@ -4307,18 +3864,16 @@ export interface ChannelCreateReleaseFlowResponse {
4307
3864
  */
4308
3865
  export interface DescribeChannelFlowEvidenceReportResponse {
4309
3866
  /**
4310
- * 出证报告 URL
3867
+ * 出证报告 URL
4311
3868
  注意:此字段可能返回 null,表示取不到有效值。
4312
- */
3869
+ */
4313
3870
  ReportUrl?: string
4314
-
4315
3871
  /**
4316
- * 执行中:EvidenceStatusExecuting
3872
+ * 执行中:EvidenceStatusExecuting
4317
3873
  成功:EvidenceStatusSuccess
4318
3874
  失败:EvidenceStatusFailed
4319
- */
3875
+ */
4320
3876
  Status?: string
4321
-
4322
3877
  /**
4323
3878
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
4324
3879
  */
@@ -4333,19 +3888,17 @@ export interface CreateSealByImageRequest {
4333
3888
  * 应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 均必填。
4334
3889
  */
4335
3890
  Agent: Agent
4336
-
4337
3891
  /**
4338
3892
  * 印章名称,最大长度不超过50字符
4339
3893
  */
4340
3894
  SealName: string
4341
-
4342
3895
  /**
4343
3896
  * 印章图片base64,大小不超过10M(原始图片不超过7.6M)
4344
3897
  */
4345
3898
  SealImage: string
4346
-
4347
3899
  /**
4348
3900
  * 操作者的信息
3901
+ * @deprecated
4349
3902
  */
4350
3903
  Operator?: UserInfo
4351
3904
  }
@@ -4368,24 +3921,22 @@ export interface ChannelCreateFlowSignUrlRequest {
4368
3921
  * 应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 均必填
4369
3922
  */
4370
3923
  Agent: Agent
4371
-
4372
3924
  /**
4373
3925
  * 流程编号
4374
3926
  */
4375
3927
  FlowId: string
4376
-
4377
3928
  /**
4378
3929
  * 流程签署人,其中Name和Mobile必传,其他可不传,ApproverType目前只支持PERSON类型的签署人,如果不传默认为该值。还需注意签署人只能有手写签名和时间类型的签署控件,其他类型的填写控件和签署控件暂时都未支持。
4379
3930
  */
4380
3931
  FlowApproverInfos: Array<FlowApproverInfo>
4381
-
4382
3932
  /**
4383
3933
  * 用户信息,暂未开放
3934
+ * @deprecated
4384
3935
  */
4385
3936
  Operator?: UserInfo
4386
-
4387
3937
  /**
4388
3938
  * 机构信息,暂未开放
3939
+ * @deprecated
4389
3940
  */
4390
3941
  Organization?: OrganizationInfo
4391
3942
  }
@@ -4395,11 +3946,10 @@ export interface ChannelCreateFlowSignUrlRequest {
4395
3946
  */
4396
3947
  export interface DescribeExtendedServiceAuthInfoResponse {
4397
3948
  /**
4398
- * 企业扩展服务授权信息
3949
+ * 企业扩展服务授权信息
4399
3950
  注意:此字段可能返回 null,表示取不到有效值。
4400
- */
3951
+ */
4401
3952
  AuthInfo?: Array<ExtentServiceAuthInfo>
4402
-
4403
3953
  /**
4404
3954
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
4405
3955
  */
@@ -4414,24 +3964,21 @@ export interface ChannelCreateEmbedWebUrlRequest {
4414
3964
  * 渠道应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 必填。
4415
3965
  */
4416
3966
  Agent: Agent
4417
-
4418
3967
  /**
4419
3968
  * WEB嵌入资源类型,取值范围:CREATE_SEAL创建印章,CREATE_TEMPLATE创建模板,MODIFY_TEMPLATE修改模板,PREVIEW_TEMPLATE预览模板,PREVIEW_FLOW预览流程
4420
3969
  */
4421
3970
  EmbedType: string
4422
-
4423
3971
  /**
4424
3972
  * WEB嵌入的业务资源ID,EmbedType取值MODIFY_TEMPLATE或PREVIEW_TEMPLATE或 PREVIEW_FLOW时BusinessId必填
4425
3973
  */
4426
3974
  BusinessId?: string
4427
-
4428
3975
  /**
4429
3976
  * 是否隐藏控件,只有预览模板时生效
4430
3977
  */
4431
3978
  HiddenComponents?: boolean
4432
-
4433
3979
  /**
4434
3980
  * 渠道操作者信息
3981
+ * @deprecated
4435
3982
  */
4436
3983
  Operator?: UserInfo
4437
3984
  }
@@ -4444,22 +3991,19 @@ export interface CcInfo {
4444
3991
  * 被抄送人手机号,大陆11位手机号
4445
3992
  */
4446
3993
  Mobile?: string
4447
-
4448
3994
  /**
4449
3995
  * 被抄送人姓名
4450
3996
  */
4451
3997
  Name?: string
4452
-
4453
3998
  /**
4454
- * 被抄送人类型
3999
+ * 被抄送人类型
4455
4000
  0--个人. 1--员工
4456
- */
4001
+ */
4457
4002
  CcType?: number
4458
-
4459
4003
  /**
4460
- * 被抄送人权限
4004
+ * 被抄送人权限
4461
4005
  0--可查看
4462
4006
  1--可查看也可下载
4463
- */
4007
+ */
4464
4008
  CcPermission?: number
4465
4009
  }