tencentcloud-sdk-nodejs-essbasic 4.0.397 → 4.0.431

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.
@@ -19,428 +19,497 @@
19
19
  * 资源链接信息
20
20
  */
21
21
  export interface ResourceUrlInfo {
22
- /**
22
+
23
+ /**
23
24
  * 资源链接地址,过期时间5分钟
24
25
  注意:此字段可能返回 null,表示取不到有效值。
25
26
  */
26
- Url: string
27
-
28
- /**
27
+ Url: string;
28
+
29
+ /**
29
30
  * 资源名称
30
31
  注意:此字段可能返回 null,表示取不到有效值。
31
32
  */
32
- Name: string
33
-
34
- /**
33
+ Name: string;
34
+
35
+ /**
35
36
  * 资源类型
36
37
  注意:此字段可能返回 null,表示取不到有效值。
37
38
  */
38
- Type: string
39
+ Type: string;
39
40
  }
40
41
 
41
42
  /**
42
43
  * SyncProxyOrganization返回参数结构体
43
44
  */
44
45
  export interface SyncProxyOrganizationResponse {
45
- /**
46
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
47
- */
48
- RequestId?: string
46
+
47
+ /**
48
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
49
+ */
50
+ RequestId?: string;
49
51
  }
50
52
 
51
53
  /**
52
54
  * 创建签署流程签署人入参
53
55
  */
54
56
  export interface FlowApproverInfo {
55
- /**
56
- * 签署人姓名,最大长度50个字符
57
- */
58
- Name?: string
59
57
 
60
- /**
58
+ /**
59
+ * 签署人姓名,最大长度50个字符
60
+ */
61
+ Name?: string;
62
+
63
+ /**
61
64
  * 经办人身份证件类型
62
65
  1.ID_CARD 居民身份证
63
66
  2.HONGKONG_MACAO_AND_TAIWAN 港澳台居民居住证
64
67
  3.HONGKONG_AND_MACAO 港澳居民来往内地通行证
65
68
  */
66
- IdCardType?: string
67
-
68
- /**
69
- * 经办人证件号
70
- */
71
- IdCardNumber?: string
72
-
73
- /**
74
- * 签署人手机号,脱敏显示。大陆手机号为11位,暂不支持海外手机号。
75
- */
76
- Mobile?: string
77
-
78
- /**
79
- * 企业签署方工商营业执照上的企业名称,签署方为非发起方企业场景下必传,最大长度64个字符;
80
- */
81
- OrganizationName?: string
82
-
83
- /**
69
+ IdCardType?: string;
70
+
71
+ /**
72
+ * 经办人证件号
73
+ */
74
+ IdCardNumber?: string;
75
+
76
+ /**
77
+ * 签署人手机号,脱敏显示。大陆手机号为11位,暂不支持海外手机号。
78
+ */
79
+ Mobile?: string;
80
+
81
+ /**
82
+ * 企业签署方工商营业执照上的企业名称,签署方为非发起方企业场景下必传,最大长度64个字符;
83
+ */
84
+ OrganizationName?: string;
85
+
86
+ /**
84
87
  * 指定签署人非渠道企业下员工,在ApproverType为ORGANIZATION时指定。
85
88
  默认为false,即签署人位于同一个渠道应用号下;
86
89
  */
87
- NotChannelOrganization?: boolean
88
-
89
- /**
90
- * 用户侧第三方id,最大长度64个字符
91
- */
92
- OpenId?: string
93
-
94
- /**
95
- * 企业签署方在同一渠道下的其他合作企业OpenId,签署方为非发起方企业场景下必传,最大长度64个字符;
96
- */
97
- OrganizationOpenId?: string
98
-
99
- /**
90
+ NotChannelOrganization?: boolean;
91
+
92
+ /**
93
+ * 用户侧第三方id,最大长度64个字符
94
+ */
95
+ OpenId?: string;
96
+
97
+ /**
98
+ * 企业签署方在同一渠道下的其他合作企业OpenId,签署方为非发起方企业场景下必传,最大长度64个字符;
99
+ */
100
+ OrganizationOpenId?: string;
101
+
102
+ /**
100
103
  * 签署人类型,PERSON-个人;
101
104
  PERSON_AUTO_SIGN-个人自动签;
102
105
  ORGANIZATION-企业;
103
106
  ENTERPRISESERVER-企业静默签;
104
107
  注:ENTERPRISESERVER 类型仅用于使用文件创建签署流程(ChannelCreateFlowByFiles)接口;并且仅能指定发起方企业签署方为静默签署;
105
108
  */
106
- ApproverType?: string
107
-
108
- /**
109
- * 签署流程签署人在模板中对应的签署人Id;在非单方签署、以及非B2C签署的场景下必传,用于指定当前签署方在签署流程中的位置;
110
- */
111
- RecipientId?: string
112
-
113
- /**
114
- * 签署截止时间,默认一年
115
- */
116
- Deadline?: number
117
-
118
- /**
119
- * 签署完回调url,最大长度1000个字符
120
- */
121
- CallbackUrl?: string
122
-
123
- /**
124
- * 使用PDF文件直接发起合同时,签署人指定的签署控件
125
- */
126
- SignComponents?: Array<Component>
127
-
128
- /**
129
- * 个人签署方指定签署控件类型,目前仅支持:OCR_ESIGN(AI智慧手写签名)
130
- */
131
- ComponentLimitType?: Array<string>
132
-
133
- /**
134
- * 合同的强制预览时间:3~300s,未指定则按合同页数计算
135
- */
136
- PreReadTime?: number
137
-
138
- /**
139
- * 签署完前端跳转的url,暂未使用
140
- */
141
- JumpUrl?: string
109
+ ApproverType?: string;
110
+
111
+ /**
112
+ * 签署流程签署人在模板中对应的签署人Id;在非单方签署、以及非B2C签署的场景下必传,用于指定当前签署方在签署流程中的位置;
113
+ */
114
+ RecipientId?: string;
115
+
116
+ /**
117
+ * 签署截止时间,默认一年
118
+ */
119
+ Deadline?: number;
120
+
121
+ /**
122
+ * 签署完回调url,最大长度1000个字符
123
+ */
124
+ CallbackUrl?: string;
125
+
126
+ /**
127
+ * 使用PDF文件直接发起合同时,签署人指定的签署控件
128
+ */
129
+ SignComponents?: Array<Component>;
130
+
131
+ /**
132
+ * 个人签署方指定签署控件类型,目前仅支持:OCR_ESIGN(AI智慧手写签名)
133
+ */
134
+ ComponentLimitType?: Array<string>;
135
+
136
+ /**
137
+ * 合同的强制预览时间:3~300s,未指定则按合同页数计算
138
+ */
139
+ PreReadTime?: number;
140
+
141
+ /**
142
+ * 签署完前端跳转的url,暂未使用
143
+ */
144
+ JumpUrl?: string;
142
145
  }
143
146
 
144
147
  /**
145
- * PrepareFlows返回参数结构体
148
+ * ChannelCreateConvertTaskApi返回参数结构体
146
149
  */
147
- export interface PrepareFlowsResponse {
148
- /**
149
- * 待发起文件确认页
150
- */
151
- ConfirmUrl: string
150
+ export interface ChannelCreateConvertTaskApiResponse {
152
151
 
153
- /**
154
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
155
- */
156
- RequestId?: string
152
+ /**
153
+ * 任务id
154
+ */
155
+ TaskId: string;
156
+
157
+ /**
158
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
159
+ */
160
+ RequestId?: string;
157
161
  }
158
162
 
159
163
  /**
160
- * 合作企业经办人列表信息
164
+ * OperateChannelTemplate请求参数结构体
161
165
  */
162
- export interface ProxyOrganizationOperator {
163
- /**
164
- * 经办人ID(渠道颁发),最大长度64个字符
165
- */
166
- Id: string
167
-
168
- /**
169
- * 经办人姓名,最大长度50个字符
170
- */
171
- Name?: string
166
+ export interface OperateChannelTemplateRequest {
172
167
 
173
- /**
174
- * 经办人身份证件类型
175
- 1.ID_CARD 居民身份证
176
- 2.HONGKONG_MACAO_AND_TAIWAN 港澳台居民居住证
177
- 3.HONGKONG_AND_MACAO 港澳居民来往内地通行证
168
+ /**
169
+ * 渠道应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 均必填。
178
170
  */
179
- IdCardType?: string
180
-
181
- /**
182
- * 经办人证件号
183
- */
184
- IdCardNumber?: string
185
-
186
- /**
187
- * 经办人手机号,大陆手机号输入11位,暂不支持海外手机号。
188
- */
189
- Mobile?: string
171
+ Agent: Agent;
172
+
173
+ /**
174
+ * 操作类型,查询:"SELECT",删除:"DELETE",更新:"UPDATE"
175
+ */
176
+ OperateType: string;
177
+
178
+ /**
179
+ * 渠道方模板库模板唯一标识
180
+ */
181
+ TemplateId: string;
182
+
183
+ /**
184
+ * 合作企业方第三方机构唯一标识数据,支持多个, 用","进行分隔
185
+ */
186
+ ProxyOrganizationOpenIds?: string;
187
+
188
+ /**
189
+ * 模板可见性, 全部可见-"all", 部分可见-"part"
190
+ */
191
+ AuthTag?: string;
192
+
193
+ /**
194
+ * 操作者的信息
195
+ */
196
+ Operator?: UserInfo;
190
197
  }
191
198
 
192
199
  /**
193
200
  * 此结构体 (TemplateInfo) 用于描述模板的信息。
194
201
  */
195
202
  export interface TemplateInfo {
196
- /**
197
- * 模板ID
198
- */
199
- TemplateId: string
200
-
201
- /**
202
- * 模板名字
203
- */
204
- TemplateName: string
205
-
206
- /**
207
- * 模板描述信息
208
- */
209
- Description: string
210
-
211
- /**
212
- * 模板控件信息结构
213
- */
214
- Components: Array<Component>
215
-
216
- /**
217
- * 签署区模板信息结构
218
- */
219
- SignComponents: Array<Component>
220
-
221
- /**
222
- * 模板中的流程参与人信息
223
- */
224
- Recipients: Array<Recipient>
225
-
226
- /**
227
- * 模板类型:1-静默签;3-普通模板
228
- */
229
- TemplateType: number
230
-
231
- /**
232
- * 是否是发起人
233
- */
234
- IsPromoter: boolean
235
-
236
- /**
237
- * 模板的创建者信息
238
- */
239
- Creator: string
240
-
241
- /**
242
- * 模板创建的时间戳(精确到秒)
243
- */
244
- CreatedOn: number
203
+
204
+ /**
205
+ * 模板ID
206
+ */
207
+ TemplateId: string;
208
+
209
+ /**
210
+ * 模板名字
211
+ */
212
+ TemplateName: string;
213
+
214
+ /**
215
+ * 模板描述信息
216
+ */
217
+ Description: string;
218
+
219
+ /**
220
+ * 模板控件信息结构
221
+ */
222
+ Components: Array<Component>;
223
+
224
+ /**
225
+ * 签署区模板信息结构
226
+ */
227
+ SignComponents: Array<Component>;
228
+
229
+ /**
230
+ * 模板中的流程参与人信息
231
+ */
232
+ Recipients: Array<Recipient>;
233
+
234
+ /**
235
+ * 模板类型:1-静默签;3-普通模板
236
+ */
237
+ TemplateType: number;
238
+
239
+ /**
240
+ * 是否是发起人
241
+ */
242
+ IsPromoter: boolean;
243
+
244
+ /**
245
+ * 模板的创建者信息
246
+ */
247
+ Creator: string;
248
+
249
+ /**
250
+ * 模板创建的时间戳(精确到秒)
251
+ */
252
+ CreatedOn: number;
253
+ }
254
+
255
+ /**
256
+ * UploadFiles请求参数结构体
257
+ */
258
+ export interface UploadFilesRequest {
259
+
260
+ /**
261
+ * 应用相关信息,若是渠道版调用 appid 和proxyappid 必填
262
+ */
263
+ Agent: Agent;
264
+
265
+ /**
266
+ * 文件对应业务类型,用于区分文件存储路径:
267
+ 1. TEMPLATE - 模板; 文件类型:.pdf .doc .docx .html
268
+ 2. DOCUMENT - 签署过程及签署后的合同文档/图片控件 文件类型:.pdf/.jpg/.png
269
+ */
270
+ BusinessType: string;
271
+
272
+ /**
273
+ * 上传文件内容数组,最多支持20个文件
274
+ */
275
+ FileInfos?: Array<UploadFile>;
276
+
277
+ /**
278
+ * 操作者的信息
279
+ */
280
+ Operator?: UserInfo;
245
281
  }
246
282
 
247
283
  /**
248
284
  * GetDownloadFlowUrl返回参数结构体
249
285
  */
250
286
  export interface GetDownloadFlowUrlResponse {
251
- /**
252
- * 合同(流程)下载地址
253
- */
254
- DownLoadUrl: string
255
287
 
256
- /**
257
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
258
- */
259
- RequestId?: string
288
+ /**
289
+ * 合同(流程)下载地址
290
+ */
291
+ DownLoadUrl: string;
292
+
293
+ /**
294
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
295
+ */
296
+ RequestId?: string;
260
297
  }
261
298
 
262
299
  /**
263
300
  * DescribeResourceUrlsByFlows返回参数结构体
264
301
  */
265
302
  export interface DescribeResourceUrlsByFlowsResponse {
266
- /**
267
- * 签署流程资源对应链接信息
268
- */
269
- FlowResourceUrlInfos: Array<FlowResourceUrlInfo>
270
303
 
271
- /**
304
+ /**
305
+ * 签署流程资源对应链接信息
306
+ */
307
+ FlowResourceUrlInfos: Array<FlowResourceUrlInfo>;
308
+
309
+ /**
272
310
  * 创建消息,对应多个合同ID,
273
311
  成功为“”,创建失败则对应失败消息
274
312
  */
275
- ErrorMessages: Array<string>
276
-
277
- /**
278
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
279
- */
280
- RequestId?: string
313
+ ErrorMessages: Array<string>;
314
+
315
+ /**
316
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
317
+ */
318
+ RequestId?: string;
281
319
  }
282
320
 
283
321
  /**
284
322
  * ChannelCreateMultiFlowSignQRCode返回参数结构体
285
323
  */
286
324
  export interface ChannelCreateMultiFlowSignQRCodeResponse {
287
- /**
288
- * 签署二维码对象
289
- */
290
- QrCode: SignQrCode
291
325
 
292
- /**
293
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
294
- */
295
- RequestId?: string
326
+ /**
327
+ * 签署二维码对象
328
+ */
329
+ QrCode: SignQrCode;
330
+
331
+ /**
332
+ * 签署链接对象
333
+ */
334
+ SignUrls: SignUrl;
335
+
336
+ /**
337
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
338
+ */
339
+ RequestId?: string;
296
340
  }
297
341
 
298
342
  /**
299
343
  * 签署参与者信息
300
344
  */
301
345
  export interface Recipient {
302
- /**
303
- * 签署人唯一标识
304
- */
305
- RecipientId?: string
306
-
307
- /**
308
- * 签署方类型:ENTERPRISE-企业INDIVIDUAL-自然人
309
- */
310
- RecipientType?: string
311
346
 
312
- /**
313
- * 描述
314
- */
315
- Description?: string
316
-
317
- /**
318
- * 签署方备注信息
319
- */
320
- RoleName?: string
321
-
322
- /**
323
- * 是否需要校验
324
- */
325
- RequireValidation?: boolean
326
-
327
- /**
328
- * 是否必须填写
329
- */
330
- RequireSign?: boolean
331
-
332
- /**
333
- * 签署类型
334
- */
335
- SignType?: number
336
-
337
- /**
338
- * 签署顺序:数字越小优先级越高
339
- */
340
- RoutingOrder?: number
341
-
342
- /**
343
- * 是否是发起方
344
- */
345
- IsPromoter?: boolean
347
+ /**
348
+ * 签署人唯一标识
349
+ */
350
+ RecipientId?: string;
351
+
352
+ /**
353
+ * 签署方类型:ENTERPRISE-企业INDIVIDUAL-自然人
354
+ */
355
+ RecipientType?: string;
356
+
357
+ /**
358
+ * 描述
359
+ */
360
+ Description?: string;
361
+
362
+ /**
363
+ * 签署方备注信息
364
+ */
365
+ RoleName?: string;
366
+
367
+ /**
368
+ * 是否需要校验
369
+ */
370
+ RequireValidation?: boolean;
371
+
372
+ /**
373
+ * 是否必须填写
374
+ */
375
+ RequireSign?: boolean;
376
+
377
+ /**
378
+ * 签署类型
379
+ */
380
+ SignType?: number;
381
+
382
+ /**
383
+ * 签署顺序:数字越小优先级越高
384
+ */
385
+ RoutingOrder?: number;
386
+
387
+ /**
388
+ * 是否是发起方
389
+ */
390
+ IsPromoter?: boolean;
346
391
  }
347
392
 
348
393
  /**
349
394
  * DescribeTemplates返回参数结构体
350
395
  */
351
396
  export interface DescribeTemplatesResponse {
352
- /**
353
- * 模板详情
354
- */
355
- Templates: Array<TemplateInfo>
356
-
357
- /**
358
- * 查询总数
359
- */
360
- TotalCount: number
361
-
362
- /**
363
- * 查询数量
364
- */
365
- Limit: number
366
397
 
367
- /**
368
- * 查询起始偏移
369
- */
370
- Offset: number
371
-
372
- /**
373
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
374
- */
375
- RequestId?: string
398
+ /**
399
+ * 模板详情
400
+ */
401
+ Templates: Array<TemplateInfo>;
402
+
403
+ /**
404
+ * 查询总数
405
+ */
406
+ TotalCount: number;
407
+
408
+ /**
409
+ * 查询数量
410
+ */
411
+ Limit: number;
412
+
413
+ /**
414
+ * 查询起始偏移
415
+ */
416
+ Offset: number;
417
+
418
+ /**
419
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
420
+ */
421
+ RequestId?: string;
376
422
  }
377
423
 
378
424
  /**
379
425
  * OperateChannelTemplate返回参数结构体
380
426
  */
381
427
  export interface OperateChannelTemplateResponse {
382
- /**
428
+
429
+ /**
383
430
  * 腾讯电子签颁发给渠道的应用ID
384
431
  注意:此字段可能返回 null,表示取不到有效值。
385
432
  */
386
- AppId: string
387
-
388
- /**
433
+ AppId: string;
434
+
435
+ /**
389
436
  * 渠道方模板库模板唯一标识
390
437
  注意:此字段可能返回 null,表示取不到有效值。
391
438
  */
392
- TemplateId: string
393
-
394
- /**
439
+ TemplateId: string;
440
+
441
+ /**
395
442
  * 全部成功-"all-success",部分成功-"part-success", 全部失败-"fail"失败的会在FailMessageList中展示
396
443
  注意:此字段可能返回 null,表示取不到有效值。
397
444
  */
398
- OperateResult: string
399
-
400
- /**
445
+ OperateResult: string;
446
+
447
+ /**
401
448
  * 模板可见性, 全部可见-"all", 部分可见-"part"
402
449
  注意:此字段可能返回 null,表示取不到有效值。
403
450
  */
404
- AuthTag: string
405
-
406
- /**
451
+ AuthTag: string;
452
+
453
+ /**
407
454
  * 合作企业方第三方机构唯一标识数据
408
455
  注意:此字段可能返回 null,表示取不到有效值。
409
456
  */
410
- ProxyOrganizationOpenIds: Array<string>
411
-
412
- /**
457
+ ProxyOrganizationOpenIds: Array<string>;
458
+
459
+ /**
413
460
  * 操作失败信息数组
414
461
  注意:此字段可能返回 null,表示取不到有效值。
415
462
  */
416
- FailMessageList: Array<AuthFailMessage>
463
+ FailMessageList: Array<AuthFailMessage>;
464
+
465
+ /**
466
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
467
+ */
468
+ RequestId?: string;
469
+ }
470
+
471
+ /**
472
+ * CreateSignUrls返回参数结构体
473
+ */
474
+ export interface CreateSignUrlsResponse {
417
475
 
418
- /**
419
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
420
- */
421
- RequestId?: string
476
+ /**
477
+ * 签署参与者签署H5链接信息数组
478
+ */
479
+ SignUrlInfos: Array<SignUrlInfo>;
480
+
481
+ /**
482
+ * 生成失败时的错误信息,成功返回”“,顺序和出参SignUrlInfos保持一致
483
+ */
484
+ ErrorMessages: Array<string>;
485
+
486
+ /**
487
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
488
+ */
489
+ RequestId?: string;
422
490
  }
423
491
 
424
492
  /**
425
493
  * CreateSignUrls请求参数结构体
426
494
  */
427
495
  export interface CreateSignUrlsRequest {
428
- /**
429
- * 渠道应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 均必填。
430
- */
431
- Agent: Agent
432
-
433
- /**
434
- * 签署流程编号数组,最多支持100个。
435
- */
436
- FlowIds: Array<string>
437
-
438
- /**
439
- * 签署链接类型:“WEIXINAPP”-直接跳小程序;“CHANNEL”-跳转H5页面;“APP”-第三方APP或小程序跳转电子签小程序;默认“WEIXINAPP”类型,即跳转至小程序;
440
- */
441
- Endpoint?: string
442
-
443
- /**
496
+
497
+ /**
498
+ * 渠道应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 均必填。
499
+ */
500
+ Agent: Agent;
501
+
502
+ /**
503
+ * 签署流程编号数组,最多支持100个。
504
+ */
505
+ FlowIds: Array<string>;
506
+
507
+ /**
508
+ * 签署链接类型:“WEIXINAPP”-直接跳小程序;“CHANNEL”-跳转H5页面;“APP”-第三方APP或小程序跳转电子签小程序;默认“WEIXINAPP”类型,即跳转至小程序;
509
+ */
510
+ Endpoint?: string;
511
+
512
+ /**
444
513
  * 签署链接生成类型,默认是 "ALL";
445
514
  "ALL":全部签署方签署链接;
446
515
  "CHANNEL":渠道合作企业;
@@ -448,221 +517,294 @@ export interface CreateSignUrlsRequest {
448
517
  "PERSON":个人;
449
518
  "FOLLOWER":关注方,目前是合同抄送方;
450
519
  */
451
- GenerateType?: string
452
-
453
- /**
454
- * 非渠道合作企业参与方的企业名称,GenerateType为"NOT_CHANNEL"时必填
455
- */
456
- OrganizationName?: string
457
-
458
- /**
459
- * 参与人姓名,GenerateType为"PERSON"时必填
460
- */
461
- Name?: string
462
-
463
- /**
520
+ GenerateType?: string;
521
+
522
+ /**
523
+ * 非渠道合作企业参与方的企业名称,GenerateType为"NOT_CHANNEL"时必填
524
+ */
525
+ OrganizationName?: string;
526
+
527
+ /**
528
+ * 参与人姓名,GenerateType为"PERSON"时必填
529
+ */
530
+ Name?: string;
531
+
532
+ /**
464
533
  * 参与人手机号;
465
534
  GenerateType为"PERSON"或"FOLLOWER"时必填
466
535
  */
467
- Mobile?: string
468
-
469
- /**
470
- * 渠道合作企业的企业Id,GenerateType为"CHANNEL"时必填
471
- */
472
- OrganizationOpenId?: string
473
-
474
- /**
475
- * 渠道合作企业参与人OpenId,GenerateType为"CHANNEL"时可用,指定到具体参与人
476
- */
477
- OpenId?: string
478
-
479
- /**
480
- * Endpoint为"APP" 类型的签署链接,可以设置此值;支持调用方小程序打开签署链接,在电子签小程序完成签署后自动回跳至调用方小程序
481
- */
482
- AutoJumpBack?: boolean
483
-
484
- /**
485
- * 签署完之后的H5页面的跳转链接,针对Endpoint为CHANNEL时有效,最大长度1000个字符。
486
- */
487
- JumpUrl?: string
488
-
489
- /**
490
- * 操作者的信息
491
- */
492
- Operator?: UserInfo
536
+ Mobile?: string;
537
+
538
+ /**
539
+ * 渠道合作企业的企业Id,GenerateType为"CHANNEL"时必填
540
+ */
541
+ OrganizationOpenId?: string;
542
+
543
+ /**
544
+ * 渠道合作企业参与人OpenId,GenerateType为"CHANNEL"时可用,指定到具体参与人
545
+ */
546
+ OpenId?: string;
547
+
548
+ /**
549
+ * Endpoint为"APP" 类型的签署链接,可以设置此值;支持调用方小程序打开签署链接,在电子签小程序完成签署后自动回跳至调用方小程序
550
+ */
551
+ AutoJumpBack?: boolean;
552
+
553
+ /**
554
+ * 签署完之后的H5页面的跳转链接,针对Endpoint为CHANNEL时有效,最大长度1000个字符。
555
+ */
556
+ JumpUrl?: string;
557
+
558
+ /**
559
+ * 操作者的信息
560
+ */
561
+ Operator?: UserInfo;
493
562
  }
494
563
 
495
564
  /**
496
565
  * ChannelCreateMultiFlowSignQRCode请求参数结构体
497
566
  */
498
567
  export interface ChannelCreateMultiFlowSignQRCodeRequest {
499
- /**
568
+
569
+ /**
500
570
  * 渠道应用相关信息。
501
571
  此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 必填。
502
572
  */
503
- Agent: Agent
504
-
505
- /**
506
- * 模版ID
507
- */
508
- TemplateId: string
509
-
510
- /**
511
- * 签署流程名称,最大长度200个字符。
512
- */
513
- FlowName: string
514
-
515
- /**
516
- * 最大可发起签署流程份数,默认5份;发起签署流程数量超过此上限后,二维码自动失效。
517
- */
518
- MaxFlowNum?: number
519
-
520
- /**
521
- * 签署流程有效天数 默认7天 最高设置不超过30天
522
- */
523
- FlowEffectiveDay?: number
524
-
525
- /**
526
- * 二维码有效天数 默认7天 最高设置不超过90天
527
- */
528
- QrEffectiveDay?: number
529
-
530
- /**
573
+ Agent: Agent;
574
+
575
+ /**
576
+ * 模版ID
577
+ */
578
+ TemplateId: string;
579
+
580
+ /**
581
+ * 签署流程名称,最大长度200个字符。
582
+ */
583
+ FlowName: string;
584
+
585
+ /**
586
+ * 最大可发起签署流程份数,默认5份;发起签署流程数量超过此上限后,二维码自动失效。
587
+ */
588
+ MaxFlowNum?: number;
589
+
590
+ /**
591
+ * 签署流程有效天数 默认7天 最高设置不超过30天
592
+ */
593
+ FlowEffectiveDay?: number;
594
+
595
+ /**
596
+ * 二维码有效天数 默认7天 最高设置不超过90天
597
+ */
598
+ QrEffectiveDay?: number;
599
+
600
+ /**
531
601
  * 回调地址,最大长度1000个字符
532
602
  不传默认使用渠道应用号配置的回调地址
533
603
  回调时机:用户通过签署二维码发起合同时,企业额度不足导致失败
534
604
  */
535
- CallbackUrl?: string
536
-
537
- /**
538
- * 用户信息
539
- */
540
- Operator?: UserInfo
605
+ CallbackUrl?: string;
606
+
607
+ /**
608
+ * 限制二维码用户条件
609
+ */
610
+ ApproverRestrictions?: ApproverRestriction;
611
+
612
+ /**
613
+ * 用户信息
614
+ */
615
+ Operator?: UserInfo;
541
616
  }
542
617
 
543
618
  /**
544
619
  * 授权出错信息
545
620
  */
546
621
  export interface AuthFailMessage {
547
- /**
548
- * 合作企业Id
549
- */
550
- ProxyOrganizationOpenId: string
551
622
 
552
- /**
553
- * 出错信息
554
- */
555
- Message: string
623
+ /**
624
+ * 合作企业Id
625
+ */
626
+ ProxyOrganizationOpenId: string;
627
+
628
+ /**
629
+ * 出错信息
630
+ */
631
+ Message: string;
556
632
  }
557
633
 
558
634
  /**
559
- * DescribeFlowDetailInfo请求参数结构体
635
+ * CreateChannelFlowEvidenceReport请求参数结构体
560
636
  */
561
- export interface DescribeFlowDetailInfoRequest {
562
- /**
563
- * 渠道应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 均必填。
564
- */
565
- Agent: Agent
566
-
567
- /**
568
- * 合同(流程)编号数组,最多支持100个。
569
- */
570
- FlowIds: Array<string>
637
+ export interface CreateChannelFlowEvidenceReportRequest {
571
638
 
572
- /**
573
- * 操作者的信息
574
- */
575
- Operator?: UserInfo
639
+ /**
640
+ * 签署流程编号
641
+ */
642
+ FlowId: string;
643
+
644
+ /**
645
+ * 渠道应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 均必填
646
+ */
647
+ Agent: Agent;
648
+
649
+ /**
650
+ * 操作者的信息
651
+ */
652
+ Operator?: UserInfo;
576
653
  }
577
654
 
578
655
  /**
579
- * 一码多扫签署二维码对象
656
+ * DescribeFlowDetailInfo请求参数结构体
580
657
  */
581
- export interface SignQrCode {
582
- /**
583
- * 二维码id
584
- */
585
- QrCodeId: string
586
-
587
- /**
588
- * 二维码url
589
- */
590
- QrCodeUrl: string
658
+ export interface DescribeFlowDetailInfoRequest {
591
659
 
592
- /**
593
- * 二维码过期时间
594
- */
595
- ExpiredTime: number
660
+ /**
661
+ * 渠道应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 均必填。
662
+ */
663
+ Agent: Agent;
664
+
665
+ /**
666
+ * 合同(流程)编号数组,最多支持100个。
667
+ */
668
+ FlowIds: Array<string>;
669
+
670
+ /**
671
+ * 操作者的信息
672
+ */
673
+ Operator?: UserInfo;
596
674
  }
597
675
 
598
676
  /**
599
- * UploadFiles请求参数结构体
677
+ * ChannelGetTaskResultApi返回参数结构体
600
678
  */
601
- export interface UploadFilesRequest {
602
- /**
603
- * 应用相关信息,若是渠道版调用 appid 和proxyappid 必填
604
- */
605
- Agent: Agent
606
-
607
- /**
608
- * 文件对应业务类型,用于区分文件存储路径:
609
- 1. TEMPLATE - 模板; 文件类型:.pdf
610
- 2. DOCUMENT - 签署过程及签署后的合同文档/图片控件 文件类型:.pdf/.jpg/.png
679
+ export interface ChannelGetTaskResultApiResponse {
680
+
681
+ /**
682
+ * 任务Id
683
+ */
684
+ TaskId: string;
685
+
686
+ /**
687
+ * 任务状态,需要关注的状态
688
+ 0 :NeedTranform - 任务已提交
689
+ 4 :Processing - 文档转换中
690
+ 8 :TaskEnd - 任务处理完成
691
+ -2 :DownloadFailed - 下载失败
692
+ -6 :ProcessFailed - 转换失败
693
+ -13:ProcessTimeout - 转换文件超时
694
+ */
695
+ TaskStatus: number;
696
+
697
+ /**
698
+ * 状态描述,需要关注的状态
699
+ NeedTranform - 任务已提交
700
+ Processing - 文档转换中
701
+ TaskEnd - 任务处理完成
702
+ DownloadFailed - 下载失败
703
+ ProcessFailed - 转换失败
704
+ ProcessTimeout - 转换文件超时
705
+ */
706
+ TaskMessage: string;
707
+
708
+ /**
709
+ * 资源Id,也是FileId,用于文件发起使用
710
+ */
711
+ ResourceId: string;
712
+
713
+ /**
714
+ * 预览文件Url,有效期30分钟
715
+ 注意:此字段可能返回 null,表示取不到有效值。
611
716
  */
612
- BusinessType: string
613
-
614
- /**
615
- * 上传文件内容数组,最多支持20个文件
616
- */
617
- FileInfos?: Array<UploadFile>
618
-
619
- /**
620
- * 操作者的信息
621
- */
622
- Operator?: UserInfo
717
+ PreviewUrl: string;
718
+
719
+ /**
720
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
721
+ */
722
+ RequestId?: string;
623
723
  }
624
724
 
625
725
  /**
626
- * DescribeResourceUrlsByFlows请求参数结构体
726
+ * 合作企业经办人列表信息
627
727
  */
628
- export interface DescribeResourceUrlsByFlowsRequest {
629
- /**
630
- * 渠道应用相关信息。
631
- 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 均必填。
728
+ export interface ProxyOrganizationOperator {
729
+
730
+ /**
731
+ * 经办人ID(渠道颁发),最大长度64个字符
732
+ */
733
+ Id: string;
734
+
735
+ /**
736
+ * 经办人姓名,最大长度50个字符
737
+ */
738
+ Name?: string;
739
+
740
+ /**
741
+ * 经办人身份证件类型
742
+ 1.ID_CARD 居民身份证
743
+ 2.HONGKONG_MACAO_AND_TAIWAN 港澳台居民居住证
744
+ 3.HONGKONG_AND_MACAO 港澳居民来往内地通行证
632
745
  */
633
- Agent: Agent
746
+ IdCardType?: string;
747
+
748
+ /**
749
+ * 经办人证件号
750
+ */
751
+ IdCardNumber?: string;
752
+
753
+ /**
754
+ * 经办人手机号,大陆手机号输入11位,暂不支持海外手机号。
755
+ */
756
+ Mobile?: string;
757
+ }
634
758
 
635
- /**
636
- * 查询资源所对应的签署流程Id,最多支持50个。
637
- */
638
- FlowIds?: Array<string>
759
+ /**
760
+ * ChannelGetTaskResultApi请求参数结构体
761
+ */
762
+ export interface ChannelGetTaskResultApiRequest {
639
763
 
640
- /**
641
- * 操作者的信息
642
- */
643
- Operator?: UserInfo
764
+ /**
765
+ * 渠道应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 均必填。
766
+ */
767
+ Agent: Agent;
768
+
769
+ /**
770
+ * 任务Id,通过ChannelCreateConvertTaskApi接口获得
771
+ */
772
+ TaskId: string;
773
+
774
+ /**
775
+ * 操作者的信息
776
+ */
777
+ Operator?: UserInfo;
778
+
779
+ /**
780
+ * 暂未开放
781
+ */
782
+ Organization?: OrganizationInfo;
644
783
  }
645
784
 
646
785
  /**
647
786
  * 此结构体 (UploadFile) 用于描述多文件上传的文件信息。
648
787
  */
649
788
  export interface UploadFile {
650
- /**
651
- * Base64编码后的文件内容
652
- */
653
- FileBody: string
654
789
 
655
- /**
656
- * 文件名
657
- */
658
- FileName?: string
790
+ /**
791
+ * Base64编码后的文件内容
792
+ */
793
+ FileBody: string;
794
+
795
+ /**
796
+ * 文件名
797
+ */
798
+ FileName?: string;
659
799
  }
660
800
 
661
801
  /**
662
802
  * 此结构体 (Component) 用于描述控件属性。
803
+
663
804
  */
664
805
  export interface Component {
665
- /**
806
+
807
+ /**
666
808
  * 控件编号
667
809
 
668
810
  注:
@@ -674,1148 +816,1517 @@ export interface Component {
674
816
  创建控件时,此值为空
675
817
  查询时返回完整结构
676
818
  */
677
- ComponentId?: string
678
-
679
- /**
819
+ ComponentId?: string;
820
+
821
+ /**
680
822
  * 如果是Component控件类型,则可选的字段为:
681
823
  TEXT - 普通文本控件;
682
- DATE - 普通日期控件;跟TEXT相比会有校验逻辑
824
+ MULTI_LINE_TEXT - 多行文本控件;
825
+ CHECK_BOX - 勾选框控件;
826
+ FILL_IMAGE - 图片控件;
827
+ DYNAMIC_TABLE - 动态表格控件;
828
+ ATTACHMENT - 附件控件;
829
+ SELECTOR - 选择器控件;
830
+
683
831
  如果是SignComponent控件类型,则可选的字段为
684
832
  SIGN_SEAL - 签署印章控件;
685
833
  SIGN_DATE - 签署日期控件;
686
834
  SIGN_SIGNATURE - 用户签名控件;
687
- SIGN_PERSONAL_SEAL - 个人签署印章控件;
835
+ SIGN_PERSONAL_SEAL - 个人签署印章控件(使用文件发起暂不支持此类型);
688
836
 
689
837
  表单域的控件不能作为印章和签名控件
690
838
  */
691
- ComponentType?: string
692
-
693
- /**
694
- * 控件简称,不能超过30个字符
695
- */
696
- ComponentName?: string
697
-
698
- /**
699
- * 定义控件是否为必填项,默认为false
700
- */
701
- ComponentRequired?: boolean
702
-
703
- /**
704
- * 控件所属文件的序号 (文档中文件的排列序号,从0开始)
705
- */
706
- FileIndex?: number
707
-
708
- /**
839
+ ComponentType?: string;
840
+
841
+ /**
842
+ * 控件简称,不能超过30个字符
843
+ */
844
+ ComponentName?: string;
845
+
846
+ /**
847
+ * 定义控件是否为必填项,默认为false
848
+ */
849
+ ComponentRequired?: boolean;
850
+
851
+ /**
852
+ * 控件所属文件的序号 (文档中文件的排列序号,从0开始)
853
+ */
854
+ FileIndex?: number;
855
+
856
+ /**
709
857
  * 控件生成的方式:
710
858
  NORMAL - 普通控件
711
859
  FIELD - 表单域
712
860
  KEYWORD - 关键字
713
861
  */
714
- GenerateMode?: string
715
-
716
- /**
862
+ GenerateMode?: string;
863
+
864
+ /**
717
865
  * 参数控件宽度,默认100,单位px
718
866
  表单域和关键字转换控件不用填
719
867
  */
720
- ComponentWidth?: number
721
-
722
- /**
868
+ ComponentWidth?: number;
869
+
870
+ /**
723
871
  * 参数控件高度,默认100,单位px
724
872
  表单域和关键字转换控件不用填
725
873
  */
726
- ComponentHeight?: number
727
-
728
- /**
729
- * 参数控件所在页码,从1开始
730
- */
731
- ComponentPage?: number
732
-
733
- /**
734
- * 参数控件X位置,单位px
735
- */
736
- ComponentPosX?: number
737
-
738
- /**
739
- * 参数控件Y位置,单位px
740
- */
741
- ComponentPosY?: number
742
-
743
- /**
874
+ ComponentHeight?: number;
875
+
876
+ /**
877
+ * 参数控件所在页码,从1开始
878
+ */
879
+ ComponentPage?: number;
880
+
881
+ /**
882
+ * 参数控件X位置,单位px
883
+ */
884
+ ComponentPosX?: number;
885
+
886
+ /**
887
+ * 参数控件Y位置,单位px
888
+ */
889
+ ComponentPosY?: number;
890
+
891
+ /**
744
892
  * 参数控件样式,json格式表述
745
893
  不同类型的控件会有部分非通用参数
746
894
  TEXT控件可以指定字体
747
895
  例如:{"FontSize":12}
748
896
  */
749
- ComponentExtra?: string
750
-
751
- /**
752
- * 印章 ID,传参 DEFAULT_COMPANY_SEAL 表示使用默认印章。
753
- 控件填入内容,印章控件里面,如果是手写签名内容为PNG图片格式的base64编码
754
- */
755
- ComponentValue?: string
756
-
757
- /**
897
+ ComponentExtra?: string;
898
+
899
+ /**
900
+ * 控件填充vaule,ComponentType和传入值类型对应关系:
901
+ TEXT - 文本内容
902
+ MULTI_LINE_TEXT - 文本内容
903
+ CHECK_BOX - true/false
904
+ FILL_IMAGE、ATTACHMENT - 附件的FileId,需要通过UploadFiles接口上传获取
905
+ SELECTOR - 选项值
906
+ DYNAMIC_TABLE - 传入json格式的表格内容,具体见数据结构FlowInfo:https://cloud.tencent.com/document/api/1420/61525#FlowInfo
907
+ */
908
+ ComponentValue?: string;
909
+
910
+ /**
758
911
  * 日期签署控件的字号,默认为 12
759
912
 
760
913
  签署区日期控件会转换成图片格式并带存证,需要通过字体决定图片大小
761
914
  */
762
- ComponentDateFontSize?: number
763
-
764
- /**
765
- * 控件所属文档的Id, 模块相关接口为空值
766
- */
767
- DocumentId?: string
768
-
769
- /**
770
- * 控件描述,不能超过30个字符
771
- */
772
- ComponentDescription?: string
773
-
774
- /**
775
- * 指定关键字时横坐标偏移量,单位pt
776
- */
777
- OffsetX?: number
778
-
779
- /**
780
- * 指定关键字时纵坐标偏移量,单位pt
781
- */
782
- OffsetY?: number
915
+ ComponentDateFontSize?: number;
916
+
917
+ /**
918
+ * 控件所属文档的Id, 模块相关接口为空值
919
+ */
920
+ DocumentId?: string;
921
+
922
+ /**
923
+ * 控件描述,不能超过30个字符
924
+ */
925
+ ComponentDescription?: string;
926
+
927
+ /**
928
+ * 指定关键字时横坐标偏移量,单位pt
929
+ */
930
+ OffsetX?: number;
931
+
932
+ /**
933
+ * 指定关键字时纵坐标偏移量,单位pt
934
+ */
935
+ OffsetY?: number;
783
936
  }
784
937
 
785
938
  /**
786
939
  * GetDownloadFlowUrl请求参数结构体
787
940
  */
788
941
  export interface GetDownloadFlowUrlRequest {
789
- /**
790
- * 渠道应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 均必填。
791
- */
792
- Agent: Agent
793
-
794
- /**
795
- * 文件夹数组,签署流程总数不能超过50个,一个文件夹下,不能超过20个签署流程
796
- */
797
- DownLoadFlows?: Array<DownloadFlowInfo>
798
942
 
799
- /**
800
- * 操作者的信息
801
- */
802
- Operator?: UserInfo
943
+ /**
944
+ * 渠道应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 均必填。
945
+ */
946
+ Agent: Agent;
947
+
948
+ /**
949
+ * 文件夹数组,签署流程总数不能超过50个,一个文件夹下,不能超过20个签署流程
950
+ */
951
+ DownLoadFlows?: Array<DownloadFlowInfo>;
952
+
953
+ /**
954
+ * 操作者的信息
955
+ */
956
+ Operator?: UserInfo;
803
957
  }
804
958
 
805
959
  /**
806
960
  * 此结构体(FlowDetailInfo)描述的是合同(流程)的详细信息
807
961
  */
808
962
  export interface FlowDetailInfo {
809
- /**
810
- * 合同(流程)的Id
811
- */
812
- FlowId: string
813
-
814
- /**
815
- * 合同(流程)的名字
816
- */
817
- FlowName: string
818
-
819
- /**
820
- * 合同(流程)的类型
821
- */
822
- FlowType: string
823
-
824
- /**
825
- * 合同(流程)的状态
826
- */
827
- FlowStatus: string
828
-
829
- /**
830
- * 合同(流程)的信息
831
- */
832
- FlowMessage: string
833
963
 
834
- /**
835
- * 合同(流程)的创建时间戳
836
- */
837
- CreateOn: number
838
-
839
- /**
840
- * 合同(流程)的签署截止时间戳
841
- */
842
- DeadLine: number
843
-
844
- /**
845
- * 用户自定义数据
846
- */
847
- CustomData: string
848
-
849
- /**
850
- * 合同(流程)的签署人数组
851
- */
852
- FlowApproverInfos: Array<FlowApproverDetail>
964
+ /**
965
+ * 合同(流程)的Id
966
+ */
967
+ FlowId: string;
968
+
969
+ /**
970
+ * 合同(流程)的名字
971
+ */
972
+ FlowName: string;
973
+
974
+ /**
975
+ * 合同(流程)的类型
976
+ */
977
+ FlowType: string;
978
+
979
+ /**
980
+ * 合同(流程)的状态
981
+ */
982
+ FlowStatus: string;
983
+
984
+ /**
985
+ * 合同(流程)的信息
986
+ */
987
+ FlowMessage: string;
988
+
989
+ /**
990
+ * 合同(流程)的创建时间戳
991
+ */
992
+ CreateOn: number;
993
+
994
+ /**
995
+ * 合同(流程)的签署截止时间戳
996
+ */
997
+ DeadLine: number;
998
+
999
+ /**
1000
+ * 用户自定义数据
1001
+ */
1002
+ CustomData: string;
1003
+
1004
+ /**
1005
+ * 合同(流程)的签署人数组
1006
+ */
1007
+ FlowApproverInfos: Array<FlowApproverDetail>;
853
1008
  }
854
1009
 
855
1010
  /**
856
1011
  * CreateConsoleLoginUrl请求参数结构体
857
1012
  */
858
1013
  export interface CreateConsoleLoginUrlRequest {
859
- /**
1014
+
1015
+ /**
860
1016
  * 应用信息
861
1017
  此接口Agent.AppId、Agent.ProxyOrganizationOpenId 和 Agent. ProxyOperator.OpenId 必填
862
1018
  */
863
- Agent: Agent
864
-
865
- /**
866
- * 渠道侧合作企业名称,最大长度64个字符
867
- */
868
- ProxyOrganizationName: string
869
-
870
- /**
871
- * 渠道侧合作企业经办人的姓名,最大长度50个字符
872
- */
873
- ProxyOperatorName?: string
874
-
875
- /**
876
- * 控制台指定模块,文件/合同管理:"DOCUMENT",模板管理:"TEMPLATE",印章管理:"SEAL",组织架构/人员:"OPERATOR",空字符串:"账号信息"
877
- */
878
- Module?: string
879
-
880
- /**
881
- * 控制台指定模块Id
882
- */
883
- ModuleId?: string
884
-
885
- /**
886
- * 渠道侧合作企业统一社会信用代码,最大长度200个字符
887
- */
888
- UniformSocialCreditCode?: string
1019
+ Agent: Agent;
1020
+
1021
+ /**
1022
+ * 渠道侧合作企业名称,最大长度64个字符
1023
+ */
1024
+ ProxyOrganizationName: string;
1025
+
1026
+ /**
1027
+ * 渠道侧合作企业经办人的姓名,最大长度50个字符
1028
+ */
1029
+ ProxyOperatorName?: string;
1030
+
1031
+ /**
1032
+ * 控制台指定模块,文件/合同管理:"DOCUMENT",模板管理:"TEMPLATE",印章管理:"SEAL",组织架构/人员:"OPERATOR",空字符串:"账号信息"
1033
+ */
1034
+ Module?: string;
1035
+
1036
+ /**
1037
+ * 控制台指定模块Id
1038
+ */
1039
+ ModuleId?: string;
1040
+
1041
+ /**
1042
+ * 渠道侧合作企业统一社会信用代码,最大长度200个字符
1043
+ */
1044
+ UniformSocialCreditCode?: string;
1045
+
1046
+ /**
1047
+ * 是否展示左侧菜单栏 是:ENABLE(默认) 否:DISABLE
1048
+ */
1049
+ MenuStatus?: string;
1050
+
1051
+ /**
1052
+ * 操作者的信息
1053
+ */
1054
+ Operator?: UserInfo;
1055
+ }
889
1056
 
890
- /**
891
- * 是否展示左侧菜单栏 是:ENABLE(默认) 否:DISABLE
892
- */
893
- MenuStatus?: string
1057
+ /**
1058
+ * 机构信息
1059
+ */
1060
+ export interface OrganizationInfo {
894
1061
 
895
- /**
896
- * 操作者的信息
897
- */
898
- Operator?: UserInfo
1062
+ /**
1063
+ * 用户在渠道的机构编号
1064
+ */
1065
+ OrganizationOpenId: string;
1066
+
1067
+ /**
1068
+ * 用户真实的IP
1069
+ */
1070
+ ClientIp: string;
1071
+
1072
+ /**
1073
+ * 机构的代理IP
1074
+ */
1075
+ ProxyIp: string;
1076
+
1077
+ /**
1078
+ * 机构在平台的编号
1079
+ */
1080
+ OrganizationId?: string;
1081
+
1082
+ /**
1083
+ * 用户渠道
1084
+ */
1085
+ Channel?: string;
899
1086
  }
900
1087
 
901
1088
  /**
902
1089
  * CreateFlowsByTemplates返回参数结构体
903
1090
  */
904
1091
  export interface CreateFlowsByTemplatesResponse {
905
- /**
906
- * 多个合同ID
907
- */
908
- FlowIds: Array<string>
909
-
910
- /**
911
- * 渠道的业务信息,限制1024字符
912
- */
913
- CustomerData: Array<string>
914
1092
 
915
- /**
1093
+ /**
1094
+ * 多个合同ID
1095
+ */
1096
+ FlowIds: Array<string>;
1097
+
1098
+ /**
1099
+ * 渠道的业务信息,限制1024字符
1100
+ */
1101
+ CustomerData: Array<string>;
1102
+
1103
+ /**
916
1104
  * 创建消息,对应多个合同ID,
917
1105
  成功为“”,创建失败则对应失败消息
918
1106
  */
919
- ErrorMessages: Array<string>
920
-
921
- /**
922
- * 预览模式下返回的预览文件url数组
923
- */
924
- PreviewUrls: Array<string>
1107
+ ErrorMessages: Array<string>;
1108
+
1109
+ /**
1110
+ * 预览模式下返回的预览文件url数组
1111
+ */
1112
+ PreviewUrls: Array<string>;
1113
+
1114
+ /**
1115
+ * 复杂文档合成任务的任务信息数组
1116
+ */
1117
+ TaskInfos: Array<TaskInfo>;
1118
+
1119
+ /**
1120
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1121
+ */
1122
+ RequestId?: string;
1123
+ }
925
1124
 
926
- /**
927
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
928
- */
929
- RequestId?: string
1125
+ /**
1126
+ * ChannelCreateFlowSignReview请求参数结构体
1127
+ */
1128
+ export interface ChannelCreateFlowSignReviewRequest {
1129
+
1130
+ /**
1131
+ * 渠道应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 均必填。
1132
+ */
1133
+ Agent: Agent;
1134
+
1135
+ /**
1136
+ * 签署流程编号
1137
+ */
1138
+ FlowId: string;
1139
+
1140
+ /**
1141
+ * 企业内部审核结果
1142
+ PASS: 通过
1143
+ REJECT: 拒绝
1144
+ */
1145
+ ReviewType: string;
1146
+
1147
+ /**
1148
+ * 审核原因
1149
+ 当ReviewType 是REJECT 时此字段必填,字符串长度不超过200
1150
+ */
1151
+ ReviewMessage?: string;
930
1152
  }
931
1153
 
932
1154
  /**
933
1155
  * PrepareFlows请求参数结构体
934
1156
  */
935
1157
  export interface PrepareFlowsRequest {
936
- /**
937
- * 渠道应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 均必填。
938
- */
939
- Agent: Agent
940
-
941
- /**
942
- * 多个合同(签署流程)信息,最大支持20个签署流程。
943
- */
944
- FlowInfos: Array<FlowInfo>
945
1158
 
946
- /**
947
- * 操作完成后的跳转地址,最大长度200
948
- */
949
- JumpUrl: string
950
-
951
- /**
952
- * 操作者的信息
953
- */
954
- Operator?: UserInfo
1159
+ /**
1160
+ * 渠道应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 均必填。
1161
+ */
1162
+ Agent: Agent;
1163
+
1164
+ /**
1165
+ * 多个合同(签署流程)信息,最大支持20个签署流程。
1166
+ */
1167
+ FlowInfos: Array<FlowInfo>;
1168
+
1169
+ /**
1170
+ * 操作完成后的跳转地址,最大长度200
1171
+ */
1172
+ JumpUrl: string;
1173
+
1174
+ /**
1175
+ * 操作者的信息
1176
+ */
1177
+ Operator?: UserInfo;
955
1178
  }
956
1179
 
957
1180
  /**
958
1181
  * SyncProxyOrganizationOperators返回参数结构体
959
1182
  */
960
1183
  export interface SyncProxyOrganizationOperatorsResponse {
961
- /**
1184
+
1185
+ /**
962
1186
  * Status 同步状态,全部同步失败接口会直接报错
963
1187
  1-成功
964
1188
  2-部分成功
965
1189
  注意:此字段可能返回 null,表示取不到有效值。
966
1190
  */
967
- Status: number
968
-
969
- /**
1191
+ Status: number;
1192
+
1193
+ /**
970
1194
  * 同步失败经办人及其失败原因
971
1195
  注意:此字段可能返回 null,表示取不到有效值。
972
1196
  */
973
- FailedList: Array<SyncFailReason>
974
-
975
- /**
976
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
977
- */
978
- RequestId?: string
1197
+ FailedList: Array<SyncFailReason>;
1198
+
1199
+ /**
1200
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1201
+ */
1202
+ RequestId?: string;
979
1203
  }
980
1204
 
981
1205
  /**
982
1206
  * CreateSealByImage返回参数结构体
983
1207
  */
984
1208
  export interface CreateSealByImageResponse {
985
- /**
986
- * 印章id
987
- */
988
- SealId: string
989
1209
 
990
- /**
991
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
992
- */
993
- RequestId?: string
1210
+ /**
1211
+ * 印章id
1212
+ */
1213
+ SealId: string;
1214
+
1215
+ /**
1216
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1217
+ */
1218
+ RequestId?: string;
1219
+ }
1220
+
1221
+ /**
1222
+ * 一码多扫签署二维码签署信息
1223
+ */
1224
+ export interface SignUrl {
1225
+
1226
+ /**
1227
+ * 小程序签署链接
1228
+ */
1229
+ AppSignUrl: string;
1230
+
1231
+ /**
1232
+ * 签署链接有效时间
1233
+ */
1234
+ EffectiveTime: string;
1235
+
1236
+ /**
1237
+ * 移动端签署链接
1238
+ */
1239
+ HttpSignUrl: string;
994
1240
  }
995
1241
 
996
1242
  /**
997
1243
  * 流程对应资源链接信息
998
1244
  */
999
1245
  export interface FlowResourceUrlInfo {
1000
- /**
1246
+
1247
+ /**
1001
1248
  * 流程对应Id
1002
1249
  注意:此字段可能返回 null,表示取不到有效值。
1003
1250
  */
1004
- FlowId: string
1005
-
1006
- /**
1251
+ FlowId: string;
1252
+
1253
+ /**
1007
1254
  * 流程对应资源链接信息数组
1008
1255
  注意:此字段可能返回 null,表示取不到有效值。
1009
1256
  */
1010
- ResourceUrlInfos: Array<ResourceUrlInfo>
1257
+ ResourceUrlInfos: Array<ResourceUrlInfo>;
1011
1258
  }
1012
1259
 
1013
1260
  /**
1014
1261
  * DescribeTemplates请求参数结构体
1015
1262
  */
1016
1263
  export interface DescribeTemplatesRequest {
1017
- /**
1018
- * 渠道应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 均必填。
1019
- */
1020
- Agent: Agent
1021
-
1022
- /**
1023
- * 模板唯一标识
1024
- */
1025
- TemplateId?: string
1026
-
1027
- /**
1028
- * 查询内容:0-模板列表及详情(默认),1-仅模板列表
1029
- */
1030
- ContentType?: number
1031
1264
 
1032
- /**
1033
- * 查询个数,默认20,最大100
1034
- */
1035
- Limit?: number
1036
-
1037
- /**
1038
- * 查询偏移位置,默认0
1039
- */
1040
- Offset?: number
1041
-
1042
- /**
1043
- * 操作者的信息
1044
- */
1045
- Operator?: UserInfo
1265
+ /**
1266
+ * 渠道应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 均必填。
1267
+ */
1268
+ Agent: Agent;
1269
+
1270
+ /**
1271
+ * 模板唯一标识
1272
+ */
1273
+ TemplateId?: string;
1274
+
1275
+ /**
1276
+ * 查询内容:0-模板列表及详情(默认),1-仅模板列表
1277
+ */
1278
+ ContentType?: number;
1279
+
1280
+ /**
1281
+ * 查询个数,默认20,最大100
1282
+ */
1283
+ Limit?: number;
1284
+
1285
+ /**
1286
+ * 查询偏移位置,默认0
1287
+ */
1288
+ Offset?: number;
1289
+
1290
+ /**
1291
+ * 操作者的信息
1292
+ */
1293
+ Operator?: UserInfo;
1046
1294
  }
1047
1295
 
1048
1296
  /**
1049
1297
  * SyncProxyOrganizationOperators请求参数结构体
1050
1298
  */
1051
1299
  export interface SyncProxyOrganizationOperatorsRequest {
1052
- /**
1053
- * 渠道应用相关信息。 此接口Agent.AppId 和 Agent.ProxyOrganizationOpenId必填。
1054
- */
1055
- Agent: Agent
1056
1300
 
1057
- /**
1058
- * 操作类型,新增:"CREATE",修改:"UPDATE",离职:"RESIGN"
1059
- */
1060
- OperatorType: string
1061
-
1062
- /**
1063
- * 经办人信息列表,最大长度200
1064
- */
1065
- ProxyOrganizationOperators: Array<ProxyOrganizationOperator>
1066
-
1067
- /**
1068
- * 操作者的信息
1069
- */
1070
- Operator?: UserInfo
1301
+ /**
1302
+ * 渠道应用相关信息。 此接口Agent.AppId 和 Agent.ProxyOrganizationOpenId必填。
1303
+ */
1304
+ Agent: Agent;
1305
+
1306
+ /**
1307
+ * 操作类型,新增:"CREATE",修改:"UPDATE",离职:"RESIGN"
1308
+ */
1309
+ OperatorType: string;
1310
+
1311
+ /**
1312
+ * 经办人信息列表,最大长度200
1313
+ */
1314
+ ProxyOrganizationOperators: Array<ProxyOrganizationOperator>;
1315
+
1316
+ /**
1317
+ * 操作者的信息
1318
+ */
1319
+ Operator?: UserInfo;
1071
1320
  }
1072
1321
 
1073
1322
  /**
1074
1323
  * CreateConsoleLoginUrl返回参数结构体
1075
1324
  */
1076
1325
  export interface CreateConsoleLoginUrlResponse {
1077
- /**
1078
- * 控制台url,此链接5分钟内有效,且只能访问一次
1079
- */
1080
- ConsoleUrl: string
1081
1326
 
1082
- /**
1327
+ /**
1328
+ * 控制台url,此链接5分钟内有效,且只能访问一次
1329
+ */
1330
+ ConsoleUrl: string;
1331
+
1332
+ /**
1083
1333
  * 渠道合作企业是否认证开通腾讯电子签。
1084
1334
  当渠道合作企业未完成认证开通腾讯电子签,建议先调用同步企业信息(SyncProxyOrganization)和同步经办人信息(SyncProxyOrganizationOperators)接口成功后再跳转到登录页面。
1085
1335
  */
1086
- IsActivated: boolean
1087
-
1088
- /**
1089
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1090
- */
1091
- RequestId?: string
1336
+ IsActivated: boolean;
1337
+
1338
+ /**
1339
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1340
+ */
1341
+ RequestId?: string;
1092
1342
  }
1093
1343
 
1094
1344
  /**
1095
1345
  * CreateFlowsByTemplates请求参数结构体
1096
1346
  */
1097
1347
  export interface CreateFlowsByTemplatesRequest {
1098
- /**
1099
- * 渠道应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 均必填。
1100
- */
1101
- Agent: Agent
1102
1348
 
1103
- /**
1104
- * 多个合同(签署流程)信息,最多支持20个
1105
- */
1106
- FlowInfos: Array<FlowInfo>
1107
-
1108
- /**
1349
+ /**
1350
+ * 渠道应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 均必填。
1351
+ */
1352
+ Agent: Agent;
1353
+
1354
+ /**
1355
+ * 多个合同(签署流程)信息,最多支持20个
1356
+ */
1357
+ FlowInfos: Array<FlowInfo>;
1358
+
1359
+ /**
1109
1360
  * 是否为预览模式;默认为false,即非预览模式,此时发起合同并返回FlowIds;若为预览模式,则返回PreviewUrls;
1110
1361
  预览链接有效期300秒;
1111
1362
  */
1112
- NeedPreview?: boolean
1113
-
1114
- /**
1115
- * 操作者的信息
1116
- */
1117
- Operator?: UserInfo
1363
+ NeedPreview?: boolean;
1364
+
1365
+ /**
1366
+ * 操作者的信息
1367
+ */
1368
+ Operator?: UserInfo;
1118
1369
  }
1119
1370
 
1120
1371
  /**
1121
1372
  * SyncProxyOrganization请求参数结构体
1122
1373
  */
1123
1374
  export interface SyncProxyOrganizationRequest {
1124
- /**
1375
+
1376
+ /**
1125
1377
  * 应用信息
1126
1378
  此接口Agent.AppId、Agent.ProxyOrganizationOpenId必填
1127
1379
  */
1128
- Agent: Agent
1129
-
1130
- /**
1131
- * 渠道侧合作企业名称,最大长度64个字符
1132
- */
1133
- ProxyOrganizationName: string
1134
-
1135
- /**
1136
- * 营业执照正面照(PNG或JPG) base64格式, 大小不超过5M
1137
- */
1138
- BusinessLicense?: string
1139
-
1140
- /**
1141
- * 渠道侧合作企业统一社会信用代码,最大长度200个字符
1142
- */
1143
- UniformSocialCreditCode?: string
1144
-
1145
- /**
1146
- * 操作者的信息
1147
- */
1148
- Operator?: UserInfo
1380
+ Agent: Agent;
1381
+
1382
+ /**
1383
+ * 渠道侧合作企业名称,最大长度64个字符
1384
+ */
1385
+ ProxyOrganizationName: string;
1386
+
1387
+ /**
1388
+ * 营业执照正面照(PNG或JPG) base64格式, 大小不超过5M
1389
+ */
1390
+ BusinessLicense?: string;
1391
+
1392
+ /**
1393
+ * 渠道侧合作企业统一社会信用代码,最大长度200个字符
1394
+ */
1395
+ UniformSocialCreditCode?: string;
1396
+
1397
+ /**
1398
+ * 操作者的信息
1399
+ */
1400
+ Operator?: UserInfo;
1149
1401
  }
1150
1402
 
1151
1403
  /**
1152
1404
  * CreateSealByImage请求参数结构体
1153
1405
  */
1154
1406
  export interface CreateSealByImageRequest {
1155
- /**
1156
- * 渠道应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 均必填。
1157
- */
1158
- Agent: Agent
1159
1407
 
1160
- /**
1161
- * 印章名称,最大长度不超过30字符
1162
- */
1163
- SealName: string
1164
-
1165
- /**
1166
- * 印章图片base64
1167
- */
1168
- SealImage: string
1169
-
1170
- /**
1171
- * 操作者的信息
1172
- */
1173
- Operator?: UserInfo
1408
+ /**
1409
+ * 渠道应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 均必填。
1410
+ */
1411
+ Agent: Agent;
1412
+
1413
+ /**
1414
+ * 印章名称,最大长度不超过30字符
1415
+ */
1416
+ SealName: string;
1417
+
1418
+ /**
1419
+ * 印章图片base64
1420
+ */
1421
+ SealImage: string;
1422
+
1423
+ /**
1424
+ * 操作者的信息
1425
+ */
1426
+ Operator?: UserInfo;
1174
1427
  }
1175
1428
 
1176
1429
  /**
1177
- * 接口调用者信息
1430
+ * 一码多扫签署二维码对象
1178
1431
  */
1179
- export interface UserInfo {
1180
- /**
1181
- * 用户在渠道的编号
1182
- */
1183
- OpenId?: string
1184
-
1185
- /**
1186
- * 用户的来源渠道
1187
- */
1188
- Channel?: string
1189
-
1190
- /**
1191
- * 自定义用户编号
1192
- */
1193
- CustomUserId?: string
1194
-
1195
- /**
1196
- * 用户真实IP
1197
- */
1198
- ClientIp?: string
1432
+ export interface SignQrCode {
1199
1433
 
1200
- /**
1201
- * 用户代理IP
1202
- */
1203
- ProxyIp?: string
1434
+ /**
1435
+ * 二维码id
1436
+ */
1437
+ QrCodeId: string;
1438
+
1439
+ /**
1440
+ * 二维码url
1441
+ */
1442
+ QrCodeUrl: string;
1443
+
1444
+ /**
1445
+ * 二维码过期时间
1446
+ */
1447
+ ExpiredTime: number;
1204
1448
  }
1205
1449
 
1206
1450
  /**
1207
1451
  * DescribeUsage返回参数结构体
1208
1452
  */
1209
1453
  export interface DescribeUsageResponse {
1210
- /**
1211
- * 用量明细条数
1212
- */
1213
- Total: number
1214
1454
 
1215
- /**
1455
+ /**
1456
+ * 用量明细条数
1457
+ */
1458
+ Total: number;
1459
+
1460
+ /**
1216
1461
  * 用量明细
1217
1462
  注意:此字段可能返回 null,表示取不到有效值。
1218
1463
  */
1219
- Details: Array<UsageDetail>
1220
-
1221
- /**
1222
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1223
- */
1224
- RequestId?: string
1464
+ Details: Array<UsageDetail>;
1465
+
1466
+ /**
1467
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1468
+ */
1469
+ RequestId?: string;
1225
1470
  }
1226
1471
 
1227
1472
  /**
1228
1473
  * 用量明细
1229
1474
  */
1230
1475
  export interface UsageDetail {
1231
- /**
1232
- * 渠道侧合作企业唯一标识
1233
- */
1234
- ProxyOrganizationOpenId: string
1235
1476
 
1236
- /**
1477
+ /**
1478
+ * 渠道侧合作企业唯一标识
1479
+ */
1480
+ ProxyOrganizationOpenId: string;
1481
+
1482
+ /**
1237
1483
  * 渠道侧合作企业名
1238
1484
  注意:此字段可能返回 null,表示取不到有效值。
1239
1485
  */
1240
- ProxyOrganizationName: string
1241
-
1242
- /**
1486
+ ProxyOrganizationName: string;
1487
+
1488
+ /**
1243
1489
  * 日期,当需要汇总数据时日期为空
1244
1490
  注意:此字段可能返回 null,表示取不到有效值。
1245
1491
  */
1246
- Date: string
1247
-
1248
- /**
1249
- * 消耗数量
1250
- */
1251
- Usage: number
1252
-
1253
- /**
1492
+ Date: string;
1493
+
1494
+ /**
1495
+ * 消耗数量
1496
+ */
1497
+ Usage: number;
1498
+
1499
+ /**
1254
1500
  * 撤回数量
1255
1501
  注意:此字段可能返回 null,表示取不到有效值。
1256
1502
  */
1257
- Cancel: number
1503
+ Cancel: number;
1258
1504
  }
1259
1505
 
1260
1506
  /**
1261
- * CreateSignUrls返回参数结构体
1507
+ * ChannelCreateBatchCancelFlowUrl返回参数结构体
1262
1508
  */
1263
- export interface CreateSignUrlsResponse {
1264
- /**
1265
- * 签署参与者签署H5链接信息数组
1266
- */
1267
- SignUrlInfos: Array<SignUrlInfo>
1268
-
1269
- /**
1270
- * 生成失败时的错误信息,成功返回”“,顺序和出参SignUrlInfos保持一致
1271
- */
1272
- ErrorMessages: Array<string>
1509
+ export interface ChannelCreateBatchCancelFlowUrlResponse {
1273
1510
 
1274
- /**
1275
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1276
- */
1277
- RequestId?: string
1511
+ /**
1512
+ * 批量撤销url
1513
+ */
1514
+ BatchCancelFlowUrl: string;
1515
+
1516
+ /**
1517
+ * 签署流程批量撤销失败原因
1518
+ */
1519
+ FailMessages: Array<string>;
1520
+
1521
+ /**
1522
+ * 签署撤销url过期时间-年月日-时分秒
1523
+ */
1524
+ UrlExpireOn: string;
1525
+
1526
+ /**
1527
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1528
+ */
1529
+ RequestId?: string;
1278
1530
  }
1279
1531
 
1280
1532
  /**
1281
- * OperateChannelTemplate请求参数结构体
1533
+ * DescribeResourceUrlsByFlows请求参数结构体
1282
1534
  */
1283
- export interface OperateChannelTemplateRequest {
1284
- /**
1285
- * 渠道应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 均必填。
1286
- */
1287
- Agent: Agent
1288
-
1289
- /**
1290
- * 操作类型,查询:"SELECT",删除:"DELETE",更新:"UPDATE"
1291
- */
1292
- OperateType: string
1293
-
1294
- /**
1295
- * 渠道方模板库模板唯一标识
1296
- */
1297
- TemplateId: string
1298
-
1299
- /**
1300
- * 合作企业方第三方机构唯一标识数据,支持多个, 用","进行分隔
1301
- */
1302
- ProxyOrganizationOpenIds?: string
1303
-
1304
- /**
1305
- * 模板可见性, 全部可见-"all", 部分可见-"part"
1306
- */
1307
- AuthTag?: string
1535
+ export interface DescribeResourceUrlsByFlowsRequest {
1308
1536
 
1309
- /**
1310
- * 操作者的信息
1311
- */
1312
- Operator?: UserInfo
1537
+ /**
1538
+ * 渠道应用相关信息。
1539
+ 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 均必填。
1540
+ */
1541
+ Agent: Agent;
1542
+
1543
+ /**
1544
+ * 查询资源所对应的签署流程Id,最多支持50个。
1545
+ */
1546
+ FlowIds?: Array<string>;
1547
+
1548
+ /**
1549
+ * 操作者的信息
1550
+ */
1551
+ Operator?: UserInfo;
1313
1552
  }
1314
1553
 
1315
1554
  /**
1316
1555
  * 签署流程下载信息
1317
1556
  */
1318
1557
  export interface DownloadFlowInfo {
1319
- /**
1320
- * 文件夹名称
1321
- */
1322
- FileName: string
1323
1558
 
1324
- /**
1325
- * 签署流程的标识数组
1326
- */
1327
- FlowIdList: Array<string>
1559
+ /**
1560
+ * 文件夹名称
1561
+ */
1562
+ FileName: string;
1563
+
1564
+ /**
1565
+ * 签署流程的标识数组
1566
+ */
1567
+ FlowIdList: Array<string>;
1328
1568
  }
1329
1569
 
1330
1570
  /**
1331
1571
  * ChannelCancelMultiFlowSignQRCode请求参数结构体
1332
1572
  */
1333
1573
  export interface ChannelCancelMultiFlowSignQRCodeRequest {
1334
- /**
1335
- * 渠道应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 均必填。
1336
- */
1337
- Agent: Agent
1338
1574
 
1339
- /**
1340
- * 二维码id
1341
- */
1342
- QrCodeId: string
1575
+ /**
1576
+ * 渠道应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 均必填。
1577
+ */
1578
+ Agent: Agent;
1579
+
1580
+ /**
1581
+ * 二维码id
1582
+ */
1583
+ QrCodeId: string;
1584
+
1585
+ /**
1586
+ * 用户信息
1587
+ */
1588
+ Operator?: UserInfo;
1589
+ }
1590
+
1591
+ /**
1592
+ * CreateChannelFlowEvidenceReport返回参数结构体
1593
+ */
1594
+ export interface CreateChannelFlowEvidenceReportResponse {
1343
1595
 
1344
- /**
1345
- * 用户信息
1346
- */
1347
- Operator?: UserInfo
1596
+ /**
1597
+ * 出证报告 URL(有效五分钟)
1598
+ */
1599
+ ReportUrl: string;
1600
+
1601
+ /**
1602
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1603
+ */
1604
+ RequestId?: string;
1348
1605
  }
1349
1606
 
1350
1607
  /**
1351
1608
  * 同步经办人失败原因
1352
1609
  */
1353
1610
  export interface SyncFailReason {
1354
- /**
1355
- * 经办人Id
1356
- */
1357
- Id: string
1358
1611
 
1359
- /**
1612
+ /**
1613
+ * 经办人Id
1614
+ */
1615
+ Id: string;
1616
+
1617
+ /**
1360
1618
  * 失败原因
1361
1619
  例如:Id不符合规范、证件号码不合法等
1362
1620
  注意:此字段可能返回 null,表示取不到有效值。
1363
1621
  */
1364
- Message: string
1622
+ Message: string;
1623
+ }
1624
+
1625
+ /**
1626
+ * PrepareFlows返回参数结构体
1627
+ */
1628
+ export interface PrepareFlowsResponse {
1629
+
1630
+ /**
1631
+ * 待发起文件确认页
1632
+ */
1633
+ ConfirmUrl: string;
1634
+
1635
+ /**
1636
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1637
+ */
1638
+ RequestId?: string;
1365
1639
  }
1366
1640
 
1367
1641
  /**
1368
1642
  * DescribeUsage请求参数结构体
1369
1643
  */
1370
1644
  export interface DescribeUsageRequest {
1371
- /**
1372
- * 应用信息
1373
- */
1374
- Agent: Agent
1375
-
1376
- /**
1377
- * 开始时间,例如:2021-03-21
1378
- */
1379
- StartDate: string
1380
1645
 
1381
- /**
1646
+ /**
1647
+ * 应用信息
1648
+ */
1649
+ Agent: Agent;
1650
+
1651
+ /**
1652
+ * 开始时间,例如:2021-03-21
1653
+ */
1654
+ StartDate: string;
1655
+
1656
+ /**
1382
1657
  * 结束时间,例如:2021-06-21;
1383
1658
  开始时间到结束时间的区间长度小于等于90天。
1384
1659
  */
1385
- EndDate: string
1386
-
1387
- /**
1660
+ EndDate: string;
1661
+
1662
+ /**
1388
1663
  * 是否汇总数据,默认不汇总。
1389
1664
  不汇总:返回在统计区间内渠道下所有企业的每日明细,即每个企业N条数据,N为统计天数;
1390
1665
  汇总:返回在统计区间内渠道下所有企业的汇总后数据,即每个企业一条数据;
1391
1666
  */
1392
- NeedAggregate?: boolean
1667
+ NeedAggregate?: boolean;
1668
+
1669
+ /**
1670
+ * 单次返回的最多条目数量。默认为1000,且不能超过1000。
1671
+ */
1672
+ Limit?: number;
1673
+
1674
+ /**
1675
+ * 偏移量,默认是0。
1676
+ */
1677
+ Offset?: number;
1678
+
1679
+ /**
1680
+ * 操作者的信息
1681
+ */
1682
+ Operator?: UserInfo;
1683
+ }
1684
+
1685
+ /**
1686
+ * ChannelCreateBatchCancelFlowUrl请求参数结构体
1687
+ */
1688
+ export interface ChannelCreateBatchCancelFlowUrlRequest {
1393
1689
 
1394
- /**
1395
- * 单次返回的最多条目数量。默认为1000,且不能超过1000。
1396
- */
1397
- Limit?: number
1690
+ /**
1691
+ * 渠道应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 均必填。
1692
+ */
1693
+ Agent: Agent;
1694
+
1695
+ /**
1696
+ * 签署流程Id数组
1697
+ */
1698
+ FlowIds: Array<string>;
1699
+
1700
+ /**
1701
+ * 操作人信息
1702
+ */
1703
+ Operator?: UserInfo;
1704
+ }
1398
1705
 
1399
- /**
1400
- * 偏移量,默认是0。
1401
- */
1402
- Offset?: number
1706
+ /**
1707
+ * 指定签署人限制项
1708
+ */
1709
+ export interface ApproverRestriction {
1403
1710
 
1404
- /**
1405
- * 操作者的信息
1406
- */
1407
- Operator?: UserInfo
1711
+ /**
1712
+ * 指定签署人名字
1713
+ */
1714
+ Name?: string;
1715
+
1716
+ /**
1717
+ * 指定签署人手机号
1718
+ */
1719
+ Mobile?: string;
1720
+
1721
+ /**
1722
+ * 指定签署人证件类型
1723
+ */
1724
+ IdCardType?: string;
1725
+
1726
+ /**
1727
+ * 指定签署人证件号码
1728
+ */
1729
+ IdCardNumber?: string;
1408
1730
  }
1409
1731
 
1410
1732
  /**
1411
1733
  * ChannelCreateFlowByFiles请求参数结构体
1412
1734
  */
1413
1735
  export interface ChannelCreateFlowByFilesRequest {
1414
- /**
1415
- * 渠道应用相关信息
1416
- */
1417
- Agent?: Agent
1418
-
1419
- /**
1420
- * 签署流程名称,长度不超过200个字符
1421
- */
1422
- FlowName?: string
1423
-
1424
- /**
1425
- * 签署流程签约方列表,最多不超过5个参与方
1426
- */
1427
- FlowApprovers?: Array<FlowApproverInfo>
1428
-
1429
- /**
1430
- * 签署文件资源Id列表,目前仅支持单个文件
1431
- */
1432
- FileIds?: Array<string>
1433
-
1434
- /**
1435
- * 签署文件中的控件,如:填写控件等
1436
- */
1437
- Components?: Array<Component>
1438
-
1439
- /**
1440
- * 签署流程截止时间,十位数时间戳,最大值为33162419560,即3020年
1441
- */
1442
- Deadline?: number
1443
-
1444
- /**
1445
- * 签署流程回调地址,长度不超过255个字符
1446
- */
1447
- CallbackUrl?: string
1448
-
1449
- /**
1450
- * 合同签署顺序类型(无序签,顺序签),默认为false,即有序签署
1451
- */
1452
- Unordered?: boolean
1453
-
1454
- /**
1455
- * 签署流程的类型,长度不超过255个字符
1456
- */
1457
- FlowType?: string
1458
-
1459
- /**
1460
- * 签署流程的描述,长度不超过1000个字符
1461
- */
1462
- FlowDescription?: string
1463
-
1464
- /**
1465
- * 合同显示的页卡模板,说明:只支持{合同名称}, {发起方企业}, {发起方姓名}, {签署方N企业}, {签署方N姓名},且N不能超过签署人的数量,N从1开始
1466
- */
1467
- CustomShowMap?: string
1468
-
1469
- /**
1470
- * 渠道的业务信息,最大长度1000个字符。发起自动签署时,需设置对应自动签署场景,目前仅支持场景:处方单-E_PRESCRIPTION_AUTO_SIGN
1471
- */
1472
- CustomerData?: string
1473
-
1474
- /**
1475
- * 操作者的信息
1476
- */
1477
- Operator?: UserInfo
1736
+
1737
+ /**
1738
+ * 渠道应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 均必填。
1739
+ */
1740
+ Agent?: Agent;
1741
+
1742
+ /**
1743
+ * 签署流程名称,长度不超过200个字符
1744
+ */
1745
+ FlowName?: string;
1746
+
1747
+ /**
1748
+ * 签署流程签约方列表,最多不超过5个参与方
1749
+ */
1750
+ FlowApprovers?: Array<FlowApproverInfo>;
1751
+
1752
+ /**
1753
+ * 签署文件资源Id列表,目前仅支持单个文件
1754
+ */
1755
+ FileIds?: Array<string>;
1756
+
1757
+ /**
1758
+ * 签署文件中的控件,如:填写控件等
1759
+ */
1760
+ Components?: Array<Component>;
1761
+
1762
+ /**
1763
+ * 签署流程截止时间,十位数时间戳,最大值为33162419560,即3020年
1764
+ */
1765
+ Deadline?: number;
1766
+
1767
+ /**
1768
+ * 签署流程回调地址,长度不超过255个字符
1769
+ */
1770
+ CallbackUrl?: string;
1771
+
1772
+ /**
1773
+ * 合同签署顺序类型(无序签,顺序签),默认为false,即有序签署
1774
+ */
1775
+ Unordered?: boolean;
1776
+
1777
+ /**
1778
+ * 签署流程的类型,长度不超过255个字符
1779
+ */
1780
+ FlowType?: string;
1781
+
1782
+ /**
1783
+ * 签署流程的描述,长度不超过1000个字符
1784
+ */
1785
+ FlowDescription?: string;
1786
+
1787
+ /**
1788
+ * 合同显示的页卡模板,说明:只支持{合同名称}, {发起方企业}, {发起方姓名}, {签署方N企业}, {签署方N姓名},且N不能超过签署人的数量,N从1开始
1789
+ */
1790
+ CustomShowMap?: string;
1791
+
1792
+ /**
1793
+ * 渠道的业务信息,最大长度1000个字符。发起自动签署时,需设置对应自动签署场景,目前仅支持场景:处方单-E_PRESCRIPTION_AUTO_SIGN
1794
+ */
1795
+ CustomerData?: string;
1796
+
1797
+ /**
1798
+ * 发起方企业的签署人进行签署操作是否需要企业内部审批。 若设置为true,审核结果需通过接口 ChannelCreateFlowSignReview 通知电子签,审核通过后,发起方企业签署人方可进行签署操作,否则会阻塞其签署操作。 注:企业可以通过此功能与企业内部的审批流程进行关联,支持手动、静默签署合同。
1799
+ */
1800
+ NeedSignReview?: boolean;
1801
+
1802
+ /**
1803
+ * 操作者的信息
1804
+ */
1805
+ Operator?: UserInfo;
1478
1806
  }
1479
1807
 
1480
1808
  /**
1481
1809
  * ChannelCreateFlowByFiles返回参数结构体
1482
1810
  */
1483
1811
  export interface ChannelCreateFlowByFilesResponse {
1484
- /**
1812
+
1813
+ /**
1485
1814
  * 合同签署流程ID
1486
1815
  注意:此字段可能返回 null,表示取不到有效值。
1487
1816
  */
1488
- FlowId: string
1489
-
1490
- /**
1491
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1492
- */
1493
- RequestId?: string
1817
+ FlowId: string;
1818
+
1819
+ /**
1820
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1821
+ */
1822
+ RequestId?: string;
1494
1823
  }
1495
1824
 
1496
1825
  /**
1497
1826
  * UploadFiles返回参数结构体
1498
1827
  */
1499
1828
  export interface UploadFilesResponse {
1500
- /**
1501
- * 文件id数组,有效期一个小时
1502
- */
1503
- FileIds: Array<string>
1504
1829
 
1505
- /**
1506
- * 上传成功文件数量
1507
- */
1508
- TotalCount: number
1830
+ /**
1831
+ * 文件id数组,有效期一个小时
1832
+ */
1833
+ FileIds: Array<string>;
1834
+
1835
+ /**
1836
+ * 上传成功文件数量
1837
+ */
1838
+ TotalCount: number;
1839
+
1840
+ /**
1841
+ * 文件Url
1842
+ */
1843
+ FileUrls: Array<string>;
1844
+
1845
+ /**
1846
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1847
+ */
1848
+ RequestId?: string;
1849
+ }
1509
1850
 
1510
- /**
1511
- * 文件Url
1512
- */
1513
- FileUrls: Array<string>
1851
+ /**
1852
+ * ChannelCreateFlowSignReview返回参数结构体
1853
+ */
1854
+ export interface ChannelCreateFlowSignReviewResponse {
1514
1855
 
1515
- /**
1516
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1517
- */
1518
- RequestId?: string
1856
+ /**
1857
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1858
+ */
1859
+ RequestId?: string;
1519
1860
  }
1520
1861
 
1521
1862
  /**
1522
1863
  * 应用相关信息
1523
1864
  */
1524
1865
  export interface Agent {
1525
- /**
1526
- * 腾讯电子签颁发给渠道的应用ID,32位字符串
1527
- */
1528
- AppId: string
1529
-
1530
- /**
1531
- * 渠道/平台合作企业的企业ID
1532
- */
1533
- ProxyOrganizationOpenId?: string
1534
-
1535
- /**
1536
- * 渠道/平台合作企业经办人(操作员)
1537
- */
1538
- ProxyOperator?: UserInfo
1539
1866
 
1540
- /**
1541
- * 腾讯电子签颁发给渠道侧合作企业的应用ID
1542
- */
1543
- ProxyAppId?: string
1544
-
1545
- /**
1546
- * 腾讯电子签颁发给渠道侧合作企业的企业ID
1547
- */
1548
- ProxyOrganizationId?: string
1867
+ /**
1868
+ * 腾讯电子签颁发给渠道的应用ID,32位字符串
1869
+ */
1870
+ AppId: string;
1871
+
1872
+ /**
1873
+ * 渠道/平台合作企业的企业ID,最大64位字符串
1874
+ */
1875
+ ProxyOrganizationOpenId?: string;
1876
+
1877
+ /**
1878
+ * 渠道/平台合作企业经办人(操作员)
1879
+ */
1880
+ ProxyOperator?: UserInfo;
1881
+
1882
+ /**
1883
+ * 腾讯电子签颁发给渠道侧合作企业的应用ID
1884
+ */
1885
+ ProxyAppId?: string;
1886
+
1887
+ /**
1888
+ * 内部参数,腾讯电子签颁发给渠道侧合作企业的企业ID,不需要传
1889
+ */
1890
+ ProxyOrganizationId?: string;
1549
1891
  }
1550
1892
 
1551
1893
  /**
1552
1894
  * 此结构 (FormField) 用于描述内容控件填充结构。
1895
+
1553
1896
  */
1554
1897
  export interface FormField {
1555
- /**
1556
- * 表单域或控件的Value
1557
- */
1558
- ComponentValue: string
1559
1898
 
1560
- /**
1561
- * 表单域或控件的ID,跟ComponentName二选一,不能全为空
1899
+ /**
1900
+ * 控件填充vaule,ComponentType和传入值类型对应关系:
1901
+ TEXT - 文本内容
1902
+ MULTI_LINE_TEXT - 文本内容
1903
+ CHECK_BOX - true/false
1904
+ FILL_IMAGE、ATTACHMENT - 附件的FileId,需要通过UploadFiles接口上传获取
1905
+ SELECTOR - 选项值
1906
+ DYNAMIC_TABLE - 传入json格式的表格内容,具体见数据结构FlowInfo:https://cloud.tencent.com/document/api/1420/61525#FlowInfo
1907
+ */
1908
+ ComponentValue: string;
1909
+
1910
+ /**
1911
+ * 表单域或控件的ID,跟ComponentName二选一,不能全为空;
1912
+ CreateFlowsByTemplates 接口不使用此字段。
1562
1913
  注意:此字段可能返回 null,表示取不到有效值。
1563
1914
  */
1564
- ComponentId?: string
1565
-
1566
- /**
1915
+ ComponentId?: string;
1916
+
1917
+ /**
1567
1918
  * 控件的名字,跟ComponentId二选一,不能全为空
1568
1919
  注意:此字段可能返回 null,表示取不到有效值。
1569
1920
  */
1570
- ComponentName?: string
1921
+ ComponentName?: string;
1571
1922
  }
1572
1923
 
1573
1924
  /**
1574
- * 签署人的流程信息明细
1925
+ * 接口调用者信息
1575
1926
  */
1576
- export interface FlowApproverDetail {
1577
- /**
1578
- * 模板配置时候的签署人id,与控件绑定
1579
- */
1580
- ReceiptId: string
1927
+ export interface UserInfo {
1581
1928
 
1582
- /**
1583
- * 渠道侧企业的第三方id
1584
- 注意:此字段可能返回 null,表示取不到有效值。
1929
+ /**
1930
+ * 用户在渠道的编号,最大64位字符串
1585
1931
  */
1586
- ProxyOrganizationOpenId: string
1587
-
1588
- /**
1589
- * 渠道侧企业操作人的第三方id
1590
- */
1591
- ProxyOperatorOpenId: string
1932
+ OpenId?: string;
1933
+
1934
+ /**
1935
+ * 用户的来源渠道
1936
+ */
1937
+ Channel?: string;
1938
+
1939
+ /**
1940
+ * 自定义用户编号
1941
+ */
1942
+ CustomUserId?: string;
1943
+
1944
+ /**
1945
+ * 用户真实IP
1946
+ */
1947
+ ClientIp?: string;
1948
+
1949
+ /**
1950
+ * 用户代理IP
1951
+ */
1952
+ ProxyIp?: string;
1953
+ }
1592
1954
 
1593
- /**
1594
- * 渠道侧企业名称
1595
- */
1596
- ProxyOrganizationName: string
1955
+ /**
1956
+ * ChannelCreateConvertTaskApi请求参数结构体
1957
+ */
1958
+ export interface ChannelCreateConvertTaskApiRequest {
1597
1959
 
1598
- /**
1599
- * 签署人手机号
1600
- */
1601
- Mobile: string
1960
+ /**
1961
+ * 渠道应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 均必填。
1962
+ */
1963
+ Agent: Agent;
1964
+
1965
+ /**
1966
+ * 资源类型 取值范围doc,docx,html之一
1967
+ */
1968
+ ResourceType: string;
1969
+
1970
+ /**
1971
+ * 资源名称,长度限制为256字符
1972
+ */
1973
+ ResourceName: string;
1974
+
1975
+ /**
1976
+ * 资源Id,通过UploadFiles获取
1977
+ */
1978
+ ResourceId: string;
1979
+
1980
+ /**
1981
+ * 操作者信息
1982
+ */
1983
+ Operator?: UserInfo;
1984
+
1985
+ /**
1986
+ * 暂未开放
1987
+ */
1988
+ Organization?: OrganizationInfo;
1989
+ }
1602
1990
 
1603
- /**
1604
- * 签署人签署顺序
1605
- */
1606
- SignOrder: number
1991
+ /**
1992
+ * 签署人的流程信息明细
1993
+ */
1994
+ export interface FlowApproverDetail {
1607
1995
 
1608
- /**
1996
+ /**
1997
+ * 模板配置时候的签署人id,与控件绑定
1998
+ */
1999
+ ReceiptId: string;
2000
+
2001
+ /**
2002
+ * 渠道侧企业的第三方id
2003
+ 注意:此字段可能返回 null,表示取不到有效值。
2004
+ */
2005
+ ProxyOrganizationOpenId: string;
2006
+
2007
+ /**
2008
+ * 渠道侧企业操作人的第三方id
2009
+ */
2010
+ ProxyOperatorOpenId: string;
2011
+
2012
+ /**
2013
+ * 渠道侧企业名称
2014
+ */
2015
+ ProxyOrganizationName: string;
2016
+
2017
+ /**
2018
+ * 签署人手机号
2019
+ */
2020
+ Mobile: string;
2021
+
2022
+ /**
2023
+ * 签署人签署顺序
2024
+ */
2025
+ SignOrder: number;
2026
+
2027
+ /**
1609
2028
  * 签署人姓名
1610
2029
  注意:此字段可能返回 null,表示取不到有效值。
1611
2030
  */
1612
- ApproveName: string
1613
-
1614
- /**
2031
+ ApproveName: string;
2032
+
2033
+ /**
1615
2034
  * 当前签署人的状态
1616
2035
  注意:此字段可能返回 null,表示取不到有效值。
1617
2036
  */
1618
- ApproveStatus: string
1619
-
1620
- /**
2037
+ ApproveStatus: string;
2038
+
2039
+ /**
1621
2040
  * 签署人信息
1622
2041
  注意:此字段可能返回 null,表示取不到有效值。
1623
2042
  */
1624
- ApproveMessage: string
1625
-
1626
- /**
1627
- * 签署人签署时间
1628
- */
1629
- ApproveTime: number
1630
-
1631
- /**
2043
+ ApproveMessage: string;
2044
+
2045
+ /**
2046
+ * 签署人签署时间
2047
+ */
2048
+ ApproveTime: number;
2049
+
2050
+ /**
1632
2051
  * 参与者类型 (ORGANIZATION企业/PERSON个人)
1633
2052
  注意:此字段可能返回 null,表示取不到有效值。
1634
2053
  */
1635
- ApproveType: string
2054
+ ApproveType: string;
1636
2055
  }
1637
2056
 
1638
2057
  /**
1639
2058
  * 此结构体 (FlowInfo) 用于描述签署流程信息。
2059
+
2060
+ 【动态表格传参说明】
2061
+ 当模板的 ComponentType='DYNAMIC_TABLE'时(渠道版),FormField.ComponentValue需要传递json格式的字符串参数,用于确定表头&填充动态表格(支持内容的单元格合并)
2062
+ 输入示例
2063
+
2064
+ ```
2065
+ {
2066
+ "headers":[
2067
+ {
2068
+ "content":"head1"
2069
+ },
2070
+ {
2071
+ "content":"head2"
2072
+ },
2073
+ {
2074
+ "content":"head3"
2075
+ }
2076
+ ],
2077
+ "rowCount":3,
2078
+ "body":{
2079
+ "cells":[
2080
+ {
2081
+ "rowStart":1,
2082
+ "rowEnd":1,
2083
+ "columnStart":1,
2084
+ "columnEnd":1,
2085
+ "content":"123"
2086
+ },
2087
+ {
2088
+ "rowStart":2,
2089
+ "rowEnd":3,
2090
+ "columnStart":1,
2091
+ "columnEnd":2,
2092
+ "content":"456"
2093
+ },
2094
+ {
2095
+ "rowStart":3,
2096
+ "rowEnd":3,
2097
+ "columnStart":3,
2098
+ "columnEnd":3,
2099
+ "content":"789"
2100
+ }
2101
+ ]
2102
+ }
2103
+ }
2104
+
2105
+ ```
2106
+
2107
+ 表格参数说明
2108
+
2109
+ | 名称 | 类型 | 描述 |
2110
+ | ------------------- | ------- | ------------------------------------------------- |
2111
+ | headers | Array | 表头:不超过10列,不支持单元格合并,字数不超过100 |
2112
+ | rowCount | Integer | 表格内容最大行数 |
2113
+ | cells.N.rowStart | Integer | 单元格坐标:行起始index |
2114
+ | cells.N.rowEnd | Integer | 单元格坐标:行结束index |
2115
+ | cells.N.columnStart | Integer | 单元格坐标:列起始index |
2116
+ | cells.N.columnEnd | Integer | 单元格坐标:列结束index |
2117
+ | cells.N.content | String | 单元格内容,字数不超过100 |
2118
+
1640
2119
  */
1641
2120
  export interface FlowInfo {
1642
- /**
1643
- * 合同名字,最大长度200个字符
1644
- */
1645
- FlowName: string
1646
-
1647
- /**
1648
- * 签署截止时间戳,超过有效签署时间则该签署流程失败,默认一年
1649
- */
1650
- Deadline: number
1651
-
1652
- /**
1653
- * 模板ID
1654
- */
1655
- TemplateId?: string
1656
-
1657
- /**
1658
- * 多个签署人信息,最大支持50个签署方
1659
- */
1660
- FlowApprovers?: Array<FlowApproverInfo>
1661
-
1662
- /**
1663
- * 表单K-V对列表
1664
- */
1665
- FormFields?: Array<FormField>
1666
-
1667
- /**
1668
- * 回调地址,最大长度1000个字符
1669
- */
1670
- CallbackUrl?: string
1671
-
1672
- /**
1673
- * 合同类型,如:1. “劳务”;2. “销售”;3. “租赁”;4. “其他”,最大长度200个字符
1674
- */
1675
- FlowType?: string
1676
-
1677
- /**
1678
- * 合同描述,最大长度1000个字符
1679
- */
1680
- FlowDescription?: string
1681
-
1682
- /**
1683
- * 渠道的业务信息,最大长度1000个字符。发起自动签署时,需设置对应自动签署场景,目前仅支持场景:处方单-E_PRESCRIPTION_AUTO_SIGN
1684
- */
1685
- CustomerData?: string
1686
-
1687
- /**
1688
- * 合同显示的页卡模板,说明:只支持{合同名称}, {发起方企业}, {发起方姓名}, {签署方N企业}, {签署方N姓名},且N不能超过签署人的数量,N从1开始
1689
- */
1690
- CustomShowMap?: string
1691
-
1692
- /**
1693
- * 被抄送人的信息列表,抄送功能暂不开放
1694
- */
1695
- CcInfos?: Array<CcInfo>
2121
+
2122
+ /**
2123
+ * 合同名字,最大长度200个字符
2124
+ */
2125
+ FlowName: string;
2126
+
2127
+ /**
2128
+ * 签署截止时间戳,超过有效签署时间则该签署流程失败,默认一年
2129
+ */
2130
+ Deadline: number;
2131
+
2132
+ /**
2133
+ * 模板ID
2134
+ */
2135
+ TemplateId?: string;
2136
+
2137
+ /**
2138
+ * 多个签署人信息,最大支持50个签署方
2139
+ */
2140
+ FlowApprovers?: Array<FlowApproverInfo>;
2141
+
2142
+ /**
2143
+ * 表单K-V对列表
2144
+ */
2145
+ FormFields?: Array<FormField>;
2146
+
2147
+ /**
2148
+ * 回调地址,最大长度1000个字符
2149
+ */
2150
+ CallbackUrl?: string;
2151
+
2152
+ /**
2153
+ * 合同类型,如:1. “劳务”;2. “销售”;3. “租赁”;4. “其他”,最大长度200个字符
2154
+ */
2155
+ FlowType?: string;
2156
+
2157
+ /**
2158
+ * 合同描述,最大长度1000个字符
2159
+ */
2160
+ FlowDescription?: string;
2161
+
2162
+ /**
2163
+ * 渠道的业务信息,最大长度1000个字符。发起自动签署时,需设置对应自动签署场景,目前仅支持场景:处方单-E_PRESCRIPTION_AUTO_SIGN
2164
+ */
2165
+ CustomerData?: string;
2166
+
2167
+ /**
2168
+ * 合同显示的页卡模板,说明:只支持{合同名称}, {发起方企业}, {发起方姓名}, {签署方N企业}, {签署方N姓名},且N不能超过签署人的数量,N从1开始
2169
+ */
2170
+ CustomShowMap?: string;
2171
+
2172
+ /**
2173
+ * 被抄送人的信息列表,抄送功能暂不开放
2174
+ */
2175
+ CcInfos?: Array<CcInfo>;
2176
+
2177
+ /**
2178
+ * 发起方企业的签署人进行签署操作是否需要企业内部审批。
2179
+ 若设置为true,审核结果需通过接口 ChannelCreateFlowSignReview 通知电子签,审核通过后,发起方企业签署人方可进行签署操作,否则会阻塞其签署操作。
2180
+
2181
+ 注:企业可以通过此功能与企业内部的审批流程进行关联,支持手动、静默签署合同。
2182
+ */
2183
+ NeedSignReview?: boolean;
1696
2184
  }
1697
2185
 
1698
2186
  /**
1699
2187
  * 签署链接内容
1700
2188
  */
1701
2189
  export interface SignUrlInfo {
1702
- /**
2190
+
2191
+ /**
1703
2192
  * 签署链接
1704
2193
  注意:此字段可能返回 null,表示取不到有效值。
1705
2194
  */
1706
- SignUrl: string
1707
-
1708
- /**
2195
+ SignUrl: string;
2196
+
2197
+ /**
1709
2198
  * 链接失效时间,默认30分钟
1710
2199
  注意:此字段可能返回 null,表示取不到有效值。
1711
2200
  */
1712
- Deadline: number
1713
-
1714
- /**
2201
+ Deadline: number;
2202
+
2203
+ /**
1715
2204
  * 当流程为顺序签署此参数有效时,数字越小优先级越高,暂不支持并行签署 可选
1716
2205
  注意:此字段可能返回 null,表示取不到有效值。
1717
2206
  */
1718
- SignOrder: number
1719
-
1720
- /**
2207
+ SignOrder: number;
2208
+
2209
+ /**
1721
2210
  * 签署人编号
1722
2211
  注意:此字段可能返回 null,表示取不到有效值。
1723
2212
  */
1724
- SignId: string
1725
-
1726
- /**
2213
+ SignId: string;
2214
+
2215
+ /**
1727
2216
  * 自定义用户编号
1728
2217
  注意:此字段可能返回 null,表示取不到有效值。
1729
2218
  */
1730
- CustomUserId: string
1731
-
1732
- /**
2219
+ CustomUserId: string;
2220
+
2221
+ /**
1733
2222
  * 用户姓名
1734
2223
  注意:此字段可能返回 null,表示取不到有效值。
1735
2224
  */
1736
- Name: string
1737
-
1738
- /**
2225
+ Name: string;
2226
+
2227
+ /**
1739
2228
  * 用户手机号码
1740
2229
  注意:此字段可能返回 null,表示取不到有效值。
1741
2230
  */
1742
- Mobile: string
1743
-
1744
- /**
2231
+ Mobile: string;
2232
+
2233
+ /**
1745
2234
  * 签署参与者机构名字
1746
2235
  注意:此字段可能返回 null,表示取不到有效值。
1747
2236
  */
1748
- OrganizationName: string
1749
-
1750
- /**
2237
+ OrganizationName: string;
2238
+
2239
+ /**
1751
2240
  * 参与者类型:
1752
2241
  ORGANIZATION 企业经办人
1753
2242
  PERSON 自然人
1754
2243
  注意:此字段可能返回 null,表示取不到有效值。
1755
2244
  */
1756
- ApproverType: string
1757
-
1758
- /**
2245
+ ApproverType: string;
2246
+
2247
+ /**
1759
2248
  * 经办人身份证号
1760
2249
  注意:此字段可能返回 null,表示取不到有效值。
1761
2250
  */
1762
- IdCardNumber: string
1763
-
1764
- /**
2251
+ IdCardNumber: string;
2252
+
2253
+ /**
1765
2254
  * 签署链接对应流程Id
1766
2255
  注意:此字段可能返回 null,表示取不到有效值。
1767
2256
  */
1768
- FlowId: string
1769
-
1770
- /**
2257
+ FlowId: string;
2258
+
2259
+ /**
1771
2260
  * 企业经办人 用户在渠道的编号
1772
2261
  注意:此字段可能返回 null,表示取不到有效值。
1773
2262
  */
1774
- OpenId: string
2263
+ OpenId: string;
2264
+ }
2265
+
2266
+ /**
2267
+ * 复杂文档合成任务的任务信息
2268
+ */
2269
+ export interface TaskInfo {
2270
+
2271
+ /**
2272
+ * 合成任务Id,可以通过 ChannelGetTaskResultApi 接口获取任务信息
2273
+ 注意:此字段可能返回 null,表示取不到有效值。
2274
+ */
2275
+ TaskId: string;
2276
+
2277
+ /**
2278
+ * 任务状态:READY - 任务已完成;NOTREADY - 任务未完成;
2279
+ 注意:此字段可能返回 null,表示取不到有效值。
2280
+ */
2281
+ TaskStatus: string;
1775
2282
  }
1776
2283
 
1777
2284
  /**
1778
2285
  * 抄送信息
1779
2286
  */
1780
2287
  export interface CcInfo {
1781
- /**
1782
- * 被抄送人手机号,大陆11位手机号
1783
- */
1784
- Mobile?: string
2288
+
2289
+ /**
2290
+ * 被抄送人手机号,大陆11位手机号
2291
+ */
2292
+ Mobile?: string;
1785
2293
  }
1786
2294
 
1787
2295
  /**
1788
2296
  * ChannelCancelMultiFlowSignQRCode返回参数结构体
1789
2297
  */
1790
2298
  export interface ChannelCancelMultiFlowSignQRCodeResponse {
1791
- /**
1792
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1793
- */
1794
- RequestId?: string
2299
+
2300
+ /**
2301
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
2302
+ */
2303
+ RequestId?: string;
1795
2304
  }
1796
2305
 
1797
2306
  /**
1798
2307
  * DescribeFlowDetailInfo返回参数结构体
1799
2308
  */
1800
2309
  export interface DescribeFlowDetailInfoResponse {
1801
- /**
1802
- * 渠道侧应用号Id
1803
- */
1804
- ApplicationId: string
1805
-
1806
- /**
1807
- * 渠道侧企业第三方Id
1808
- */
1809
- ProxyOrganizationOpenId: string
1810
2310
 
1811
- /**
2311
+ /**
2312
+ * 渠道侧应用号Id
2313
+ */
2314
+ ApplicationId: string;
2315
+
2316
+ /**
2317
+ * 渠道侧企业第三方Id
2318
+ */
2319
+ ProxyOrganizationOpenId: string;
2320
+
2321
+ /**
1812
2322
  * 合同(签署流程)的具体详细描述信息
1813
2323
  注意:此字段可能返回 null,表示取不到有效值。
1814
2324
  */
1815
- FlowInfo: Array<FlowDetailInfo>
1816
-
1817
- /**
1818
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1819
- */
1820
- RequestId?: string
2325
+ FlowInfo: Array<FlowDetailInfo>;
2326
+
2327
+ /**
2328
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
2329
+ */
2330
+ RequestId?: string;
1821
2331
  }
2332
+