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