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