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