tencentcloud-sdk-nodejs-ess 4.0.431 → 4.0.432
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 +1 -1
- package/package.json +1 -1
- package/src/services/ess/index.ts +4 -7
- package/src/services/ess/v20201111/ess_client.ts +194 -144
- package/src/services/ess/v20201111/ess_models.ts +1221 -1276
- package/src/services/ess/v20201111/index.ts +3 -3
- package/tencentcloud/services/ess/v20201111/ess_client.d.ts +60 -60
- package/tencentcloud/services/ess/v20201111/ess_client.js +60 -60
- package/tencentcloud/services/ess/v20201111/ess_models.d.ts +659 -659
- package/tencentcloud/services/ess/v20201111/index.js +1 -1
|
@@ -3,12 +3,12 @@
|
|
|
3
3
|
*/
|
|
4
4
|
export interface UploadFile {
|
|
5
5
|
/**
|
|
6
|
-
|
|
7
|
-
|
|
6
|
+
* Base64编码后的文件内容
|
|
7
|
+
*/
|
|
8
8
|
FileBody: string;
|
|
9
9
|
/**
|
|
10
|
-
|
|
11
|
-
|
|
10
|
+
* 文件名,最大长度不超过200字符
|
|
11
|
+
*/
|
|
12
12
|
FileName?: string;
|
|
13
13
|
}
|
|
14
14
|
/**
|
|
@@ -16,16 +16,16 @@ export interface UploadFile {
|
|
|
16
16
|
*/
|
|
17
17
|
export interface CancelMultiFlowSignQRCodeRequest {
|
|
18
18
|
/**
|
|
19
|
-
|
|
20
|
-
|
|
19
|
+
* 用户信息
|
|
20
|
+
*/
|
|
21
21
|
Operator: UserInfo;
|
|
22
22
|
/**
|
|
23
|
-
|
|
24
|
-
|
|
23
|
+
* 二维码id
|
|
24
|
+
*/
|
|
25
25
|
QrCodeId: string;
|
|
26
26
|
/**
|
|
27
|
-
|
|
28
|
-
|
|
27
|
+
* 应用信息
|
|
28
|
+
*/
|
|
29
29
|
Agent?: Agent;
|
|
30
30
|
}
|
|
31
31
|
/**
|
|
@@ -33,12 +33,12 @@ export interface CancelMultiFlowSignQRCodeRequest {
|
|
|
33
33
|
*/
|
|
34
34
|
export interface CreateFlowEvidenceReportResponse {
|
|
35
35
|
/**
|
|
36
|
-
|
|
37
|
-
|
|
36
|
+
* 出证报告 URL(有效期5分钟)
|
|
37
|
+
*/
|
|
38
38
|
ReportUrl: string;
|
|
39
39
|
/**
|
|
40
|
-
|
|
41
|
-
|
|
40
|
+
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
41
|
+
*/
|
|
42
42
|
RequestId?: string;
|
|
43
43
|
}
|
|
44
44
|
/**
|
|
@@ -46,16 +46,16 @@ export interface CreateFlowEvidenceReportResponse {
|
|
|
46
46
|
*/
|
|
47
47
|
export interface DescribeFileUrlsResponse {
|
|
48
48
|
/**
|
|
49
|
-
|
|
50
|
-
|
|
49
|
+
* URL信息
|
|
50
|
+
*/
|
|
51
51
|
FileUrls: Array<FileUrl>;
|
|
52
52
|
/**
|
|
53
|
-
|
|
54
|
-
|
|
53
|
+
* URL数量
|
|
54
|
+
*/
|
|
55
55
|
TotalCount: number;
|
|
56
56
|
/**
|
|
57
|
-
|
|
58
|
-
|
|
57
|
+
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
58
|
+
*/
|
|
59
59
|
RequestId?: string;
|
|
60
60
|
}
|
|
61
61
|
/**
|
|
@@ -63,60 +63,60 @@ export interface DescribeFileUrlsResponse {
|
|
|
63
63
|
*/
|
|
64
64
|
export interface TemplateInfo {
|
|
65
65
|
/**
|
|
66
|
-
|
|
67
|
-
|
|
66
|
+
* 模板ID
|
|
67
|
+
*/
|
|
68
68
|
TemplateId?: string;
|
|
69
69
|
/**
|
|
70
|
-
|
|
71
|
-
|
|
70
|
+
* 模板名字
|
|
71
|
+
*/
|
|
72
72
|
TemplateName?: string;
|
|
73
73
|
/**
|
|
74
|
-
|
|
75
|
-
|
|
74
|
+
* 模板描述信息
|
|
75
|
+
*/
|
|
76
76
|
Description?: string;
|
|
77
77
|
/**
|
|
78
|
-
|
|
79
|
-
|
|
78
|
+
* 模板关联的资源IDs
|
|
79
|
+
*/
|
|
80
80
|
DocumentResourceIds?: Array<string>;
|
|
81
81
|
/**
|
|
82
|
-
|
|
83
|
-
|
|
82
|
+
* 返回的文件信息结构
|
|
83
|
+
*/
|
|
84
84
|
FileInfos?: Array<FileInfo>;
|
|
85
85
|
/**
|
|
86
|
-
|
|
87
|
-
|
|
86
|
+
* 附件关联的资源ID是
|
|
87
|
+
*/
|
|
88
88
|
AttachmentResourceIds?: Array<string>;
|
|
89
89
|
/**
|
|
90
|
-
|
|
91
|
-
|
|
90
|
+
* 签署顺序
|
|
91
|
+
*/
|
|
92
92
|
SignOrder?: Array<number>;
|
|
93
93
|
/**
|
|
94
|
-
|
|
95
|
-
|
|
94
|
+
* 签署参与者的信息
|
|
95
|
+
*/
|
|
96
96
|
Recipients?: Array<Recipient>;
|
|
97
97
|
/**
|
|
98
|
-
|
|
99
|
-
|
|
98
|
+
* 模板信息结构
|
|
99
|
+
*/
|
|
100
100
|
Components?: Array<Component>;
|
|
101
101
|
/**
|
|
102
|
-
|
|
103
|
-
|
|
102
|
+
* 签署区模板信息结构
|
|
103
|
+
*/
|
|
104
104
|
SignComponents?: Array<Component>;
|
|
105
105
|
/**
|
|
106
|
-
|
|
107
|
-
|
|
106
|
+
* 模板状态(-1:不可用;0:草稿态;1:正式态)
|
|
107
|
+
*/
|
|
108
108
|
Status?: number;
|
|
109
109
|
/**
|
|
110
|
-
|
|
111
|
-
|
|
110
|
+
* 模板的创建人
|
|
111
|
+
*/
|
|
112
112
|
Creator?: string;
|
|
113
113
|
/**
|
|
114
|
-
|
|
115
|
-
|
|
114
|
+
* 模板创建的时间戳(精确到秒)
|
|
115
|
+
*/
|
|
116
116
|
CreatedOn?: number;
|
|
117
117
|
/**
|
|
118
|
-
|
|
119
|
-
|
|
118
|
+
* 发起人角色信息
|
|
119
|
+
*/
|
|
120
120
|
Promoter?: Recipient;
|
|
121
121
|
}
|
|
122
122
|
/**
|
|
@@ -124,17 +124,17 @@ export interface TemplateInfo {
|
|
|
124
124
|
*/
|
|
125
125
|
export interface CreateDocumentResponse {
|
|
126
126
|
/**
|
|
127
|
-
|
|
128
|
-
|
|
127
|
+
* 签署流程电子文档ID
|
|
128
|
+
*/
|
|
129
129
|
DocumentId: string;
|
|
130
130
|
/**
|
|
131
|
-
|
|
132
|
-
注意:此字段可能返回 null,表示取不到有效值。
|
|
133
|
-
|
|
131
|
+
* 签署流程文件的预览地址, 5分钟内有效。仅当NeedPreview为true 时返回
|
|
132
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
133
|
+
*/
|
|
134
134
|
PreviewFileUrl: string;
|
|
135
135
|
/**
|
|
136
|
-
|
|
137
|
-
|
|
136
|
+
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
137
|
+
*/
|
|
138
138
|
RequestId?: string;
|
|
139
139
|
}
|
|
140
140
|
/**
|
|
@@ -142,20 +142,20 @@ export interface CreateDocumentResponse {
|
|
|
142
142
|
*/
|
|
143
143
|
export interface StartFlowRequest {
|
|
144
144
|
/**
|
|
145
|
-
|
|
146
|
-
|
|
145
|
+
* 调用方用户信息,userId 必填
|
|
146
|
+
*/
|
|
147
147
|
Operator: UserInfo;
|
|
148
148
|
/**
|
|
149
|
-
|
|
150
|
-
|
|
149
|
+
* 签署流程编号,由CreateFlow接口返回
|
|
150
|
+
*/
|
|
151
151
|
FlowId: string;
|
|
152
152
|
/**
|
|
153
|
-
|
|
154
|
-
|
|
153
|
+
* 客户端Token,保持接口幂等性,最大长度64个字符
|
|
154
|
+
*/
|
|
155
155
|
ClientToken?: string;
|
|
156
156
|
/**
|
|
157
|
-
|
|
158
|
-
|
|
157
|
+
* 应用相关信息
|
|
158
|
+
*/
|
|
159
159
|
Agent?: Agent;
|
|
160
160
|
}
|
|
161
161
|
/**
|
|
@@ -163,8 +163,8 @@ export interface StartFlowRequest {
|
|
|
163
163
|
*/
|
|
164
164
|
export interface CancelFlowResponse {
|
|
165
165
|
/**
|
|
166
|
-
|
|
167
|
-
|
|
166
|
+
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
167
|
+
*/
|
|
168
168
|
RequestId?: string;
|
|
169
169
|
}
|
|
170
170
|
/**
|
|
@@ -172,37 +172,37 @@ export interface CancelFlowResponse {
|
|
|
172
172
|
*/
|
|
173
173
|
export interface CreateDocumentRequest {
|
|
174
174
|
/**
|
|
175
|
-
|
|
176
|
-
|
|
175
|
+
* 调用方用户信息,userId 必填
|
|
176
|
+
*/
|
|
177
177
|
Operator: UserInfo;
|
|
178
178
|
/**
|
|
179
|
-
|
|
180
|
-
|
|
179
|
+
* 签署流程编号,由CreateFlow接口返回
|
|
180
|
+
*/
|
|
181
181
|
FlowId: string;
|
|
182
182
|
/**
|
|
183
|
-
|
|
184
|
-
|
|
183
|
+
* 用户上传的模板ID
|
|
184
|
+
*/
|
|
185
185
|
TemplateId: string;
|
|
186
186
|
/**
|
|
187
|
-
|
|
188
|
-
|
|
187
|
+
* 文件名列表,单个文件名最大长度200个字符,暂时仅支持单文件发起
|
|
188
|
+
*/
|
|
189
189
|
FileNames: Array<string>;
|
|
190
190
|
/**
|
|
191
|
-
|
|
192
|
-
|
|
191
|
+
* 内容控件信息数组
|
|
192
|
+
*/
|
|
193
193
|
FormFields?: Array<FormField>;
|
|
194
194
|
/**
|
|
195
|
-
|
|
196
|
-
预览链接有效期300秒;
|
|
197
|
-
|
|
195
|
+
* 是否需要生成预览文件 默认不生成;
|
|
196
|
+
预览链接有效期300秒;
|
|
197
|
+
*/
|
|
198
198
|
NeedPreview?: boolean;
|
|
199
199
|
/**
|
|
200
|
-
|
|
201
|
-
|
|
200
|
+
* 客户端Token,保持接口幂等性,最大长度64个字符
|
|
201
|
+
*/
|
|
202
202
|
ClientToken?: string;
|
|
203
203
|
/**
|
|
204
|
-
|
|
205
|
-
|
|
204
|
+
* 应用相关信息
|
|
205
|
+
*/
|
|
206
206
|
Agent?: Agent;
|
|
207
207
|
}
|
|
208
208
|
/**
|
|
@@ -210,67 +210,67 @@ export interface CreateDocumentRequest {
|
|
|
210
210
|
*/
|
|
211
211
|
export interface CreateFlowRequest {
|
|
212
212
|
/**
|
|
213
|
-
|
|
214
|
-
|
|
213
|
+
* 调用方用户信息,userId 必填
|
|
214
|
+
*/
|
|
215
215
|
Operator: UserInfo;
|
|
216
216
|
/**
|
|
217
|
-
|
|
218
|
-
|
|
217
|
+
* 签署流程名称,最大长度200个字符
|
|
218
|
+
*/
|
|
219
219
|
FlowName: string;
|
|
220
220
|
/**
|
|
221
|
-
|
|
222
|
-
|
|
221
|
+
* 签署流程参与者信息,最大限制50方
|
|
222
|
+
*/
|
|
223
223
|
Approvers: Array<FlowCreateApprover>;
|
|
224
224
|
/**
|
|
225
|
-
|
|
226
|
-
|
|
225
|
+
* 签署流程的类型(如销售合同/入职合同等),最大长度200个字符
|
|
226
|
+
*/
|
|
227
227
|
FlowType?: string;
|
|
228
228
|
/**
|
|
229
|
-
|
|
230
|
-
|
|
229
|
+
* 客户端Token,保持接口幂等性,最大长度64个字符
|
|
230
|
+
*/
|
|
231
231
|
ClientToken?: string;
|
|
232
232
|
/**
|
|
233
|
-
|
|
234
|
-
|
|
233
|
+
* 暂未开放
|
|
234
|
+
*/
|
|
235
235
|
CallbackUrl?: string;
|
|
236
236
|
/**
|
|
237
|
-
|
|
238
|
-
值为unix时间戳,精确到秒,不传默认为当前时间一年后
|
|
239
|
-
|
|
237
|
+
* 签署流程的签署截止时间。
|
|
238
|
+
值为unix时间戳,精确到秒,不传默认为当前时间一年后
|
|
239
|
+
*/
|
|
240
240
|
DeadLine?: number;
|
|
241
241
|
/**
|
|
242
|
-
|
|
243
|
-
|
|
242
|
+
* 用户自定义字段(需进行base64 encode),回调的时候会进行透传, 长度需要小于20480
|
|
243
|
+
*/
|
|
244
244
|
UserData?: string;
|
|
245
245
|
/**
|
|
246
|
-
|
|
247
|
-
|
|
246
|
+
* 签署流程描述,最大长度1000个字符
|
|
247
|
+
*/
|
|
248
248
|
FlowDescription?: string;
|
|
249
249
|
/**
|
|
250
|
-
|
|
251
|
-
true:无序签
|
|
252
|
-
false:有序签
|
|
253
|
-
注:默认为false(有序签),请和模板中的配置保持一致
|
|
254
|
-
|
|
250
|
+
* 发送类型:
|
|
251
|
+
true:无序签
|
|
252
|
+
false:有序签
|
|
253
|
+
注:默认为false(有序签),请和模板中的配置保持一致
|
|
254
|
+
*/
|
|
255
255
|
Unordered?: boolean;
|
|
256
256
|
/**
|
|
257
|
-
|
|
258
|
-
|
|
257
|
+
* 合同显示的页卡模板,说明:只支持{合同名称}, {发起方企业}, {发起方姓名}, {签署方N企业}, {签署方N姓名},且N不能超过签署人的数量,N从1开始
|
|
258
|
+
*/
|
|
259
259
|
CustomShowMap?: string;
|
|
260
260
|
/**
|
|
261
|
-
|
|
262
|
-
若设置为true,审核结果需通过接口 CreateFlowSignReview 通知电子签,审核通过后,发起方企业签署人方可进行签署操作,否则会阻塞其签署操作。
|
|
263
|
-
|
|
264
|
-
注:企业可以通过此功能与企业内部的审批流程进行关联,支持手动、静默签署合同。
|
|
265
|
-
|
|
261
|
+
* 发起方企业的签署人进行签署操作是否需要企业内部审批。
|
|
262
|
+
若设置为true,审核结果需通过接口 CreateFlowSignReview 通知电子签,审核通过后,发起方企业签署人方可进行签署操作,否则会阻塞其签署操作。
|
|
263
|
+
|
|
264
|
+
注:企业可以通过此功能与企业内部的审批流程进行关联,支持手动、静默签署合同。
|
|
265
|
+
*/
|
|
266
266
|
NeedSignReview?: boolean;
|
|
267
267
|
/**
|
|
268
|
-
|
|
269
|
-
|
|
268
|
+
* 暂未开放
|
|
269
|
+
*/
|
|
270
270
|
RelatedFlowId?: string;
|
|
271
271
|
/**
|
|
272
|
-
|
|
273
|
-
|
|
272
|
+
* 应用相关信息
|
|
273
|
+
*/
|
|
274
274
|
Agent?: Agent;
|
|
275
275
|
}
|
|
276
276
|
/**
|
|
@@ -278,43 +278,43 @@ false:有序签
|
|
|
278
278
|
*/
|
|
279
279
|
export interface CreateSchemeUrlRequest {
|
|
280
280
|
/**
|
|
281
|
-
|
|
282
|
-
|
|
281
|
+
* 调用方用户信息,userId 必填
|
|
282
|
+
*/
|
|
283
283
|
Operator: UserInfo;
|
|
284
284
|
/**
|
|
285
|
-
|
|
286
|
-
|
|
285
|
+
* 企业名称
|
|
286
|
+
*/
|
|
287
287
|
OrganizationName?: string;
|
|
288
288
|
/**
|
|
289
|
-
|
|
290
|
-
|
|
289
|
+
* 姓名,最大长度50个字符
|
|
290
|
+
*/
|
|
291
291
|
Name?: string;
|
|
292
292
|
/**
|
|
293
|
-
|
|
294
|
-
|
|
293
|
+
* 手机号,大陆手机号11位
|
|
294
|
+
*/
|
|
295
295
|
Mobile?: string;
|
|
296
296
|
/**
|
|
297
|
-
|
|
298
|
-
HTTP:跳转电子签小程序的http_url,
|
|
299
|
-
APP:第三方APP或小程序跳转电子签小程序的path。
|
|
300
|
-
默认为HTTP类型
|
|
301
|
-
|
|
297
|
+
* 链接类型
|
|
298
|
+
HTTP:跳转电子签小程序的http_url,
|
|
299
|
+
APP:第三方APP或小程序跳转电子签小程序的path。
|
|
300
|
+
默认为HTTP类型
|
|
301
|
+
*/
|
|
302
302
|
EndPoint?: string;
|
|
303
303
|
/**
|
|
304
|
-
|
|
305
|
-
|
|
304
|
+
* 签署流程编号 (PathType=1时必传)
|
|
305
|
+
*/
|
|
306
306
|
FlowId?: string;
|
|
307
307
|
/**
|
|
308
|
-
|
|
309
|
-
|
|
308
|
+
* 跳转页面 1: 小程序合同详情 2: 小程序合同列表页 0: 不传, 默认主页
|
|
309
|
+
*/
|
|
310
310
|
PathType?: number;
|
|
311
311
|
/**
|
|
312
|
-
|
|
313
|
-
|
|
312
|
+
* 是否自动回跳 true:是, false:否。该参数只针对"APP" 类型的签署链接有效
|
|
313
|
+
*/
|
|
314
314
|
AutoJumpBack?: boolean;
|
|
315
315
|
/**
|
|
316
|
-
|
|
317
|
-
|
|
316
|
+
* 应用相关信息
|
|
317
|
+
*/
|
|
318
318
|
Agent?: Agent;
|
|
319
319
|
}
|
|
320
320
|
/**
|
|
@@ -322,13 +322,13 @@ APP:第三方APP或小程序跳转电子签小程序的path。
|
|
|
322
322
|
*/
|
|
323
323
|
export interface FileUrl {
|
|
324
324
|
/**
|
|
325
|
-
|
|
326
|
-
|
|
325
|
+
* 下载文件的URL
|
|
326
|
+
*/
|
|
327
327
|
Url: string;
|
|
328
328
|
/**
|
|
329
|
-
|
|
330
|
-
注意:此字段可能返回 null,表示取不到有效值。
|
|
331
|
-
|
|
329
|
+
* 下载文件的附加信息
|
|
330
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
331
|
+
*/
|
|
332
332
|
Option: string;
|
|
333
333
|
}
|
|
334
334
|
/**
|
|
@@ -336,8 +336,8 @@ export interface FileUrl {
|
|
|
336
336
|
*/
|
|
337
337
|
export interface DescribeThirdPartyAuthCodeRequest {
|
|
338
338
|
/**
|
|
339
|
-
|
|
340
|
-
|
|
339
|
+
* 电子签小程序跳转客户小程序时携带的授权查看码
|
|
340
|
+
*/
|
|
341
341
|
AuthCode: string;
|
|
342
342
|
}
|
|
343
343
|
/**
|
|
@@ -345,12 +345,12 @@ export interface DescribeThirdPartyAuthCodeRequest {
|
|
|
345
345
|
*/
|
|
346
346
|
export interface Filter {
|
|
347
347
|
/**
|
|
348
|
-
|
|
349
|
-
|
|
348
|
+
* 查询过滤条件的Key
|
|
349
|
+
*/
|
|
350
350
|
Key: string;
|
|
351
351
|
/**
|
|
352
|
-
|
|
353
|
-
|
|
352
|
+
* 查询过滤条件的Value列表
|
|
353
|
+
*/
|
|
354
354
|
Values: Array<string>;
|
|
355
355
|
}
|
|
356
356
|
/**
|
|
@@ -358,16 +358,16 @@ export interface Filter {
|
|
|
358
358
|
*/
|
|
359
359
|
export interface SignQrCode {
|
|
360
360
|
/**
|
|
361
|
-
|
|
362
|
-
|
|
361
|
+
* 二维码id
|
|
362
|
+
*/
|
|
363
363
|
QrCodeId: string;
|
|
364
364
|
/**
|
|
365
|
-
|
|
366
|
-
|
|
365
|
+
* 二维码url
|
|
366
|
+
*/
|
|
367
367
|
QrCodeUrl: string;
|
|
368
368
|
/**
|
|
369
|
-
|
|
370
|
-
|
|
369
|
+
* 二维码过期时间
|
|
370
|
+
*/
|
|
371
371
|
ExpiredTime: number;
|
|
372
372
|
}
|
|
373
373
|
/**
|
|
@@ -375,20 +375,20 @@ export interface SignQrCode {
|
|
|
375
375
|
*/
|
|
376
376
|
export interface GetTaskResultApiRequest {
|
|
377
377
|
/**
|
|
378
|
-
|
|
379
|
-
|
|
378
|
+
* 任务Id,通过CreateConvertTaskApi得到
|
|
379
|
+
*/
|
|
380
380
|
TaskId: string;
|
|
381
381
|
/**
|
|
382
|
-
|
|
383
|
-
|
|
382
|
+
* 操作人信息
|
|
383
|
+
*/
|
|
384
384
|
Operator?: UserInfo;
|
|
385
385
|
/**
|
|
386
|
-
|
|
387
|
-
|
|
386
|
+
* 应用号信息
|
|
387
|
+
*/
|
|
388
388
|
Agent?: Agent;
|
|
389
389
|
/**
|
|
390
|
-
|
|
391
|
-
|
|
390
|
+
* 暂未开放
|
|
391
|
+
*/
|
|
392
392
|
Organization?: OrganizationInfo;
|
|
393
393
|
}
|
|
394
394
|
/**
|
|
@@ -396,38 +396,38 @@ export interface GetTaskResultApiRequest {
|
|
|
396
396
|
*/
|
|
397
397
|
export interface UploadFilesRequest {
|
|
398
398
|
/**
|
|
399
|
-
|
|
400
|
-
1. TEMPLATE - 模板; 文件类型:.pdf .doc .docx .html
|
|
401
|
-
2. DOCUMENT - 签署过程及签署后的合同文档/图片控件 文件类型:.pdf/.jpg/.png
|
|
402
|
-
3. SEAL - 印章; 文件类型:.jpg/.jpeg/.png
|
|
403
|
-
|
|
399
|
+
* 文件对应业务类型,用于区分文件存储路径:
|
|
400
|
+
1. TEMPLATE - 模板; 文件类型:.pdf .doc .docx .html
|
|
401
|
+
2. DOCUMENT - 签署过程及签署后的合同文档/图片控件 文件类型:.pdf/.jpg/.png
|
|
402
|
+
3. SEAL - 印章; 文件类型:.jpg/.jpeg/.png
|
|
403
|
+
*/
|
|
404
404
|
BusinessType: string;
|
|
405
405
|
/**
|
|
406
|
-
|
|
407
|
-
|
|
406
|
+
* 调用方信息
|
|
407
|
+
*/
|
|
408
408
|
Caller?: Caller;
|
|
409
409
|
/**
|
|
410
|
-
|
|
411
|
-
|
|
410
|
+
* 上传文件内容数组,最多支持20个文件
|
|
411
|
+
*/
|
|
412
412
|
FileInfos?: Array<UploadFile>;
|
|
413
413
|
/**
|
|
414
|
-
|
|
415
|
-
|
|
414
|
+
* 上传文件链接数组,最多支持20个URL
|
|
415
|
+
*/
|
|
416
416
|
FileUrls?: string;
|
|
417
417
|
/**
|
|
418
|
-
|
|
419
|
-
true--是,处理置白
|
|
420
|
-
false--否,不处理
|
|
421
|
-
|
|
418
|
+
* 此参数只对 PDF 文件有效。是否将pdf灰色矩阵置白
|
|
419
|
+
true--是,处理置白
|
|
420
|
+
false--否,不处理
|
|
421
|
+
*/
|
|
422
422
|
CoverRect?: boolean;
|
|
423
423
|
/**
|
|
424
|
-
|
|
425
|
-
如:PDF 表示上传的文件 xxx.pdf的文件类型是 PDF
|
|
426
|
-
|
|
424
|
+
* 文件类型, 默认通过文件内容解析得到文件类型,客户可以显示的说明上传文件的类型。
|
|
425
|
+
如:PDF 表示上传的文件 xxx.pdf的文件类型是 PDF
|
|
426
|
+
*/
|
|
427
427
|
FileType?: string;
|
|
428
428
|
/**
|
|
429
|
-
|
|
430
|
-
|
|
429
|
+
* 用户自定义ID数组,与上传文件一一对应
|
|
430
|
+
*/
|
|
431
431
|
CustomIds?: Array<string>;
|
|
432
432
|
}
|
|
433
433
|
/**
|
|
@@ -435,20 +435,20 @@ false--否,不处理
|
|
|
435
435
|
*/
|
|
436
436
|
export interface CancelFlowRequest {
|
|
437
437
|
/**
|
|
438
|
-
|
|
439
|
-
|
|
438
|
+
* 调用方用户信息,userId 必填
|
|
439
|
+
*/
|
|
440
440
|
Operator: UserInfo;
|
|
441
441
|
/**
|
|
442
|
-
|
|
443
|
-
|
|
442
|
+
* 签署流程id
|
|
443
|
+
*/
|
|
444
444
|
FlowId: string;
|
|
445
445
|
/**
|
|
446
|
-
|
|
447
|
-
|
|
446
|
+
* 撤销原因,最长200个字符;
|
|
447
|
+
*/
|
|
448
448
|
CancelMessage: string;
|
|
449
449
|
/**
|
|
450
|
-
|
|
451
|
-
|
|
450
|
+
* 应用相关信息
|
|
451
|
+
*/
|
|
452
452
|
Agent?: Agent;
|
|
453
453
|
}
|
|
454
454
|
/**
|
|
@@ -456,12 +456,12 @@ export interface CancelFlowRequest {
|
|
|
456
456
|
*/
|
|
457
457
|
export interface DescribeFlowBriefsResponse {
|
|
458
458
|
/**
|
|
459
|
-
|
|
460
|
-
|
|
459
|
+
* 流程列表
|
|
460
|
+
*/
|
|
461
461
|
FlowBriefs: Array<FlowBrief>;
|
|
462
462
|
/**
|
|
463
|
-
|
|
464
|
-
|
|
463
|
+
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
464
|
+
*/
|
|
465
465
|
RequestId?: string;
|
|
466
466
|
}
|
|
467
467
|
/**
|
|
@@ -469,107 +469,107 @@ export interface DescribeFlowBriefsResponse {
|
|
|
469
469
|
*/
|
|
470
470
|
export interface Component {
|
|
471
471
|
/**
|
|
472
|
-
|
|
473
|
-
TEXT - 普通文本控件;
|
|
474
|
-
MULTI_LINE_TEXT - 多行文本控件;
|
|
475
|
-
CHECK_BOX - 勾选框控件;
|
|
476
|
-
FILL_IMAGE - 图片控件;
|
|
477
|
-
DYNAMIC_TABLE - 动态表格控件;
|
|
478
|
-
ATTACHMENT - 附件控件;
|
|
479
|
-
SELECTOR - 选择器控件;
|
|
480
|
-
|
|
481
|
-
如果是SignComponent控件类型,则可选的字段为
|
|
482
|
-
SIGN_SEAL - 签署印章控件;
|
|
483
|
-
SIGN_DATE - 签署日期控件;
|
|
484
|
-
SIGN_SIGNATURE - 用户签名控件;
|
|
485
|
-
SIGN_PERSONAL_SEAL - 个人签署印章控件(使用文件发起暂不支持此类型);
|
|
486
|
-
|
|
487
|
-
表单域的控件不能作为印章和签名控件
|
|
488
|
-
|
|
472
|
+
* 如果是Component控件类型,则可选的字段为:
|
|
473
|
+
TEXT - 普通文本控件;
|
|
474
|
+
MULTI_LINE_TEXT - 多行文本控件;
|
|
475
|
+
CHECK_BOX - 勾选框控件;
|
|
476
|
+
FILL_IMAGE - 图片控件;
|
|
477
|
+
DYNAMIC_TABLE - 动态表格控件;
|
|
478
|
+
ATTACHMENT - 附件控件;
|
|
479
|
+
SELECTOR - 选择器控件;
|
|
480
|
+
|
|
481
|
+
如果是SignComponent控件类型,则可选的字段为
|
|
482
|
+
SIGN_SEAL - 签署印章控件;
|
|
483
|
+
SIGN_DATE - 签署日期控件;
|
|
484
|
+
SIGN_SIGNATURE - 用户签名控件;
|
|
485
|
+
SIGN_PERSONAL_SEAL - 个人签署印章控件(使用文件发起暂不支持此类型);
|
|
486
|
+
|
|
487
|
+
表单域的控件不能作为印章和签名控件
|
|
488
|
+
*/
|
|
489
489
|
ComponentType: string;
|
|
490
490
|
/**
|
|
491
|
-
|
|
492
|
-
|
|
491
|
+
* 参数控件宽度,单位pt
|
|
492
|
+
*/
|
|
493
493
|
ComponentWidth: number;
|
|
494
494
|
/**
|
|
495
|
-
|
|
496
|
-
|
|
495
|
+
* 参数控件高度,单位pt
|
|
496
|
+
*/
|
|
497
497
|
ComponentHeight: number;
|
|
498
498
|
/**
|
|
499
|
-
|
|
500
|
-
|
|
499
|
+
* 参数控件所在页码,取值为:1-N
|
|
500
|
+
*/
|
|
501
501
|
ComponentPage: number;
|
|
502
502
|
/**
|
|
503
|
-
|
|
504
|
-
|
|
503
|
+
* 参数控件X位置,单位pt
|
|
504
|
+
*/
|
|
505
505
|
ComponentPosX: number;
|
|
506
506
|
/**
|
|
507
|
-
|
|
508
|
-
|
|
507
|
+
* 参数控件Y位置,单位pt
|
|
508
|
+
*/
|
|
509
509
|
ComponentPosY: number;
|
|
510
510
|
/**
|
|
511
|
-
|
|
512
|
-
|
|
511
|
+
* 控件所属文件的序号(模板中的resourceId排列序号,取值为:0-N)
|
|
512
|
+
*/
|
|
513
513
|
FileIndex: number;
|
|
514
514
|
/**
|
|
515
|
-
|
|
516
|
-
|
|
515
|
+
* GenerateMode==KEYWORD 指定关键字
|
|
516
|
+
*/
|
|
517
517
|
ComponentId?: string;
|
|
518
518
|
/**
|
|
519
|
-
|
|
520
|
-
|
|
519
|
+
* GenerateMode==FIELD 指定表单域名称
|
|
520
|
+
*/
|
|
521
521
|
ComponentName?: string;
|
|
522
522
|
/**
|
|
523
|
-
|
|
524
|
-
|
|
523
|
+
* 是否必选,默认为false
|
|
524
|
+
*/
|
|
525
525
|
ComponentRequired?: boolean;
|
|
526
526
|
/**
|
|
527
|
-
|
|
528
|
-
ComponentType为SIGN_SIGNATURE类型可以控制签署方式
|
|
529
|
-
{“ComponentTypeLimit”: [“xxx”]}
|
|
530
|
-
xxx可以为:
|
|
531
|
-
HANDWRITE – 手写签名
|
|
532
|
-
BORDERLESS_ESIGN – 自动生成无边框腾讯体
|
|
533
|
-
OCR_ESIGN -- AI智能识别手写签名
|
|
534
|
-
ESIGN -- 个人印章类型
|
|
535
|
-
如:{“ComponentTypeLimit”: [“BORDERLESS_ESIGN”]}
|
|
536
|
-
|
|
527
|
+
* 扩展参数:
|
|
528
|
+
ComponentType为SIGN_SIGNATURE类型可以控制签署方式
|
|
529
|
+
{“ComponentTypeLimit”: [“xxx”]}
|
|
530
|
+
xxx可以为:
|
|
531
|
+
HANDWRITE – 手写签名
|
|
532
|
+
BORDERLESS_ESIGN – 自动生成无边框腾讯体
|
|
533
|
+
OCR_ESIGN -- AI智能识别手写签名
|
|
534
|
+
ESIGN -- 个人印章类型
|
|
535
|
+
如:{“ComponentTypeLimit”: [“BORDERLESS_ESIGN”]}
|
|
536
|
+
*/
|
|
537
537
|
ComponentExtra?: string;
|
|
538
538
|
/**
|
|
539
|
-
|
|
540
|
-
|
|
539
|
+
* 控件关联的签署人ID
|
|
540
|
+
*/
|
|
541
541
|
ComponentRecipientId?: string;
|
|
542
542
|
/**
|
|
543
|
-
|
|
544
|
-
TEXT - 文本内容
|
|
545
|
-
MULTI_LINE_TEXT - 文本内容
|
|
546
|
-
CHECK_BOX - true/false
|
|
547
|
-
FILL_IMAGE、ATTACHMENT - 附件的FileId,需要通过UploadFiles接口上传获取
|
|
548
|
-
SELECTOR - 选项值
|
|
549
|
-
DYNAMIC_TABLE - 传入json格式的表格内容,具体见数据结构FlowInfo:https://cloud.tencent.com/document/api/1420/61525#FlowInfo
|
|
550
|
-
|
|
543
|
+
* 控件填充vaule,ComponentType和传入值类型对应关系:
|
|
544
|
+
TEXT - 文本内容
|
|
545
|
+
MULTI_LINE_TEXT - 文本内容
|
|
546
|
+
CHECK_BOX - true/false
|
|
547
|
+
FILL_IMAGE、ATTACHMENT - 附件的FileId,需要通过UploadFiles接口上传获取
|
|
548
|
+
SELECTOR - 选项值
|
|
549
|
+
DYNAMIC_TABLE - 传入json格式的表格内容,具体见数据结构FlowInfo:https://cloud.tencent.com/document/api/1420/61525#FlowInfo
|
|
550
|
+
*/
|
|
551
551
|
ComponentValue?: string;
|
|
552
552
|
/**
|
|
553
|
-
|
|
554
|
-
|
|
553
|
+
* 是否是表单域类型,默认不存在
|
|
554
|
+
*/
|
|
555
555
|
IsFormType?: boolean;
|
|
556
556
|
/**
|
|
557
|
-
|
|
558
|
-
FIELD 表单域,需使用ComponentName指定表单域名称
|
|
559
|
-
KEYWORD 关键字,使用ComponentId指定关键字
|
|
560
|
-
|
|
557
|
+
* NORMAL 正常模式,使用坐标制定签署控件位置
|
|
558
|
+
FIELD 表单域,需使用ComponentName指定表单域名称
|
|
559
|
+
KEYWORD 关键字,使用ComponentId指定关键字
|
|
560
|
+
*/
|
|
561
561
|
GenerateMode?: string;
|
|
562
562
|
/**
|
|
563
|
-
|
|
564
|
-
|
|
563
|
+
* 日期控件类型字号
|
|
564
|
+
*/
|
|
565
565
|
ComponentDateFontSize?: number;
|
|
566
566
|
/**
|
|
567
|
-
|
|
568
|
-
|
|
567
|
+
* 指定关键字时横坐标偏移量,单位pt
|
|
568
|
+
*/
|
|
569
569
|
OffsetX?: number;
|
|
570
570
|
/**
|
|
571
|
-
|
|
572
|
-
|
|
571
|
+
* 指定关键字时纵坐标偏移量,单位pt
|
|
572
|
+
*/
|
|
573
573
|
OffsetY?: number;
|
|
574
574
|
}
|
|
575
575
|
/**
|
|
@@ -577,16 +577,16 @@ KEYWORD 关键字,使用ComponentId指定关键字
|
|
|
577
577
|
*/
|
|
578
578
|
export interface CreateMultiFlowSignQRCodeResponse {
|
|
579
579
|
/**
|
|
580
|
-
|
|
581
|
-
|
|
580
|
+
* 签署二维码对象
|
|
581
|
+
*/
|
|
582
582
|
QrCode: SignQrCode;
|
|
583
583
|
/**
|
|
584
|
-
|
|
585
|
-
|
|
584
|
+
* 签署链接对象
|
|
585
|
+
*/
|
|
586
586
|
SignUrls: SignUrl;
|
|
587
587
|
/**
|
|
588
|
-
|
|
589
|
-
|
|
588
|
+
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
589
|
+
*/
|
|
590
590
|
RequestId?: string;
|
|
591
591
|
}
|
|
592
592
|
/**
|
|
@@ -594,62 +594,62 @@ export interface CreateMultiFlowSignQRCodeResponse {
|
|
|
594
594
|
*/
|
|
595
595
|
export interface FlowCreateApprover {
|
|
596
596
|
/**
|
|
597
|
-
|
|
598
|
-
0:企业
|
|
599
|
-
1:个人
|
|
600
|
-
3:企业静默签署
|
|
601
|
-
注:类型为3(企业静默签署)时,此接口会默认完成该签署方的签署。
|
|
602
|
-
|
|
597
|
+
* 参与者类型:
|
|
598
|
+
0:企业
|
|
599
|
+
1:个人
|
|
600
|
+
3:企业静默签署
|
|
601
|
+
注:类型为3(企业静默签署)时,此接口会默认完成该签署方的签署。
|
|
602
|
+
*/
|
|
603
603
|
ApproverType: number;
|
|
604
604
|
/**
|
|
605
|
-
|
|
606
|
-
|
|
605
|
+
* 如果签署方为企业,需要填入企业全称
|
|
606
|
+
*/
|
|
607
607
|
OrganizationName?: string;
|
|
608
608
|
/**
|
|
609
|
-
|
|
610
|
-
|
|
609
|
+
* 签署方经办人姓名
|
|
610
|
+
*/
|
|
611
611
|
ApproverName?: string;
|
|
612
612
|
/**
|
|
613
|
-
|
|
614
|
-
|
|
613
|
+
* 签署方经办人手机号码
|
|
614
|
+
*/
|
|
615
615
|
ApproverMobile?: string;
|
|
616
616
|
/**
|
|
617
|
-
|
|
618
|
-
HONGKONG_AND_MACAO 港澳居民来往内地通行证
|
|
619
|
-
HONGKONG_MACAO_AND_TAIWAN 港澳台居民居住证(格式同居民身份证)
|
|
620
|
-
|
|
617
|
+
* 签署方经办人证件类型ID_CARD 身份证
|
|
618
|
+
HONGKONG_AND_MACAO 港澳居民来往内地通行证
|
|
619
|
+
HONGKONG_MACAO_AND_TAIWAN 港澳台居民居住证(格式同居民身份证)
|
|
620
|
+
*/
|
|
621
621
|
ApproverIdCardType?: string;
|
|
622
622
|
/**
|
|
623
|
-
|
|
624
|
-
|
|
623
|
+
* 签署方经办人证件号码
|
|
624
|
+
*/
|
|
625
625
|
ApproverIdCardNumber?: string;
|
|
626
626
|
/**
|
|
627
|
-
|
|
628
|
-
|
|
627
|
+
* 签署方经办人在模板中的角色ID
|
|
628
|
+
*/
|
|
629
629
|
RecipientId?: string;
|
|
630
630
|
/**
|
|
631
|
-
|
|
632
|
-
|
|
631
|
+
* 签署意愿确认渠道,WEIXINAPP:人脸识别
|
|
632
|
+
*/
|
|
633
633
|
VerifyChannel?: Array<string>;
|
|
634
634
|
/**
|
|
635
|
-
|
|
636
|
-
|
|
635
|
+
* 是否发送短信,sms--短信通知,none--不通知,默认为sms
|
|
636
|
+
*/
|
|
637
637
|
NotifyType?: string;
|
|
638
638
|
/**
|
|
639
|
-
|
|
640
|
-
|
|
639
|
+
* 签署前置条件:是否需要阅读全文,默认为不需要
|
|
640
|
+
*/
|
|
641
641
|
IsFullText?: boolean;
|
|
642
642
|
/**
|
|
643
|
-
|
|
644
|
-
|
|
643
|
+
* 签署前置条件:阅读时长限制,默认为不需要
|
|
644
|
+
*/
|
|
645
645
|
PreReadTime?: number;
|
|
646
646
|
/**
|
|
647
|
-
|
|
648
|
-
|
|
647
|
+
* 签署方经办人的用户ID,和签署方经办人姓名+手机号+证件必须有一个
|
|
648
|
+
*/
|
|
649
649
|
UserId?: string;
|
|
650
650
|
/**
|
|
651
|
-
|
|
652
|
-
|
|
651
|
+
* 当前只支持true,默认为true
|
|
652
|
+
*/
|
|
653
653
|
Required?: boolean;
|
|
654
654
|
}
|
|
655
655
|
/**
|
|
@@ -657,16 +657,16 @@ HONGKONG_MACAO_AND_TAIWAN 港澳台居民居住证(格式同居民身份证)
|
|
|
657
657
|
*/
|
|
658
658
|
export interface UploadFilesResponse {
|
|
659
659
|
/**
|
|
660
|
-
|
|
661
|
-
|
|
660
|
+
* 文件id数组
|
|
661
|
+
*/
|
|
662
662
|
FileIds: Array<string>;
|
|
663
663
|
/**
|
|
664
|
-
|
|
665
|
-
|
|
664
|
+
* 上传成功文件数量
|
|
665
|
+
*/
|
|
666
666
|
TotalCount: number;
|
|
667
667
|
/**
|
|
668
|
-
|
|
669
|
-
|
|
668
|
+
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
669
|
+
*/
|
|
670
670
|
RequestId?: string;
|
|
671
671
|
}
|
|
672
672
|
/**
|
|
@@ -674,12 +674,12 @@ export interface UploadFilesResponse {
|
|
|
674
674
|
*/
|
|
675
675
|
export interface DescribeThirdPartyAuthCodeResponse {
|
|
676
676
|
/**
|
|
677
|
-
|
|
678
|
-
|
|
677
|
+
* 用户是否实名,VERIFIED 为实名,UNVERIFIED 未实名
|
|
678
|
+
*/
|
|
679
679
|
VerifyStatus: string;
|
|
680
680
|
/**
|
|
681
|
-
|
|
682
|
-
|
|
681
|
+
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
682
|
+
*/
|
|
683
683
|
RequestId?: string;
|
|
684
684
|
}
|
|
685
685
|
/**
|
|
@@ -687,17 +687,17 @@ export interface DescribeThirdPartyAuthCodeResponse {
|
|
|
687
687
|
*/
|
|
688
688
|
export interface CreateFlowByFilesResponse {
|
|
689
689
|
/**
|
|
690
|
-
|
|
691
|
-
|
|
690
|
+
* 签署流程编号
|
|
691
|
+
*/
|
|
692
692
|
FlowId: string;
|
|
693
693
|
/**
|
|
694
|
-
|
|
695
|
-
注意:此字段可能返回 null,表示取不到有效值。
|
|
696
|
-
|
|
694
|
+
* 合同预览链接
|
|
695
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
696
|
+
*/
|
|
697
697
|
PreviewUrl: string;
|
|
698
698
|
/**
|
|
699
|
-
|
|
700
|
-
|
|
699
|
+
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
700
|
+
*/
|
|
701
701
|
RequestId?: string;
|
|
702
702
|
}
|
|
703
703
|
/**
|
|
@@ -705,24 +705,24 @@ export interface CreateFlowByFilesResponse {
|
|
|
705
705
|
*/
|
|
706
706
|
export interface OrganizationInfo {
|
|
707
707
|
/**
|
|
708
|
-
|
|
709
|
-
|
|
708
|
+
* 机构在平台的编号
|
|
709
|
+
*/
|
|
710
710
|
OrganizationId?: string;
|
|
711
711
|
/**
|
|
712
|
-
|
|
713
|
-
|
|
712
|
+
* 用户渠道
|
|
713
|
+
*/
|
|
714
714
|
Channel?: string;
|
|
715
715
|
/**
|
|
716
|
-
|
|
717
|
-
|
|
716
|
+
* 用户在渠道的机构编号
|
|
717
|
+
*/
|
|
718
718
|
OrganizationOpenId?: string;
|
|
719
719
|
/**
|
|
720
|
-
|
|
721
|
-
|
|
720
|
+
* 用户真实的IP
|
|
721
|
+
*/
|
|
722
722
|
ClientIp?: string;
|
|
723
723
|
/**
|
|
724
|
-
|
|
725
|
-
|
|
724
|
+
* 机构的代理IP
|
|
725
|
+
*/
|
|
726
726
|
ProxyIp?: string;
|
|
727
727
|
}
|
|
728
728
|
/**
|
|
@@ -730,16 +730,16 @@ export interface OrganizationInfo {
|
|
|
730
730
|
*/
|
|
731
731
|
export interface DescribeFlowBriefsRequest {
|
|
732
732
|
/**
|
|
733
|
-
|
|
734
|
-
|
|
733
|
+
* 调用方用户信息,userId 必填
|
|
734
|
+
*/
|
|
735
735
|
Operator: UserInfo;
|
|
736
736
|
/**
|
|
737
|
-
|
|
738
|
-
|
|
737
|
+
* 需要查询的流程ID列表,限制最大20个
|
|
738
|
+
*/
|
|
739
739
|
FlowIds: Array<string>;
|
|
740
740
|
/**
|
|
741
|
-
|
|
742
|
-
|
|
741
|
+
* 应用相关信息
|
|
742
|
+
*/
|
|
743
743
|
Agent?: Agent;
|
|
744
744
|
}
|
|
745
745
|
/**
|
|
@@ -747,56 +747,56 @@ export interface DescribeFlowBriefsRequest {
|
|
|
747
747
|
*/
|
|
748
748
|
export interface Recipient {
|
|
749
749
|
/**
|
|
750
|
-
|
|
751
|
-
|
|
750
|
+
* 签署参与者ID
|
|
751
|
+
*/
|
|
752
752
|
RecipientId?: string;
|
|
753
753
|
/**
|
|
754
|
-
|
|
755
|
-
|
|
754
|
+
* 参与者类型(ENTERPRISE/INDIVIDUAL)
|
|
755
|
+
*/
|
|
756
756
|
RecipientType?: string;
|
|
757
757
|
/**
|
|
758
|
-
|
|
759
|
-
|
|
758
|
+
* 描述信息
|
|
759
|
+
*/
|
|
760
760
|
Description?: string;
|
|
761
761
|
/**
|
|
762
|
-
|
|
763
|
-
|
|
762
|
+
* 角色名称
|
|
763
|
+
*/
|
|
764
764
|
RoleName?: string;
|
|
765
765
|
/**
|
|
766
|
-
|
|
767
|
-
|
|
766
|
+
* 是否需要验证,默认为false
|
|
767
|
+
*/
|
|
768
768
|
RequireValidation?: boolean;
|
|
769
769
|
/**
|
|
770
|
-
|
|
771
|
-
|
|
770
|
+
* 是否需要签署,默认为true
|
|
771
|
+
*/
|
|
772
772
|
RequireSign?: boolean;
|
|
773
773
|
/**
|
|
774
|
-
|
|
775
|
-
|
|
774
|
+
* 添加序列
|
|
775
|
+
*/
|
|
776
776
|
RoutingOrder?: number;
|
|
777
777
|
/**
|
|
778
|
-
|
|
779
|
-
|
|
778
|
+
* 是否需要发送,默认为true
|
|
779
|
+
*/
|
|
780
780
|
RequireDelivery?: boolean;
|
|
781
781
|
/**
|
|
782
|
-
|
|
783
|
-
|
|
782
|
+
* 邮箱地址
|
|
783
|
+
*/
|
|
784
784
|
Email?: string;
|
|
785
785
|
/**
|
|
786
|
-
|
|
787
|
-
|
|
786
|
+
* 电话号码
|
|
787
|
+
*/
|
|
788
788
|
Mobile?: string;
|
|
789
789
|
/**
|
|
790
|
-
|
|
791
|
-
|
|
790
|
+
* 关联的用户ID
|
|
791
|
+
*/
|
|
792
792
|
UserId?: string;
|
|
793
793
|
/**
|
|
794
|
-
|
|
795
|
-
|
|
794
|
+
* 发送方式(EMAIL/MOBILE)
|
|
795
|
+
*/
|
|
796
796
|
DeliveryMethod?: string;
|
|
797
797
|
/**
|
|
798
|
-
|
|
799
|
-
|
|
798
|
+
* 附属信息
|
|
799
|
+
*/
|
|
800
800
|
RecipientExtra?: string;
|
|
801
801
|
}
|
|
802
802
|
/**
|
|
@@ -804,24 +804,24 @@ export interface Recipient {
|
|
|
804
804
|
*/
|
|
805
805
|
export interface UserInfo {
|
|
806
806
|
/**
|
|
807
|
-
|
|
808
|
-
|
|
807
|
+
* 用户在平台的编号
|
|
808
|
+
*/
|
|
809
809
|
UserId?: string;
|
|
810
810
|
/**
|
|
811
|
-
|
|
812
|
-
|
|
811
|
+
* 用户的来源渠道
|
|
812
|
+
*/
|
|
813
813
|
Channel?: string;
|
|
814
814
|
/**
|
|
815
|
-
|
|
816
|
-
|
|
815
|
+
* 用户在渠道的编号
|
|
816
|
+
*/
|
|
817
817
|
OpenId?: string;
|
|
818
818
|
/**
|
|
819
|
-
|
|
820
|
-
|
|
819
|
+
* 用户真实IP
|
|
820
|
+
*/
|
|
821
821
|
ClientIp?: string;
|
|
822
822
|
/**
|
|
823
|
-
|
|
824
|
-
|
|
823
|
+
* 用户代理IP
|
|
824
|
+
*/
|
|
825
825
|
ProxyIp?: string;
|
|
826
826
|
}
|
|
827
827
|
/**
|
|
@@ -829,16 +829,16 @@ export interface UserInfo {
|
|
|
829
829
|
*/
|
|
830
830
|
export interface SignUrl {
|
|
831
831
|
/**
|
|
832
|
-
|
|
833
|
-
|
|
832
|
+
* 小程序签署链接
|
|
833
|
+
*/
|
|
834
834
|
AppSignUrl: string;
|
|
835
835
|
/**
|
|
836
|
-
|
|
837
|
-
|
|
836
|
+
* 签署链接有效时间
|
|
837
|
+
*/
|
|
838
838
|
EffectiveTime: string;
|
|
839
839
|
/**
|
|
840
|
-
|
|
841
|
-
|
|
840
|
+
* 移动端签署链接
|
|
841
|
+
*/
|
|
842
842
|
HttpSignUrl: string;
|
|
843
843
|
}
|
|
844
844
|
/**
|
|
@@ -846,53 +846,53 @@ export interface SignUrl {
|
|
|
846
846
|
*/
|
|
847
847
|
export interface DescribeFileUrlsRequest {
|
|
848
848
|
/**
|
|
849
|
-
|
|
850
|
-
- 模板 "TEMPLATE"
|
|
851
|
-
- 文档 "DOCUMENT"
|
|
852
|
-
- 印章 “SEAL”
|
|
853
|
-
- 流程 "FLOW"
|
|
854
|
-
|
|
849
|
+
* 文件对应的业务类型,目前支持:
|
|
850
|
+
- 模板 "TEMPLATE"
|
|
851
|
+
- 文档 "DOCUMENT"
|
|
852
|
+
- 印章 “SEAL”
|
|
853
|
+
- 流程 "FLOW"
|
|
854
|
+
*/
|
|
855
855
|
BusinessType: string;
|
|
856
856
|
/**
|
|
857
|
-
|
|
858
|
-
最大支持20个资源
|
|
859
|
-
|
|
857
|
+
* 业务编号的数组,如模板编号、文档编号、印章编号
|
|
858
|
+
最大支持20个资源
|
|
859
|
+
*/
|
|
860
860
|
BusinessIds: Array<string>;
|
|
861
861
|
/**
|
|
862
|
-
|
|
863
|
-
|
|
862
|
+
* 操作者信息
|
|
863
|
+
*/
|
|
864
864
|
Operator: UserInfo;
|
|
865
865
|
/**
|
|
866
|
-
|
|
867
|
-
|
|
866
|
+
* 应用相关信息
|
|
867
|
+
*/
|
|
868
868
|
Agent?: Agent;
|
|
869
869
|
/**
|
|
870
|
-
|
|
871
|
-
|
|
870
|
+
* 下载后的文件命名,只有fileType为zip的时候生效
|
|
871
|
+
*/
|
|
872
872
|
FileName?: string;
|
|
873
873
|
/**
|
|
874
|
-
|
|
875
|
-
|
|
874
|
+
* 文件类型,"JPG", "PDF","ZIP"等
|
|
875
|
+
*/
|
|
876
876
|
FileType?: string;
|
|
877
877
|
/**
|
|
878
|
-
|
|
879
|
-
|
|
878
|
+
* 指定资源起始偏移量,默认0
|
|
879
|
+
*/
|
|
880
880
|
Offset?: number;
|
|
881
881
|
/**
|
|
882
|
-
|
|
883
|
-
|
|
882
|
+
* 指定资源数量,查询全部资源则传入-1
|
|
883
|
+
*/
|
|
884
884
|
Limit?: number;
|
|
885
885
|
/**
|
|
886
|
-
|
|
887
|
-
|
|
886
|
+
* 下载url过期时间,单位秒。0: 按默认值5分钟,允许范围:1s~24x60x60s(1天)
|
|
887
|
+
*/
|
|
888
888
|
UrlTtl?: number;
|
|
889
889
|
/**
|
|
890
|
-
|
|
891
|
-
|
|
890
|
+
* 暂不开放
|
|
891
|
+
*/
|
|
892
892
|
Scene?: string;
|
|
893
893
|
/**
|
|
894
|
-
|
|
895
|
-
|
|
894
|
+
* 暂不开放
|
|
895
|
+
*/
|
|
896
896
|
CcToken?: string;
|
|
897
897
|
}
|
|
898
898
|
/**
|
|
@@ -900,55 +900,55 @@ export interface DescribeFileUrlsRequest {
|
|
|
900
900
|
*/
|
|
901
901
|
export interface ApproverInfo {
|
|
902
902
|
/**
|
|
903
|
-
|
|
904
|
-
0:企业
|
|
905
|
-
1:个人
|
|
906
|
-
3:企业静默签署
|
|
907
|
-
注:类型为3(企业静默签署)时,此接口会默认完成该签署方的签署。
|
|
908
|
-
|
|
903
|
+
* 参与者类型:
|
|
904
|
+
0:企业
|
|
905
|
+
1:个人
|
|
906
|
+
3:企业静默签署
|
|
907
|
+
注:类型为3(企业静默签署)时,此接口会默认完成该签署方的签署。
|
|
908
|
+
*/
|
|
909
909
|
ApproverType: number;
|
|
910
910
|
/**
|
|
911
|
-
|
|
912
|
-
|
|
911
|
+
* 本环节需要操作人的名字
|
|
912
|
+
*/
|
|
913
913
|
ApproverName: string;
|
|
914
914
|
/**
|
|
915
|
-
|
|
916
|
-
|
|
915
|
+
* 本环节需要操作人的手机号
|
|
916
|
+
*/
|
|
917
917
|
ApproverMobile: string;
|
|
918
918
|
/**
|
|
919
|
-
|
|
920
|
-
|
|
919
|
+
* 本环节操作人签署控件配置
|
|
920
|
+
*/
|
|
921
921
|
SignComponents: Array<Component>;
|
|
922
922
|
/**
|
|
923
|
-
|
|
924
|
-
|
|
923
|
+
* 如果是企业,则为企业的名字
|
|
924
|
+
*/
|
|
925
925
|
OrganizationName?: string;
|
|
926
926
|
/**
|
|
927
|
-
|
|
928
|
-
|
|
927
|
+
* 身份证号
|
|
928
|
+
*/
|
|
929
929
|
ApproverIdCardNumber?: string;
|
|
930
930
|
/**
|
|
931
|
-
|
|
932
|
-
ID_CARD 身份证
|
|
933
|
-
HONGKONG_AND_MACAO 港澳居民来往内地通行证
|
|
934
|
-
HONGKONG_MACAO_AND_TAIWAN 港澳台居民居住证(格式同居民身份证)
|
|
935
|
-
|
|
931
|
+
* 证件类型
|
|
932
|
+
ID_CARD 身份证
|
|
933
|
+
HONGKONG_AND_MACAO 港澳居民来往内地通行证
|
|
934
|
+
HONGKONG_MACAO_AND_TAIWAN 港澳台居民居住证(格式同居民身份证)
|
|
935
|
+
*/
|
|
936
936
|
ApproverIdCardType?: string;
|
|
937
937
|
/**
|
|
938
|
-
|
|
939
|
-
|
|
938
|
+
* sms--短信,none--不通知
|
|
939
|
+
*/
|
|
940
940
|
NotifyType?: string;
|
|
941
941
|
/**
|
|
942
|
-
|
|
943
|
-
|
|
942
|
+
* 1--收款人、2--开具人、3--见证人
|
|
943
|
+
*/
|
|
944
944
|
ApproverRole?: number;
|
|
945
945
|
/**
|
|
946
|
-
|
|
947
|
-
|
|
946
|
+
* 签署意愿确认渠道,WEIXINAPP:人脸识别
|
|
947
|
+
*/
|
|
948
948
|
VerifyChannel?: Array<string>;
|
|
949
949
|
/**
|
|
950
|
-
|
|
951
|
-
|
|
950
|
+
* 合同的强制预览时间:3~300s,未指定则按合同页数计算
|
|
951
|
+
*/
|
|
952
952
|
PreReadTime?: number;
|
|
953
953
|
}
|
|
954
954
|
/**
|
|
@@ -956,8 +956,8 @@ HONGKONG_MACAO_AND_TAIWAN 港澳台居民居住证(格式同居民身份证)
|
|
|
956
956
|
*/
|
|
957
957
|
export interface CreateFlowSignReviewResponse {
|
|
958
958
|
/**
|
|
959
|
-
|
|
960
|
-
|
|
959
|
+
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
960
|
+
*/
|
|
961
961
|
RequestId?: string;
|
|
962
962
|
}
|
|
963
963
|
/**
|
|
@@ -965,20 +965,20 @@ export interface CreateFlowSignReviewResponse {
|
|
|
965
965
|
*/
|
|
966
966
|
export interface Caller {
|
|
967
967
|
/**
|
|
968
|
-
|
|
969
|
-
|
|
968
|
+
* 应用号
|
|
969
|
+
*/
|
|
970
970
|
ApplicationId?: string;
|
|
971
971
|
/**
|
|
972
|
-
|
|
973
|
-
|
|
972
|
+
* 主机构ID
|
|
973
|
+
*/
|
|
974
974
|
OrganizationId?: string;
|
|
975
975
|
/**
|
|
976
|
-
|
|
977
|
-
|
|
976
|
+
* 经办人的用户ID
|
|
977
|
+
*/
|
|
978
978
|
OperatorId?: string;
|
|
979
979
|
/**
|
|
980
|
-
|
|
981
|
-
|
|
980
|
+
* 下属机构ID
|
|
981
|
+
*/
|
|
982
982
|
SubOrganizationId?: string;
|
|
983
983
|
}
|
|
984
984
|
/**
|
|
@@ -986,16 +986,16 @@ export interface Caller {
|
|
|
986
986
|
*/
|
|
987
987
|
export interface DescribeFlowTemplatesResponse {
|
|
988
988
|
/**
|
|
989
|
-
|
|
990
|
-
|
|
989
|
+
* 模板详情列表
|
|
990
|
+
*/
|
|
991
991
|
Templates: Array<TemplateInfo>;
|
|
992
992
|
/**
|
|
993
|
-
|
|
994
|
-
|
|
993
|
+
* 查询到的总个数
|
|
994
|
+
*/
|
|
995
995
|
TotalCount: number;
|
|
996
996
|
/**
|
|
997
|
-
|
|
998
|
-
|
|
997
|
+
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
998
|
+
*/
|
|
999
999
|
RequestId?: string;
|
|
1000
1000
|
}
|
|
1001
1001
|
/**
|
|
@@ -1003,12 +1003,12 @@ export interface DescribeFlowTemplatesResponse {
|
|
|
1003
1003
|
*/
|
|
1004
1004
|
export interface CreateFlowEvidenceReportRequest {
|
|
1005
1005
|
/**
|
|
1006
|
-
|
|
1007
|
-
|
|
1006
|
+
* 调用方用户信息,userId 必填
|
|
1007
|
+
*/
|
|
1008
1008
|
Operator: UserInfo;
|
|
1009
1009
|
/**
|
|
1010
|
-
|
|
1011
|
-
|
|
1010
|
+
* 签署流程编号
|
|
1011
|
+
*/
|
|
1012
1012
|
FlowId: string;
|
|
1013
1013
|
}
|
|
1014
1014
|
/**
|
|
@@ -1016,20 +1016,20 @@ export interface CreateFlowEvidenceReportRequest {
|
|
|
1016
1016
|
*/
|
|
1017
1017
|
export interface CreateBatchCancelFlowUrlResponse {
|
|
1018
1018
|
/**
|
|
1019
|
-
|
|
1020
|
-
|
|
1019
|
+
* 批量撤回签署流程链接
|
|
1020
|
+
*/
|
|
1021
1021
|
BatchCancelFlowUrl: string;
|
|
1022
1022
|
/**
|
|
1023
|
-
|
|
1024
|
-
|
|
1023
|
+
* 签署流程撤回失败信息
|
|
1024
|
+
*/
|
|
1025
1025
|
FailMessages: Array<string>;
|
|
1026
1026
|
/**
|
|
1027
|
-
|
|
1028
|
-
|
|
1027
|
+
* 签署连接过期时间字符串:年月日-时分秒
|
|
1028
|
+
*/
|
|
1029
1029
|
UrlExpireOn: string;
|
|
1030
1030
|
/**
|
|
1031
|
-
|
|
1032
|
-
|
|
1031
|
+
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
1032
|
+
*/
|
|
1033
1033
|
RequestId?: string;
|
|
1034
1034
|
}
|
|
1035
1035
|
/**
|
|
@@ -1037,12 +1037,12 @@ export interface CreateBatchCancelFlowUrlResponse {
|
|
|
1037
1037
|
*/
|
|
1038
1038
|
export interface StartFlowResponse {
|
|
1039
1039
|
/**
|
|
1040
|
-
|
|
1041
|
-
|
|
1040
|
+
* 返回描述,START-发起成功, REVIEW-提交审核成功,EXECUTING-已提交发起任务
|
|
1041
|
+
*/
|
|
1042
1042
|
Status: string;
|
|
1043
1043
|
/**
|
|
1044
|
-
|
|
1045
|
-
|
|
1044
|
+
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
1045
|
+
*/
|
|
1046
1046
|
RequestId?: string;
|
|
1047
1047
|
}
|
|
1048
1048
|
/**
|
|
@@ -1050,20 +1050,20 @@ export interface StartFlowResponse {
|
|
|
1050
1050
|
*/
|
|
1051
1051
|
export interface FileInfo {
|
|
1052
1052
|
/**
|
|
1053
|
-
|
|
1054
|
-
|
|
1053
|
+
* 文件Id
|
|
1054
|
+
*/
|
|
1055
1055
|
FileId?: string;
|
|
1056
1056
|
/**
|
|
1057
|
-
|
|
1058
|
-
|
|
1057
|
+
* 文件名
|
|
1058
|
+
*/
|
|
1059
1059
|
FileName?: string;
|
|
1060
1060
|
/**
|
|
1061
|
-
|
|
1062
|
-
|
|
1061
|
+
* 文件大小,单位为Byte
|
|
1062
|
+
*/
|
|
1063
1063
|
FileSize?: number;
|
|
1064
1064
|
/**
|
|
1065
|
-
|
|
1066
|
-
|
|
1065
|
+
* 文件上传时间,10位时间戳(精确到秒)
|
|
1066
|
+
*/
|
|
1067
1067
|
CreatedOn?: number;
|
|
1068
1068
|
}
|
|
1069
1069
|
/**
|
|
@@ -1071,12 +1071,12 @@ export interface FileInfo {
|
|
|
1071
1071
|
*/
|
|
1072
1072
|
export interface CreateBatchCancelFlowUrlRequest {
|
|
1073
1073
|
/**
|
|
1074
|
-
|
|
1075
|
-
|
|
1074
|
+
* 调用方用户信息,userId 必填
|
|
1075
|
+
*/
|
|
1076
1076
|
Operator: UserInfo;
|
|
1077
1077
|
/**
|
|
1078
|
-
|
|
1079
|
-
|
|
1078
|
+
* 需要执行撤回的签署流程id数组,最多100个
|
|
1079
|
+
*/
|
|
1080
1080
|
FlowIds: Array<string>;
|
|
1081
1081
|
}
|
|
1082
1082
|
/**
|
|
@@ -1084,43 +1084,43 @@ export interface CreateBatchCancelFlowUrlRequest {
|
|
|
1084
1084
|
*/
|
|
1085
1085
|
export interface CreateMultiFlowSignQRCodeRequest {
|
|
1086
1086
|
/**
|
|
1087
|
-
|
|
1088
|
-
|
|
1087
|
+
* 模板ID
|
|
1088
|
+
*/
|
|
1089
1089
|
TemplateId: string;
|
|
1090
1090
|
/**
|
|
1091
|
-
|
|
1092
|
-
|
|
1091
|
+
* 签署流程名称,最大长度不超过200字符
|
|
1092
|
+
*/
|
|
1093
1093
|
FlowName: string;
|
|
1094
1094
|
/**
|
|
1095
|
-
|
|
1096
|
-
|
|
1095
|
+
* 用户信息
|
|
1096
|
+
*/
|
|
1097
1097
|
Operator: UserInfo;
|
|
1098
1098
|
/**
|
|
1099
|
-
|
|
1100
|
-
|
|
1099
|
+
* 应用信息
|
|
1100
|
+
*/
|
|
1101
1101
|
Agent?: Agent;
|
|
1102
1102
|
/**
|
|
1103
|
-
|
|
1104
|
-
回调时机:
|
|
1105
|
-
用户通过签署二维码发起签署流程时,企业额度不足导致失败
|
|
1106
|
-
|
|
1103
|
+
* 回调地址,最大长度1000字符串
|
|
1104
|
+
回调时机:
|
|
1105
|
+
用户通过签署二维码发起签署流程时,企业额度不足导致失败
|
|
1106
|
+
*/
|
|
1107
1107
|
CallbackUrl?: string;
|
|
1108
1108
|
/**
|
|
1109
|
-
|
|
1110
|
-
发起流程数量超过此上限后二维码自动失效
|
|
1111
|
-
|
|
1109
|
+
* 最大可发起签署流程份数,默认5份
|
|
1110
|
+
发起流程数量超过此上限后二维码自动失效
|
|
1111
|
+
*/
|
|
1112
1112
|
MaxFlowNum?: number;
|
|
1113
1113
|
/**
|
|
1114
|
-
|
|
1115
|
-
|
|
1114
|
+
* 签署流程有效天数 默认7天 最高设置不超过30天
|
|
1115
|
+
*/
|
|
1116
1116
|
FlowEffectiveDay?: number;
|
|
1117
1117
|
/**
|
|
1118
|
-
|
|
1119
|
-
|
|
1118
|
+
* 二维码有效天数 默认7天 最高设置不超过90天
|
|
1119
|
+
*/
|
|
1120
1120
|
QrEffectiveDay?: number;
|
|
1121
1121
|
/**
|
|
1122
|
-
|
|
1123
|
-
|
|
1122
|
+
* 限制二维码用户条件
|
|
1123
|
+
*/
|
|
1124
1124
|
ApproverRestrictions?: ApproverRestriction;
|
|
1125
1125
|
}
|
|
1126
1126
|
/**
|
|
@@ -1128,12 +1128,12 @@ export interface CreateMultiFlowSignQRCodeRequest {
|
|
|
1128
1128
|
*/
|
|
1129
1129
|
export interface CreateConvertTaskApiResponse {
|
|
1130
1130
|
/**
|
|
1131
|
-
|
|
1132
|
-
|
|
1131
|
+
* 转换任务Id
|
|
1132
|
+
*/
|
|
1133
1133
|
TaskId: string;
|
|
1134
1134
|
/**
|
|
1135
|
-
|
|
1136
|
-
|
|
1135
|
+
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
1136
|
+
*/
|
|
1137
1137
|
RequestId?: string;
|
|
1138
1138
|
}
|
|
1139
1139
|
/**
|
|
@@ -1141,27 +1141,27 @@ export interface CreateConvertTaskApiResponse {
|
|
|
1141
1141
|
*/
|
|
1142
1142
|
export interface CreateFlowSignReviewRequest {
|
|
1143
1143
|
/**
|
|
1144
|
-
|
|
1145
|
-
|
|
1144
|
+
* 调用方用户信息,userId 必填
|
|
1145
|
+
*/
|
|
1146
1146
|
Operator: UserInfo;
|
|
1147
1147
|
/**
|
|
1148
|
-
|
|
1149
|
-
|
|
1148
|
+
* 签署流程编号
|
|
1149
|
+
*/
|
|
1150
1150
|
FlowId: string;
|
|
1151
1151
|
/**
|
|
1152
|
-
|
|
1153
|
-
PASS: 通过
|
|
1154
|
-
REJECT: 拒绝
|
|
1155
|
-
|
|
1152
|
+
* 企业内部审核结果
|
|
1153
|
+
PASS: 通过
|
|
1154
|
+
REJECT: 拒绝
|
|
1155
|
+
*/
|
|
1156
1156
|
ReviewType: string;
|
|
1157
1157
|
/**
|
|
1158
|
-
|
|
1159
|
-
当ReviewType 是REJECT 时此字段必填,字符串长度不超过200
|
|
1160
|
-
|
|
1158
|
+
* 审核原因
|
|
1159
|
+
当ReviewType 是REJECT 时此字段必填,字符串长度不超过200
|
|
1160
|
+
*/
|
|
1161
1161
|
ReviewMessage?: string;
|
|
1162
1162
|
/**
|
|
1163
|
-
|
|
1164
|
-
|
|
1163
|
+
* 应用相关信息
|
|
1164
|
+
*/
|
|
1165
1165
|
Agent?: Agent;
|
|
1166
1166
|
}
|
|
1167
1167
|
/**
|
|
@@ -1169,28 +1169,28 @@ REJECT: 拒绝
|
|
|
1169
1169
|
*/
|
|
1170
1170
|
export interface CreateConvertTaskApiRequest {
|
|
1171
1171
|
/**
|
|
1172
|
-
|
|
1173
|
-
|
|
1172
|
+
* 资源类型 取值范围doc,docx,html之一
|
|
1173
|
+
*/
|
|
1174
1174
|
ResourceType: string;
|
|
1175
1175
|
/**
|
|
1176
|
-
|
|
1177
|
-
|
|
1176
|
+
* 资源名称,长度限制为256字符
|
|
1177
|
+
*/
|
|
1178
1178
|
ResourceName: string;
|
|
1179
1179
|
/**
|
|
1180
|
-
|
|
1181
|
-
|
|
1180
|
+
* 资源Id,通过UploadFiles获取
|
|
1181
|
+
*/
|
|
1182
1182
|
ResourceId: string;
|
|
1183
1183
|
/**
|
|
1184
|
-
|
|
1185
|
-
|
|
1184
|
+
* 操作者信息
|
|
1185
|
+
*/
|
|
1186
1186
|
Operator?: UserInfo;
|
|
1187
1187
|
/**
|
|
1188
|
-
|
|
1189
|
-
|
|
1188
|
+
* 应用号信息
|
|
1189
|
+
*/
|
|
1190
1190
|
Agent?: Agent;
|
|
1191
1191
|
/**
|
|
1192
|
-
|
|
1193
|
-
|
|
1192
|
+
* 暂未开放
|
|
1193
|
+
*/
|
|
1194
1194
|
Organization?: OrganizationInfo;
|
|
1195
1195
|
}
|
|
1196
1196
|
/**
|
|
@@ -1198,12 +1198,12 @@ export interface CreateConvertTaskApiRequest {
|
|
|
1198
1198
|
*/
|
|
1199
1199
|
export interface CreateSchemeUrlResponse {
|
|
1200
1200
|
/**
|
|
1201
|
-
|
|
1202
|
-
|
|
1201
|
+
* 小程序链接地址
|
|
1202
|
+
*/
|
|
1203
1203
|
SchemeUrl: string;
|
|
1204
1204
|
/**
|
|
1205
|
-
|
|
1206
|
-
|
|
1205
|
+
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
1206
|
+
*/
|
|
1207
1207
|
RequestId?: string;
|
|
1208
1208
|
}
|
|
1209
1209
|
/**
|
|
@@ -1211,69 +1211,69 @@ export interface CreateSchemeUrlResponse {
|
|
|
1211
1211
|
*/
|
|
1212
1212
|
export interface CreateFlowByFilesRequest {
|
|
1213
1213
|
/**
|
|
1214
|
-
|
|
1215
|
-
|
|
1214
|
+
* 调用方用户信息,userId 必填
|
|
1215
|
+
*/
|
|
1216
1216
|
Operator: UserInfo;
|
|
1217
1217
|
/**
|
|
1218
|
-
|
|
1219
|
-
|
|
1218
|
+
* 签署流程名称,最大长度200个字符
|
|
1219
|
+
*/
|
|
1220
1220
|
FlowName: string;
|
|
1221
1221
|
/**
|
|
1222
|
-
|
|
1223
|
-
|
|
1222
|
+
* 签署参与者信息,最大限制50方
|
|
1223
|
+
*/
|
|
1224
1224
|
Approvers: Array<ApproverInfo>;
|
|
1225
1225
|
/**
|
|
1226
|
-
|
|
1227
|
-
|
|
1226
|
+
* 签署pdf文件的资源编号列表,通过UploadFiles接口获取,暂时仅支持单文件发起
|
|
1227
|
+
*/
|
|
1228
1228
|
FileIds: Array<string>;
|
|
1229
1229
|
/**
|
|
1230
|
-
|
|
1231
|
-
|
|
1230
|
+
* 签署流程的类型(如销售合同/入职合同等),最大长度200个字符
|
|
1231
|
+
*/
|
|
1232
1232
|
FlowType?: string;
|
|
1233
1233
|
/**
|
|
1234
|
-
|
|
1235
|
-
|
|
1234
|
+
* 经办人内容控件配置
|
|
1235
|
+
*/
|
|
1236
1236
|
Components?: Array<Component>;
|
|
1237
1237
|
/**
|
|
1238
|
-
|
|
1239
|
-
注:此功能为白名单功能,若有需要,请联系电子签客服开白使用
|
|
1240
|
-
|
|
1238
|
+
* 被抄送人的信息列表。
|
|
1239
|
+
注:此功能为白名单功能,若有需要,请联系电子签客服开白使用
|
|
1240
|
+
*/
|
|
1241
1241
|
CcInfos?: Array<CcInfo>;
|
|
1242
1242
|
/**
|
|
1243
|
-
|
|
1244
|
-
预览链接有效期300秒;
|
|
1245
|
-
|
|
1243
|
+
* 是否需要预览,true:预览模式,false:非预览(默认);
|
|
1244
|
+
预览链接有效期300秒;
|
|
1245
|
+
*/
|
|
1246
1246
|
NeedPreview?: boolean;
|
|
1247
1247
|
/**
|
|
1248
|
-
|
|
1249
|
-
|
|
1248
|
+
* 签署流程描述,最大长度1000个字符
|
|
1249
|
+
*/
|
|
1250
1250
|
FlowDescription?: string;
|
|
1251
1251
|
/**
|
|
1252
|
-
|
|
1253
|
-
值为unix时间戳,精确到秒,不传默认为当前时间一年后
|
|
1254
|
-
|
|
1252
|
+
* 签署流程的签署截止时间。
|
|
1253
|
+
值为unix时间戳,精确到秒,不传默认为当前时间一年后
|
|
1254
|
+
*/
|
|
1255
1255
|
Deadline?: number;
|
|
1256
1256
|
/**
|
|
1257
|
-
|
|
1258
|
-
true:无序签
|
|
1259
|
-
false:有序签
|
|
1260
|
-
注:默认为false(有序签)
|
|
1261
|
-
|
|
1257
|
+
* 发送类型:
|
|
1258
|
+
true:无序签
|
|
1259
|
+
false:有序签
|
|
1260
|
+
注:默认为false(有序签)
|
|
1261
|
+
*/
|
|
1262
1262
|
Unordered?: boolean;
|
|
1263
1263
|
/**
|
|
1264
|
-
|
|
1265
|
-
|
|
1264
|
+
* 合同显示的页卡模板,说明:只支持{合同名称}, {发起方企业}, {发起方姓名}, {签署方N企业}, {签署方N姓名},且N不能超过签署人的数量,N从1开始
|
|
1265
|
+
*/
|
|
1266
1266
|
CustomShowMap?: string;
|
|
1267
1267
|
/**
|
|
1268
|
-
|
|
1269
|
-
若设置为true,审核结果需通过接口 CreateFlowSignReview 通知电子签,审核通过后,发起方企业签署人方可进行签署操作,否则会阻塞其签署操作。
|
|
1270
|
-
|
|
1271
|
-
注:企业可以通过此功能与企业内部的审批流程进行关联,支持手动、静默签署合同。
|
|
1272
|
-
|
|
1268
|
+
* 发起方企业的签署人进行签署操作是否需要企业内部审批。
|
|
1269
|
+
若设置为true,审核结果需通过接口 CreateFlowSignReview 通知电子签,审核通过后,发起方企业签署人方可进行签署操作,否则会阻塞其签署操作。
|
|
1270
|
+
|
|
1271
|
+
注:企业可以通过此功能与企业内部的审批流程进行关联,支持手动、静默签署合同。
|
|
1272
|
+
*/
|
|
1273
1273
|
NeedSignReview?: boolean;
|
|
1274
1274
|
/**
|
|
1275
|
-
|
|
1276
|
-
|
|
1275
|
+
* 应用号信息
|
|
1276
|
+
*/
|
|
1277
1277
|
Agent?: Agent;
|
|
1278
1278
|
}
|
|
1279
1279
|
/**
|
|
@@ -1281,20 +1281,20 @@ false:有序签
|
|
|
1281
1281
|
*/
|
|
1282
1282
|
export interface ApproverRestriction {
|
|
1283
1283
|
/**
|
|
1284
|
-
|
|
1285
|
-
|
|
1284
|
+
* 指定签署人名字
|
|
1285
|
+
*/
|
|
1286
1286
|
Name?: string;
|
|
1287
1287
|
/**
|
|
1288
|
-
|
|
1289
|
-
|
|
1288
|
+
* 指定签署人手机号
|
|
1289
|
+
*/
|
|
1290
1290
|
Mobile?: string;
|
|
1291
1291
|
/**
|
|
1292
|
-
|
|
1293
|
-
|
|
1292
|
+
* 指定签署人证件类型
|
|
1293
|
+
*/
|
|
1294
1294
|
IdCardType?: string;
|
|
1295
1295
|
/**
|
|
1296
|
-
|
|
1297
|
-
|
|
1296
|
+
* 指定签署人证件号码
|
|
1297
|
+
*/
|
|
1298
1298
|
IdCardNumber?: string;
|
|
1299
1299
|
}
|
|
1300
1300
|
/**
|
|
@@ -1302,8 +1302,8 @@ export interface ApproverRestriction {
|
|
|
1302
1302
|
*/
|
|
1303
1303
|
export interface CancelMultiFlowSignQRCodeResponse {
|
|
1304
1304
|
/**
|
|
1305
|
-
|
|
1306
|
-
|
|
1305
|
+
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
1306
|
+
*/
|
|
1307
1307
|
RequestId?: string;
|
|
1308
1308
|
}
|
|
1309
1309
|
/**
|
|
@@ -1311,12 +1311,12 @@ export interface CancelMultiFlowSignQRCodeResponse {
|
|
|
1311
1311
|
*/
|
|
1312
1312
|
export interface CreateFlowResponse {
|
|
1313
1313
|
/**
|
|
1314
|
-
|
|
1315
|
-
|
|
1314
|
+
* 签署流程编号
|
|
1315
|
+
*/
|
|
1316
1316
|
FlowId: string;
|
|
1317
1317
|
/**
|
|
1318
|
-
|
|
1319
|
-
|
|
1318
|
+
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
1319
|
+
*/
|
|
1320
1320
|
RequestId?: string;
|
|
1321
1321
|
}
|
|
1322
1322
|
/**
|
|
@@ -1328,22 +1328,22 @@ export declare type Agent = null;
|
|
|
1328
1328
|
*/
|
|
1329
1329
|
export interface FormField {
|
|
1330
1330
|
/**
|
|
1331
|
-
|
|
1332
|
-
TEXT - 文本内容
|
|
1333
|
-
MULTI_LINE_TEXT - 文本内容
|
|
1334
|
-
CHECK_BOX - true/false
|
|
1335
|
-
FILL_IMAGE、ATTACHMENT - 附件的FileId,需要通过UploadFiles接口上传获取
|
|
1336
|
-
SELECTOR - 选项值
|
|
1337
|
-
DYNAMIC_TABLE - 传入json格式的表格内容,具体见数据结构FlowInfo:https://cloud.tencent.com/document/api/1420/61525#FlowInfo
|
|
1338
|
-
|
|
1331
|
+
* 控件填充vaule,ComponentType和传入值类型对应关系:
|
|
1332
|
+
TEXT - 文本内容
|
|
1333
|
+
MULTI_LINE_TEXT - 文本内容
|
|
1334
|
+
CHECK_BOX - true/false
|
|
1335
|
+
FILL_IMAGE、ATTACHMENT - 附件的FileId,需要通过UploadFiles接口上传获取
|
|
1336
|
+
SELECTOR - 选项值
|
|
1337
|
+
DYNAMIC_TABLE - 传入json格式的表格内容,具体见数据结构FlowInfo:https://cloud.tencent.com/document/api/1420/61525#FlowInfo
|
|
1338
|
+
*/
|
|
1339
1339
|
ComponentValue: string;
|
|
1340
1340
|
/**
|
|
1341
|
-
|
|
1342
|
-
|
|
1341
|
+
* 控件id,和ComponentName选择一项传入即可
|
|
1342
|
+
*/
|
|
1343
1343
|
ComponentId?: string;
|
|
1344
1344
|
/**
|
|
1345
|
-
|
|
1346
|
-
|
|
1345
|
+
* 控件名字,最大长度不超过30字符,和ComponentId选择一项传入即可
|
|
1346
|
+
*/
|
|
1347
1347
|
ComponentName?: string;
|
|
1348
1348
|
}
|
|
1349
1349
|
/**
|
|
@@ -1351,32 +1351,32 @@ DYNAMIC_TABLE - 传入json格式的表格内容,具体见数据结构FlowInfo
|
|
|
1351
1351
|
*/
|
|
1352
1352
|
export interface DescribeFlowTemplatesRequest {
|
|
1353
1353
|
/**
|
|
1354
|
-
|
|
1355
|
-
|
|
1354
|
+
* 调用方用户信息,userId 必填
|
|
1355
|
+
*/
|
|
1356
1356
|
Operator: UserInfo;
|
|
1357
1357
|
/**
|
|
1358
|
-
|
|
1359
|
-
|
|
1358
|
+
* 搜索条件,具体参考Filter结构体。本接口取值:template-id:按照【 **模板唯一标识** 】进行过滤
|
|
1359
|
+
*/
|
|
1360
1360
|
Filters?: Array<Filter>;
|
|
1361
1361
|
/**
|
|
1362
|
-
|
|
1363
|
-
|
|
1362
|
+
* 查询个数,默认20,最大200
|
|
1363
|
+
*/
|
|
1364
1364
|
Limit?: number;
|
|
1365
1365
|
/**
|
|
1366
|
-
|
|
1367
|
-
|
|
1366
|
+
* 查询偏移位置,默认0
|
|
1367
|
+
*/
|
|
1368
1368
|
Offset?: number;
|
|
1369
1369
|
/**
|
|
1370
|
-
|
|
1371
|
-
|
|
1370
|
+
* 查询内容:0-模板列表及详情(默认),1-仅模板列表
|
|
1371
|
+
*/
|
|
1372
1372
|
ContentType?: number;
|
|
1373
1373
|
/**
|
|
1374
|
-
|
|
1375
|
-
|
|
1374
|
+
* 暂未开放
|
|
1375
|
+
*/
|
|
1376
1376
|
GenerateSource?: number;
|
|
1377
1377
|
/**
|
|
1378
|
-
|
|
1379
|
-
|
|
1378
|
+
* 应用相关信息
|
|
1379
|
+
*/
|
|
1380
1380
|
Agent?: Agent;
|
|
1381
1381
|
}
|
|
1382
1382
|
/**
|
|
@@ -1384,36 +1384,36 @@ export interface DescribeFlowTemplatesRequest {
|
|
|
1384
1384
|
*/
|
|
1385
1385
|
export interface GetTaskResultApiResponse {
|
|
1386
1386
|
/**
|
|
1387
|
-
|
|
1388
|
-
|
|
1387
|
+
* 任务Id
|
|
1388
|
+
*/
|
|
1389
1389
|
TaskId: string;
|
|
1390
1390
|
/**
|
|
1391
|
-
|
|
1392
|
-
0 :NeedTranform - 任务已提交
|
|
1393
|
-
4 :Processing - 文档转换中
|
|
1394
|
-
8 :TaskEnd - 任务处理完成
|
|
1395
|
-
-2 :DownloadFailed - 下载失败
|
|
1396
|
-
-6 :ProcessFailed - 转换失败
|
|
1397
|
-
-13:ProcessTimeout - 转换文件超时
|
|
1398
|
-
|
|
1391
|
+
* 任务状态,需要关注的状态
|
|
1392
|
+
0 :NeedTranform - 任务已提交
|
|
1393
|
+
4 :Processing - 文档转换中
|
|
1394
|
+
8 :TaskEnd - 任务处理完成
|
|
1395
|
+
-2 :DownloadFailed - 下载失败
|
|
1396
|
+
-6 :ProcessFailed - 转换失败
|
|
1397
|
+
-13:ProcessTimeout - 转换文件超时
|
|
1398
|
+
*/
|
|
1399
1399
|
TaskStatus: number;
|
|
1400
1400
|
/**
|
|
1401
|
-
|
|
1402
|
-
NeedTranform - 任务已提交
|
|
1403
|
-
Processing - 文档转换中
|
|
1404
|
-
TaskEnd - 任务处理完成
|
|
1405
|
-
DownloadFailed - 下载失败
|
|
1406
|
-
ProcessFailed - 转换失败
|
|
1407
|
-
ProcessTimeout - 转换文件超时
|
|
1408
|
-
|
|
1401
|
+
* 状态描述,需要关注的状态
|
|
1402
|
+
NeedTranform - 任务已提交
|
|
1403
|
+
Processing - 文档转换中
|
|
1404
|
+
TaskEnd - 任务处理完成
|
|
1405
|
+
DownloadFailed - 下载失败
|
|
1406
|
+
ProcessFailed - 转换失败
|
|
1407
|
+
ProcessTimeout - 转换文件超时
|
|
1408
|
+
*/
|
|
1409
1409
|
TaskMessage: string;
|
|
1410
1410
|
/**
|
|
1411
|
-
|
|
1412
|
-
|
|
1411
|
+
* 资源Id,也是FileId,用于文件发起使用
|
|
1412
|
+
*/
|
|
1413
1413
|
ResourceId: string;
|
|
1414
1414
|
/**
|
|
1415
|
-
|
|
1416
|
-
|
|
1415
|
+
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
1416
|
+
*/
|
|
1417
1417
|
RequestId?: string;
|
|
1418
1418
|
}
|
|
1419
1419
|
/**
|
|
@@ -1421,47 +1421,47 @@ ProcessTimeout - 转换文件超时
|
|
|
1421
1421
|
*/
|
|
1422
1422
|
export interface FlowBrief {
|
|
1423
1423
|
/**
|
|
1424
|
-
|
|
1425
|
-
|
|
1424
|
+
* 流程的编号
|
|
1425
|
+
*/
|
|
1426
1426
|
FlowId: string;
|
|
1427
1427
|
/**
|
|
1428
|
-
|
|
1429
|
-
|
|
1428
|
+
* 流程的名称
|
|
1429
|
+
*/
|
|
1430
1430
|
FlowName: string;
|
|
1431
1431
|
/**
|
|
1432
|
-
|
|
1433
|
-
注意:此字段可能返回 null,表示取不到有效值。
|
|
1434
|
-
|
|
1432
|
+
* 流程的描述
|
|
1433
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
1434
|
+
*/
|
|
1435
1435
|
FlowDescription: string;
|
|
1436
1436
|
/**
|
|
1437
|
-
|
|
1438
|
-
|
|
1437
|
+
* 流程的类型
|
|
1438
|
+
*/
|
|
1439
1439
|
FlowType: string;
|
|
1440
1440
|
/**
|
|
1441
|
-
|
|
1442
|
-
- `0` 还没有发起
|
|
1443
|
-
- `1` 未签署
|
|
1444
|
-
- `2` 部分签署
|
|
1445
|
-
- `3` 已退回
|
|
1446
|
-
- `4` 完成签署
|
|
1447
|
-
- `5` 已过期
|
|
1448
|
-
- `6` 已取消
|
|
1449
|
-
- `7` 还没有预发起
|
|
1450
|
-
- `8` 等待填写
|
|
1451
|
-
- `9` 部分填写
|
|
1452
|
-
- `10` 拒填
|
|
1453
|
-
注意:此字段可能返回 null,表示取不到有效值。
|
|
1454
|
-
|
|
1441
|
+
* 流程状态
|
|
1442
|
+
- `0` 还没有发起
|
|
1443
|
+
- `1` 未签署
|
|
1444
|
+
- `2` 部分签署
|
|
1445
|
+
- `3` 已退回
|
|
1446
|
+
- `4` 完成签署
|
|
1447
|
+
- `5` 已过期
|
|
1448
|
+
- `6` 已取消
|
|
1449
|
+
- `7` 还没有预发起
|
|
1450
|
+
- `8` 等待填写
|
|
1451
|
+
- `9` 部分填写
|
|
1452
|
+
- `10` 拒填
|
|
1453
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
1454
|
+
*/
|
|
1455
1455
|
FlowStatus: number;
|
|
1456
1456
|
/**
|
|
1457
|
-
|
|
1458
|
-
注意:此字段可能返回 null,表示取不到有效值。
|
|
1459
|
-
|
|
1457
|
+
* 流程创建的时间戳
|
|
1458
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
1459
|
+
*/
|
|
1460
1460
|
CreatedOn: number;
|
|
1461
1461
|
/**
|
|
1462
|
-
|
|
1463
|
-
注意:此字段可能返回 null,表示取不到有效值。
|
|
1464
|
-
|
|
1462
|
+
* 拒签或者取消的原因描述
|
|
1463
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
1464
|
+
*/
|
|
1465
1465
|
FlowMessage: string;
|
|
1466
1466
|
}
|
|
1467
1467
|
/**
|
|
@@ -1469,7 +1469,7 @@ export interface FlowBrief {
|
|
|
1469
1469
|
*/
|
|
1470
1470
|
export interface CcInfo {
|
|
1471
1471
|
/**
|
|
1472
|
-
|
|
1473
|
-
|
|
1472
|
+
* 被抄送人手机号
|
|
1473
|
+
*/
|
|
1474
1474
|
Mobile?: string;
|
|
1475
1475
|
}
|