tencentcloud-sdk-nodejs-essbasic 4.0.372 → 4.0.375
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +760 -0
- package/SERVICE_CHANGELOG.md +791 -51
- package/package.json +1 -1
- package/products.md +30 -28
- package/src/services/essbasic/v20210526/essbasic_client.ts +7 -7
- package/src/services/essbasic/v20210526/essbasic_models.ts +222 -206
- package/tencentcloud/services/essbasic/v20210526/essbasic_client.d.ts +7 -7
- package/tencentcloud/services/essbasic/v20210526/essbasic_client.js +7 -7
- package/tencentcloud/services/essbasic/v20210526/essbasic_models.d.ts +212 -199
|
@@ -49,86 +49,94 @@ export interface SyncProxyOrganizationResponse {
|
|
|
49
49
|
}
|
|
50
50
|
|
|
51
51
|
/**
|
|
52
|
-
*
|
|
52
|
+
* 创建签署流程签署人入参
|
|
53
53
|
*/
|
|
54
54
|
export interface FlowApproverInfo {
|
|
55
55
|
/**
|
|
56
|
-
*
|
|
56
|
+
* 签署人姓名,最大长度50个字符
|
|
57
57
|
*/
|
|
58
58
|
Name?: string
|
|
59
59
|
|
|
60
60
|
/**
|
|
61
|
-
|
|
61
|
+
* 经办人身份证件类型
|
|
62
|
+
1.ID_CARD 居民身份证
|
|
63
|
+
2.HONGKONG_MACAO_AND_TAIWAN 港澳台居民居住证
|
|
64
|
+
3.HONGKONG_AND_MACAO 港澳居民来往内地通行证
|
|
65
|
+
*/
|
|
66
|
+
IdCardType?: string
|
|
67
|
+
|
|
68
|
+
/**
|
|
69
|
+
* 经办人证件号
|
|
62
70
|
*/
|
|
63
71
|
IdCardNumber?: string
|
|
64
72
|
|
|
65
73
|
/**
|
|
66
|
-
*
|
|
74
|
+
* 签署人手机号,脱敏显示。大陆手机号为11位,暂不支持海外手机号。
|
|
67
75
|
*/
|
|
68
76
|
Mobile?: string
|
|
69
77
|
|
|
70
78
|
/**
|
|
71
|
-
*
|
|
79
|
+
* 企业签署方工商营业执照上的企业名称,签署方为非发起方企业场景下必传,最大长度64个字符;
|
|
72
80
|
*/
|
|
73
|
-
|
|
81
|
+
OrganizationName?: string
|
|
74
82
|
|
|
75
83
|
/**
|
|
76
|
-
|
|
84
|
+
* 指定签署人非渠道企业下员工,在ApproverType为ORGANIZATION时指定。
|
|
85
|
+
默认为false,即签署人位于同一个渠道应用号下;
|
|
86
|
+
*/
|
|
87
|
+
NotChannelOrganization?: boolean
|
|
88
|
+
|
|
89
|
+
/**
|
|
90
|
+
* 用户侧第三方id,最大长度64个字符
|
|
77
91
|
*/
|
|
78
|
-
|
|
92
|
+
OpenId?: string
|
|
79
93
|
|
|
80
94
|
/**
|
|
81
|
-
*
|
|
95
|
+
* 企业签署方在同一渠道下的其他合作企业OpenId,签署方为非发起方企业场景下必传,最大长度64个字符;
|
|
82
96
|
*/
|
|
83
|
-
|
|
97
|
+
OrganizationOpenId?: string
|
|
84
98
|
|
|
85
99
|
/**
|
|
86
100
|
* 签署人类型,PERSON-个人;ORGANIZATION-企业;
|
|
87
101
|
ENTERPRISESERVER-企业静默签;
|
|
88
|
-
注:ENTERPRISESERVER
|
|
102
|
+
注:ENTERPRISESERVER 类型仅用于使用文件创建签署流程(ChannelCreateFlowByFiles)接口;并且仅能指定发起方企业签署方为静默签署;
|
|
89
103
|
*/
|
|
90
104
|
ApproverType?: string
|
|
91
105
|
|
|
92
106
|
/**
|
|
93
|
-
*
|
|
107
|
+
* 签署流程签署人在模板中对应的签署人Id;在非单方签署、以及非B2C签署的场景下必传,用于指定当前签署方在签署流程中的位置;
|
|
94
108
|
*/
|
|
95
|
-
|
|
109
|
+
RecipientId?: string
|
|
96
110
|
|
|
97
111
|
/**
|
|
98
|
-
*
|
|
112
|
+
* 签署截止时间,默认一年
|
|
99
113
|
*/
|
|
100
|
-
|
|
114
|
+
Deadline?: number
|
|
101
115
|
|
|
102
116
|
/**
|
|
103
|
-
*
|
|
117
|
+
* 签署完回调url,最大长度1000个字符
|
|
104
118
|
*/
|
|
105
|
-
|
|
119
|
+
CallbackUrl?: string
|
|
106
120
|
|
|
107
121
|
/**
|
|
108
|
-
*
|
|
122
|
+
* 使用PDF文件直接发起合同时,签署人指定的签署控件
|
|
109
123
|
*/
|
|
110
|
-
|
|
124
|
+
SignComponents?: Array<Component>
|
|
111
125
|
|
|
112
126
|
/**
|
|
113
|
-
*
|
|
127
|
+
* 个人签署方指定签署控件类型,目前仅支持:OCR_ESIGN(AI智慧手写签名)
|
|
114
128
|
*/
|
|
115
|
-
|
|
129
|
+
ComponentLimitType?: Array<string>
|
|
116
130
|
|
|
117
131
|
/**
|
|
118
|
-
*
|
|
132
|
+
* 合同的强制预览时间:3~300s,未指定则按合同页数计算
|
|
119
133
|
*/
|
|
120
|
-
|
|
121
|
-
|
|
122
|
-
/**
|
|
123
|
-
* 指定签署人非渠道企业下员工,在ApproverType为ORGANIZATION时指定。
|
|
124
|
-
默认为false,即签署人位于同一个渠道应用号下;
|
|
125
|
-
*/
|
|
126
|
-
NotChannelOrganization?: boolean
|
|
134
|
+
PreReadTime?: number
|
|
127
135
|
|
|
128
136
|
/**
|
|
129
|
-
*
|
|
137
|
+
* 签署完前端跳转的url,暂未使用
|
|
130
138
|
*/
|
|
131
|
-
|
|
139
|
+
JumpUrl?: string
|
|
132
140
|
}
|
|
133
141
|
|
|
134
142
|
/**
|
|
@@ -151,31 +159,30 @@ export interface PrepareFlowsResponse {
|
|
|
151
159
|
*/
|
|
152
160
|
export interface ProxyOrganizationOperator {
|
|
153
161
|
/**
|
|
154
|
-
* 经办人ID
|
|
162
|
+
* 经办人ID(渠道颁发),最大长度64个字符
|
|
155
163
|
*/
|
|
156
164
|
Id: string
|
|
157
165
|
|
|
158
166
|
/**
|
|
159
|
-
*
|
|
167
|
+
* 经办人姓名,最大长度50个字符
|
|
160
168
|
*/
|
|
161
169
|
Name?: string
|
|
162
170
|
|
|
163
171
|
/**
|
|
164
172
|
* 经办人身份证件类型
|
|
165
|
-
|
|
166
|
-
|
|
167
|
-
|
|
168
|
-
3. TEMP_ID_CARD - 临时居民身份证
|
|
173
|
+
1.ID_CARD 居民身份证
|
|
174
|
+
2.HONGKONG_MACAO_AND_TAIWAN 港澳台居民居住证
|
|
175
|
+
3.HONGKONG_AND_MACAO 港澳居民来往内地通行证
|
|
169
176
|
*/
|
|
170
177
|
IdCardType?: string
|
|
171
178
|
|
|
172
179
|
/**
|
|
173
|
-
*
|
|
180
|
+
* 经办人证件号
|
|
174
181
|
*/
|
|
175
182
|
IdCardNumber?: string
|
|
176
183
|
|
|
177
184
|
/**
|
|
178
|
-
*
|
|
185
|
+
* 经办人手机号,大陆手机号输入11位,暂不支持海外手机号。
|
|
179
186
|
*/
|
|
180
187
|
Mobile?: string
|
|
181
188
|
}
|
|
@@ -210,29 +217,29 @@ export interface TemplateInfo {
|
|
|
210
217
|
SignComponents: Array<Component>
|
|
211
218
|
|
|
212
219
|
/**
|
|
213
|
-
*
|
|
220
|
+
* 模板中的流程参与人信息
|
|
214
221
|
*/
|
|
215
|
-
|
|
222
|
+
Recipients: Array<Recipient>
|
|
216
223
|
|
|
217
224
|
/**
|
|
218
|
-
*
|
|
225
|
+
* 模板类型:1-静默签;2-静默签授权;3-普通模板
|
|
219
226
|
*/
|
|
220
|
-
|
|
227
|
+
TemplateType: number
|
|
221
228
|
|
|
222
229
|
/**
|
|
223
|
-
*
|
|
230
|
+
* 是否是发起人
|
|
224
231
|
*/
|
|
225
|
-
|
|
232
|
+
IsPromoter: boolean
|
|
226
233
|
|
|
227
234
|
/**
|
|
228
|
-
*
|
|
235
|
+
* 模板的创建者信息
|
|
229
236
|
*/
|
|
230
|
-
|
|
237
|
+
Creator: string
|
|
231
238
|
|
|
232
239
|
/**
|
|
233
|
-
*
|
|
240
|
+
* 模板创建的时间戳(精确到秒)
|
|
234
241
|
*/
|
|
235
|
-
|
|
242
|
+
CreatedOn: number
|
|
236
243
|
}
|
|
237
244
|
|
|
238
245
|
/**
|
|
@@ -255,7 +262,7 @@ export interface GetDownloadFlowUrlResponse {
|
|
|
255
262
|
*/
|
|
256
263
|
export interface DescribeResourceUrlsByFlowsResponse {
|
|
257
264
|
/**
|
|
258
|
-
*
|
|
265
|
+
* 签署流程资源对应链接信息
|
|
259
266
|
*/
|
|
260
267
|
FlowResourceUrlInfos: Array<FlowResourceUrlInfo>
|
|
261
268
|
|
|
@@ -422,22 +429,17 @@ export interface CreateSignUrlsRequest {
|
|
|
422
429
|
Agent: Agent
|
|
423
430
|
|
|
424
431
|
/**
|
|
425
|
-
*
|
|
432
|
+
* 签署流程编号数组,最多支持100个。
|
|
426
433
|
*/
|
|
427
434
|
FlowIds: Array<string>
|
|
428
435
|
|
|
429
436
|
/**
|
|
430
|
-
*
|
|
431
|
-
*/
|
|
432
|
-
Operator?: UserInfo
|
|
433
|
-
|
|
434
|
-
/**
|
|
435
|
-
* 签署链接类型,默认:“WEIXINAPP”-直接跳小程序; “CHANNEL”-跳转H5页面; “APP”-第三方APP或小程序跳转电子签小程序;
|
|
437
|
+
* 签署链接类型:“WEIXINAPP”-直接跳小程序;“CHANNEL”-跳转H5页面;“APP”-第三方APP或小程序跳转电子签小程序;默认“WEIXINAPP”类型,即跳转至小程序。
|
|
436
438
|
*/
|
|
437
439
|
Endpoint?: string
|
|
438
440
|
|
|
439
441
|
/**
|
|
440
|
-
* 签署完之后的H5页面的跳转链接,针对Endpoint为CHANNEL
|
|
442
|
+
* 签署完之后的H5页面的跳转链接,针对Endpoint为CHANNEL时有效,最大长度1000个字符。
|
|
441
443
|
*/
|
|
442
444
|
JumpUrl?: string
|
|
443
445
|
|
|
@@ -445,6 +447,11 @@ export interface CreateSignUrlsRequest {
|
|
|
445
447
|
* Endpoint为"APP" 类型的签署链接,可以设置此值;支持调用方小程序打开签署链接,在电子签小程序完成签署后自动回跳至调用方小程序
|
|
446
448
|
*/
|
|
447
449
|
AutoJumpBack?: boolean
|
|
450
|
+
|
|
451
|
+
/**
|
|
452
|
+
* 操作者的信息
|
|
453
|
+
*/
|
|
454
|
+
Operator?: UserInfo
|
|
448
455
|
}
|
|
449
456
|
|
|
450
457
|
/**
|
|
@@ -463,17 +470,17 @@ export interface ChannelCreateMultiFlowSignQRCodeRequest {
|
|
|
463
470
|
TemplateId: string
|
|
464
471
|
|
|
465
472
|
/**
|
|
466
|
-
*
|
|
473
|
+
* 签署流程名称,最大长度200个字符。
|
|
467
474
|
*/
|
|
468
475
|
FlowName: string
|
|
469
476
|
|
|
470
477
|
/**
|
|
471
|
-
*
|
|
478
|
+
* 最大可发起签署流程份数,默认5份;发起签署流程数量超过此上限后,二维码自动失效。
|
|
472
479
|
*/
|
|
473
|
-
|
|
480
|
+
MaxFlowNum?: number
|
|
474
481
|
|
|
475
482
|
/**
|
|
476
|
-
*
|
|
483
|
+
* 签署流程有效天数 默认7天 最高设置不超过30天
|
|
477
484
|
*/
|
|
478
485
|
FlowEffectiveDay?: number
|
|
479
486
|
|
|
@@ -483,14 +490,16 @@ export interface ChannelCreateMultiFlowSignQRCodeRequest {
|
|
|
483
490
|
QrEffectiveDay?: number
|
|
484
491
|
|
|
485
492
|
/**
|
|
486
|
-
|
|
487
|
-
|
|
488
|
-
|
|
493
|
+
* 回调地址,最大长度1000个字符
|
|
494
|
+
不传默认使用渠道应用号配置的回调地址
|
|
495
|
+
回调时机:用户通过签署二维码发起合同时,企业额度不足导致失败
|
|
496
|
+
*/
|
|
497
|
+
CallbackUrl?: string
|
|
489
498
|
|
|
490
499
|
/**
|
|
491
|
-
*
|
|
500
|
+
* 用户信息
|
|
492
501
|
*/
|
|
493
|
-
|
|
502
|
+
Operator?: UserInfo
|
|
494
503
|
}
|
|
495
504
|
|
|
496
505
|
/**
|
|
@@ -518,7 +527,7 @@ export interface DescribeFlowDetailInfoRequest {
|
|
|
518
527
|
Agent: Agent
|
|
519
528
|
|
|
520
529
|
/**
|
|
521
|
-
* 合同(流程)
|
|
530
|
+
* 合同(流程)编号数组,最多支持100个。
|
|
522
531
|
*/
|
|
523
532
|
FlowIds: Array<string>
|
|
524
533
|
|
|
@@ -552,6 +561,11 @@ export interface SignQrCode {
|
|
|
552
561
|
* UploadFiles请求参数结构体
|
|
553
562
|
*/
|
|
554
563
|
export interface UploadFilesRequest {
|
|
564
|
+
/**
|
|
565
|
+
* 应用相关信息,若是渠道版调用 appid 和proxyappid 必填
|
|
566
|
+
*/
|
|
567
|
+
Agent: Agent
|
|
568
|
+
|
|
555
569
|
/**
|
|
556
570
|
* 文件对应业务类型,用于区分文件存储路径:
|
|
557
571
|
1. TEMPLATE - 模板; 文件类型:.pdf
|
|
@@ -559,11 +573,6 @@ export interface UploadFilesRequest {
|
|
|
559
573
|
*/
|
|
560
574
|
BusinessType: string
|
|
561
575
|
|
|
562
|
-
/**
|
|
563
|
-
* 应用相关信息,若是渠道版调用 appid 和proxyappid 必填
|
|
564
|
-
*/
|
|
565
|
-
Agent: Agent
|
|
566
|
-
|
|
567
576
|
/**
|
|
568
577
|
* 上传文件内容数组,最多支持20个文件
|
|
569
578
|
*/
|
|
@@ -586,14 +595,14 @@ export interface DescribeResourceUrlsByFlowsRequest {
|
|
|
586
595
|
Agent: Agent
|
|
587
596
|
|
|
588
597
|
/**
|
|
589
|
-
*
|
|
598
|
+
* 查询资源所对应的签署流程Id,最多支持50个。
|
|
590
599
|
*/
|
|
591
|
-
|
|
600
|
+
FlowIds?: Array<string>
|
|
592
601
|
|
|
593
602
|
/**
|
|
594
|
-
*
|
|
603
|
+
* 操作者的信息
|
|
595
604
|
*/
|
|
596
|
-
|
|
605
|
+
Operator?: UserInfo
|
|
597
606
|
}
|
|
598
607
|
|
|
599
608
|
/**
|
|
@@ -644,7 +653,7 @@ SIGN_PERSONAL_SEAL - 个人签署印章控件;
|
|
|
644
653
|
ComponentType?: string
|
|
645
654
|
|
|
646
655
|
/**
|
|
647
|
-
*
|
|
656
|
+
* 控件简称,不能超过30个字符
|
|
648
657
|
*/
|
|
649
658
|
ComponentName?: string
|
|
650
659
|
|
|
@@ -654,7 +663,7 @@ SIGN_PERSONAL_SEAL - 个人签署印章控件;
|
|
|
654
663
|
ComponentRequired?: boolean
|
|
655
664
|
|
|
656
665
|
/**
|
|
657
|
-
* 控件所属文件的序号 (
|
|
666
|
+
* 控件所属文件的序号 (文档中文件的排列序号,从0开始)
|
|
658
667
|
*/
|
|
659
668
|
FileIndex?: number
|
|
660
669
|
|
|
@@ -679,7 +688,7 @@ KEYWORD - 关键字
|
|
|
679
688
|
ComponentHeight?: number
|
|
680
689
|
|
|
681
690
|
/**
|
|
682
|
-
*
|
|
691
|
+
* 参数控件所在页码,从1开始
|
|
683
692
|
*/
|
|
684
693
|
ComponentPage?: number
|
|
685
694
|
|
|
@@ -720,17 +729,17 @@ TEXT控件可以指定字体
|
|
|
720
729
|
DocumentId?: string
|
|
721
730
|
|
|
722
731
|
/**
|
|
723
|
-
*
|
|
732
|
+
* 控件描述,不能超过30个字符
|
|
724
733
|
*/
|
|
725
734
|
ComponentDescription?: string
|
|
726
735
|
|
|
727
736
|
/**
|
|
728
|
-
*
|
|
737
|
+
* 指定关键字时横坐标偏移量,单位pt
|
|
729
738
|
*/
|
|
730
739
|
OffsetX?: number
|
|
731
740
|
|
|
732
741
|
/**
|
|
733
|
-
*
|
|
742
|
+
* 指定关键字时纵坐标偏移量,单位pt
|
|
734
743
|
*/
|
|
735
744
|
OffsetY?: number
|
|
736
745
|
}
|
|
@@ -745,14 +754,14 @@ export interface GetDownloadFlowUrlRequest {
|
|
|
745
754
|
Agent: Agent
|
|
746
755
|
|
|
747
756
|
/**
|
|
748
|
-
*
|
|
757
|
+
* 文件夹数组,签署流程总数不能超过50个,一个文件夹下,不能超过20个签署流程
|
|
749
758
|
*/
|
|
750
|
-
|
|
759
|
+
DownLoadFlows?: Array<DownloadFlowInfo>
|
|
751
760
|
|
|
752
761
|
/**
|
|
753
|
-
*
|
|
762
|
+
* 操作者的信息
|
|
754
763
|
*/
|
|
755
|
-
|
|
764
|
+
Operator?: UserInfo
|
|
756
765
|
}
|
|
757
766
|
|
|
758
767
|
/**
|
|
@@ -811,39 +820,39 @@ export interface FlowDetailInfo {
|
|
|
811
820
|
export interface CreateConsoleLoginUrlRequest {
|
|
812
821
|
/**
|
|
813
822
|
* 应用信息
|
|
814
|
-
此接口Agent.ProxyOrganizationOpenId 和 Agent. ProxyOperator.OpenId 必填
|
|
823
|
+
此接口Agent.AppId、Agent.ProxyOrganizationOpenId 和 Agent. ProxyOperator.OpenId 必填
|
|
815
824
|
*/
|
|
816
825
|
Agent: Agent
|
|
817
826
|
|
|
818
827
|
/**
|
|
819
|
-
*
|
|
828
|
+
* 渠道侧合作企业名称,最大长度64个字符
|
|
820
829
|
*/
|
|
821
830
|
ProxyOrganizationName: string
|
|
822
831
|
|
|
823
832
|
/**
|
|
824
|
-
*
|
|
833
|
+
* 渠道侧合作企业经办人的姓名,最大长度50个字符
|
|
825
834
|
*/
|
|
826
|
-
|
|
835
|
+
ProxyOperatorName?: string
|
|
827
836
|
|
|
828
837
|
/**
|
|
829
|
-
*
|
|
838
|
+
* 控制台指定模块,文件/合同管理:"DOCUMENT",模板管理:"TEMPLATE",印章管理:"SEAL",组织架构/人员:"OPERATOR",空字符串:"账号信息"
|
|
830
839
|
*/
|
|
831
|
-
|
|
840
|
+
Module?: string
|
|
832
841
|
|
|
833
842
|
/**
|
|
834
|
-
*
|
|
843
|
+
* 控制台指定模块Id
|
|
835
844
|
*/
|
|
836
|
-
|
|
845
|
+
ModuleId?: string
|
|
837
846
|
|
|
838
847
|
/**
|
|
839
|
-
*
|
|
848
|
+
* 渠道侧合作企业统一社会信用代码,最大长度200个字符
|
|
840
849
|
*/
|
|
841
|
-
|
|
850
|
+
UniformSocialCreditCode?: string
|
|
842
851
|
|
|
843
852
|
/**
|
|
844
|
-
*
|
|
853
|
+
* 操作者的信息
|
|
845
854
|
*/
|
|
846
|
-
|
|
855
|
+
Operator?: UserInfo
|
|
847
856
|
}
|
|
848
857
|
|
|
849
858
|
/**
|
|
@@ -882,17 +891,17 @@ export interface CreateFlowsByTemplatesResponse {
|
|
|
882
891
|
*/
|
|
883
892
|
export interface PrepareFlowsRequest {
|
|
884
893
|
/**
|
|
885
|
-
*
|
|
894
|
+
* 渠道应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 均必填。
|
|
886
895
|
*/
|
|
887
896
|
Agent: Agent
|
|
888
897
|
|
|
889
898
|
/**
|
|
890
|
-
*
|
|
899
|
+
* 多个合同(签署流程)信息,最大支持20个签署流程。
|
|
891
900
|
*/
|
|
892
901
|
FlowInfos: Array<FlowInfo>
|
|
893
902
|
|
|
894
903
|
/**
|
|
895
|
-
*
|
|
904
|
+
* 操作完成后的跳转地址,最大长度200
|
|
896
905
|
*/
|
|
897
906
|
JumpUrl: string
|
|
898
907
|
|
|
@@ -967,11 +976,6 @@ export interface DescribeTemplatesRequest {
|
|
|
967
976
|
*/
|
|
968
977
|
Agent: Agent
|
|
969
978
|
|
|
970
|
-
/**
|
|
971
|
-
* 操作者的信息
|
|
972
|
-
*/
|
|
973
|
-
Operator?: UserInfo
|
|
974
|
-
|
|
975
979
|
/**
|
|
976
980
|
* 模板唯一标识
|
|
977
981
|
*/
|
|
@@ -991,6 +995,11 @@ export interface DescribeTemplatesRequest {
|
|
|
991
995
|
* 查询偏移位置,默认0
|
|
992
996
|
*/
|
|
993
997
|
Offset?: number
|
|
998
|
+
|
|
999
|
+
/**
|
|
1000
|
+
* 操作者的信息
|
|
1001
|
+
*/
|
|
1002
|
+
Operator?: UserInfo
|
|
994
1003
|
}
|
|
995
1004
|
|
|
996
1005
|
/**
|
|
@@ -998,17 +1007,17 @@ export interface DescribeTemplatesRequest {
|
|
|
998
1007
|
*/
|
|
999
1008
|
export interface SyncProxyOrganizationOperatorsRequest {
|
|
1000
1009
|
/**
|
|
1001
|
-
*
|
|
1010
|
+
* 渠道应用相关信息。 此接口Agent.AppId 和 Agent.ProxyOrganizationOpenId必填。
|
|
1002
1011
|
*/
|
|
1003
|
-
|
|
1012
|
+
Agent: Agent
|
|
1004
1013
|
|
|
1005
1014
|
/**
|
|
1006
|
-
*
|
|
1015
|
+
* 操作类型,新增:"CREATE",修改:"UPDATE",离职:"RESIGN"
|
|
1007
1016
|
*/
|
|
1008
|
-
|
|
1017
|
+
OperatorType: string
|
|
1009
1018
|
|
|
1010
1019
|
/**
|
|
1011
|
-
*
|
|
1020
|
+
* 经办人信息列表,最大长度200
|
|
1012
1021
|
*/
|
|
1013
1022
|
ProxyOrganizationOperators: Array<ProxyOrganizationOperator>
|
|
1014
1023
|
|
|
@@ -1044,24 +1053,25 @@ export interface CreateConsoleLoginUrlResponse {
|
|
|
1044
1053
|
*/
|
|
1045
1054
|
export interface CreateFlowsByTemplatesRequest {
|
|
1046
1055
|
/**
|
|
1047
|
-
*
|
|
1056
|
+
* 渠道应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 均必填。
|
|
1048
1057
|
*/
|
|
1049
1058
|
Agent: Agent
|
|
1050
1059
|
|
|
1051
1060
|
/**
|
|
1052
|
-
*
|
|
1061
|
+
* 多个合同(签署流程)信息,最多支持20个
|
|
1053
1062
|
*/
|
|
1054
1063
|
FlowInfos: Array<FlowInfo>
|
|
1055
1064
|
|
|
1056
1065
|
/**
|
|
1057
|
-
|
|
1058
|
-
|
|
1059
|
-
|
|
1066
|
+
* 是否为预览模式;默认为false,即非预览模式,此时发起合同并返回FlowIds;若为预览模式,则返回PreviewUrls;
|
|
1067
|
+
预览链接有效期300秒;
|
|
1068
|
+
*/
|
|
1069
|
+
NeedPreview?: boolean
|
|
1060
1070
|
|
|
1061
1071
|
/**
|
|
1062
|
-
*
|
|
1072
|
+
* 操作者的信息
|
|
1063
1073
|
*/
|
|
1064
|
-
|
|
1074
|
+
Operator?: UserInfo
|
|
1065
1075
|
}
|
|
1066
1076
|
|
|
1067
1077
|
/**
|
|
@@ -1070,24 +1080,24 @@ export interface CreateFlowsByTemplatesRequest {
|
|
|
1070
1080
|
export interface SyncProxyOrganizationRequest {
|
|
1071
1081
|
/**
|
|
1072
1082
|
* 应用信息
|
|
1073
|
-
此接口Agent.ProxyOrganizationOpenId必填
|
|
1083
|
+
此接口Agent.AppId、Agent.ProxyOrganizationOpenId必填
|
|
1074
1084
|
*/
|
|
1075
1085
|
Agent: Agent
|
|
1076
1086
|
|
|
1077
1087
|
/**
|
|
1078
|
-
*
|
|
1088
|
+
* 渠道侧合作企业名称,最大长度64个字符
|
|
1079
1089
|
*/
|
|
1080
1090
|
ProxyOrganizationName: string
|
|
1081
1091
|
|
|
1082
1092
|
/**
|
|
1083
|
-
*
|
|
1093
|
+
* 营业执照正面照(PNG或JPG) base64格式, 大小不超过5M
|
|
1084
1094
|
*/
|
|
1085
|
-
|
|
1095
|
+
BusinessLicense?: string
|
|
1086
1096
|
|
|
1087
1097
|
/**
|
|
1088
|
-
*
|
|
1098
|
+
* 渠道侧合作企业统一社会信用代码,最大长度200个字符
|
|
1089
1099
|
*/
|
|
1090
|
-
|
|
1100
|
+
UniformSocialCreditCode?: string
|
|
1091
1101
|
|
|
1092
1102
|
/**
|
|
1093
1103
|
* 操作者的信息
|
|
@@ -1100,12 +1110,12 @@ export interface SyncProxyOrganizationRequest {
|
|
|
1100
1110
|
*/
|
|
1101
1111
|
export interface CreateSealByImageRequest {
|
|
1102
1112
|
/**
|
|
1103
|
-
*
|
|
1113
|
+
* 渠道应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 均必填。
|
|
1104
1114
|
*/
|
|
1105
1115
|
Agent: Agent
|
|
1106
1116
|
|
|
1107
1117
|
/**
|
|
1108
|
-
*
|
|
1118
|
+
* 印章名称,最大长度不超过30字符
|
|
1109
1119
|
*/
|
|
1110
1120
|
SealName: string
|
|
1111
1121
|
|
|
@@ -1125,9 +1135,9 @@ export interface CreateSealByImageRequest {
|
|
|
1125
1135
|
*/
|
|
1126
1136
|
export interface UserInfo {
|
|
1127
1137
|
/**
|
|
1128
|
-
*
|
|
1138
|
+
* 用户在渠道的编号
|
|
1129
1139
|
*/
|
|
1130
|
-
|
|
1140
|
+
OpenId?: string
|
|
1131
1141
|
|
|
1132
1142
|
/**
|
|
1133
1143
|
* 用户的来源渠道
|
|
@@ -1135,9 +1145,9 @@ export interface UserInfo {
|
|
|
1135
1145
|
Channel?: string
|
|
1136
1146
|
|
|
1137
1147
|
/**
|
|
1138
|
-
*
|
|
1148
|
+
* 自定义用户编号
|
|
1139
1149
|
*/
|
|
1140
|
-
|
|
1150
|
+
CustomUserId?: string
|
|
1141
1151
|
|
|
1142
1152
|
/**
|
|
1143
1153
|
* 用户真实IP
|
|
@@ -1181,9 +1191,10 @@ export interface UsageDetail {
|
|
|
1181
1191
|
ProxyOrganizationOpenId: string
|
|
1182
1192
|
|
|
1183
1193
|
/**
|
|
1184
|
-
|
|
1185
|
-
|
|
1186
|
-
|
|
1194
|
+
* 渠道侧合作企业名
|
|
1195
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
1196
|
+
*/
|
|
1197
|
+
ProxyOrganizationName: string
|
|
1187
1198
|
|
|
1188
1199
|
/**
|
|
1189
1200
|
* 日期,当需要汇总数据时日期为空
|
|
@@ -1192,10 +1203,9 @@ export interface UsageDetail {
|
|
|
1192
1203
|
Date: string
|
|
1193
1204
|
|
|
1194
1205
|
/**
|
|
1195
|
-
|
|
1196
|
-
|
|
1197
|
-
|
|
1198
|
-
ProxyOrganizationName: string
|
|
1206
|
+
* 消耗量
|
|
1207
|
+
*/
|
|
1208
|
+
Usage: number
|
|
1199
1209
|
}
|
|
1200
1210
|
|
|
1201
1211
|
/**
|
|
@@ -1228,19 +1238,19 @@ export interface OperateChannelTemplateRequest {
|
|
|
1228
1238
|
Agent: Agent
|
|
1229
1239
|
|
|
1230
1240
|
/**
|
|
1231
|
-
*
|
|
1241
|
+
* 操作类型,查询:"SELECT",删除:"DELETE",更新:"UPDATE"
|
|
1232
1242
|
*/
|
|
1233
|
-
|
|
1243
|
+
OperateType: string
|
|
1234
1244
|
|
|
1235
1245
|
/**
|
|
1236
|
-
*
|
|
1246
|
+
* 渠道方模板库模板唯一标识
|
|
1237
1247
|
*/
|
|
1238
|
-
|
|
1248
|
+
TemplateId: string
|
|
1239
1249
|
|
|
1240
1250
|
/**
|
|
1241
|
-
*
|
|
1251
|
+
* 合作企业方第三方机构唯一标识数据,支持多个, 用","进行分隔
|
|
1242
1252
|
*/
|
|
1243
|
-
|
|
1253
|
+
ProxyOrganizationOpenIds?: string
|
|
1244
1254
|
|
|
1245
1255
|
/**
|
|
1246
1256
|
* 模板可见性, 全部可见-"all", 部分可见-"part"
|
|
@@ -1248,13 +1258,13 @@ export interface OperateChannelTemplateRequest {
|
|
|
1248
1258
|
AuthTag?: string
|
|
1249
1259
|
|
|
1250
1260
|
/**
|
|
1251
|
-
*
|
|
1261
|
+
* 操作者的信息
|
|
1252
1262
|
*/
|
|
1253
|
-
|
|
1263
|
+
Operator?: UserInfo
|
|
1254
1264
|
}
|
|
1255
1265
|
|
|
1256
1266
|
/**
|
|
1257
|
-
*
|
|
1267
|
+
* 签署流程下载信息
|
|
1258
1268
|
*/
|
|
1259
1269
|
export interface DownloadFlowInfo {
|
|
1260
1270
|
/**
|
|
@@ -1263,7 +1273,7 @@ export interface DownloadFlowInfo {
|
|
|
1263
1273
|
FileName: string
|
|
1264
1274
|
|
|
1265
1275
|
/**
|
|
1266
|
-
*
|
|
1276
|
+
* 签署流程的标识数组
|
|
1267
1277
|
*/
|
|
1268
1278
|
FlowIdList: Array<string>
|
|
1269
1279
|
}
|
|
@@ -1315,37 +1325,37 @@ export interface DescribeUsageRequest {
|
|
|
1315
1325
|
Agent: Agent
|
|
1316
1326
|
|
|
1317
1327
|
/**
|
|
1318
|
-
*
|
|
1328
|
+
* 开始时间,例如:2021-03-21
|
|
1319
1329
|
*/
|
|
1320
1330
|
StartDate: string
|
|
1321
1331
|
|
|
1322
1332
|
/**
|
|
1323
|
-
*
|
|
1324
|
-
开始时间到结束时间的区间长度小于等于90
|
|
1333
|
+
* 结束时间,例如:2021-06-21;
|
|
1334
|
+
开始时间到结束时间的区间长度小于等于90天。
|
|
1325
1335
|
*/
|
|
1326
1336
|
EndDate: string
|
|
1327
1337
|
|
|
1328
1338
|
/**
|
|
1329
|
-
|
|
1330
|
-
|
|
1331
|
-
|
|
1332
|
-
|
|
1333
|
-
/**
|
|
1334
|
-
* 是否汇总数据,默认不汇总
|
|
1335
|
-
不汇总:返回在统计区间内渠道下所有企业的每日明细,即每个企业N条数据,N为统计天数
|
|
1336
|
-
汇总:返回在统计区间内渠道下所有企业的汇总后数据,即每个企业一条数据
|
|
1339
|
+
* 是否汇总数据,默认不汇总。
|
|
1340
|
+
不汇总:返回在统计区间内渠道下所有企业的每日明细,即每个企业N条数据,N为统计天数;
|
|
1341
|
+
汇总:返回在统计区间内渠道下所有企业的汇总后数据,即每个企业一条数据;
|
|
1337
1342
|
*/
|
|
1338
1343
|
NeedAggregate?: boolean
|
|
1339
1344
|
|
|
1340
1345
|
/**
|
|
1341
|
-
*
|
|
1346
|
+
* 单次返回的最多条目数量。默认为1000,且不能超过1000。
|
|
1342
1347
|
*/
|
|
1343
1348
|
Limit?: number
|
|
1344
1349
|
|
|
1345
1350
|
/**
|
|
1346
|
-
*
|
|
1351
|
+
* 偏移量,默认是0。
|
|
1347
1352
|
*/
|
|
1348
1353
|
Offset?: number
|
|
1354
|
+
|
|
1355
|
+
/**
|
|
1356
|
+
* 操作者的信息
|
|
1357
|
+
*/
|
|
1358
|
+
Operator?: UserInfo
|
|
1349
1359
|
}
|
|
1350
1360
|
|
|
1351
1361
|
/**
|
|
@@ -1358,9 +1368,14 @@ export interface ChannelCreateFlowByFilesRequest {
|
|
|
1358
1368
|
Agent?: Agent
|
|
1359
1369
|
|
|
1360
1370
|
/**
|
|
1361
|
-
*
|
|
1371
|
+
* 签署流程名称,长度不超过200个字符
|
|
1362
1372
|
*/
|
|
1363
|
-
|
|
1373
|
+
FlowName?: string
|
|
1374
|
+
|
|
1375
|
+
/**
|
|
1376
|
+
* 签署流程签约方列表,最多不超过5个参与方
|
|
1377
|
+
*/
|
|
1378
|
+
FlowApprovers?: Array<FlowApproverInfo>
|
|
1364
1379
|
|
|
1365
1380
|
/**
|
|
1366
1381
|
* 签署文件资源Id列表,目前仅支持单个文件
|
|
@@ -1368,44 +1383,44 @@ export interface ChannelCreateFlowByFilesRequest {
|
|
|
1368
1383
|
FileIds?: Array<string>
|
|
1369
1384
|
|
|
1370
1385
|
/**
|
|
1371
|
-
*
|
|
1386
|
+
* 签署文件中的控件,如:填写控件等
|
|
1372
1387
|
*/
|
|
1373
|
-
|
|
1388
|
+
Components?: Array<Component>
|
|
1374
1389
|
|
|
1375
1390
|
/**
|
|
1376
|
-
*
|
|
1391
|
+
* 签署流程截止时间,十位数时间戳,最大值为33162419560,即3020年
|
|
1377
1392
|
*/
|
|
1378
1393
|
Deadline?: number
|
|
1379
1394
|
|
|
1380
1395
|
/**
|
|
1381
|
-
*
|
|
1396
|
+
* 签署流程回调地址,长度不超过255个字符
|
|
1382
1397
|
*/
|
|
1383
|
-
|
|
1398
|
+
CallbackUrl?: string
|
|
1384
1399
|
|
|
1385
1400
|
/**
|
|
1386
|
-
*
|
|
1401
|
+
* 合同签署顺序类型(无序签,顺序签),默认为false,即有序签署
|
|
1387
1402
|
*/
|
|
1388
|
-
|
|
1403
|
+
Unordered?: boolean
|
|
1389
1404
|
|
|
1390
1405
|
/**
|
|
1391
|
-
*
|
|
1406
|
+
* 签署流程的类型,长度不超过255个字符
|
|
1392
1407
|
*/
|
|
1393
|
-
|
|
1408
|
+
FlowType?: string
|
|
1394
1409
|
|
|
1395
1410
|
/**
|
|
1396
|
-
*
|
|
1411
|
+
* 签署流程的描述,长度不超过1000个字符
|
|
1397
1412
|
*/
|
|
1398
|
-
|
|
1413
|
+
FlowDescription?: string
|
|
1399
1414
|
|
|
1400
1415
|
/**
|
|
1401
|
-
*
|
|
1416
|
+
* 合同显示的页卡模板,说明:只支持{合同名称}, {发起方企业}, {发起方姓名}, {签署方N企业}, {签署方N姓名},且N不能超过签署人的数量,N从1开始
|
|
1402
1417
|
*/
|
|
1403
|
-
|
|
1418
|
+
CustomShowMap?: string
|
|
1404
1419
|
|
|
1405
1420
|
/**
|
|
1406
|
-
*
|
|
1421
|
+
* 操作者的信息
|
|
1407
1422
|
*/
|
|
1408
|
-
|
|
1423
|
+
Operator?: UserInfo
|
|
1409
1424
|
}
|
|
1410
1425
|
|
|
1411
1426
|
/**
|
|
@@ -1413,7 +1428,7 @@ export interface ChannelCreateFlowByFilesRequest {
|
|
|
1413
1428
|
*/
|
|
1414
1429
|
export interface ChannelCreateFlowByFilesResponse {
|
|
1415
1430
|
/**
|
|
1416
|
-
*
|
|
1431
|
+
* 合同签署流程ID
|
|
1417
1432
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
1418
1433
|
*/
|
|
1419
1434
|
FlowId: string
|
|
@@ -1459,24 +1474,24 @@ export interface Agent {
|
|
|
1459
1474
|
AppId: string
|
|
1460
1475
|
|
|
1461
1476
|
/**
|
|
1462
|
-
*
|
|
1477
|
+
* 渠道/平台合作企业的企业ID
|
|
1463
1478
|
*/
|
|
1464
|
-
|
|
1479
|
+
ProxyOrganizationOpenId?: string
|
|
1465
1480
|
|
|
1466
1481
|
/**
|
|
1467
|
-
*
|
|
1482
|
+
* 渠道/平台合作企业经办人(操作员)
|
|
1468
1483
|
*/
|
|
1469
|
-
|
|
1484
|
+
ProxyOperator?: UserInfo
|
|
1470
1485
|
|
|
1471
1486
|
/**
|
|
1472
|
-
*
|
|
1487
|
+
* 腾讯电子签颁发给渠道侧合作企业的应用ID
|
|
1473
1488
|
*/
|
|
1474
|
-
|
|
1489
|
+
ProxyAppId?: string
|
|
1475
1490
|
|
|
1476
1491
|
/**
|
|
1477
|
-
*
|
|
1492
|
+
* 腾讯电子签颁发给渠道侧合作企业的企业ID
|
|
1478
1493
|
*/
|
|
1479
|
-
|
|
1494
|
+
ProxyOrganizationId?: string
|
|
1480
1495
|
}
|
|
1481
1496
|
|
|
1482
1497
|
/**
|
|
@@ -1567,11 +1582,11 @@ export interface FlowApproverDetail {
|
|
|
1567
1582
|
}
|
|
1568
1583
|
|
|
1569
1584
|
/**
|
|
1570
|
-
* 此结构体 (FlowInfo)
|
|
1585
|
+
* 此结构体 (FlowInfo) 用于描述签署流程信息。
|
|
1571
1586
|
*/
|
|
1572
1587
|
export interface FlowInfo {
|
|
1573
1588
|
/**
|
|
1574
|
-
*
|
|
1589
|
+
* 合同名字,最大长度200个字符
|
|
1575
1590
|
*/
|
|
1576
1591
|
FlowName: string
|
|
1577
1592
|
|
|
@@ -1586,39 +1601,40 @@ export interface FlowInfo {
|
|
|
1586
1601
|
TemplateId?: string
|
|
1587
1602
|
|
|
1588
1603
|
/**
|
|
1589
|
-
|
|
1590
|
-
|
|
1591
|
-
|
|
1592
|
-
3. “租赁”
|
|
1593
|
-
4. “其他”
|
|
1594
|
-
*/
|
|
1595
|
-
FlowType?: string
|
|
1604
|
+
* 多个签署人信息,最大支持50个签署方
|
|
1605
|
+
*/
|
|
1606
|
+
FlowApprovers?: Array<FlowApproverInfo>
|
|
1596
1607
|
|
|
1597
1608
|
/**
|
|
1598
|
-
*
|
|
1609
|
+
* 表单K-V对列表
|
|
1599
1610
|
*/
|
|
1600
|
-
|
|
1611
|
+
FormFields?: Array<FormField>
|
|
1601
1612
|
|
|
1602
1613
|
/**
|
|
1603
|
-
*
|
|
1614
|
+
* 回调地址,最大长度1000个字符
|
|
1604
1615
|
*/
|
|
1605
|
-
|
|
1616
|
+
CallbackUrl?: string
|
|
1606
1617
|
|
|
1607
1618
|
/**
|
|
1608
|
-
*
|
|
1619
|
+
* 合同类型,如:1. “劳务”;2. “销售”;3. “租赁”;4. “其他”,最大长度200个字符
|
|
1609
1620
|
*/
|
|
1610
|
-
|
|
1621
|
+
FlowType?: string
|
|
1611
1622
|
|
|
1612
1623
|
/**
|
|
1613
|
-
*
|
|
1624
|
+
* 合同描述,最大长度1000个字符
|
|
1614
1625
|
*/
|
|
1615
1626
|
FlowDescription?: string
|
|
1616
1627
|
|
|
1617
1628
|
/**
|
|
1618
|
-
*
|
|
1629
|
+
* 渠道的业务信息,最大长度1000个字符
|
|
1619
1630
|
*/
|
|
1620
1631
|
CustomerData?: string
|
|
1621
1632
|
|
|
1633
|
+
/**
|
|
1634
|
+
* 合同显示的页卡模板,说明:只支持{合同名称}, {发起方企业}, {发起方姓名}, {签署方N企业}, {签署方N姓名},且N不能超过签署人的数量,N从1开始
|
|
1635
|
+
*/
|
|
1636
|
+
CustomShowMap?: string
|
|
1637
|
+
|
|
1622
1638
|
/**
|
|
1623
1639
|
* 被抄送人的信息列表,抄送功能暂不开放
|
|
1624
1640
|
*/
|
|
@@ -1709,7 +1725,7 @@ PERSON 自然人
|
|
|
1709
1725
|
*/
|
|
1710
1726
|
export interface CcInfo {
|
|
1711
1727
|
/**
|
|
1712
|
-
*
|
|
1728
|
+
* 被抄送人手机号,大陆11位手机号
|
|
1713
1729
|
*/
|
|
1714
1730
|
Mobile?: string
|
|
1715
1731
|
}
|
|
@@ -1739,7 +1755,7 @@ export interface DescribeFlowDetailInfoResponse {
|
|
|
1739
1755
|
ProxyOrganizationOpenId: string
|
|
1740
1756
|
|
|
1741
1757
|
/**
|
|
1742
|
-
* 合同(
|
|
1758
|
+
* 合同(签署流程)的具体详细描述信息
|
|
1743
1759
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
1744
1760
|
*/
|
|
1745
1761
|
FlowInfo: Array<FlowDetailInfo>
|