tencentcloud-sdk-nodejs-essbasic 4.0.476 → 4.0.477

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.
@@ -16,345 +16,397 @@
16
16
  */
17
17
 
18
18
  /**
19
- * 资源链接信息
19
+ * SyncProxyOrganization返回参数结构体
20
20
  */
21
- export interface ResourceUrlInfo {
21
+ export interface SyncProxyOrganizationResponse {
22
22
  /**
23
- * 资源链接地址,过期时间5分钟
24
- 注意:此字段可能返回 null,表示取不到有效值。
25
- */
26
- Url: string
23
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
24
+ */
25
+ RequestId?: string
26
+ }
27
+
28
+ /**
29
+ * ChannelCreateConvertTaskApi返回参数结构体
30
+ */
31
+ export interface ChannelCreateConvertTaskApiResponse {
32
+ /**
33
+ * 任务id
34
+ */
35
+ TaskId: string
27
36
 
28
37
  /**
29
- * 资源名称
38
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
39
+ */
40
+ RequestId?: string
41
+ }
42
+
43
+ /**
44
+ * ChannelBatchCancelFlows返回参数结构体
45
+ */
46
+ export interface ChannelBatchCancelFlowsResponse {
47
+ /**
48
+ * 签署流程批量撤销失败原因,错误信息与流程Id一一对应,如果部分流程不可撤销,不会返回错误信息,只会撤销可撤销流程
49
+ */
50
+ FailMessages: Array<string>
51
+
52
+ /**
53
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
54
+ */
55
+ RequestId?: string
56
+ }
57
+
58
+ /**
59
+ * 渠道版员工部门信息
60
+ */
61
+ export interface Department {
62
+ /**
63
+ * 部门id
30
64
  注意:此字段可能返回 null,表示取不到有效值。
31
65
  */
32
- Name: string
66
+ DepartmentId: string
33
67
 
34
68
  /**
35
- * 资源类型
69
+ * 部门名称
36
70
  注意:此字段可能返回 null,表示取不到有效值。
37
71
  */
38
- Type: string
72
+ DepartmentName: string
39
73
  }
40
74
 
41
75
  /**
42
- * 合同文件验签单个结果结构体
76
+ * ChannelCreateFlowSignReview请求参数结构体
43
77
  */
44
- export interface PdfVerifyResult {
78
+ export interface ChannelCreateFlowSignReviewRequest {
45
79
  /**
46
- * 验签结果
80
+ * 渠道应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 均必填。
47
81
  */
48
- VerifyResult: number
82
+ Agent: Agent
49
83
 
50
84
  /**
51
- * 签署平台
85
+ * 签署流程编号
52
86
  */
53
- SignPlatform: string
87
+ FlowId: string
54
88
 
55
89
  /**
56
- * 签署人名称
57
- */
58
- SignerName: string
90
+ * 企业内部审核结果
91
+ PASS: 通过
92
+ REJECT: 拒绝
93
+ SIGN_REJECT:拒签(流程结束)
94
+ */
95
+ ReviewType: string
59
96
 
60
97
  /**
61
- * 签署时间
62
- */
63
- SignTime: number
98
+ * 审核原因
99
+ 当ReviewType 是REJECT 时此字段必填,字符串长度不超过200
100
+ */
101
+ ReviewMessage?: string
102
+ }
64
103
 
104
+ /**
105
+ * 授权出错信息
106
+ */
107
+ export interface AuthFailMessage {
65
108
  /**
66
- * 签名算法
109
+ * 合作企业Id
67
110
  */
68
- SignAlgorithm: string
111
+ ProxyOrganizationOpenId: string
69
112
 
70
113
  /**
71
- * 签名证书序列号
114
+ * 出错信息
72
115
  */
73
- CertSn: string
116
+ Message: string
117
+ }
74
118
 
119
+ /**
120
+ * DescribeFlowDetailInfo请求参数结构体
121
+ */
122
+ export interface DescribeFlowDetailInfoRequest {
75
123
  /**
76
- * 证书起始时间
124
+ * 渠道应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 均必填。
77
125
  */
78
- CertNotBefore: number
126
+ Agent: Agent
79
127
 
80
128
  /**
81
- * 证书过期时间
82
- */
83
- CertNotAfter: number
129
+ * 合同(流程)编号数组,最多支持100个。
130
+ (备注:该参数和合同组编号必须二选一)
131
+ */
132
+ FlowIds?: Array<string>
84
133
 
85
134
  /**
86
- * 签名类型
135
+ * 操作者的信息
87
136
  */
88
- SignType: number
137
+ Operator?: UserInfo
89
138
 
90
139
  /**
91
- * 签名域横坐标
140
+ * 合同组编号(备注:该参数和合同(流程)编号数组必须二选一)
92
141
  */
93
- ComponentPosX: number
142
+ FlowGroupId?: string
143
+ }
94
144
 
145
+ /**
146
+ * UploadFiles请求参数结构体
147
+ */
148
+ export interface UploadFilesRequest {
95
149
  /**
96
- * 签名域纵坐标
150
+ * 应用相关信息,若是渠道版调用 appid 和proxyappid 必填
97
151
  */
98
- ComponentPosY: number
152
+ Agent: Agent
99
153
 
100
154
  /**
101
- * 签名域宽度
102
- */
103
- ComponentWidth: number
155
+ * 文件对应业务类型
156
+ 1. TEMPLATE - 模板; 文件类型:.pdf/.doc/.docx/.html
157
+ 2. DOCUMENT - 签署过程及签署后的合同文档/图片控件 文件类型:.pdf/.doc/.docx/.jpg/.png/.xls.xlsx/.html
158
+ */
159
+ BusinessType: string
104
160
 
105
161
  /**
106
- * 签名域高度
162
+ * 上传文件内容数组,最多支持20个文件
107
163
  */
108
- ComponentHeight: number
164
+ FileInfos?: Array<UploadFile>
109
165
 
110
166
  /**
111
- * 签名域所在页码
167
+ * 操作者的信息
112
168
  */
113
- ComponentPage: number
169
+ Operator?: UserInfo
114
170
  }
115
171
 
116
172
  /**
117
- * 创建签署流程签署人入参。
118
-
119
- 其中签署方FlowApproverInfo需要传递的参数
120
- 非单C、单B、B2C合同,ApproverType、RecipientId(模板发起合同时)必传,建议都传。其他身份标识
121
- 1-个人:Name、Mobile必传
122
- 2-渠道子客企业指定经办人:OpenId必传,OrgName必传、OrgOpenId必传;
123
- 3-渠道合作企业不指定经办人:(暂不支持)
124
- 4-非渠道合作企业:Name、Mobile必传,OrgName必传,且NotChannelOrganization=True。
125
-
126
- RecipientId参数:
127
- 从DescribeTemplates接口中,可以得到模板下的签署方Recipient列表,根据模板自定义的Rolename在此结构体中确定其RecipientId
173
+ * DescribeResourceUrlsByFlows请求参数结构体
128
174
  */
129
- export interface FlowApproverInfo {
175
+ export interface DescribeResourceUrlsByFlowsRequest {
130
176
  /**
131
- * 签署人姓名,最大长度50个字符
132
- */
133
- Name?: string
177
+ * 渠道应用相关信息。
178
+ 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 均必填。
179
+ */
180
+ Agent: Agent
134
181
 
135
182
  /**
136
- * 经办人身份证件类型
137
- 1.ID_CARD 居民身份证
138
- 2.HONGKONG_MACAO_AND_TAIWAN 港澳台居民居住证
139
- 3.HONGKONG_AND_MACAO 港澳居民来往内地通行证
140
- */
141
- IdCardType?: string
183
+ * 查询资源所对应的签署流程Id,最多支持50个
184
+ */
185
+ FlowIds?: Array<string>
142
186
 
143
187
  /**
144
- * 经办人证件号
188
+ * 操作者的信息
145
189
  */
146
- IdCardNumber?: string
190
+ Operator?: UserInfo
191
+ }
147
192
 
193
+ /**
194
+ * CreateSealByImage返回参数结构体
195
+ */
196
+ export interface CreateSealByImageResponse {
148
197
  /**
149
- * 签署人手机号,脱敏显示。大陆手机号为11位,暂不支持海外手机号。
198
+ * 印章id
150
199
  */
151
- Mobile?: string
200
+ SealId: string
152
201
 
153
202
  /**
154
- * 企业签署方工商营业执照上的企业名称,签署方为非发起方企业场景下必传,最大长度64个字符;
203
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
155
204
  */
156
- OrganizationName?: string
205
+ RequestId?: string
206
+ }
157
207
 
208
+ /**
209
+ * OperateChannelTemplate返回参数结构体
210
+ */
211
+ export interface OperateChannelTemplateResponse {
158
212
  /**
159
- * 指定签署人非渠道企业下员工,在ApproverType为ORGANIZATION时指定。
160
- 默认为false,即签署人位于同一个渠道应用号下;
213
+ * 腾讯电子签颁发给渠道的应用ID
214
+ 注意:此字段可能返回 null,表示取不到有效值。
161
215
  */
162
- NotChannelOrganization?: boolean
216
+ AppId: string
163
217
 
164
218
  /**
165
- * 用户侧第三方id,最大长度64个字符
166
- */
167
- OpenId?: string
219
+ * 渠道方模板库模板唯一标识
220
+ 注意:此字段可能返回 null,表示取不到有效值。
221
+ */
222
+ TemplateId: string
168
223
 
169
224
  /**
170
- * 企业签署方在同一渠道下的其他合作企业OpenId,签署方为非发起方企业场景下必传,最大长度64个字符;
171
- */
172
- OrganizationOpenId?: string
225
+ * 全部成功-"all-success",部分成功-"part-success", 全部失败-"fail"失败的会在FailMessageList中展示
226
+ 注意:此字段可能返回 null,表示取不到有效值。
227
+ */
228
+ OperateResult: string
173
229
 
174
230
  /**
175
- * 签署人类型,PERSON-个人;
176
- PERSON_AUTO_SIGN-个人自动签;
177
- ORGANIZATION-企业;
178
- ENTERPRISESERVER-企业静默签;
179
- 注:ENTERPRISESERVER 类型仅用于使用文件创建签署流程(ChannelCreateFlowByFiles)接口;
231
+ * 模板可见性, 全部可见-"all", 部分可见-"part"
232
+ 注意:此字段可能返回 null,表示取不到有效值。
180
233
  */
181
- ApproverType?: string
234
+ AuthTag: string
182
235
 
183
236
  /**
184
- * 签署流程签署人在模板中对应的签署人Id;在非单方签署、以及非B2C签署的场景下必传,用于指定当前签署方在签署流程中的位置;
185
- */
186
- RecipientId?: string
237
+ * 合作企业方第三方机构唯一标识数据
238
+ 注意:此字段可能返回 null,表示取不到有效值。
239
+ */
240
+ ProxyOrganizationOpenIds: Array<string>
187
241
 
188
242
  /**
189
- * 签署截止时间,默认一年
190
- */
191
- Deadline?: number
243
+ * 操作失败信息数组
244
+ 注意:此字段可能返回 null,表示取不到有效值。
245
+ */
246
+ FailMessageList: Array<AuthFailMessage>
192
247
 
193
248
  /**
194
- * 签署完回调url,最大长度1000个字符
249
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
195
250
  */
196
- CallbackUrl?: string
251
+ RequestId?: string
252
+ }
197
253
 
254
+ /**
255
+ * 合同组中每个子合同的发起信息
256
+ */
257
+ export interface FlowFileInfo {
198
258
  /**
199
- * 使用PDF文件直接发起合同时,签署人指定的签署控件
259
+ * 签署文件资源Id列表,目前仅支持单个文件
200
260
  */
201
- SignComponents?: Array<Component>
261
+ FileIds: Array<string>
202
262
 
203
263
  /**
204
- * 个人签署方指定签署控件类型,目前仅支持:OCR_ESIGN(AI智慧手写签名)
264
+ * 签署流程名称,长度不超过200个字符
205
265
  */
206
- ComponentLimitType?: Array<string>
266
+ FlowName: string
207
267
 
208
268
  /**
209
- * 合同的强制预览时间:3~300s,未指定则按合同页数计算
269
+ * 签署流程签约方列表,最多不超过5个参与方
210
270
  */
211
- PreReadTime?: number
271
+ FlowApprovers: Array<FlowApproverInfo>
212
272
 
213
273
  /**
214
- * 签署完前端跳转的url,暂未使用
274
+ * 签署流程截止时间,十位数时间戳,最大值为33162419560,即3020年
215
275
  */
216
- JumpUrl?: string
276
+ Deadline?: number
217
277
 
218
278
  /**
219
- * 签署人个性化能力值
279
+ * 签署流程的描述,长度不超过1000个字符
220
280
  */
221
- ApproverOption?: ApproverOption
281
+ FlowDescription?: string
222
282
 
223
283
  /**
224
- * 当前签署方进行签署操作是否需要企业内部审批,true 则为需要
284
+ * 签署流程的类型,长度不超过255个字符
225
285
  */
226
- ApproverNeedSignReview?: boolean
227
- }
286
+ FlowType?: string
228
287
 
229
- /**
230
- * ChannelCreateConvertTaskApi返回参数结构体
231
- */
232
- export interface ChannelCreateConvertTaskApiResponse {
233
288
  /**
234
- * 任务id
289
+ * 签署流程回调地址,长度不超过255个字符
235
290
  */
236
- TaskId: string
291
+ CallbackUrl?: string
237
292
 
238
293
  /**
239
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
294
+ * 渠道的业务信息,最大长度1000个字符。发起自动签署时,需设置对应自动签署场景,目前仅支持场景:处方单-E_PRESCRIPTION_AUTO_SIGN
240
295
  */
241
- RequestId?: string
242
- }
296
+ CustomerData?: string
243
297
 
244
- /**
245
- * OperateChannelTemplate请求参数结构体
246
- */
247
- export interface OperateChannelTemplateRequest {
248
298
  /**
249
- * 渠道应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 均必填。
299
+ * 合同签署顺序类型(无序签,顺序签),默认为false,即有序签署
250
300
  */
251
- Agent: Agent
301
+ Unordered?: boolean
252
302
 
253
303
  /**
254
- * 操作类型,查询:"SELECT",删除:"DELETE",更新:"UPDATE"
304
+ * 合同显示的页卡模板,说明:只支持{合同名称}, {发起方企业}, {发起方姓名}, {签署方N企业}, {签署方N姓名},且N不能超过签署人的数量,N从1开始
255
305
  */
256
- OperateType: string
306
+ CustomShowMap?: string
257
307
 
258
308
  /**
259
- * 渠道方模板库模板唯一标识
309
+ * 本企业(发起方企业)是否需要签署审批
260
310
  */
261
- TemplateId: string
311
+ NeedSignReview?: boolean
312
+ }
262
313
 
314
+ /**
315
+ * CreateConsoleLoginUrl返回参数结构体
316
+ */
317
+ export interface CreateConsoleLoginUrlResponse {
263
318
  /**
264
- * 合作企业方第三方机构唯一标识数据,支持多个, 用","进行分隔
265
- */
266
- ProxyOrganizationOpenIds?: string
319
+ * 子客Web控制台url,此链接5分钟内有效,且只能访问一次。同时需要注意:
320
+ 1. 此链接仅单次有效,使用后需要再次创建新的链接(部分聊天软件,如企业微信默认会对链接进行解析,此时需要使用类似“代码片段”的方式或者放到txt文件里发送链接);
321
+ 2. 创建的链接应避免被转义,如:&被转义为\u0026;如使用Postman请求后,请选择响应类型为 JSON,否则链接将被转义
322
+ */
323
+ ConsoleUrl: string
267
324
 
268
325
  /**
269
- * 模板可见性, 全部可见-"all", 部分可见-"part"
326
+ * 渠道子客企业是否已开通腾讯电子签
270
327
  */
271
- AuthTag?: string
328
+ IsActivated: boolean
272
329
 
273
330
  /**
274
- * 操作者的信息
331
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
275
332
  */
276
- Operator?: UserInfo
333
+ RequestId?: string
277
334
  }
278
335
 
279
336
  /**
280
- * 此结构体 (TemplateInfo) 用于描述模板的信息。
337
+ * SyncProxyOrganization请求参数结构体
281
338
  */
282
- export interface TemplateInfo {
283
- /**
284
- * 模板ID
285
- */
286
- TemplateId: string
287
-
339
+ export interface SyncProxyOrganizationRequest {
288
340
  /**
289
- * 模板名字
290
- */
291
- TemplateName: string
341
+ * 应用信息
342
+ 此接口Agent.AppId、Agent.ProxyOrganizationOpenId必填
343
+ */
344
+ Agent: Agent
292
345
 
293
346
  /**
294
- * 模板描述信息
347
+ * 渠道侧合作企业名称,最大长度64个字符
295
348
  */
296
- Description: string
349
+ ProxyOrganizationName: string
297
350
 
298
351
  /**
299
- * 模板控件信息结构
352
+ * 营业执照正面照(PNG或JPG) base64格式, 大小不超过5M
300
353
  */
301
- Components: Array<Component>
354
+ BusinessLicense?: string
302
355
 
303
356
  /**
304
- * 签署区模板信息结构
357
+ * 渠道侧合作企业统一社会信用代码,最大长度200个字符
305
358
  */
306
- SignComponents: Array<Component>
359
+ UniformSocialCreditCode?: string
307
360
 
308
361
  /**
309
- * 模板中的流程参与人信息
362
+ * 操作者的信息
310
363
  */
311
- Recipients: Array<Recipient>
364
+ Operator?: UserInfo
365
+ }
312
366
 
367
+ /**
368
+ * CreateSealByImage请求参数结构体
369
+ */
370
+ export interface CreateSealByImageRequest {
313
371
  /**
314
- * 模板类型:1-静默签;3-普通模板
372
+ * 渠道应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 均必填。
315
373
  */
316
- TemplateType: number
374
+ Agent: Agent
317
375
 
318
376
  /**
319
- * 是否是发起人 ,已弃用
377
+ * 印章名称,最大长度不超过30字符
320
378
  */
321
- IsPromoter: boolean
379
+ SealName: string
322
380
 
323
381
  /**
324
- * 模板的创建者信息
382
+ * 印章图片base64
325
383
  */
326
- Creator: string
384
+ SealImage: string
327
385
 
328
386
  /**
329
- * 模板创建的时间戳(精确到秒)
387
+ * 操作者的信息
330
388
  */
331
- CreatedOn: number
389
+ Operator?: UserInfo
332
390
  }
333
391
 
334
392
  /**
335
- * ChannelDescribeEmployees请求参数结构体
393
+ * PrepareFlows请求参数结构体
336
394
  */
337
- export interface ChannelDescribeEmployeesRequest {
338
- /**
339
- * 返回最大数量,最大为20
340
- */
341
- Limit: number
342
-
395
+ export interface PrepareFlowsRequest {
343
396
  /**
344
397
  * 渠道应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 均必填。
345
398
  */
346
- Agent?: Agent
399
+ Agent: Agent
347
400
 
348
401
  /**
349
- * 查询过滤实名用户,Key为Status,Values为["IsVerified"]
350
- 根据第三方系统openId过滤查询员工时,Key为StaffOpenId,Values为["OpenId","OpenId",...]
351
- */
352
- Filters?: Array<Filter>
402
+ * 多个合同(签署流程)信息,最大支持20个签署流程。
403
+ */
404
+ FlowInfos: Array<FlowInfo>
353
405
 
354
406
  /**
355
- * 偏移量,默认为0,最大为20000
407
+ * 操作完成后的跳转地址,最大长度200
356
408
  */
357
- Offset?: number
409
+ JumpUrl: string
358
410
 
359
411
  /**
360
412
  * 操作者的信息
@@ -363,9 +415,9 @@ export interface ChannelDescribeEmployeesRequest {
363
415
  }
364
416
 
365
417
  /**
366
- * SyncProxyOrganization返回参数结构体
418
+ * ChannelCancelFlow返回参数结构体
367
419
  */
368
- export interface SyncProxyOrganizationResponse {
420
+ export interface ChannelCancelFlowResponse {
369
421
  /**
370
422
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
371
423
  */
@@ -373,594 +425,561 @@ export interface SyncProxyOrganizationResponse {
373
425
  }
374
426
 
375
427
  /**
376
- * ChannelCreateFlowGroupByFiles返回参数结构体
428
+ * 签署流程下载信息
377
429
  */
378
- export interface ChannelCreateFlowGroupByFilesResponse {
379
- /**
380
- * 合同组ID
381
- 注意:此字段可能返回 null,表示取不到有效值。
382
- */
383
- FlowGroupId: string
384
-
430
+ export interface DownloadFlowInfo {
385
431
  /**
386
- * 子合同ID列表
387
- 注意:此字段可能返回 null,表示取不到有效值。
388
- */
389
- FlowIds: Array<string>
432
+ * 文件夹名称
433
+ */
434
+ FileName: string
390
435
 
391
436
  /**
392
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
437
+ * 签署流程的标识数组
393
438
  */
394
- RequestId?: string
439
+ FlowIdList: Array<string>
395
440
  }
396
441
 
397
442
  /**
398
- * GetDownloadFlowUrl返回参数结构体
443
+ * ChannelCreateConvertTaskApi请求参数结构体
399
444
  */
400
- export interface GetDownloadFlowUrlResponse {
401
- /**
402
- * 合同(流程)下载地址
403
- */
404
- DownLoadUrl: string
405
-
445
+ export interface ChannelCreateConvertTaskApiRequest {
406
446
  /**
407
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
447
+ * 渠道应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 均必填。
408
448
  */
409
- RequestId?: string
410
- }
449
+ Agent: Agent
411
450
 
412
- /**
413
- * DescribeTemplates返回参数结构体
414
- */
415
- export interface DescribeTemplatesResponse {
416
451
  /**
417
- * 模板详情
452
+ * 资源类型 取值范围doc,docx,html,excel之一
418
453
  */
419
- Templates: Array<TemplateInfo>
454
+ ResourceType: string
420
455
 
421
456
  /**
422
- * 查询总数
457
+ * 资源名称,长度限制为256字符
423
458
  */
424
- TotalCount: number
459
+ ResourceName: string
425
460
 
426
461
  /**
427
- * 查询数量
462
+ * 资源Id,通过UploadFiles获取
428
463
  */
429
- Limit: number
464
+ ResourceId: string
430
465
 
431
466
  /**
432
- * 查询起始偏移
467
+ * 操作者信息
433
468
  */
434
- Offset: number
469
+ Operator?: UserInfo
435
470
 
436
471
  /**
437
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
472
+ * 暂未开放
438
473
  */
439
- RequestId?: string
474
+ Organization?: OrganizationInfo
440
475
  }
441
476
 
442
477
  /**
443
- * DescribeResourceUrlsByFlows返回参数结构体
478
+ * ChannelCreateFlowByFiles请求参数结构体
444
479
  */
445
- export interface DescribeResourceUrlsByFlowsResponse {
480
+ export interface ChannelCreateFlowByFilesRequest {
446
481
  /**
447
- * 签署流程资源对应链接信息
482
+ * 渠道应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 均必填。
448
483
  */
449
- FlowResourceUrlInfos: Array<FlowResourceUrlInfo>
484
+ Agent?: Agent
450
485
 
451
486
  /**
452
- * 创建消息,对应多个合同ID,
453
- 成功为“”,创建失败则对应失败消息
454
- */
455
- ErrorMessages: Array<string>
487
+ * 签署流程名称,长度不超过200个字符
488
+ */
489
+ FlowName?: string
456
490
 
457
491
  /**
458
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
492
+ * 签署流程签约方列表,最多不超过5个参与方
459
493
  */
460
- RequestId?: string
461
- }
494
+ FlowApprovers?: Array<FlowApproverInfo>
462
495
 
463
- /**
464
- * ChannelCreateMultiFlowSignQRCode返回参数结构体
465
- */
466
- export interface ChannelCreateMultiFlowSignQRCodeResponse {
467
496
  /**
468
- * 签署二维码对象
497
+ * 签署文件资源Id列表,目前仅支持单个文件
469
498
  */
470
- QrCode: SignQrCode
499
+ FileIds?: Array<string>
471
500
 
472
501
  /**
473
- * 签署链接对象
502
+ * 签署文件中的发起方的填写控件,需要在发起的时候进行填充
474
503
  */
475
- SignUrls: SignUrl
504
+ Components?: Array<Component>
476
505
 
477
506
  /**
478
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
507
+ * 签署流程截止时间,十位数时间戳,最大值为33162419560,即3020年
479
508
  */
480
- RequestId?: string
481
- }
509
+ Deadline?: number
482
510
 
483
- /**
484
- * 签署人个性化能力信息
485
- */
486
- export interface ApproverOption {
487
511
  /**
488
- * 是否隐藏一键签署 false-不隐藏,默认 true-隐藏
512
+ * 签署流程回调地址,长度不超过255个字符
489
513
  */
490
- HideOneKeySign?: boolean
491
- }
514
+ CallbackUrl?: string
492
515
 
493
- /**
494
- * 签署参与者信息
495
- */
496
- export interface Recipient {
497
516
  /**
498
- * 签署人唯一标识
517
+ * 合同签署顺序类型(无序签,顺序签),默认为false,即有序签署。有序签署时以传入FlowApprovers数组的顺序作为签署顺序
499
518
  */
500
- RecipientId?: string
519
+ Unordered?: boolean
501
520
 
502
521
  /**
503
- * 签署方类型:ENTERPRISE-企业INDIVIDUAL-自然人
522
+ * 签署流程的类型,长度不超过255个字符
504
523
  */
505
- RecipientType?: string
524
+ FlowType?: string
506
525
 
507
526
  /**
508
- * 描述
527
+ * 签署流程的描述,长度不超过1000个字符
509
528
  */
510
- Description?: string
529
+ FlowDescription?: string
511
530
 
512
531
  /**
513
- * 签署方备注信息
532
+ * 合同显示的页卡模板,说明:只支持{合同名称}, {发起方企业}, {发起方姓名}, {签署方N企业}, {签署方N姓名},且N不能超过签署人的数量,N从1开始
514
533
  */
515
- RoleName?: string
534
+ CustomShowMap?: string
516
535
 
517
536
  /**
518
- * 是否需要校验
537
+ * 渠道的业务信息,最大长度1000个字符。发起自动签署时,需设置对应自动签署场景,目前仅支持场景:处方单-E_PRESCRIPTION_AUTO_SIGN
519
538
  */
520
- RequireValidation?: boolean
539
+ CustomerData?: string
521
540
 
522
541
  /**
523
- * 是否必须填写
542
+ * 发起方企业的签署人进行签署操作是否需要企业内部审批。 若设置为true,审核结果需通过接口 ChannelCreateFlowSignReview 通知电子签,审核通过后,发起方企业签署人方可进行签署操作,否则会阻塞其签署操作。 注:企业可以通过此功能与企业内部的审批流程进行关联,支持手动、静默签署合同。
524
543
  */
525
- RequireSign?: boolean
544
+ NeedSignReview?: boolean
526
545
 
527
546
  /**
528
- * 签署类型
547
+ * 操作者的信息
529
548
  */
530
- SignType?: number
549
+ Operator?: UserInfo
531
550
 
532
551
  /**
533
- * 签署顺序:数字越小优先级越高
552
+ * 签署人校验方式
553
+ VerifyCheck: 人脸识别(默认)
554
+ MobileCheck:手机号验证
555
+ 参数说明:可选人脸识别或手机号验证两种方式,若选择后者,未实名个人签署方在签署合同时,无需经过实名认证和意愿确认两次人脸识别,该能力仅适用于个人签署方。
556
+ */
557
+ ApproverVerifyType?: string
558
+ }
559
+
560
+ /**
561
+ * 应用相关信息
562
+ */
563
+ export interface Agent {
564
+ /**
565
+ * 腾讯电子签颁发给渠道的应用ID,32位字符串
534
566
  */
535
- RoutingOrder?: number
567
+ AppId: string
536
568
 
537
569
  /**
538
- * 是否是发起方
570
+ * 渠道/平台合作企业的企业ID,最大64位字符串
539
571
  */
540
- IsPromoter?: boolean
541
- }
572
+ ProxyOrganizationOpenId?: string
542
573
 
543
- /**
544
- * 渠道版员工部门信息
545
- */
546
- export interface Department {
547
574
  /**
548
- * 部门id
549
- 注意:此字段可能返回 null,表示取不到有效值。
550
- */
551
- DepartmentId: string
575
+ * 渠道/平台合作企业经办人(操作员)
576
+ */
577
+ ProxyOperator?: UserInfo
552
578
 
553
579
  /**
554
- * 部门名称
555
- 注意:此字段可能返回 null,表示取不到有效值。
556
- */
557
- DepartmentName: string
580
+ * 腾讯电子签颁发给渠道侧合作企业的应用ID
581
+ */
582
+ ProxyAppId?: string
583
+
584
+ /**
585
+ * 内部参数,腾讯电子签颁发给渠道侧合作企业的企业ID,不需要传
586
+ */
587
+ ProxyOrganizationId?: string
558
588
  }
559
589
 
560
590
  /**
561
- * OperateChannelTemplate返回参数结构体
591
+ * 签署人的流程信息明细
562
592
  */
563
- export interface OperateChannelTemplateResponse {
593
+ export interface FlowApproverDetail {
564
594
  /**
565
- * 腾讯电子签颁发给渠道的应用ID
566
- 注意:此字段可能返回 null,表示取不到有效值。
567
- */
568
- AppId: string
595
+ * 模板配置时候的签署人id,与控件绑定
596
+ */
597
+ ReceiptId: string
569
598
 
570
599
  /**
571
- * 渠道方模板库模板唯一标识
600
+ * 渠道侧企业的第三方id
572
601
  注意:此字段可能返回 null,表示取不到有效值。
573
602
  */
574
- TemplateId: string
603
+ ProxyOrganizationOpenId: string
575
604
 
576
605
  /**
577
- * 全部成功-"all-success",部分成功-"part-success", 全部失败-"fail"失败的会在FailMessageList中展示
606
+ * 渠道侧企业操作人的第三方id
607
+ */
608
+ ProxyOperatorOpenId: string
609
+
610
+ /**
611
+ * 渠道侧企业名称
612
+ */
613
+ ProxyOrganizationName: string
614
+
615
+ /**
616
+ * 签署人手机号
617
+ */
618
+ Mobile: string
619
+
620
+ /**
621
+ * 签署人签署顺序
622
+ */
623
+ SignOrder: number
624
+
625
+ /**
626
+ * 签署人姓名
578
627
  注意:此字段可能返回 null,表示取不到有效值。
579
628
  */
580
- OperateResult: string
629
+ ApproveName: string
581
630
 
582
631
  /**
583
- * 模板可见性, 全部可见-"all", 部分可见-"part"
632
+ * 当前签署人的状态
584
633
  注意:此字段可能返回 null,表示取不到有效值。
585
634
  */
586
- AuthTag: string
635
+ ApproveStatus: string
587
636
 
588
637
  /**
589
- * 合作企业方第三方机构唯一标识数据
638
+ * 签署人信息
590
639
  注意:此字段可能返回 null,表示取不到有效值。
591
640
  */
592
- ProxyOrganizationOpenIds: Array<string>
641
+ ApproveMessage: string
593
642
 
594
643
  /**
595
- * 操作失败信息数组
644
+ * 签署人签署时间
645
+ */
646
+ ApproveTime: number
647
+
648
+ /**
649
+ * 参与者类型 (ORGANIZATION企业/PERSON个人)
596
650
  注意:此字段可能返回 null,表示取不到有效值。
597
651
  */
598
- FailMessageList: Array<AuthFailMessage>
652
+ ApproveType: string
653
+ }
599
654
 
655
+ /**
656
+ * ChannelCreateFlowGroupByFiles请求参数结构体
657
+ */
658
+ export interface ChannelCreateFlowGroupByFilesRequest {
600
659
  /**
601
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
660
+ * 每个子合同的发起所需的信息,数量限制2-100
602
661
  */
603
- RequestId?: string
662
+ FlowFileInfos: Array<FlowFileInfo>
663
+
664
+ /**
665
+ * 合同组名称,长度不超过200个字符
666
+ */
667
+ FlowGroupName: string
668
+
669
+ /**
670
+ * 渠道应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 均必填。
671
+ */
672
+ Agent?: Agent
673
+
674
+ /**
675
+ * 操作者的信息
676
+ */
677
+ Operator?: UserInfo
604
678
  }
605
679
 
606
680
  /**
607
- * 渠道版员工角色信息
681
+ * 复杂文档合成任务的任务信息
608
682
  */
609
- export interface StaffRole {
683
+ export interface TaskInfo {
610
684
  /**
611
- * 角色id
685
+ * 合成任务Id,可以通过 ChannelGetTaskResultApi 接口获取任务信息
612
686
  注意:此字段可能返回 null,表示取不到有效值。
613
687
  */
614
- RoleId: string
688
+ TaskId: string
615
689
 
616
690
  /**
617
- * 角色名称
691
+ * 任务状态:READY - 任务已完成;NOTREADY - 任务未完成;
618
692
  注意:此字段可能返回 null,表示取不到有效值。
619
693
  */
620
- RoleName: string
694
+ TaskStatus: string
621
695
  }
622
696
 
623
697
  /**
624
- * CreateSignUrls返回参数结构体
698
+ * 资源链接信息
625
699
  */
626
- export interface CreateSignUrlsResponse {
700
+ export interface ResourceUrlInfo {
627
701
  /**
628
- * 签署参与者签署H5链接信息数组
629
- */
630
- SignUrlInfos: Array<SignUrlInfo>
702
+ * 资源链接地址,过期时间5分钟
703
+ 注意:此字段可能返回 null,表示取不到有效值。
704
+ */
705
+ Url: string
631
706
 
632
707
  /**
633
- * 生成失败时的错误信息,成功返回”“,顺序和出参SignUrlInfos保持一致
634
- */
635
- ErrorMessages: Array<string>
708
+ * 资源名称
709
+ 注意:此字段可能返回 null,表示取不到有效值。
710
+ */
711
+ Name: string
636
712
 
637
713
  /**
638
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
639
- */
640
- RequestId?: string
714
+ * 资源类型
715
+ 注意:此字段可能返回 null,表示取不到有效值。
716
+ */
717
+ Type: string
641
718
  }
642
719
 
643
720
  /**
644
- * CreateSignUrls请求参数结构体
721
+ * 创建签署流程签署人入参。
722
+
723
+ 其中签署方FlowApproverInfo需要传递的参数
724
+ 非单C、单B、B2C合同,ApproverType、RecipientId(模板发起合同时)必传,建议都传。其他身份标识
725
+ 1-个人:Name、Mobile必传
726
+ 2-渠道子客企业指定经办人:OpenId必传,OrgName必传、OrgOpenId必传;
727
+ 3-渠道合作企业不指定经办人:(暂不支持)
728
+ 4-非渠道合作企业:Name、Mobile必传,OrgName必传,且NotChannelOrganization=True。
729
+
730
+ RecipientId参数:
731
+ 从DescribeTemplates接口中,可以得到模板下的签署方Recipient列表,根据模板自定义的Rolename在此结构体中确定其RecipientId
645
732
  */
646
- export interface CreateSignUrlsRequest {
733
+ export interface FlowApproverInfo {
647
734
  /**
648
- * 渠道应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 均必填。
735
+ * 签署人姓名,最大长度50个字符
649
736
  */
650
- Agent: Agent
737
+ Name?: string
651
738
 
652
739
  /**
653
- * 签署流程编号数组,最多支持100个。(备注:该参数和合同组编号必须二选一)
740
+ * 经办人身份证件类型
741
+ 1.ID_CARD 居民身份证
742
+ 2.HONGKONG_MACAO_AND_TAIWAN 港澳台居民居住证
743
+ 3.HONGKONG_AND_MACAO 港澳居民来往内地通行证
744
+ */
745
+ IdCardType?: string
746
+
747
+ /**
748
+ * 经办人证件号
654
749
  */
655
- FlowIds?: Array<string>
750
+ IdCardNumber?: string
656
751
 
657
752
  /**
658
- * 合同组编号(备注:该参数和合同(流程)编号数组必须二选一)
753
+ * 签署人手机号,脱敏显示。大陆手机号为11位,暂不支持海外手机号。
659
754
  */
660
- FlowGroupId?: string
755
+ Mobile?: string
661
756
 
662
757
  /**
663
- * 签署链接类型:“WEIXINAPP”-短链直接跳小程序;“CHANNEL”-跳转H5页面;“APP”-第三方APP或小程序跳转电子签小程序;"LONGURL2WEIXINAPP"-长链接跳转小程序;默认“WEIXINAPP”类型,即跳转至小程序;
758
+ * 企业签署方工商营业执照上的企业名称,签署方为非发起方企业场景下必传,最大长度64个字符;
664
759
  */
665
- Endpoint?: string
760
+ OrganizationName?: string
666
761
 
667
762
  /**
668
- * 签署链接生成类型,默认是 "ALL";
669
- "ALL":全部签署方签署链接,此时不会给自动签署的签署方创建签署链接;
670
- "CHANNEL":渠道合作企业;
671
- "NOT_CHANNEL":非渠道合作企业;
672
- "PERSON":个人;
673
- "FOLLOWER":关注方,目前是合同抄送方;
763
+ * 指定签署人非渠道企业下员工,在ApproverType为ORGANIZATION时指定。
764
+ 默认为false,即签署人位于同一个渠道应用号下;
674
765
  */
675
- GenerateType?: string
766
+ NotChannelOrganization?: boolean
676
767
 
677
768
  /**
678
- * 非渠道合作企业参与方的企业名称,GenerateType为"NOT_CHANNEL"时必填
769
+ * 用户侧第三方id,最大长度64个字符
679
770
  */
680
- OrganizationName?: string
771
+ OpenId?: string
681
772
 
682
773
  /**
683
- * 参与人姓名,GenerateType为"PERSON"时必填
774
+ * 企业签署方在同一渠道下的其他合作企业OpenId,签署方为非发起方企业场景下必传,最大长度64个字符;
684
775
  */
685
- Name?: string
776
+ OrganizationOpenId?: string
686
777
 
687
778
  /**
688
- * 参与人手机号;
689
- GenerateType为"PERSON"或"FOLLOWER"时必填
779
+ * 签署人类型,PERSON-个人;
780
+ PERSON_AUTO_SIGN-个人自动签;
781
+ ORGANIZATION-企业;
782
+ ENTERPRISESERVER-企业静默签;
783
+ 注:ENTERPRISESERVER 类型仅用于使用文件创建签署流程(ChannelCreateFlowByFiles)接口;
690
784
  */
691
- Mobile?: string
785
+ ApproverType?: string
692
786
 
693
787
  /**
694
- * 渠道合作企业的企业Id,GenerateType为"CHANNEL"时必填
788
+ * 签署流程签署人在模板中对应的签署人Id;在非单方签署、以及非B2C签署的场景下必传,用于指定当前签署方在签署流程中的位置;
695
789
  */
696
- OrganizationOpenId?: string
697
-
698
- /**
699
- * 渠道合作企业参与人OpenId,GenerateType为"CHANNEL"时可用,指定到具体参与人
700
- */
701
- OpenId?: string
702
-
703
- /**
704
- * Endpoint为"APP" 类型的签署链接,可以设置此值;支持调用方小程序打开签署链接,在电子签小程序完成签署后自动回跳至调用方小程序
705
- */
706
- AutoJumpBack?: boolean
707
-
708
- /**
709
- * 签署完之后的H5页面的跳转链接,针对Endpoint为CHANNEL时有效,最大长度1000个字符。
710
- */
711
- JumpUrl?: string
712
-
713
- /**
714
- * 操作者的信息
715
- */
716
- Operator?: UserInfo
717
- }
718
-
719
- /**
720
- * ChannelCreateMultiFlowSignQRCode请求参数结构体
721
- */
722
- export interface ChannelCreateMultiFlowSignQRCodeRequest {
723
- /**
724
- * 渠道应用相关信息。
725
- 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 必填。
726
- */
727
- Agent: Agent
790
+ RecipientId?: string
728
791
 
729
792
  /**
730
- * 模版ID
793
+ * 签署截止时间,默认一年
731
794
  */
732
- TemplateId: string
795
+ Deadline?: number
733
796
 
734
797
  /**
735
- * 签署流程名称,最大长度200个字符。
798
+ * 签署完回调url,最大长度1000个字符
736
799
  */
737
- FlowName: string
800
+ CallbackUrl?: string
738
801
 
739
802
  /**
740
- * 最大可发起签署流程份数,默认5份;发起签署流程数量超过此上限后,二维码自动失效。
803
+ * 使用PDF文件直接发起合同时,签署人指定的签署控件
741
804
  */
742
- MaxFlowNum?: number
805
+ SignComponents?: Array<Component>
743
806
 
744
807
  /**
745
- * 签署流程有效天数 默认7天 最高设置不超过30天
808
+ * 个人签署方指定签署控件类型,目前仅支持:OCR_ESIGN(AI智慧手写签名)
746
809
  */
747
- FlowEffectiveDay?: number
810
+ ComponentLimitType?: Array<string>
748
811
 
749
812
  /**
750
- * 二维码有效天数 默认7天 最高设置不超过90天
813
+ * 合同的强制预览时间:3~300s,未指定则按合同页数计算
751
814
  */
752
- QrEffectiveDay?: number
815
+ PreReadTime?: number
753
816
 
754
817
  /**
755
- * 限制二维码用户条件
818
+ * 签署完前端跳转的url,暂未使用
756
819
  */
757
- Restrictions?: Array<ApproverRestriction>
758
-
759
- /**
760
- * 回调地址,最大长度1000个字符
761
- 不传默认使用渠道应用号配置的回调地址
762
- 回调时机:用户通过签署二维码发起合同时,企业额度不足导致失败
763
- */
764
- CallbackUrl?: string
820
+ JumpUrl?: string
765
821
 
766
822
  /**
767
- * 用户信息
823
+ * 签署人个性化能力值
768
824
  */
769
- Operator?: UserInfo
825
+ ApproverOption?: ApproverOption
770
826
 
771
827
  /**
772
- * 限制二维码用户条件(已弃用)
828
+ * 当前签署方进行签署操作是否需要企业内部审批,true 则为需要
773
829
  */
774
- ApproverRestrictions?: ApproverRestriction
830
+ ApproverNeedSignReview?: boolean
775
831
  }
776
832
 
777
833
  /**
778
- * 授权出错信息
834
+ * PrepareFlows返回参数结构体
779
835
  */
780
- export interface AuthFailMessage {
836
+ export interface PrepareFlowsResponse {
781
837
  /**
782
- * 合作企业Id
838
+ * 待发起文件确认页
783
839
  */
784
- ProxyOrganizationOpenId: string
840
+ ConfirmUrl: string
785
841
 
786
842
  /**
787
- * 出错信息
843
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
788
844
  */
789
- Message: string
845
+ RequestId?: string
790
846
  }
791
847
 
792
848
  /**
793
- * DescribeFlowDetailInfo请求参数结构体
849
+ * 此结构体 (TemplateInfo) 用于描述模板的信息。
794
850
  */
795
- export interface DescribeFlowDetailInfoRequest {
851
+ export interface TemplateInfo {
796
852
  /**
797
- * 渠道应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 均必填。
853
+ * 模板ID
798
854
  */
799
- Agent: Agent
855
+ TemplateId: string
800
856
 
801
857
  /**
802
- * 合同(流程)编号数组,最多支持100个。
803
- (备注:该参数和合同组编号必须二选一)
804
- */
805
- FlowIds?: Array<string>
858
+ * 模板名字
859
+ */
860
+ TemplateName: string
806
861
 
807
862
  /**
808
- * 操作者的信息
863
+ * 模板描述信息
809
864
  */
810
- Operator?: UserInfo
865
+ Description: string
811
866
 
812
867
  /**
813
- * 合同组编号(备注:该参数和合同(流程)编号数组必须二选一)
868
+ * 模板控件信息结构
814
869
  */
815
- FlowGroupId?: string
816
- }
870
+ Components: Array<Component>
817
871
 
818
- /**
819
- * ChannelGetTaskResultApi返回参数结构体
820
- */
821
- export interface ChannelGetTaskResultApiResponse {
822
872
  /**
823
- * 任务Id
873
+ * 签署区模板信息结构
824
874
  */
825
- TaskId: string
875
+ SignComponents: Array<Component>
826
876
 
827
877
  /**
828
- * 任务状态,需要关注的状态
829
- 0 :NeedTranform - 任务已提交
830
- 4 :Processing - 文档转换中
831
- 8 :TaskEnd - 任务处理完成
832
- -2 :DownloadFailed - 下载失败
833
- -6 :ProcessFailed - 转换失败
834
- -13:ProcessTimeout - 转换文件超时
835
- */
836
- TaskStatus: number
878
+ * 模板中的流程参与人信息
879
+ */
880
+ Recipients: Array<Recipient>
837
881
 
838
882
  /**
839
- * 状态描述,需要关注的状态
840
- NeedTranform - 任务已提交
841
- Processing - 文档转换中
842
- TaskEnd - 任务处理完成
843
- DownloadFailed - 下载失败
844
- ProcessFailed - 转换失败
845
- ProcessTimeout - 转换文件超时
846
- */
847
- TaskMessage: string
883
+ * 模板类型:1-静默签;3-普通模板
884
+ */
885
+ TemplateType: number
848
886
 
849
887
  /**
850
- * 资源Id,也是FileId,用于文件发起使用
888
+ * 是否是发起人 ,已弃用
851
889
  */
852
- ResourceId: string
890
+ IsPromoter: boolean
853
891
 
854
892
  /**
855
- * 预览文件Url,有效期30分钟
856
- 注意:此字段可能返回 null,表示取不到有效值。
857
- */
858
- PreviewUrl: string
893
+ * 模板的创建者信息
894
+ */
895
+ Creator: string
859
896
 
860
897
  /**
861
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
898
+ * 模板创建的时间戳(精确到秒)
862
899
  */
863
- RequestId?: string
900
+ CreatedOn: number
864
901
  }
865
902
 
866
903
  /**
867
- * 此结构体 (UploadFile) 用于描述多文件上传的文件信息。
904
+ * GetDownloadFlowUrl返回参数结构体
868
905
  */
869
- export interface UploadFile {
906
+ export interface GetDownloadFlowUrlResponse {
870
907
  /**
871
- * Base64编码后的文件内容
908
+ * 合同(流程)下载地址
872
909
  */
873
- FileBody: string
910
+ DownLoadUrl: string
874
911
 
875
912
  /**
876
- * 文件名
913
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
877
914
  */
878
- FileName?: string
915
+ RequestId?: string
879
916
  }
880
917
 
881
918
  /**
882
- * 合同组中每个子合同的发起信息
919
+ * DescribeTemplates返回参数结构体
883
920
  */
884
- export interface FlowFileInfo {
885
- /**
886
- * 签署文件资源Id列表,目前仅支持单个文件
887
- */
888
- FileIds: Array<string>
889
-
890
- /**
891
- * 签署流程名称,长度不超过200个字符
892
- */
893
- FlowName: string
894
-
895
- /**
896
- * 签署流程签约方列表,最多不超过5个参与方
897
- */
898
- FlowApprovers: Array<FlowApproverInfo>
899
-
900
- /**
901
- * 签署流程截止时间,十位数时间戳,最大值为33162419560,即3020年
902
- */
903
- Deadline?: number
904
-
921
+ export interface DescribeTemplatesResponse {
905
922
  /**
906
- * 签署流程的描述,长度不超过1000个字符
923
+ * 模板详情
907
924
  */
908
- FlowDescription?: string
925
+ Templates: Array<TemplateInfo>
909
926
 
910
927
  /**
911
- * 签署流程的类型,长度不超过255个字符
928
+ * 查询总数
912
929
  */
913
- FlowType?: string
930
+ TotalCount: number
914
931
 
915
932
  /**
916
- * 签署流程回调地址,长度不超过255个字符
933
+ * 查询数量
917
934
  */
918
- CallbackUrl?: string
935
+ Limit: number
919
936
 
920
937
  /**
921
- * 渠道的业务信息,最大长度1000个字符。发起自动签署时,需设置对应自动签署场景,目前仅支持场景:处方单-E_PRESCRIPTION_AUTO_SIGN
938
+ * 查询起始偏移
922
939
  */
923
- CustomerData?: string
940
+ Offset: number
924
941
 
925
942
  /**
926
- * 合同签署顺序类型(无序签,顺序签),默认为false,即有序签署
943
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
927
944
  */
928
- Unordered?: boolean
945
+ RequestId?: string
946
+ }
929
947
 
948
+ /**
949
+ * 渠道版员工角色信息
950
+ */
951
+ export interface StaffRole {
930
952
  /**
931
- * 合同显示的页卡模板,说明:只支持{合同名称}, {发起方企业}, {发起方姓名}, {签署方N企业}, {签署方N姓名},且N不能超过签署人的数量,N从1开始
932
- */
933
- CustomShowMap?: string
953
+ * 角色id
954
+ 注意:此字段可能返回 null,表示取不到有效值。
955
+ */
956
+ RoleId: string
934
957
 
935
958
  /**
936
- * 本企业(发起方企业)是否需要签署审批
937
- */
938
- NeedSignReview?: boolean
959
+ * 角色名称
960
+ 注意:此字段可能返回 null,表示取不到有效值。
961
+ */
962
+ RoleName: string
939
963
  }
940
964
 
941
965
  /**
942
- * ChannelGetTaskResultApi请求参数结构体
966
+ * ChannelVerifyPdf请求参数结构体
943
967
  */
944
- export interface ChannelGetTaskResultApiRequest {
968
+ export interface ChannelVerifyPdfRequest {
945
969
  /**
946
- * 渠道应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 均必填。
970
+ * 合同Id,流程Id
947
971
  */
948
- Agent: Agent
972
+ FlowId: string
949
973
 
950
974
  /**
951
- * 任务Id,通过ChannelCreateConvertTaskApi接口获得
975
+ * 渠道应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 均必填。
952
976
  */
953
- TaskId: string
977
+ Agent?: Agent
954
978
 
955
979
  /**
956
980
  * 操作者的信息
957
981
  */
958
982
  Operator?: UserInfo
959
-
960
- /**
961
- * 暂未开放
962
- */
963
- Organization?: OrganizationInfo
964
983
  }
965
984
 
966
985
  /**
@@ -985,508 +1004,473 @@ export interface ChannelVerifyPdfResponse {
985
1004
  }
986
1005
 
987
1006
  /**
988
- * 签署链接内容
1007
+ * CreateConsoleLoginUrl请求参数结构体
989
1008
  */
990
- export interface SignUrlInfo {
1009
+ export interface CreateConsoleLoginUrlRequest {
991
1010
  /**
992
- * 签署链接,过期时间为30天
993
- 注意:此字段可能返回 null,表示取不到有效值。
1011
+ * 应用信息
1012
+ 此接口Agent.AppId、Agent.ProxyOrganizationOpenId 和 Agent. ProxyOperator.OpenId 必填
994
1013
  */
995
- SignUrl: string
996
-
997
- /**
998
- * 合同过期时间
999
- 注意:此字段可能返回 null,表示取不到有效值。
1000
- */
1001
- Deadline: number
1002
-
1003
- /**
1004
- * 当流程为顺序签署此参数有效时,数字越小优先级越高,暂不支持并行签署 可选
1005
- 注意:此字段可能返回 null,表示取不到有效值。
1006
- */
1007
- SignOrder: number
1008
-
1009
- /**
1010
- * 签署人编号
1011
- 注意:此字段可能返回 null,表示取不到有效值。
1012
- */
1013
- SignId: string
1014
-
1015
- /**
1016
- * 自定义用户编号
1017
- 注意:此字段可能返回 null,表示取不到有效值。
1018
- */
1019
- CustomUserId: string
1020
-
1021
- /**
1022
- * 用户姓名
1023
- 注意:此字段可能返回 null,表示取不到有效值。
1024
- */
1025
- Name: string
1014
+ Agent: Agent
1026
1015
 
1027
1016
  /**
1028
- * 用户手机号码
1029
- 注意:此字段可能返回 null,表示取不到有效值。
1030
- */
1031
- Mobile: string
1017
+ * 渠道子客企业名称,最大长度64个字符
1018
+ */
1019
+ ProxyOrganizationName: string
1032
1020
 
1033
1021
  /**
1034
- * 签署参与者机构名字
1035
- 注意:此字段可能返回 null,表示取不到有效值。
1036
- */
1037
- OrganizationName: string
1022
+ * 渠道子客企业经办人的姓名,最大长度50个字符
1023
+ */
1024
+ ProxyOperatorName?: string
1038
1025
 
1039
1026
  /**
1040
- * 参与者类型:
1041
- ORGANIZATION 企业经办人
1042
- PERSON 自然人
1043
- 注意:此字段可能返回 null,表示取不到有效值。
1044
- */
1045
- ApproverType: string
1027
+ * 控制台指定模块,文件/合同管理:"DOCUMENT",模板管理:"TEMPLATE",印章管理:"SEAL",组织架构/人员:"OPERATOR",空字符串:"账号信息"
1028
+ */
1029
+ Module?: string
1046
1030
 
1047
1031
  /**
1048
- * 经办人身份证号
1049
- 注意:此字段可能返回 null,表示取不到有效值。
1050
- */
1051
- IdCardNumber: string
1032
+ * 控制台指定模块Id
1033
+ */
1034
+ ModuleId?: string
1052
1035
 
1053
1036
  /**
1054
- * 签署链接对应流程Id
1055
- 注意:此字段可能返回 null,表示取不到有效值。
1056
- */
1057
- FlowId: string
1037
+ * 渠道子客企业统一社会信用代码,最大长度200个字符
1038
+ */
1039
+ UniformSocialCreditCode?: string
1058
1040
 
1059
1041
  /**
1060
- * 企业经办人 用户在渠道的编号
1061
- 注意:此字段可能返回 null,表示取不到有效值。
1062
- */
1063
- OpenId: string
1042
+ * 是否展示左侧菜单栏 是:ENABLE(默认) 否:DISABLE
1043
+ */
1044
+ MenuStatus?: string
1064
1045
 
1065
1046
  /**
1066
- * 合同组签署链接对应的合同组id
1067
- 注意:此字段可能返回 null,表示取不到有效值。
1068
- */
1069
- FlowGroupId: string
1047
+ * 操作者的信息
1048
+ */
1049
+ Operator?: UserInfo
1070
1050
  }
1071
1051
 
1072
1052
  /**
1073
- * 此结构体 (Component) 用于描述控件属性。
1074
-
1075
- 在通过文件发起合同时,对应的component有三种定位方式
1076
- 1. 绝对定位方式
1077
- 2. 表单域(FIELD)定位方式
1078
- 3. 关键字(KEYWORD)定位方式
1079
- 可以参考官网说明
1080
- https://cloud.tencent.com/document/product/1323/78346#component-.E4.B8.89.E7.A7.8D.E5.AE.9A.E4.BD.8D.E6.96.B9.E5.BC.8F.E8.AF.B4.E6.98.8E
1053
+ * 机构信息
1081
1054
  */
1082
- export interface Component {
1055
+ export interface OrganizationInfo {
1083
1056
  /**
1084
- * 控件编号
1085
-
1086
- CreateFlowByTemplates发起合同时优先以ComponentId(不为空)填充;否则以ComponentName填充
1087
-
1088
- 注:
1089
- 当GenerateMode=3时,通过"^"来决定是否使用关键字整词匹配能力。
1090
- 例:
1091
- 当GenerateMode=3时,如果传入关键字"^甲方签署^",则会在PDF文件中有且仅有"甲方签署"关键字的地方进行对应操作。
1092
- 如传入的关键字为"甲方签署",则PDF文件中每个出现关键字的位置都会执行相应操作。
1093
-
1094
- 创建控件时,此值为空
1095
- 查询时返回完整结构
1096
- */
1097
- ComponentId?: string
1057
+ * 用户在渠道的机构编号
1058
+ */
1059
+ OrganizationOpenId: string
1098
1060
 
1099
1061
  /**
1100
- * 如果是Component控件类型,则可选的字段为:
1101
- TEXT - 普通文本控件;
1102
- MULTI_LINE_TEXT - 多行文本控件;
1103
- CHECK_BOX - 勾选框控件;
1104
- FILL_IMAGE - 图片控件;
1105
- DYNAMIC_TABLE - 动态表格控件;
1106
- ATTACHMENT - 附件控件;
1107
- SELECTOR - 选择器控件;
1108
- DATE - 日期控件;默认是格式化为xxxx年xx月xx日
1109
-
1110
- 如果是SignComponent控件类型,则可选的字段为
1111
- SIGN_SEAL - 签署印章控件;
1112
- SIGN_DATE - 签署日期控件;
1113
- SIGN_SIGNATURE - 用户签名控件;
1114
- SIGN_PERSONAL_SEAL - 个人签署印章控件(使用文件发起暂不支持此类型);
1115
- SIGN_PAGING_SEAL - 骑缝章;若文件发起,需要对应填充ComponentPosY、ComponentWidth、ComponentHeight
1116
-
1117
- 表单域的控件不能作为印章和签名控件
1118
- */
1119
- ComponentType?: string
1062
+ * 用户真实的IP
1063
+ */
1064
+ ClientIp: string
1120
1065
 
1121
1066
  /**
1122
- * 控件简称,不能超过30个字符
1067
+ * 机构的代理IP
1123
1068
  */
1124
- ComponentName?: string
1069
+ ProxyIp: string
1125
1070
 
1126
1071
  /**
1127
- * 定义控件是否为必填项,默认为false
1072
+ * 机构在平台的编号
1128
1073
  */
1129
- ComponentRequired?: boolean
1074
+ OrganizationId?: string
1130
1075
 
1131
1076
  /**
1132
- * 控件关联的签署方id
1077
+ * 用户渠道
1133
1078
  */
1134
- ComponentRecipientId?: string
1079
+ Channel?: string
1080
+ }
1135
1081
 
1082
+ /**
1083
+ * 合同文件验签单个结果结构体
1084
+ */
1085
+ export interface PdfVerifyResult {
1136
1086
  /**
1137
- * 控件所属文件的序号 (文档中文件的排列序号,从0开始)
1087
+ * 验签结果
1138
1088
  */
1139
- FileIndex?: number
1089
+ VerifyResult: number
1140
1090
 
1141
1091
  /**
1142
- * 控件生成的方式:
1143
- NORMAL - 普通控件
1144
- FIELD - 表单域
1145
- KEYWORD - 关键字
1146
- */
1147
- GenerateMode?: string
1092
+ * 签署平台
1093
+ */
1094
+ SignPlatform: string
1148
1095
 
1149
1096
  /**
1150
- * 参数控件宽度,默认100,单位px
1151
- 表单域和关键字转换控件不用填
1152
- */
1153
- ComponentWidth?: number
1097
+ * 签署人名称
1098
+ */
1099
+ SignerName: string
1154
1100
 
1155
1101
  /**
1156
- * 参数控件高度,默认100,单位px
1157
- 表单域和关键字转换控件不用填
1158
- */
1159
- ComponentHeight?: number
1102
+ * 签署时间
1103
+ */
1104
+ SignTime: number
1160
1105
 
1161
1106
  /**
1162
- * 参数控件所在页码,从1开始
1107
+ * 签名算法
1163
1108
  */
1164
- ComponentPage?: number
1109
+ SignAlgorithm: string
1165
1110
 
1166
1111
  /**
1167
- * 参数控件X位置,单位px
1112
+ * 签名证书序列号
1168
1113
  */
1169
- ComponentPosX?: number
1114
+ CertSn: string
1170
1115
 
1171
1116
  /**
1172
- * 参数控件Y位置,单位px
1117
+ * 证书起始时间
1173
1118
  */
1174
- ComponentPosY?: number
1119
+ CertNotBefore: number
1175
1120
 
1176
1121
  /**
1177
- * 参数控件样式,json格式表述
1178
- 不同类型的控件会有部分非通用参数
1179
- TEXT/MULTI_LINE_TEXT控件可以指定
1180
- 1 Font:目前只支持黑体、宋体
1181
- 2 FontSize: 范围12-72
1182
- 3 FontAlign: Left/Right/Center,左对齐/居中/右对齐
1183
- 例如:{"FontSize":12}
1184
- */
1185
- ComponentExtra?: string
1122
+ * 证书过期时间
1123
+ */
1124
+ CertNotAfter: number
1186
1125
 
1187
1126
  /**
1188
- * 控件填充vaule,ComponentType和传入值类型对应关系:
1189
- TEXT - 文本内容
1190
- MULTI_LINE_TEXT - 文本内容
1191
- CHECK_BOX - true/false
1192
- FILL_IMAGE、ATTACHMENT - 附件的FileId,需要通过UploadFiles接口上传获取
1193
- SELECTOR - 选项值
1194
- DATE - 默认是格式化为xxxx年xx月xx日
1195
- DYNAMIC_TABLE - 传入json格式的表格内容,具体见数据结构FlowInfo:https://cloud.tencent.com/document/api/1420/61525#FlowInfo
1196
- SIGN_SEAL - 印章ID
1197
- SIGN_PAGING_SEAL - 可以指定印章ID
1198
- */
1199
- ComponentValue?: string
1127
+ * 签名类型
1128
+ */
1129
+ SignType: number
1200
1130
 
1201
1131
  /**
1202
- * 日期签署控件的字号,默认为 12
1203
-
1204
- 签署区日期控件会转换成图片格式并带存证,需要通过字体决定图片大小
1205
- */
1206
- ComponentDateFontSize?: number
1132
+ * 签名域横坐标
1133
+ */
1134
+ ComponentPosX: number
1207
1135
 
1208
1136
  /**
1209
- * 控件所属文档的Id, 模块相关接口为空值
1137
+ * 签名域纵坐标
1210
1138
  */
1211
- DocumentId?: string
1139
+ ComponentPosY: number
1212
1140
 
1213
1141
  /**
1214
- * 控件描述,不能超过30个字符
1142
+ * 签名域宽度
1215
1143
  */
1216
- ComponentDescription?: string
1144
+ ComponentWidth: number
1217
1145
 
1218
1146
  /**
1219
- * 指定关键字时横坐标偏移量,单位pt
1147
+ * 签名域高度
1220
1148
  */
1221
- OffsetX?: number
1149
+ ComponentHeight: number
1222
1150
 
1223
1151
  /**
1224
- * 指定关键字时纵坐标偏移量,单位pt
1152
+ * 签名域所在页码
1225
1153
  */
1226
- OffsetY?: number
1154
+ ComponentPage: number
1227
1155
  }
1228
1156
 
1229
1157
  /**
1230
- * GetDownloadFlowUrl请求参数结构体
1158
+ * ChannelCancelMultiFlowSignQRCode请求参数结构体
1231
1159
  */
1232
- export interface GetDownloadFlowUrlRequest {
1160
+ export interface ChannelCancelMultiFlowSignQRCodeRequest {
1233
1161
  /**
1234
1162
  * 渠道应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 均必填。
1235
1163
  */
1236
1164
  Agent: Agent
1237
1165
 
1238
1166
  /**
1239
- * 文件夹数组,签署流程总数不能超过50个,一个文件夹下,不能超过20个签署流程
1167
+ * 二维码id
1240
1168
  */
1241
- DownLoadFlows?: Array<DownloadFlowInfo>
1169
+ QrCodeId: string
1242
1170
 
1243
1171
  /**
1244
- * 操作者的信息
1172
+ * 用户信息
1245
1173
  */
1246
1174
  Operator?: UserInfo
1247
1175
  }
1248
1176
 
1249
1177
  /**
1250
- * ChannelBatchCancelFlows请求参数结构体
1178
+ * ChannelDescribeOrganizationSeals请求参数结构体
1251
1179
  */
1252
- export interface ChannelBatchCancelFlowsRequest {
1180
+ export interface ChannelDescribeOrganizationSealsRequest {
1253
1181
  /**
1254
1182
  * 渠道应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 均必填。
1255
1183
  */
1256
1184
  Agent: Agent
1257
1185
 
1258
1186
  /**
1259
- * 签署流程Id数组,最多100个,超过100不处理
1187
+ * 返回最大数量,最大为100
1260
1188
  */
1261
- FlowIds: Array<string>
1189
+ Limit: number
1262
1190
 
1263
1191
  /**
1264
- * 撤销理由
1192
+ * 偏移量,默认为0,最大为20000
1265
1193
  */
1266
- CancelMessage?: string
1194
+ Offset?: number
1267
1195
 
1268
1196
  /**
1269
- * 撤销理由自定义格式;选项:
1270
- 0 默认格式
1271
- 1 只保留身份信息:展示为【发起方】
1272
- 2 保留身份信息+企业名称:展示为【发起方xxx公司】
1273
- 3 保留身份信息+企业名称+经办人名称:展示为【发起方xxxx公司-经办人姓名】
1274
- */
1275
- CancelMessageFormat?: number
1197
+ * 查询信息类型,为0时不返回授权用户,为1时返回
1198
+ */
1199
+ InfoType?: number
1276
1200
 
1277
1201
  /**
1278
- * 操作人信息
1202
+ * 印章id(没有输入返回所有)
1279
1203
  */
1280
- Operator?: UserInfo
1204
+ SealId?: string
1281
1205
  }
1282
1206
 
1283
1207
  /**
1284
- * 此结构体(FlowDetailInfo)描述的是合同(流程)的详细信息
1208
+ * DescribeUsage请求参数结构体
1285
1209
  */
1286
- export interface FlowDetailInfo {
1287
- /**
1288
- * 合同(流程)的Id
1289
- */
1290
- FlowId: string
1291
-
1292
- /**
1293
- * 合同(流程)的名字
1294
- */
1295
- FlowName: string
1296
-
1210
+ export interface DescribeUsageRequest {
1297
1211
  /**
1298
- * 合同(流程)的类型
1212
+ * 应用信息
1299
1213
  */
1300
- FlowType: string
1214
+ Agent: Agent
1301
1215
 
1302
1216
  /**
1303
- * 合同(流程)的状态
1217
+ * 开始时间,例如:2021-03-21
1304
1218
  */
1305
- FlowStatus: string
1219
+ StartDate: string
1306
1220
 
1307
1221
  /**
1308
- * 合同(流程)的信息
1309
- */
1310
- FlowMessage: string
1222
+ * 结束时间,例如:2021-06-21;
1223
+ 开始时间到结束时间的区间长度小于等于90天。
1224
+ */
1225
+ EndDate: string
1311
1226
 
1312
1227
  /**
1313
- * 合同(流程)的创建时间戳
1314
- */
1315
- CreateOn: number
1228
+ * 是否汇总数据,默认不汇总。
1229
+ 不汇总:返回在统计区间内渠道下所有企业的每日明细,即每个企业N条数据,N为统计天数;
1230
+ 汇总:返回在统计区间内渠道下所有企业的汇总后数据,即每个企业一条数据;
1231
+ */
1232
+ NeedAggregate?: boolean
1316
1233
 
1317
1234
  /**
1318
- * 合同(流程)的签署截止时间戳
1235
+ * 单次返回的最多条目数量。默认为1000,且不能超过1000。
1319
1236
  */
1320
- DeadLine: number
1237
+ Limit?: number
1321
1238
 
1322
1239
  /**
1323
- * 用户自定义数据
1240
+ * 偏移量,默认是0。
1324
1241
  */
1325
- CustomData: string
1242
+ Offset?: number
1326
1243
 
1327
1244
  /**
1328
- * 合同(流程)的签署人数组
1245
+ * 操作者的信息
1329
1246
  */
1330
- FlowApproverInfos: Array<FlowApproverDetail>
1247
+ Operator?: UserInfo
1331
1248
  }
1332
1249
 
1333
1250
  /**
1334
- * 同步经办人失败原因
1251
+ * 此结构 (FormField) 用于描述内容控件填充结构。
1252
+
1335
1253
  */
1336
- export interface SyncFailReason {
1254
+ export interface FormField {
1337
1255
  /**
1338
- * 经办人Id
1339
- */
1340
- Id: string
1256
+ * 控件填充vaule,ComponentType和传入值类型对应关系:
1257
+ TEXT - 文本内容
1258
+ MULTI_LINE_TEXT - 文本内容
1259
+ CHECK_BOX - true/false
1260
+ FILL_IMAGE、ATTACHMENT - 附件的FileId,需要通过UploadFiles接口上传获取
1261
+ SELECTOR - 选项值
1262
+ DYNAMIC_TABLE - 传入json格式的表格内容,具体见数据结构FlowInfo:https://cloud.tencent.com/document/api/1420/61525#FlowInfo
1263
+ */
1264
+ ComponentValue: string
1341
1265
 
1342
1266
  /**
1343
- * 失败原因
1344
- 例如:Id不符合规范、证件号码不合法等
1267
+ * 表单域或控件的ID,跟ComponentName二选一,不能全为空;
1268
+ CreateFlowsByTemplates 接口不使用此字段。
1345
1269
  注意:此字段可能返回 null,表示取不到有效值。
1346
1270
  */
1347
- Message: string
1348
- }
1271
+ ComponentId?: string
1349
1272
 
1350
- /**
1351
- * CreateConsoleLoginUrl请求参数结构体
1352
- */
1353
- export interface CreateConsoleLoginUrlRequest {
1354
1273
  /**
1355
- * 应用信息
1356
- 此接口Agent.AppId、Agent.ProxyOrganizationOpenId 和 Agent. ProxyOperator.OpenId 必填
1274
+ * 控件的名字,跟ComponentId二选一,不能全为空
1275
+ 注意:此字段可能返回 null,表示取不到有效值。
1357
1276
  */
1358
- Agent: Agent
1277
+ ComponentName?: string
1278
+ }
1279
+
1280
+ /**
1281
+ * 此结构体 (FlowInfo) 用于描述签署流程信息。
1282
+
1283
+ 【动态表格传参说明】
1284
+ 当模板的 ComponentType='DYNAMIC_TABLE'时(渠道版),FormField.ComponentValue需要传递json格式的字符串参数,用于确定表头&填充动态表格(支持内容的单元格合并)
1285
+ 输入示例
1286
+
1287
+ ```
1288
+ {
1289
+ "headers":[
1290
+ {
1291
+ "content":"head1"
1292
+ },
1293
+ {
1294
+ "content":"head2"
1295
+ },
1296
+ {
1297
+ "content":"head3"
1298
+ }
1299
+ ],
1300
+ "rowCount":3,
1301
+ "body":{
1302
+ "cells":[
1303
+ {
1304
+ "rowStart":1,
1305
+ "rowEnd":1,
1306
+ "columnStart":1,
1307
+ "columnEnd":1,
1308
+ "content":"123"
1309
+ },
1310
+ {
1311
+ "rowStart":2,
1312
+ "rowEnd":3,
1313
+ "columnStart":1,
1314
+ "columnEnd":2,
1315
+ "content":"456"
1316
+ },
1317
+ {
1318
+ "rowStart":3,
1319
+ "rowEnd":3,
1320
+ "columnStart":3,
1321
+ "columnEnd":3,
1322
+ "content":"789"
1323
+ }
1324
+ ]
1325
+ }
1326
+ }
1327
+
1328
+ ```
1329
+
1330
+ 表格参数说明
1331
+
1332
+ | 名称 | 类型 | 描述 |
1333
+ | ------------------- | ------- | ------------------------------------------------- |
1334
+ | headers | Array | 表头:不超过10列,不支持单元格合并,字数不超过100 |
1335
+ | rowCount | Integer | 表格内容最大行数 |
1336
+ | cells.N.rowStart | Integer | 单元格坐标:行起始index |
1337
+ | cells.N.rowEnd | Integer | 单元格坐标:行结束index |
1338
+ | cells.N.columnStart | Integer | 单元格坐标:列起始index |
1339
+ | cells.N.columnEnd | Integer | 单元格坐标:列结束index |
1340
+ | cells.N.content | String | 单元格内容,字数不超过100 |
1359
1341
 
1342
+ */
1343
+ export interface FlowInfo {
1360
1344
  /**
1361
- * 渠道子客企业名称,最大长度64个字符
1345
+ * 合同名字,最大长度200个字符
1362
1346
  */
1363
- ProxyOrganizationName: string
1347
+ FlowName: string
1364
1348
 
1365
1349
  /**
1366
- * 渠道子客企业经办人的姓名,最大长度50个字符
1350
+ * 签署截止时间戳,超过有效签署时间则该签署流程失败,默认一年
1367
1351
  */
1368
- ProxyOperatorName?: string
1352
+ Deadline: number
1369
1353
 
1370
1354
  /**
1371
- * 控制台指定模块,文件/合同管理:"DOCUMENT",模板管理:"TEMPLATE",印章管理:"SEAL",组织架构/人员:"OPERATOR",空字符串:"账号信息"
1355
+ * 模板ID
1372
1356
  */
1373
- Module?: string
1357
+ TemplateId?: string
1374
1358
 
1375
1359
  /**
1376
- * 控制台指定模块Id
1360
+ * 多个签署人信息,最大支持50个签署方
1377
1361
  */
1378
- ModuleId?: string
1362
+ FlowApprovers?: Array<FlowApproverInfo>
1379
1363
 
1380
1364
  /**
1381
- * 渠道子客企业统一社会信用代码,最大长度200个字符
1365
+ * 表单K-V对列表
1382
1366
  */
1383
- UniformSocialCreditCode?: string
1367
+ FormFields?: Array<FormField>
1384
1368
 
1385
1369
  /**
1386
- * 是否展示左侧菜单栏 是:ENABLE(默认) 否:DISABLE
1370
+ * 回调地址,最大长度1000个字符
1387
1371
  */
1388
- MenuStatus?: string
1372
+ CallbackUrl?: string
1389
1373
 
1390
1374
  /**
1391
- * 操作者的信息
1375
+ * 合同类型,如:1. “劳务”;2. “销售”;3. “租赁”;4. “其他”,最大长度200个字符
1392
1376
  */
1393
- Operator?: UserInfo
1394
- }
1377
+ FlowType?: string
1395
1378
 
1396
- /**
1397
- * 机构信息
1398
- */
1399
- export interface OrganizationInfo {
1400
1379
  /**
1401
- * 用户在渠道的机构编号
1380
+ * 合同描述,最大长度1000个字符
1402
1381
  */
1403
- OrganizationOpenId: string
1382
+ FlowDescription?: string
1404
1383
 
1405
1384
  /**
1406
- * 用户真实的IP
1385
+ * 渠道的业务信息,最大长度1000个字符。发起自动签署时,需设置对应自动签署场景,目前仅支持场景:处方单-E_PRESCRIPTION_AUTO_SIGN
1407
1386
  */
1408
- ClientIp: string
1387
+ CustomerData?: string
1409
1388
 
1410
1389
  /**
1411
- * 机构的代理IP
1390
+ * 合同显示的页卡模板,说明:只支持{合同名称}, {发起方企业}, {发起方姓名}, {签署方N企业}, {签署方N姓名},且N不能超过签署人的数量,N从1开始
1412
1391
  */
1413
- ProxyIp: string
1392
+ CustomShowMap?: string
1414
1393
 
1415
1394
  /**
1416
- * 机构在平台的编号
1395
+ * 被抄送人的信息列表,抄送功能暂不开放
1417
1396
  */
1418
- OrganizationId?: string
1397
+ CcInfos?: Array<CcInfo>
1419
1398
 
1420
1399
  /**
1421
- * 用户渠道
1422
- */
1423
- Channel?: string
1400
+ * 发起方企业的签署人进行签署操作是否需要企业内部审批。
1401
+ 若设置为true,审核结果需通过接口 ChannelCreateFlowSignReview 通知电子签,审核通过后,发起方企业签署人方可进行签署操作,否则会阻塞其签署操作。
1402
+
1403
+ 注:企业可以通过此功能与企业内部的审批流程进行关联,支持手动、静默签署合同。
1404
+ */
1405
+ NeedSignReview?: boolean
1424
1406
  }
1425
1407
 
1426
1408
  /**
1427
- * CreateFlowsByTemplates返回参数结构体
1409
+ * 接口调用者信息
1428
1410
  */
1429
- export interface CreateFlowsByTemplatesResponse {
1411
+ export interface UserInfo {
1430
1412
  /**
1431
- * 多个合同ID
1413
+ * 用户在渠道的编号,最大64位字符串
1432
1414
  */
1433
- FlowIds: Array<string>
1415
+ OpenId?: string
1434
1416
 
1435
1417
  /**
1436
- * 渠道的业务信息,限制1024字符
1418
+ * 用户的来源渠道
1437
1419
  */
1438
- CustomerData: Array<string>
1439
-
1440
- /**
1441
- * 创建消息,对应多个合同ID,
1442
- 成功为“”,创建失败则对应失败消息
1443
- */
1444
- ErrorMessages: Array<string>
1420
+ Channel?: string
1445
1421
 
1446
1422
  /**
1447
- * 预览模式下返回的预览文件url数组
1423
+ * 自定义用户编号
1448
1424
  */
1449
- PreviewUrls: Array<string>
1425
+ CustomUserId?: string
1450
1426
 
1451
1427
  /**
1452
- * 复杂文档合成任务(如,包含动态表格的预览任务)的任务信息数组;
1453
- 如果文档需要异步合成,此字段会返回该异步任务的任务信息,后续可以通过ChannelGetTaskResultApi接口查询任务详情;
1454
- */
1455
- TaskInfos: Array<TaskInfo>
1428
+ * 用户真实IP
1429
+ */
1430
+ ClientIp?: string
1456
1431
 
1457
1432
  /**
1458
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1433
+ * 用户代理IP
1459
1434
  */
1460
- RequestId?: string
1435
+ ProxyIp?: string
1461
1436
  }
1462
1437
 
1463
1438
  /**
1464
- * ChannelCreateFlowSignReview请求参数结构体
1439
+ * DescribeFlowDetailInfo返回参数结构体
1465
1440
  */
1466
- export interface ChannelCreateFlowSignReviewRequest {
1441
+ export interface DescribeFlowDetailInfoResponse {
1467
1442
  /**
1468
- * 渠道应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 均必填。
1443
+ * 渠道侧应用号Id
1469
1444
  */
1470
- Agent: Agent
1445
+ ApplicationId: string
1471
1446
 
1472
1447
  /**
1473
- * 签署流程编号
1448
+ * 渠道侧企业第三方Id
1474
1449
  */
1475
- FlowId: string
1450
+ ProxyOrganizationOpenId: string
1476
1451
 
1477
1452
  /**
1478
- * 企业内部审核结果
1479
- PASS: 通过
1480
- REJECT: 拒绝
1481
- SIGN_REJECT:拒签(流程结束)
1453
+ * 合同(签署流程)的具体详细描述信息
1454
+ 注意:此字段可能返回 null,表示取不到有效值。
1482
1455
  */
1483
- ReviewType: string
1456
+ FlowInfo: Array<FlowDetailInfo>
1484
1457
 
1485
1458
  /**
1486
- * 审核原因
1487
- 当ReviewType 是REJECT 时此字段必填,字符串长度不超过200
1459
+ * 合同组编号
1460
+ 注意:此字段可能返回 null,表示取不到有效值。
1488
1461
  */
1489
- ReviewMessage?: string
1462
+ FlowGroupId: string
1463
+
1464
+ /**
1465
+ * 合同组名称
1466
+ 注意:此字段可能返回 null,表示取不到有效值。
1467
+ */
1468
+ FlowGroupName: string
1469
+
1470
+ /**
1471
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1472
+ */
1473
+ RequestId?: string
1490
1474
  }
1491
1475
 
1492
1476
  /**
@@ -1511,85 +1495,72 @@ export interface DescribeUsageResponse {
1511
1495
  }
1512
1496
 
1513
1497
  /**
1514
- * 合作企业经办人列表信息
1498
+ * 企业员工信息
1515
1499
  */
1516
- export interface ProxyOrganizationOperator {
1500
+ export interface Staff {
1517
1501
  /**
1518
- * 经办人ID(渠道颁发),最大长度64个字符
1502
+ * 员工在电子签平台的id
1519
1503
  */
1520
- Id: string
1504
+ UserId: string
1521
1505
 
1522
1506
  /**
1523
- * 经办人姓名,最大长度50个字符
1507
+ * 显示的员工名
1524
1508
  */
1525
- Name?: string
1509
+ DisplayName: string
1526
1510
 
1527
1511
  /**
1528
- * 经办人身份证件类型
1529
- 1.ID_CARD 居民身份证
1530
- 2.HONGKONG_MACAO_AND_TAIWAN 港澳台居民居住证
1531
- 3.HONGKONG_AND_MACAO 港澳居民来往内地通行证
1532
- */
1533
- IdCardType?: string
1512
+ * 员工手机号
1513
+ */
1514
+ Mobile: string
1534
1515
 
1535
1516
  /**
1536
- * 经办人证件号
1537
- */
1538
- IdCardNumber?: string
1517
+ * 员工邮箱
1518
+ 注意:此字段可能返回 null,表示取不到有效值。
1519
+ */
1520
+ Email: string
1539
1521
 
1540
1522
  /**
1541
- * 经办人手机号,大陆手机号输入11位,暂不支持海外手机号。
1542
- */
1543
- Mobile?: string
1544
- }
1523
+ * 员工在第三方平台id
1524
+ 注意:此字段可能返回 null,表示取不到有效值。
1525
+ */
1526
+ OpenId: string
1545
1527
 
1546
- /**
1547
- * SyncProxyOrganizationOperators返回参数结构体
1548
- */
1549
- export interface SyncProxyOrganizationOperatorsResponse {
1550
1528
  /**
1551
- * Status 同步状态,全部同步失败接口会直接报错
1552
- 1-成功
1553
- 2-部分成功
1529
+ * 员工角色
1554
1530
  注意:此字段可能返回 null,表示取不到有效值。
1555
1531
  */
1556
- Status: number
1532
+ Roles: Array<StaffRole>
1557
1533
 
1558
1534
  /**
1559
- * 同步失败经办人及其失败原因
1535
+ * 员工部门
1560
1536
  注意:此字段可能返回 null,表示取不到有效值。
1561
1537
  */
1562
- FailedList: Array<SyncFailReason>
1538
+ Department: Department
1563
1539
 
1564
1540
  /**
1565
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1541
+ * 员工是否实名
1566
1542
  */
1567
- RequestId?: string
1568
- }
1543
+ Verified: boolean
1569
1544
 
1570
- /**
1571
- * CreateSealByImage返回参数结构体
1572
- */
1573
- export interface CreateSealByImageResponse {
1574
1545
  /**
1575
- * 印章id
1546
+ * 员工创建时间戳
1576
1547
  */
1577
- SealId: string
1548
+ CreatedOn: number
1578
1549
 
1579
1550
  /**
1580
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1551
+ * 员工实名时间戳
1581
1552
  */
1582
- RequestId?: string
1553
+ VerifiedOn: number
1583
1554
  }
1584
1555
 
1585
1556
  /**
1586
- * ChannelVerifyPdf请求参数结构体
1557
+ * ChannelDescribeEmployees请求参数结构体
1587
1558
  */
1588
- export interface ChannelVerifyPdfRequest {
1559
+ export interface ChannelDescribeEmployeesRequest {
1589
1560
  /**
1590
- * 合同Id,流程Id
1561
+ * 返回最大数量,最大为20
1591
1562
  */
1592
- FlowId: string
1563
+ Limit: number
1593
1564
 
1594
1565
  /**
1595
1566
  * 渠道应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 均必填。
@@ -1597,25 +1568,15 @@ export interface ChannelVerifyPdfRequest {
1597
1568
  Agent?: Agent
1598
1569
 
1599
1570
  /**
1600
- * 操作者的信息
1601
- */
1602
- Operator?: UserInfo
1603
- }
1604
-
1605
- /**
1606
- * DescribeResourceUrlsByFlows请求参数结构体
1607
- */
1608
- export interface DescribeResourceUrlsByFlowsRequest {
1609
- /**
1610
- * 渠道应用相关信息。
1611
- 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 均必填。
1571
+ * 查询过滤实名用户,Key为Status,Values为["IsVerified"]
1572
+ 根据第三方系统openId过滤查询员工时,Key为StaffOpenId,Values为["OpenId","OpenId",...]
1612
1573
  */
1613
- Agent: Agent
1574
+ Filters?: Array<Filter>
1614
1575
 
1615
1576
  /**
1616
- * 查询资源所对应的签署流程Id,最多支持50个
1577
+ * 偏移量,默认为0,最大为20000
1617
1578
  */
1618
- FlowIds?: Array<string>
1579
+ Offset?: number
1619
1580
 
1620
1581
  /**
1621
1582
  * 操作者的信息
@@ -1624,119 +1585,130 @@ export interface DescribeResourceUrlsByFlowsRequest {
1624
1585
  }
1625
1586
 
1626
1587
  /**
1627
- * 流程对应资源链接信息
1588
+ * 授权用户
1628
1589
  */
1629
- export interface FlowResourceUrlInfo {
1590
+ export interface AuthorizedUser {
1630
1591
  /**
1631
- * 流程对应Id
1632
- 注意:此字段可能返回 null,表示取不到有效值。
1633
- */
1634
- FlowId: string
1592
+ * 用户openid
1593
+ */
1594
+ OpenId: string
1595
+ }
1635
1596
 
1597
+ /**
1598
+ * DescribeResourceUrlsByFlows返回参数结构体
1599
+ */
1600
+ export interface DescribeResourceUrlsByFlowsResponse {
1636
1601
  /**
1637
- * 流程对应资源链接信息数组
1638
- 注意:此字段可能返回 null,表示取不到有效值。
1602
+ * 签署流程资源对应链接信息
1603
+ */
1604
+ FlowResourceUrlInfos: Array<FlowResourceUrlInfo>
1605
+
1606
+ /**
1607
+ * 创建消息,对应多个合同ID,
1608
+ 成功为“”,创建失败则对应失败消息
1639
1609
  */
1640
- ResourceUrlInfos: Array<ResourceUrlInfo>
1610
+ ErrorMessages: Array<string>
1611
+
1612
+ /**
1613
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1614
+ */
1615
+ RequestId?: string
1641
1616
  }
1642
1617
 
1643
1618
  /**
1644
- * ChannelCancelFlow请求参数结构体
1619
+ * SyncProxyOrganizationOperators请求参数结构体
1645
1620
  */
1646
- export interface ChannelCancelFlowRequest {
1621
+ export interface SyncProxyOrganizationOperatorsRequest {
1647
1622
  /**
1648
- * 签署流程编号
1623
+ * 渠道应用相关信息。 此接口Agent.AppId 和 Agent.ProxyOrganizationOpenId必填。
1649
1624
  */
1650
- FlowId: string
1625
+ Agent: Agent
1651
1626
 
1652
1627
  /**
1653
- * 渠道应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 均必填。
1628
+ * 操作类型,新增:"CREATE",修改:"UPDATE",离职:"RESIGN"
1654
1629
  */
1655
- Agent?: Agent
1630
+ OperatorType: string
1656
1631
 
1657
1632
  /**
1658
- * 撤回原因,最大不超过200字符
1633
+ * 经办人信息列表,最大长度200
1659
1634
  */
1660
- CancelMessage?: string
1635
+ ProxyOrganizationOperators: Array<ProxyOrganizationOperator>
1661
1636
 
1662
1637
  /**
1663
1638
  * 操作者的信息
1664
1639
  */
1665
1640
  Operator?: UserInfo
1666
-
1667
- /**
1668
- * 撤销理由自定义格式;选项:
1669
- 0 默认格式
1670
- 1 只保留身份信息:展示为【发起方】
1671
- 2 保留身份信息+企业名称:展示为【发起方xxx公司】
1672
- 3 保留身份信息+企业名称+经办人名称:展示为【发起方xxxx公司-经办人姓名】
1673
- */
1674
- CancelMessageFormat?: number
1675
1641
  }
1676
1642
 
1677
1643
  /**
1678
- * DescribeTemplates请求参数结构体
1644
+ * CreateSignUrls请求参数结构体
1679
1645
  */
1680
- export interface DescribeTemplatesRequest {
1646
+ export interface CreateSignUrlsRequest {
1681
1647
  /**
1682
1648
  * 渠道应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 均必填。
1683
1649
  */
1684
1650
  Agent: Agent
1685
1651
 
1686
1652
  /**
1687
- * 模板唯一标识,查询单个模板时使用
1653
+ * 签署流程编号数组,最多支持100个。(备注:该参数和合同组编号必须二选一)
1688
1654
  */
1689
- TemplateId?: string
1655
+ FlowIds?: Array<string>
1690
1656
 
1691
1657
  /**
1692
- * 查询内容:0-模板列表及详情(默认),1-仅模板列表
1658
+ * 合同组编号(备注:该参数和合同(流程)编号数组必须二选一)
1693
1659
  */
1694
- ContentType?: number
1660
+ FlowGroupId?: string
1695
1661
 
1696
1662
  /**
1697
- * 查询个数,默认20,最大100;在查询列表的时候有效
1663
+ * 签署链接类型:“WEIXINAPP”-短链直接跳小程序;“CHANNEL”-跳转H5页面;“APP”-第三方APP或小程序跳转电子签小程序;"LONGURL2WEIXINAPP"-长链接跳转小程序;默认“WEIXINAPP”类型,即跳转至小程序;
1698
1664
  */
1699
- Limit?: number
1665
+ Endpoint?: string
1700
1666
 
1701
1667
  /**
1702
- * 查询偏移位置,默认0;在查询列表的时候有效
1703
- */
1704
- Offset?: number
1668
+ * 签署链接生成类型,默认是 "ALL";
1669
+ "ALL":全部签署方签署链接,此时不会给自动签署的签署方创建签署链接;
1670
+ "CHANNEL":渠道合作企业;
1671
+ "NOT_CHANNEL":非渠道合作企业;
1672
+ "PERSON":个人;
1673
+ "FOLLOWER":关注方,目前是合同抄送方;
1674
+ */
1675
+ GenerateType?: string
1705
1676
 
1706
1677
  /**
1707
- * 是否返回所有组件信息。默认false,只返回发起方控件;true,返回所有签署方控件
1678
+ * 非渠道合作企业参与方的企业名称,GenerateType为"NOT_CHANNEL"时必填
1708
1679
  */
1709
- QueryAllComponents?: boolean
1680
+ OrganizationName?: string
1710
1681
 
1711
1682
  /**
1712
- * 模糊搜索模板名称,最大长度200
1683
+ * 参与人姓名,GenerateType为"PERSON"时必填
1713
1684
  */
1714
- TemplateName?: string
1685
+ Name?: string
1715
1686
 
1716
1687
  /**
1717
- * 操作者的信息
1688
+ * 参与人手机号;
1689
+ GenerateType为"PERSON"或"FOLLOWER"时必填
1690
+ */
1691
+ Mobile?: string
1692
+
1693
+ /**
1694
+ * 渠道合作企业的企业Id,GenerateType为"CHANNEL"时必填
1718
1695
  */
1719
- Operator?: UserInfo
1720
- }
1696
+ OrganizationOpenId?: string
1721
1697
 
1722
- /**
1723
- * SyncProxyOrganizationOperators请求参数结构体
1724
- */
1725
- export interface SyncProxyOrganizationOperatorsRequest {
1726
1698
  /**
1727
- * 渠道应用相关信息。 此接口Agent.AppId 和 Agent.ProxyOrganizationOpenId必填。
1699
+ * 渠道合作企业参与人OpenId,GenerateType为"CHANNEL"时可用,指定到具体参与人
1728
1700
  */
1729
- Agent: Agent
1701
+ OpenId?: string
1730
1702
 
1731
1703
  /**
1732
- * 操作类型,新增:"CREATE",修改:"UPDATE",离职:"RESIGN"
1704
+ * Endpoint为"APP" 类型的签署链接,可以设置此值;支持调用方小程序打开签署链接,在电子签小程序完成签署后自动回跳至调用方小程序
1733
1705
  */
1734
- OperatorType: string
1706
+ AutoJumpBack?: boolean
1735
1707
 
1736
1708
  /**
1737
- * 经办人信息列表,最大长度200
1709
+ * 签署完之后的H5页面的跳转链接,针对Endpoint为CHANNEL时有效,最大长度1000个字符。
1738
1710
  */
1739
- ProxyOrganizationOperators: Array<ProxyOrganizationOperator>
1711
+ JumpUrl?: string
1740
1712
 
1741
1713
  /**
1742
1714
  * 操作者的信息
@@ -1745,123 +1717,61 @@ export interface SyncProxyOrganizationOperatorsRequest {
1745
1717
  }
1746
1718
 
1747
1719
  /**
1748
- * CreateConsoleLoginUrl返回参数结构体
1720
+ * ChannelCreateMultiFlowSignQRCode请求参数结构体
1749
1721
  */
1750
- export interface CreateConsoleLoginUrlResponse {
1722
+ export interface ChannelCreateMultiFlowSignQRCodeRequest {
1751
1723
  /**
1752
- * 子客Web控制台url,此链接5分钟内有效,且只能访问一次。同时需要注意:
1753
- 1. 此链接仅单次有效,使用后需要再次创建新的链接(部分聊天软件,如企业微信默认会对链接进行解析,此时需要使用类似“代码片段”的方式或者放到txt文件里发送链接);
1754
- 2. 创建的链接应避免被转义,如:&被转义为\u0026;如使用Postman请求后,请选择响应类型为 JSON,否则链接将被转义
1724
+ * 渠道应用相关信息。
1725
+ 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 必填。
1755
1726
  */
1756
- ConsoleUrl: string
1727
+ Agent: Agent
1757
1728
 
1758
1729
  /**
1759
- * 渠道子客企业是否已开通腾讯电子签
1760
- */
1761
- IsActivated: boolean
1762
-
1763
- /**
1764
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1730
+ * 模版ID
1765
1731
  */
1766
- RequestId?: string
1767
- }
1732
+ TemplateId: string
1768
1733
 
1769
- /**
1770
- * CreateFlowsByTemplates请求参数结构体
1771
- */
1772
- export interface CreateFlowsByTemplatesRequest {
1773
1734
  /**
1774
- * 渠道应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 均必填。
1735
+ * 签署流程名称,最大长度200个字符。
1775
1736
  */
1776
- Agent: Agent
1737
+ FlowName: string
1777
1738
 
1778
1739
  /**
1779
- * 多个合同(签署流程)信息,最多支持20个
1740
+ * 最大可发起签署流程份数,默认5份;发起签署流程数量超过此上限后,二维码自动失效。
1780
1741
  */
1781
- FlowInfos: Array<FlowInfo>
1782
-
1783
- /**
1784
- * 是否为预览模式;默认为false,即非预览模式,此时发起合同并返回FlowIds;若为预览模式,不会发起合同,会返回PreviewUrls(此Url返回的是PDF文件流 );
1785
- 预览链接有效期300秒;
1786
- 同时,如果预览的文件中指定了动态表格控件,需要进行异步合成;此时此接口返回的是合成前的文档预览链接,而合成完成后的文档预览链接会通过:回调通知的方式、或使用返回的TaskInfo中的TaskId通过ChannelGetTaskResultApi接口查询;
1787
- */
1788
- NeedPreview?: boolean
1742
+ MaxFlowNum?: number
1789
1743
 
1790
1744
  /**
1791
- * 操作者的信息
1745
+ * 签署流程有效天数 默认7天 最高设置不超过30天
1792
1746
  */
1793
- Operator?: UserInfo
1794
- }
1747
+ FlowEffectiveDay?: number
1795
1748
 
1796
- /**
1797
- * 此结构体 (Filter) 用于描述查询过滤条件。
1798
- */
1799
- export interface Filter {
1800
1749
  /**
1801
- * 查询过滤条件的Key
1750
+ * 二维码有效天数 默认7天 最高设置不超过90天
1802
1751
  */
1803
- Key: string
1752
+ QrEffectiveDay?: number
1804
1753
 
1805
1754
  /**
1806
- * 查询过滤条件的Value列表
1755
+ * 限制二维码用户条件
1807
1756
  */
1808
- Values: Array<string>
1809
- }
1757
+ Restrictions?: Array<ApproverRestriction>
1810
1758
 
1811
- /**
1812
- * SyncProxyOrganization请求参数结构体
1813
- */
1814
- export interface SyncProxyOrganizationRequest {
1815
1759
  /**
1816
- * 应用信息
1817
- 此接口Agent.AppId、Agent.ProxyOrganizationOpenId必填
1760
+ * 回调地址,最大长度1000个字符
1761
+ 不传默认使用渠道应用号配置的回调地址
1762
+ 回调时机:用户通过签署二维码发起合同时,企业额度不足导致失败
1818
1763
  */
1819
- Agent: Agent
1820
-
1821
- /**
1822
- * 渠道侧合作企业名称,最大长度64个字符
1823
- */
1824
- ProxyOrganizationName: string
1825
-
1826
- /**
1827
- * 营业执照正面照(PNG或JPG) base64格式, 大小不超过5M
1828
- */
1829
- BusinessLicense?: string
1830
-
1831
- /**
1832
- * 渠道侧合作企业统一社会信用代码,最大长度200个字符
1833
- */
1834
- UniformSocialCreditCode?: string
1764
+ CallbackUrl?: string
1835
1765
 
1836
1766
  /**
1837
- * 操作者的信息
1767
+ * 用户信息
1838
1768
  */
1839
1769
  Operator?: UserInfo
1840
- }
1841
-
1842
- /**
1843
- * CreateSealByImage请求参数结构体
1844
- */
1845
- export interface CreateSealByImageRequest {
1846
- /**
1847
- * 渠道应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 均必填。
1848
- */
1849
- Agent: Agent
1850
-
1851
- /**
1852
- * 印章名称,最大长度不超过30字符
1853
- */
1854
- SealName: string
1855
-
1856
- /**
1857
- * 印章图片base64
1858
- */
1859
- SealImage: string
1860
1770
 
1861
1771
  /**
1862
- * 操作者的信息
1772
+ * 限制二维码用户条件(已弃用)
1863
1773
  */
1864
- Operator?: UserInfo
1774
+ ApproverRestrictions?: ApproverRestriction
1865
1775
  }
1866
1776
 
1867
1777
  /**
@@ -1885,127 +1795,146 @@ export interface SignQrCode {
1885
1795
  }
1886
1796
 
1887
1797
  /**
1888
- * 一码多扫签署二维码签署信息
1798
+ * ChannelGetTaskResultApi请求参数结构体
1889
1799
  */
1890
- export interface SignUrl {
1800
+ export interface ChannelGetTaskResultApiRequest {
1891
1801
  /**
1892
- * 小程序签署链接
1802
+ * 渠道应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 均必填。
1893
1803
  */
1894
- AppSignUrl: string
1804
+ Agent: Agent
1895
1805
 
1896
1806
  /**
1897
- * 签署链接有效时间
1807
+ * 任务Id,通过ChannelCreateConvertTaskApi接口获得
1898
1808
  */
1899
- EffectiveTime: string
1809
+ TaskId: string
1900
1810
 
1901
1811
  /**
1902
- * 移动端签署链接
1812
+ * 操作者的信息
1903
1813
  */
1904
- HttpSignUrl: string
1814
+ Operator?: UserInfo
1815
+
1816
+ /**
1817
+ * 暂未开放
1818
+ */
1819
+ Organization?: OrganizationInfo
1905
1820
  }
1906
1821
 
1907
1822
  /**
1908
- * ChannelBatchCancelFlows返回参数结构体
1823
+ * 签署链接内容
1909
1824
  */
1910
- export interface ChannelBatchCancelFlowsResponse {
1825
+ export interface SignUrlInfo {
1911
1826
  /**
1912
- * 签署流程批量撤销失败原因,错误信息与流程Id一一对应,如果部分流程不可撤销,不会返回错误信息,只会撤销可撤销流程
1913
- */
1914
- FailMessages: Array<string>
1827
+ * 签署链接,过期时间为30天
1828
+ 注意:此字段可能返回 null,表示取不到有效值。
1829
+ */
1830
+ SignUrl: string
1915
1831
 
1916
1832
  /**
1917
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1918
- */
1919
- RequestId?: string
1920
- }
1833
+ * 合同过期时间
1834
+ 注意:此字段可能返回 null,表示取不到有效值。
1835
+ */
1836
+ Deadline: number
1921
1837
 
1922
- /**
1923
- * PrepareFlows请求参数结构体
1924
- */
1925
- export interface PrepareFlowsRequest {
1926
1838
  /**
1927
- * 渠道应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 均必填。
1928
- */
1929
- Agent: Agent
1839
+ * 当流程为顺序签署此参数有效时,数字越小优先级越高,暂不支持并行签署 可选
1840
+ 注意:此字段可能返回 null,表示取不到有效值。
1841
+ */
1842
+ SignOrder: number
1930
1843
 
1931
1844
  /**
1932
- * 多个合同(签署流程)信息,最大支持20个签署流程。
1933
- */
1934
- FlowInfos: Array<FlowInfo>
1845
+ * 签署人编号
1846
+ 注意:此字段可能返回 null,表示取不到有效值。
1847
+ */
1848
+ SignId: string
1935
1849
 
1936
1850
  /**
1937
- * 操作完成后的跳转地址,最大长度200
1938
- */
1939
- JumpUrl: string
1851
+ * 自定义用户编号
1852
+ 注意:此字段可能返回 null,表示取不到有效值。
1853
+ */
1854
+ CustomUserId: string
1940
1855
 
1941
1856
  /**
1942
- * 操作者的信息
1943
- */
1944
- Operator?: UserInfo
1945
- }
1857
+ * 用户姓名
1858
+ 注意:此字段可能返回 null,表示取不到有效值。
1859
+ */
1860
+ Name: string
1946
1861
 
1947
- /**
1948
- * 用量明细
1949
- */
1950
- export interface UsageDetail {
1951
1862
  /**
1952
- * 渠道侧合作企业唯一标识
1953
- */
1954
- ProxyOrganizationOpenId: string
1863
+ * 用户手机号码
1864
+ 注意:此字段可能返回 null,表示取不到有效值。
1865
+ */
1866
+ Mobile: string
1955
1867
 
1956
1868
  /**
1957
- * 渠道侧合作企业名
1869
+ * 签署参与者机构名字
1958
1870
  注意:此字段可能返回 null,表示取不到有效值。
1959
1871
  */
1960
- ProxyOrganizationName: string
1872
+ OrganizationName: string
1961
1873
 
1962
1874
  /**
1963
- * 日期,当需要汇总数据时日期为空
1875
+ * 参与者类型:
1876
+ ORGANIZATION 企业经办人
1877
+ PERSON 自然人
1964
1878
  注意:此字段可能返回 null,表示取不到有效值。
1965
1879
  */
1966
- Date: string
1880
+ ApproverType: string
1967
1881
 
1968
1882
  /**
1969
- * 消耗数量
1970
- */
1971
- Usage: number
1883
+ * 经办人身份证号
1884
+ 注意:此字段可能返回 null,表示取不到有效值。
1885
+ */
1886
+ IdCardNumber: string
1972
1887
 
1973
1888
  /**
1974
- * 撤回数量
1889
+ * 签署链接对应流程Id
1975
1890
  注意:此字段可能返回 null,表示取不到有效值。
1976
1891
  */
1977
- Cancel: number
1892
+ FlowId: string
1893
+
1894
+ /**
1895
+ * 企业经办人 用户在渠道的编号
1896
+ 注意:此字段可能返回 null,表示取不到有效值。
1897
+ */
1898
+ OpenId: string
1899
+
1900
+ /**
1901
+ * 合同组签署链接对应的合同组id
1902
+ 注意:此字段可能返回 null,表示取不到有效值。
1903
+ */
1904
+ FlowGroupId: string
1978
1905
  }
1979
1906
 
1980
1907
  /**
1981
- * ChannelCreateBatchCancelFlowUrl返回参数结构体
1908
+ * CreateFlowsByTemplates返回参数结构体
1982
1909
  */
1983
- export interface ChannelCreateBatchCancelFlowUrlResponse {
1910
+ export interface CreateFlowsByTemplatesResponse {
1984
1911
  /**
1985
- * 批量撤销url
1912
+ * 多个合同ID
1986
1913
  */
1987
- BatchCancelFlowUrl: string
1914
+ FlowIds: Array<string>
1988
1915
 
1989
1916
  /**
1990
- * 签署流程批量撤销失败原因
1917
+ * 渠道的业务信息,限制1024字符
1991
1918
  */
1992
- FailMessages: Array<string>
1919
+ CustomerData: Array<string>
1993
1920
 
1994
1921
  /**
1995
- * 签署撤销url过期时间-年月日-时分秒
1996
- */
1997
- UrlExpireOn: string
1922
+ * 创建消息,对应多个合同ID,
1923
+ 成功为“”,创建失败则对应失败消息
1924
+ */
1925
+ ErrorMessages: Array<string>
1998
1926
 
1999
1927
  /**
2000
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1928
+ * 预览模式下返回的预览文件url数组
2001
1929
  */
2002
- RequestId?: string
2003
- }
1930
+ PreviewUrls: Array<string>
1931
+
1932
+ /**
1933
+ * 复杂文档合成任务(如,包含动态表格的预览任务)的任务信息数组;
1934
+ 如果文档需要异步合成,此字段会返回该异步任务的任务信息,后续可以通过ChannelGetTaskResultApi接口查询任务详情;
1935
+ */
1936
+ TaskInfos: Array<TaskInfo>
2004
1937
 
2005
- /**
2006
- * ChannelCancelFlow返回参数结构体
2007
- */
2008
- export interface ChannelCancelFlowResponse {
2009
1938
  /**
2010
1939
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
2011
1940
  */
@@ -2013,145 +1942,219 @@ export interface ChannelCancelFlowResponse {
2013
1942
  }
2014
1943
 
2015
1944
  /**
2016
- * 签署流程下载信息
1945
+ * 签署参与者信息
2017
1946
  */
2018
- export interface DownloadFlowInfo {
1947
+ export interface Recipient {
2019
1948
  /**
2020
- * 文件夹名称
1949
+ * 签署人唯一标识
2021
1950
  */
2022
- FileName: string
1951
+ RecipientId?: string
2023
1952
 
2024
1953
  /**
2025
- * 签署流程的标识数组
1954
+ * 签署方类型:ENTERPRISE-企业INDIVIDUAL-自然人
2026
1955
  */
2027
- FlowIdList: Array<string>
2028
- }
1956
+ RecipientType?: string
2029
1957
 
2030
- /**
2031
- * ChannelCancelMultiFlowSignQRCode请求参数结构体
2032
- */
2033
- export interface ChannelCancelMultiFlowSignQRCodeRequest {
2034
1958
  /**
2035
- * 渠道应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 均必填。
1959
+ * 描述
2036
1960
  */
2037
- Agent: Agent
1961
+ Description?: string
2038
1962
 
2039
1963
  /**
2040
- * 二维码id
1964
+ * 签署方备注信息
2041
1965
  */
2042
- QrCodeId: string
1966
+ RoleName?: string
2043
1967
 
2044
1968
  /**
2045
- * 用户信息
1969
+ * 是否需要校验
2046
1970
  */
2047
- Operator?: UserInfo
2048
- }
1971
+ RequireValidation?: boolean
2049
1972
 
2050
- /**
2051
- * PrepareFlows返回参数结构体
2052
- */
2053
- export interface PrepareFlowsResponse {
2054
1973
  /**
2055
- * 待发起文件确认页
1974
+ * 是否必须填写
2056
1975
  */
2057
- ConfirmUrl: string
1976
+ RequireSign?: boolean
2058
1977
 
2059
1978
  /**
2060
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1979
+ * 签署类型
2061
1980
  */
2062
- RequestId?: string
1981
+ SignType?: number
1982
+
1983
+ /**
1984
+ * 签署顺序:数字越小优先级越高
1985
+ */
1986
+ RoutingOrder?: number
1987
+
1988
+ /**
1989
+ * 是否是发起方
1990
+ */
1991
+ IsPromoter?: boolean
2063
1992
  }
2064
1993
 
2065
1994
  /**
2066
- * ChannelDescribeEmployees返回参数结构体
1995
+ * SyncProxyOrganizationOperators返回参数结构体
2067
1996
  */
2068
- export interface ChannelDescribeEmployeesResponse {
1997
+ export interface SyncProxyOrganizationOperatorsResponse {
2069
1998
  /**
2070
- * 员工数据列表
1999
+ * Status 同步状态,全部同步失败接口会直接报错
2000
+ 1-成功
2001
+ 2-部分成功
2071
2002
  注意:此字段可能返回 null,表示取不到有效值。
2072
2003
  */
2073
- Employees: Array<Staff>
2004
+ Status: number
2074
2005
 
2075
2006
  /**
2076
- * 偏移量,默认为0,最大为20000
2007
+ * 同步失败经办人及其失败原因
2077
2008
  注意:此字段可能返回 null,表示取不到有效值。
2078
2009
  */
2079
- Offset: number
2010
+ FailedList: Array<SyncFailReason>
2080
2011
 
2081
2012
  /**
2082
- * 返回最大数量,最大为20
2013
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
2083
2014
  */
2084
- Limit: number
2015
+ RequestId?: string
2016
+ }
2085
2017
 
2018
+ /**
2019
+ * 此结构体(FlowDetailInfo)描述的是合同(流程)的详细信息
2020
+ */
2021
+ export interface FlowDetailInfo {
2086
2022
  /**
2087
- * 符合条件的员工数量
2023
+ * 合同(流程)的Id
2088
2024
  */
2089
- TotalCount: number
2025
+ FlowId: string
2090
2026
 
2091
2027
  /**
2092
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
2028
+ * 合同(流程)的名字
2093
2029
  */
2094
- RequestId?: string
2030
+ FlowName: string
2031
+
2032
+ /**
2033
+ * 合同(流程)的类型
2034
+ */
2035
+ FlowType: string
2036
+
2037
+ /**
2038
+ * 合同(流程)的状态
2039
+ */
2040
+ FlowStatus: string
2041
+
2042
+ /**
2043
+ * 合同(流程)的信息
2044
+ */
2045
+ FlowMessage: string
2046
+
2047
+ /**
2048
+ * 合同(流程)的创建时间戳
2049
+ */
2050
+ CreateOn: number
2051
+
2052
+ /**
2053
+ * 合同(流程)的签署截止时间戳
2054
+ */
2055
+ DeadLine: number
2056
+
2057
+ /**
2058
+ * 用户自定义数据
2059
+ */
2060
+ CustomData: string
2061
+
2062
+ /**
2063
+ * 合同(流程)的签署人数组
2064
+ */
2065
+ FlowApproverInfos: Array<FlowApproverDetail>
2095
2066
  }
2096
2067
 
2097
2068
  /**
2098
- * 复杂文档合成任务的任务信息
2069
+ * 流程对应资源链接信息
2099
2070
  */
2100
- export interface TaskInfo {
2071
+ export interface FlowResourceUrlInfo {
2101
2072
  /**
2102
- * 合成任务Id,可以通过 ChannelGetTaskResultApi 接口获取任务信息
2073
+ * 流程对应Id
2103
2074
  注意:此字段可能返回 null,表示取不到有效值。
2104
2075
  */
2105
- TaskId: string
2076
+ FlowId: string
2106
2077
 
2107
2078
  /**
2108
- * 任务状态:READY - 任务已完成;NOTREADY - 任务未完成;
2079
+ * 流程对应资源链接信息数组
2109
2080
  注意:此字段可能返回 null,表示取不到有效值。
2110
2081
  */
2111
- TaskStatus: string
2082
+ ResourceUrlInfos: Array<ResourceUrlInfo>
2112
2083
  }
2113
2084
 
2114
2085
  /**
2115
- * DescribeUsage请求参数结构体
2086
+ * 此结构体 (UploadFile) 用于描述多文件上传的文件信息。
2116
2087
  */
2117
- export interface DescribeUsageRequest {
2088
+ export interface UploadFile {
2118
2089
  /**
2119
- * 应用信息
2090
+ * Base64编码后的文件内容
2120
2091
  */
2121
- Agent: Agent
2092
+ FileBody: string
2122
2093
 
2123
2094
  /**
2124
- * 开始时间,例如:2021-03-21
2095
+ * 文件名
2125
2096
  */
2126
- StartDate: string
2097
+ FileName?: string
2098
+ }
2127
2099
 
2100
+ /**
2101
+ * 此结构体 (Filter) 用于描述查询过滤条件。
2102
+ */
2103
+ export interface Filter {
2128
2104
  /**
2129
- * 结束时间,例如:2021-06-21;
2130
- 开始时间到结束时间的区间长度小于等于90天。
2131
- */
2132
- EndDate: string
2105
+ * 查询过滤条件的Key
2106
+ */
2107
+ Key: string
2133
2108
 
2134
2109
  /**
2135
- * 是否汇总数据,默认不汇总。
2136
- 不汇总:返回在统计区间内渠道下所有企业的每日明细,即每个企业N条数据,N为统计天数;
2137
- 汇总:返回在统计区间内渠道下所有企业的汇总后数据,即每个企业一条数据;
2138
- */
2139
- NeedAggregate?: boolean
2110
+ * 查询过滤条件的Value列表
2111
+ */
2112
+ Values: Array<string>
2113
+ }
2114
+
2115
+ /**
2116
+ * CreateSignUrls返回参数结构体
2117
+ */
2118
+ export interface CreateSignUrlsResponse {
2119
+ /**
2120
+ * 签署参与者签署H5链接信息数组
2121
+ */
2122
+ SignUrlInfos: Array<SignUrlInfo>
2140
2123
 
2141
2124
  /**
2142
- * 单次返回的最多条目数量。默认为1000,且不能超过1000。
2125
+ * 生成失败时的错误信息,成功返回”“,顺序和出参SignUrlInfos保持一致
2143
2126
  */
2144
- Limit?: number
2127
+ ErrorMessages: Array<string>
2145
2128
 
2146
2129
  /**
2147
- * 偏移量,默认是0
2130
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId
2148
2131
  */
2149
- Offset?: number
2132
+ RequestId?: string
2133
+ }
2134
+
2135
+ /**
2136
+ * UploadFiles返回参数结构体
2137
+ */
2138
+ export interface UploadFilesResponse {
2139
+ /**
2140
+ * 文件id数组,有效期一个小时;有效期内此文件id可以反复使用
2141
+ */
2142
+ FileIds: Array<string>
2150
2143
 
2151
2144
  /**
2152
- * 操作者的信息
2145
+ * 上传成功文件数量
2153
2146
  */
2154
- Operator?: UserInfo
2147
+ TotalCount: number
2148
+
2149
+ /**
2150
+ * 文件Url
2151
+ */
2152
+ FileUrls: Array<string>
2153
+
2154
+ /**
2155
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
2156
+ */
2157
+ RequestId?: string
2155
2158
  }
2156
2159
 
2157
2160
  /**
@@ -2200,97 +2203,109 @@ export interface ApproverRestriction {
2200
2203
  }
2201
2204
 
2202
2205
  /**
2203
- * ChannelCreateFlowByFiles请求参数结构体
2206
+ * 合作企业经办人列表信息
2204
2207
  */
2205
- export interface ChannelCreateFlowByFilesRequest {
2208
+ export interface ProxyOrganizationOperator {
2206
2209
  /**
2207
- * 渠道应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 均必填。
2210
+ * 经办人ID(渠道颁发),最大长度64个字符
2208
2211
  */
2209
- Agent?: Agent
2212
+ Id: string
2210
2213
 
2211
2214
  /**
2212
- * 签署流程名称,长度不超过200个字符
2215
+ * 经办人姓名,最大长度50个字符
2213
2216
  */
2214
- FlowName?: string
2217
+ Name?: string
2215
2218
 
2216
2219
  /**
2217
- * 签署流程签约方列表,最多不超过5个参与方
2218
- */
2219
- FlowApprovers?: Array<FlowApproverInfo>
2220
+ * 经办人身份证件类型
2221
+ 1.ID_CARD 居民身份证
2222
+ 2.HONGKONG_MACAO_AND_TAIWAN 港澳台居民居住证
2223
+ 3.HONGKONG_AND_MACAO 港澳居民来往内地通行证
2224
+ */
2225
+ IdCardType?: string
2220
2226
 
2221
2227
  /**
2222
- * 签署文件资源Id列表,目前仅支持单个文件
2228
+ * 经办人证件号
2223
2229
  */
2224
- FileIds?: Array<string>
2230
+ IdCardNumber?: string
2225
2231
 
2226
2232
  /**
2227
- * 签署文件中的发起方的填写控件,需要在发起的时候进行填充
2233
+ * 经办人手机号,大陆手机号输入11位,暂不支持海外手机号。
2228
2234
  */
2229
- Components?: Array<Component>
2235
+ Mobile?: string
2236
+ }
2230
2237
 
2238
+ /**
2239
+ * ChannelCreateFlowByFiles返回参数结构体
2240
+ */
2241
+ export interface ChannelCreateFlowByFilesResponse {
2231
2242
  /**
2232
- * 签署流程截止时间,十位数时间戳,最大值为33162419560,即3020年
2233
- */
2234
- Deadline?: number
2243
+ * 合同签署流程ID
2244
+ 注意:此字段可能返回 null,表示取不到有效值。
2245
+ */
2246
+ FlowId: string
2235
2247
 
2236
2248
  /**
2237
- * 签署流程回调地址,长度不超过255个字符
2249
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
2238
2250
  */
2239
- CallbackUrl?: string
2251
+ RequestId?: string
2252
+ }
2240
2253
 
2254
+ /**
2255
+ * ChannelCreateFlowSignReview返回参数结构体
2256
+ */
2257
+ export interface ChannelCreateFlowSignReviewResponse {
2241
2258
  /**
2242
- * 合同签署顺序类型(无序签,顺序签),默认为false,即有序签署。有序签署时以传入FlowApprovers数组的顺序作为签署顺序
2259
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
2243
2260
  */
2244
- Unordered?: boolean
2261
+ RequestId?: string
2262
+ }
2245
2263
 
2264
+ /**
2265
+ * ChannelDescribeOrganizationSeals返回参数结构体
2266
+ */
2267
+ export interface ChannelDescribeOrganizationSealsResponse {
2246
2268
  /**
2247
- * 签署流程的类型,长度不超过255个字符
2269
+ * 在设置了SealId时返回0或1,没有设置时返回公司的总印章数量,可能比返回的印章数组数量多
2248
2270
  */
2249
- FlowType?: string
2250
-
2251
- /**
2252
- * 签署流程的描述,长度不超过1000个字符
2253
- */
2254
- FlowDescription?: string
2255
-
2256
- /**
2257
- * 合同显示的页卡模板,说明:只支持{合同名称}, {发起方企业}, {发起方姓名}, {签署方N企业}, {签署方N姓名},且N不能超过签署人的数量,N从1开始
2258
- */
2259
- CustomShowMap?: string
2271
+ TotalCount: number
2260
2272
 
2261
2273
  /**
2262
- * 渠道的业务信息,最大长度1000个字符。发起自动签署时,需设置对应自动签署场景,目前仅支持场景:处方单-E_PRESCRIPTION_AUTO_SIGN
2274
+ * 查询到的印章结果数组
2263
2275
  */
2264
- CustomerData?: string
2276
+ Seals: Array<OccupiedSeal>
2265
2277
 
2266
2278
  /**
2267
- * 发起方企业的签署人进行签署操作是否需要企业内部审批。 若设置为true,审核结果需通过接口 ChannelCreateFlowSignReview 通知电子签,审核通过后,发起方企业签署人方可进行签署操作,否则会阻塞其签署操作。 注:企业可以通过此功能与企业内部的审批流程进行关联,支持手动、静默签署合同。
2279
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
2268
2280
  */
2269
- NeedSignReview?: boolean
2281
+ RequestId?: string
2282
+ }
2270
2283
 
2284
+ /**
2285
+ * ChannelCancelMultiFlowSignQRCode返回参数结构体
2286
+ */
2287
+ export interface ChannelCancelMultiFlowSignQRCodeResponse {
2271
2288
  /**
2272
- * 操作者的信息
2289
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
2273
2290
  */
2274
- Operator?: UserInfo
2275
-
2276
- /**
2277
- * 签署人校验方式
2278
- VerifyCheck: 人脸识别(默认)
2279
- MobileCheck:手机号验证
2280
- 参数说明:可选人脸识别或手机号验证两种方式,若选择后者,未实名个人签署方在签署合同时,无需经过实名认证和意愿确认两次人脸识别,该能力仅适用于个人签署方。
2281
- */
2282
- ApproverVerifyType?: string
2291
+ RequestId?: string
2283
2292
  }
2284
2293
 
2285
2294
  /**
2286
- * ChannelCreateFlowByFiles返回参数结构体
2295
+ * ChannelCreateFlowGroupByFiles返回参数结构体
2287
2296
  */
2288
- export interface ChannelCreateFlowByFilesResponse {
2297
+ export interface ChannelCreateFlowGroupByFilesResponse {
2289
2298
  /**
2290
- * 合同签署流程ID
2299
+ * 合同组ID
2291
2300
  注意:此字段可能返回 null,表示取不到有效值。
2292
2301
  */
2293
- FlowId: string
2302
+ FlowGroupId: string
2303
+
2304
+ /**
2305
+ * 子合同ID列表
2306
+ 注意:此字段可能返回 null,表示取不到有效值。
2307
+ */
2308
+ FlowIds: Array<string>
2294
2309
 
2295
2310
  /**
2296
2311
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
@@ -2299,23 +2314,18 @@ export interface ChannelCreateFlowByFilesResponse {
2299
2314
  }
2300
2315
 
2301
2316
  /**
2302
- * UploadFiles返回参数结构体
2317
+ * ChannelCreateMultiFlowSignQRCode返回参数结构体
2303
2318
  */
2304
- export interface UploadFilesResponse {
2305
- /**
2306
- * 文件id数组,有效期一个小时;有效期内此文件id可以反复使用
2307
- */
2308
- FileIds: Array<string>
2309
-
2319
+ export interface ChannelCreateMultiFlowSignQRCodeResponse {
2310
2320
  /**
2311
- * 上传成功文件数量
2321
+ * 签署二维码对象
2312
2322
  */
2313
- TotalCount: number
2323
+ QrCode: SignQrCode
2314
2324
 
2315
2325
  /**
2316
- * 文件Url
2326
+ * 签署链接对象
2317
2327
  */
2318
- FileUrls: Array<string>
2328
+ SignUrls: SignUrl
2319
2329
 
2320
2330
  /**
2321
2331
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
@@ -2324,378 +2334,454 @@ export interface UploadFilesResponse {
2324
2334
  }
2325
2335
 
2326
2336
  /**
2327
- * ChannelCreateFlowSignReview返回参数结构体
2337
+ * 签署人个性化能力信息
2328
2338
  */
2329
- export interface ChannelCreateFlowSignReviewResponse {
2339
+ export interface ApproverOption {
2330
2340
  /**
2331
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
2341
+ * 是否隐藏一键签署 false-不隐藏,默认 true-隐藏
2332
2342
  */
2333
- RequestId?: string
2343
+ HideOneKeySign?: boolean
2334
2344
  }
2335
2345
 
2336
2346
  /**
2337
- * 应用相关信息
2347
+ * ChannelGetTaskResultApi返回参数结构体
2338
2348
  */
2339
- export interface Agent {
2349
+ export interface ChannelGetTaskResultApiResponse {
2340
2350
  /**
2341
- * 腾讯电子签颁发给渠道的应用ID,32位字符串
2351
+ * 任务Id
2342
2352
  */
2343
- AppId: string
2353
+ TaskId: string
2344
2354
 
2345
2355
  /**
2346
- * 渠道/平台合作企业的企业ID,最大64位字符串
2347
- */
2348
- ProxyOrganizationOpenId?: string
2356
+ * 任务状态,需要关注的状态
2357
+ 0 :NeedTranform - 任务已提交
2358
+ 4 :Processing - 文档转换中
2359
+ 8 :TaskEnd - 任务处理完成
2360
+ -2 :DownloadFailed - 下载失败
2361
+ -6 :ProcessFailed - 转换失败
2362
+ -13:ProcessTimeout - 转换文件超时
2363
+ */
2364
+ TaskStatus: number
2349
2365
 
2350
2366
  /**
2351
- * 渠道/平台合作企业经办人(操作员)
2352
- */
2353
- ProxyOperator?: UserInfo
2367
+ * 状态描述,需要关注的状态
2368
+ NeedTranform - 任务已提交
2369
+ Processing - 文档转换中
2370
+ TaskEnd - 任务处理完成
2371
+ DownloadFailed - 下载失败
2372
+ ProcessFailed - 转换失败
2373
+ ProcessTimeout - 转换文件超时
2374
+ */
2375
+ TaskMessage: string
2354
2376
 
2355
2377
  /**
2356
- * 腾讯电子签颁发给渠道侧合作企业的应用ID
2378
+ * 资源Id,也是FileId,用于文件发起使用
2357
2379
  */
2358
- ProxyAppId?: string
2380
+ ResourceId: string
2359
2381
 
2360
2382
  /**
2361
- * 内部参数,腾讯电子签颁发给渠道侧合作企业的企业ID,不需要传
2383
+ * 预览文件Url,有效期30分钟
2384
+ 注意:此字段可能返回 null,表示取不到有效值。
2385
+ */
2386
+ PreviewUrl: string
2387
+
2388
+ /**
2389
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
2362
2390
  */
2363
- ProxyOrganizationId?: string
2391
+ RequestId?: string
2364
2392
  }
2365
2393
 
2366
2394
  /**
2367
- * 此结构 (FormField) 用于描述内容控件填充结构。
2395
+ * 此结构体 (Component) 用于描述控件属性。
2368
2396
 
2397
+ 在通过文件发起合同时,对应的component有三种定位方式
2398
+ 1. 绝对定位方式
2399
+ 2. 表单域(FIELD)定位方式
2400
+ 3. 关键字(KEYWORD)定位方式
2401
+ 可以参考官网说明
2402
+ https://cloud.tencent.com/document/product/1323/78346#component-.E4.B8.89.E7.A7.8D.E5.AE.9A.E4.BD.8D.E6.96.B9.E5.BC.8F.E8.AF.B4.E6.98.8E
2369
2403
  */
2370
- export interface FormField {
2404
+ export interface Component {
2371
2405
  /**
2372
- * 控件填充vaule,ComponentType和传入值类型对应关系:
2373
- TEXT - 文本内容
2374
- MULTI_LINE_TEXT - 文本内容
2375
- CHECK_BOX - true/false
2376
- FILL_IMAGE、ATTACHMENT - 附件的FileId,需要通过UploadFiles接口上传获取
2377
- SELECTOR - 选项值
2378
- DYNAMIC_TABLE - 传入json格式的表格内容,具体见数据结构FlowInfo:https://cloud.tencent.com/document/api/1420/61525#FlowInfo
2379
- */
2380
- ComponentValue: string
2406
+ * 控件编号
2381
2407
 
2382
- /**
2383
- * 表单域或控件的ID,跟ComponentName二选一,不能全为空;
2384
- CreateFlowsByTemplates 接口不使用此字段。
2385
- 注意:此字段可能返回 null,表示取不到有效值。
2408
+ CreateFlowByTemplates发起合同时优先以ComponentId(不为空)填充;否则以ComponentName填充
2409
+
2410
+ 注:
2411
+ 当GenerateMode=3时,通过"^"来决定是否使用关键字整词匹配能力。
2412
+ 例:
2413
+ 当GenerateMode=3时,如果传入关键字"^甲方签署^",则会在PDF文件中有且仅有"甲方签署"关键字的地方进行对应操作。
2414
+ 如传入的关键字为"甲方签署",则PDF文件中每个出现关键字的位置都会执行相应操作。
2415
+
2416
+ 创建控件时,此值为空
2417
+ 查询时返回完整结构
2386
2418
  */
2387
2419
  ComponentId?: string
2388
2420
 
2389
2421
  /**
2390
- * 控件的名字,跟ComponentId二选一,不能全为空
2391
- 注意:此字段可能返回 null,表示取不到有效值。
2422
+ * 如果是Component控件类型,则可选的字段为:
2423
+ TEXT - 普通文本控件;
2424
+ MULTI_LINE_TEXT - 多行文本控件;
2425
+ CHECK_BOX - 勾选框控件;
2426
+ FILL_IMAGE - 图片控件;
2427
+ DYNAMIC_TABLE - 动态表格控件;
2428
+ ATTACHMENT - 附件控件;
2429
+ SELECTOR - 选择器控件;
2430
+ DATE - 日期控件;默认是格式化为xxxx年xx月xx日
2431
+
2432
+ 如果是SignComponent控件类型,则可选的字段为
2433
+ SIGN_SEAL - 签署印章控件;
2434
+ SIGN_DATE - 签署日期控件;
2435
+ SIGN_SIGNATURE - 用户签名控件;
2436
+ SIGN_PERSONAL_SEAL - 个人签署印章控件(使用文件发起暂不支持此类型);
2437
+ SIGN_PAGING_SEAL - 骑缝章;若文件发起,需要对应填充ComponentPosY、ComponentWidth、ComponentHeight
2438
+
2439
+ 表单域的控件不能作为印章和签名控件
2392
2440
  */
2393
- ComponentName?: string
2394
- }
2441
+ ComponentType?: string
2395
2442
 
2396
- /**
2397
- * 接口调用者信息
2398
- */
2399
- export interface UserInfo {
2400
2443
  /**
2401
- * 用户在渠道的编号,最大64位字符串
2444
+ * 控件简称,不能超过30个字符
2402
2445
  */
2403
- OpenId?: string
2446
+ ComponentName?: string
2404
2447
 
2405
2448
  /**
2406
- * 用户的来源渠道
2449
+ * 定义控件是否为必填项,默认为false
2407
2450
  */
2408
- Channel?: string
2451
+ ComponentRequired?: boolean
2409
2452
 
2410
2453
  /**
2411
- * 自定义用户编号
2454
+ * 控件关联的签署方id
2412
2455
  */
2413
- CustomUserId?: string
2456
+ ComponentRecipientId?: string
2414
2457
 
2415
2458
  /**
2416
- * 用户真实IP
2459
+ * 控件所属文件的序号 (文档中文件的排列序号,从0开始)
2417
2460
  */
2418
- ClientIp?: string
2461
+ FileIndex?: number
2419
2462
 
2420
2463
  /**
2421
- * 用户代理IP
2464
+ * 控件生成的方式:
2465
+ NORMAL - 普通控件
2466
+ FIELD - 表单域
2467
+ KEYWORD - 关键字
2468
+ */
2469
+ GenerateMode?: string
2470
+
2471
+ /**
2472
+ * 参数控件宽度,默认100,单位px
2473
+ 表单域和关键字转换控件不用填
2474
+ */
2475
+ ComponentWidth?: number
2476
+
2477
+ /**
2478
+ * 参数控件高度,默认100,单位px
2479
+ 表单域和关键字转换控件不用填
2480
+ */
2481
+ ComponentHeight?: number
2482
+
2483
+ /**
2484
+ * 参数控件所在页码,从1开始
2422
2485
  */
2423
- ProxyIp?: string
2424
- }
2486
+ ComponentPage?: number
2425
2487
 
2426
- /**
2427
- * ChannelCreateConvertTaskApi请求参数结构体
2428
- */
2429
- export interface ChannelCreateConvertTaskApiRequest {
2430
2488
  /**
2431
- * 渠道应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 均必填。
2489
+ * 参数控件X位置,单位px
2432
2490
  */
2433
- Agent: Agent
2491
+ ComponentPosX?: number
2434
2492
 
2435
2493
  /**
2436
- * 资源类型 取值范围doc,docx,html,excel之一
2494
+ * 参数控件Y位置,单位px
2437
2495
  */
2438
- ResourceType: string
2496
+ ComponentPosY?: number
2439
2497
 
2440
2498
  /**
2441
- * 资源名称,长度限制为256字符
2499
+ * 参数控件样式,json格式表述
2500
+ 不同类型的控件会有部分非通用参数
2501
+ TEXT/MULTI_LINE_TEXT控件可以指定
2502
+ 1 Font:目前只支持黑体、宋体
2503
+ 2 FontSize: 范围12-72
2504
+ 3 FontAlign: Left/Right/Center,左对齐/居中/右对齐
2505
+ 例如:{"FontSize":12}
2506
+ */
2507
+ ComponentExtra?: string
2508
+
2509
+ /**
2510
+ * 控件填充vaule,ComponentType和传入值类型对应关系:
2511
+ TEXT - 文本内容
2512
+ MULTI_LINE_TEXT - 文本内容
2513
+ CHECK_BOX - true/false
2514
+ FILL_IMAGE、ATTACHMENT - 附件的FileId,需要通过UploadFiles接口上传获取
2515
+ SELECTOR - 选项值
2516
+ DATE - 默认是格式化为xxxx年xx月xx日
2517
+ DYNAMIC_TABLE - 传入json格式的表格内容,具体见数据结构FlowInfo:https://cloud.tencent.com/document/api/1420/61525#FlowInfo
2518
+ SIGN_SEAL - 印章ID
2519
+ SIGN_PAGING_SEAL - 可以指定印章ID
2520
+ */
2521
+ ComponentValue?: string
2522
+
2523
+ /**
2524
+ * 日期签署控件的字号,默认为 12
2525
+
2526
+ 签署区日期控件会转换成图片格式并带存证,需要通过字体决定图片大小
2527
+ */
2528
+ ComponentDateFontSize?: number
2529
+
2530
+ /**
2531
+ * 控件所属文档的Id, 模块相关接口为空值
2442
2532
  */
2443
- ResourceName: string
2533
+ DocumentId?: string
2444
2534
 
2445
2535
  /**
2446
- * 资源Id,通过UploadFiles获取
2536
+ * 控件描述,不能超过30个字符
2447
2537
  */
2448
- ResourceId: string
2538
+ ComponentDescription?: string
2449
2539
 
2450
2540
  /**
2451
- * 操作者信息
2541
+ * 指定关键字时横坐标偏移量,单位pt
2452
2542
  */
2453
- Operator?: UserInfo
2543
+ OffsetX?: number
2454
2544
 
2455
2545
  /**
2456
- * 暂未开放
2546
+ * 指定关键字时纵坐标偏移量,单位pt
2457
2547
  */
2458
- Organization?: OrganizationInfo
2548
+ OffsetY?: number
2459
2549
  }
2460
2550
 
2461
2551
  /**
2462
- * 签署人的流程信息明细
2552
+ * GetDownloadFlowUrl请求参数结构体
2463
2553
  */
2464
- export interface FlowApproverDetail {
2554
+ export interface GetDownloadFlowUrlRequest {
2465
2555
  /**
2466
- * 模板配置时候的签署人id,与控件绑定
2556
+ * 渠道应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 均必填。
2467
2557
  */
2468
- ReceiptId: string
2558
+ Agent: Agent
2469
2559
 
2470
2560
  /**
2471
- * 渠道侧企业的第三方id
2472
- 注意:此字段可能返回 null,表示取不到有效值。
2473
- */
2474
- ProxyOrganizationOpenId: string
2561
+ * 文件夹数组,签署流程总数不能超过50个,一个文件夹下,不能超过20个签署流程
2562
+ */
2563
+ DownLoadFlows?: Array<DownloadFlowInfo>
2475
2564
 
2476
2565
  /**
2477
- * 渠道侧企业操作人的第三方id
2566
+ * 操作者的信息
2478
2567
  */
2479
- ProxyOperatorOpenId: string
2568
+ Operator?: UserInfo
2569
+ }
2480
2570
 
2571
+ /**
2572
+ * ChannelBatchCancelFlows请求参数结构体
2573
+ */
2574
+ export interface ChannelBatchCancelFlowsRequest {
2481
2575
  /**
2482
- * 渠道侧企业名称
2576
+ * 渠道应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 均必填。
2483
2577
  */
2484
- ProxyOrganizationName: string
2578
+ Agent: Agent
2485
2579
 
2486
2580
  /**
2487
- * 签署人手机号
2581
+ * 签署流程Id数组,最多100个,超过100不处理
2488
2582
  */
2489
- Mobile: string
2583
+ FlowIds: Array<string>
2490
2584
 
2491
2585
  /**
2492
- * 签署人签署顺序
2586
+ * 撤销理由
2493
2587
  */
2494
- SignOrder: number
2588
+ CancelMessage?: string
2495
2589
 
2496
2590
  /**
2497
- * 签署人姓名
2498
- 注意:此字段可能返回 null,表示取不到有效值。
2591
+ * 撤销理由自定义格式;选项:
2592
+ 0 默认格式
2593
+ 1 只保留身份信息:展示为【发起方】
2594
+ 2 保留身份信息+企业名称:展示为【发起方xxx公司】
2595
+ 3 保留身份信息+企业名称+经办人名称:展示为【发起方xxxx公司-经办人姓名】
2499
2596
  */
2500
- ApproveName: string
2597
+ CancelMessageFormat?: number
2501
2598
 
2502
2599
  /**
2503
- * 当前签署人的状态
2504
- 注意:此字段可能返回 null,表示取不到有效值。
2505
- */
2506
- ApproveStatus: string
2600
+ * 操作人信息
2601
+ */
2602
+ Operator?: UserInfo
2603
+ }
2507
2604
 
2605
+ /**
2606
+ * 一码多扫签署二维码签署信息
2607
+ */
2608
+ export interface SignUrl {
2508
2609
  /**
2509
- * 签署人信息
2510
- 注意:此字段可能返回 null,表示取不到有效值。
2511
- */
2512
- ApproveMessage: string
2610
+ * 小程序签署链接
2611
+ */
2612
+ AppSignUrl: string
2513
2613
 
2514
2614
  /**
2515
- * 签署人签署时间
2615
+ * 签署链接有效时间
2516
2616
  */
2517
- ApproveTime: number
2617
+ EffectiveTime: string
2518
2618
 
2519
2619
  /**
2520
- * 参与者类型 (ORGANIZATION企业/PERSON个人)
2521
- 注意:此字段可能返回 null,表示取不到有效值。
2522
- */
2523
- ApproveType: string
2620
+ * 移动端签署链接
2621
+ */
2622
+ HttpSignUrl: string
2524
2623
  }
2525
2624
 
2526
2625
  /**
2527
- * 此结构体 (FlowInfo) 用于描述签署流程信息。
2626
+ * ChannelCancelFlow请求参数结构体
2627
+ */
2628
+ export interface ChannelCancelFlowRequest {
2629
+ /**
2630
+ * 签署流程编号
2631
+ */
2632
+ FlowId: string
2528
2633
 
2529
- 【动态表格传参说明】
2530
- 当模板的 ComponentType='DYNAMIC_TABLE'时(渠道版),FormField.ComponentValue需要传递json格式的字符串参数,用于确定表头&填充动态表格(支持内容的单元格合并)
2531
- 输入示例
2634
+ /**
2635
+ * 渠道应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 均必填。
2636
+ */
2637
+ Agent?: Agent
2532
2638
 
2533
- ```
2534
- {
2535
- "headers":[
2536
- {
2537
- "content":"head1"
2538
- },
2539
- {
2540
- "content":"head2"
2541
- },
2542
- {
2543
- "content":"head3"
2544
- }
2545
- ],
2546
- "rowCount":3,
2547
- "body":{
2548
- "cells":[
2549
- {
2550
- "rowStart":1,
2551
- "rowEnd":1,
2552
- "columnStart":1,
2553
- "columnEnd":1,
2554
- "content":"123"
2555
- },
2556
- {
2557
- "rowStart":2,
2558
- "rowEnd":3,
2559
- "columnStart":1,
2560
- "columnEnd":2,
2561
- "content":"456"
2562
- },
2563
- {
2564
- "rowStart":3,
2565
- "rowEnd":3,
2566
- "columnStart":3,
2567
- "columnEnd":3,
2568
- "content":"789"
2569
- }
2570
- ]
2571
- }
2572
- }
2639
+ /**
2640
+ * 撤回原因,最大不超过200字符
2641
+ */
2642
+ CancelMessage?: string
2573
2643
 
2574
- ```
2644
+ /**
2645
+ * 操作者的信息
2646
+ */
2647
+ Operator?: UserInfo
2648
+
2649
+ /**
2650
+ * 撤销理由自定义格式;选项:
2651
+ 0 默认格式
2652
+ 1 只保留身份信息:展示为【发起方】
2653
+ 2 保留身份信息+企业名称:展示为【发起方xxx公司】
2654
+ 3 保留身份信息+企业名称+经办人名称:展示为【发起方xxxx公司-经办人姓名】
2655
+ */
2656
+ CancelMessageFormat?: number
2657
+ }
2575
2658
 
2576
- 表格参数说明
2659
+ /**
2660
+ * DescribeTemplates请求参数结构体
2661
+ */
2662
+ export interface DescribeTemplatesRequest {
2663
+ /**
2664
+ * 渠道应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 均必填。
2665
+ */
2666
+ Agent: Agent
2577
2667
 
2578
- | 名称 | 类型 | 描述 |
2579
- | ------------------- | ------- | ------------------------------------------------- |
2580
- | headers | Array | 表头:不超过10列,不支持单元格合并,字数不超过100 |
2581
- | rowCount | Integer | 表格内容最大行数 |
2582
- | cells.N.rowStart | Integer | 单元格坐标:行起始index |
2583
- | cells.N.rowEnd | Integer | 单元格坐标:行结束index |
2584
- | cells.N.columnStart | Integer | 单元格坐标:列起始index |
2585
- | cells.N.columnEnd | Integer | 单元格坐标:列结束index |
2586
- | cells.N.content | String | 单元格内容,字数不超过100 |
2668
+ /**
2669
+ * 模板唯一标识,查询单个模板时使用
2670
+ */
2671
+ TemplateId?: string
2587
2672
 
2588
- */
2589
- export interface FlowInfo {
2590
2673
  /**
2591
- * 合同名字,最大长度200个字符
2674
+ * 查询内容:0-模板列表及详情(默认),1-仅模板列表
2592
2675
  */
2593
- FlowName: string
2676
+ ContentType?: number
2594
2677
 
2595
2678
  /**
2596
- * 签署截止时间戳,超过有效签署时间则该签署流程失败,默认一年
2679
+ * 查询个数,默认20,最大100;在查询列表的时候有效
2597
2680
  */
2598
- Deadline: number
2681
+ Limit?: number
2599
2682
 
2600
2683
  /**
2601
- * 模板ID
2684
+ * 查询偏移位置,默认0;在查询列表的时候有效
2602
2685
  */
2603
- TemplateId?: string
2686
+ Offset?: number
2604
2687
 
2605
2688
  /**
2606
- * 多个签署人信息,最大支持50个签署方
2689
+ * 是否返回所有组件信息。默认false,只返回发起方控件;true,返回所有签署方控件
2607
2690
  */
2608
- FlowApprovers?: Array<FlowApproverInfo>
2691
+ QueryAllComponents?: boolean
2609
2692
 
2610
2693
  /**
2611
- * 表单K-V对列表
2694
+ * 模糊搜索模板名称,最大长度200
2612
2695
  */
2613
- FormFields?: Array<FormField>
2696
+ TemplateName?: string
2614
2697
 
2615
2698
  /**
2616
- * 回调地址,最大长度1000个字符
2699
+ * 操作者的信息
2617
2700
  */
2618
- CallbackUrl?: string
2701
+ Operator?: UserInfo
2702
+ }
2619
2703
 
2704
+ /**
2705
+ * 持有的电子印章信息
2706
+ */
2707
+ export interface OccupiedSeal {
2620
2708
  /**
2621
- * 合同类型,如:1. “劳务”;2. “销售”;3. “租赁”;4. “其他”,最大长度200个字符
2709
+ * 电子印章编号
2622
2710
  */
2623
- FlowType?: string
2711
+ SealId: string
2624
2712
 
2625
2713
  /**
2626
- * 合同描述,最大长度1000个字符
2714
+ * 电子印章名称
2627
2715
  */
2628
- FlowDescription?: string
2716
+ SealName: string
2629
2717
 
2630
2718
  /**
2631
- * 渠道的业务信息,最大长度1000个字符。发起自动签署时,需设置对应自动签署场景,目前仅支持场景:处方单-E_PRESCRIPTION_AUTO_SIGN
2719
+ * 电子印章授权时间戳
2632
2720
  */
2633
- CustomerData?: string
2721
+ CreateOn: number
2634
2722
 
2635
2723
  /**
2636
- * 合同显示的页卡模板,说明:只支持{合同名称}, {发起方企业}, {发起方姓名}, {签署方N企业}, {签署方N姓名},且N不能超过签署人的数量,N从1开始
2724
+ * 电子印章授权人
2637
2725
  */
2638
- CustomShowMap?: string
2726
+ Creator: string
2639
2727
 
2640
2728
  /**
2641
- * 被抄送人的信息列表,抄送功能暂不开放
2729
+ * 电子印章策略Id
2642
2730
  */
2643
- CcInfos?: Array<CcInfo>
2731
+ SealPolicyId: string
2644
2732
 
2645
2733
  /**
2646
- * 发起方企业的签署人进行签署操作是否需要企业内部审批。
2647
- 若设置为true,审核结果需通过接口 ChannelCreateFlowSignReview 通知电子签,审核通过后,发起方企业签署人方可进行签署操作,否则会阻塞其签署操作。
2734
+ * 印章状态,有以下六种:CHECKING(审核中)SUCCESS(已启用)FAIL(审核拒绝)CHECKING-SADM(待超管审核)DISABLE(已停用)STOPPED(已终止)
2735
+ */
2736
+ SealStatus: string
2648
2737
 
2649
- 注:企业可以通过此功能与企业内部的审批流程进行关联,支持手动、静默签署合同。
2738
+ /**
2739
+ * 审核失败原因
2740
+ 注意:此字段可能返回 null,表示取不到有效值。
2650
2741
  */
2651
- NeedSignReview?: boolean
2652
- }
2742
+ FailReason: string
2653
2743
 
2654
- /**
2655
- * ChannelCreateFlowGroupByFiles请求参数结构体
2656
- */
2657
- export interface ChannelCreateFlowGroupByFilesRequest {
2658
2744
  /**
2659
- * 每个子合同的发起所需的信息,数量限制2-100
2745
+ * 印章图片url,5分钟内有效
2660
2746
  */
2661
- FlowFileInfos: Array<FlowFileInfo>
2747
+ Url: string
2662
2748
 
2663
2749
  /**
2664
- * 合同组名称,长度不超过200个字符
2750
+ * 印章类型
2665
2751
  */
2666
- FlowGroupName: string
2752
+ SealType: string
2667
2753
 
2668
2754
  /**
2669
- * 渠道应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 均必填。
2755
+ * 用印申请是否为永久授权
2670
2756
  */
2671
- Agent?: Agent
2757
+ IsAllTime: boolean
2672
2758
 
2673
2759
  /**
2674
- * 操作者的信息
2760
+ * 授权人列表
2675
2761
  */
2676
- Operator?: UserInfo
2762
+ AuthorizedUsers: Array<AuthorizedUser>
2677
2763
  }
2678
2764
 
2679
2765
  /**
2680
- * UploadFiles请求参数结构体
2766
+ * CreateFlowsByTemplates请求参数结构体
2681
2767
  */
2682
- export interface UploadFilesRequest {
2768
+ export interface CreateFlowsByTemplatesRequest {
2683
2769
  /**
2684
- * 应用相关信息,若是渠道版调用 appidproxyappid 必填
2770
+ * 渠道应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId Agent.ProxyAppId 均必填。
2685
2771
  */
2686
2772
  Agent: Agent
2687
2773
 
2688
2774
  /**
2689
- * 文件对应业务类型
2690
- 1. TEMPLATE - 模板; 文件类型:.pdf/.doc/.docx/.html
2691
- 2. DOCUMENT - 签署过程及签署后的合同文档/图片控件 文件类型:.pdf/.doc/.docx/.jpg/.png/.xls.xlsx/.html
2692
- */
2693
- BusinessType: string
2775
+ * 多个合同(签署流程)信息,最多支持20个
2776
+ */
2777
+ FlowInfos: Array<FlowInfo>
2694
2778
 
2695
2779
  /**
2696
- * 上传文件内容数组,最多支持20个文件
2697
- */
2698
- FileInfos?: Array<UploadFile>
2780
+ * 是否为预览模式;默认为false,即非预览模式,此时发起合同并返回FlowIds;若为预览模式,不会发起合同,会返回PreviewUrls(此Url返回的是PDF文件流 );
2781
+ 预览链接有效期300秒;
2782
+ 同时,如果预览的文件中指定了动态表格控件,需要进行异步合成;此时此接口返回的是合成前的文档预览链接,而合成完成后的文档预览链接会通过:回调通知的方式、或使用返回的TaskInfo中的TaskId通过ChannelGetTaskResultApi接口查询;
2783
+ */
2784
+ NeedPreview?: boolean
2699
2785
 
2700
2786
  /**
2701
2787
  * 操作者的信息
@@ -2704,118 +2790,153 @@ export interface UploadFilesRequest {
2704
2790
  }
2705
2791
 
2706
2792
  /**
2707
- * 企业员工信息
2793
+ * 用量明细
2708
2794
  */
2709
- export interface Staff {
2710
- /**
2711
- * 员工在电子签平台的id
2712
- */
2713
- UserId: string
2714
-
2715
- /**
2716
- * 显示的员工名
2717
- */
2718
- DisplayName: string
2719
-
2795
+ export interface UsageDetail {
2720
2796
  /**
2721
- * 员工手机号
2797
+ * 渠道侧合作企业唯一标识
2722
2798
  */
2723
- Mobile: string
2799
+ ProxyOrganizationOpenId: string
2724
2800
 
2725
2801
  /**
2726
- * 员工邮箱
2802
+ * 渠道侧合作企业名
2727
2803
  注意:此字段可能返回 null,表示取不到有效值。
2728
2804
  */
2729
- Email: string
2805
+ ProxyOrganizationName: string
2730
2806
 
2731
2807
  /**
2732
- * 员工在第三方平台id
2808
+ * 日期,当需要汇总数据时日期为空
2733
2809
  注意:此字段可能返回 null,表示取不到有效值。
2734
2810
  */
2735
- OpenId: string
2811
+ Date: string
2736
2812
 
2737
2813
  /**
2738
- * 员工角色
2739
- 注意:此字段可能返回 null,表示取不到有效值。
2740
- */
2741
- Roles: Array<StaffRole>
2814
+ * 消耗数量
2815
+ */
2816
+ Usage: number
2742
2817
 
2743
2818
  /**
2744
- * 员工部门
2819
+ * 撤回数量
2745
2820
  注意:此字段可能返回 null,表示取不到有效值。
2746
2821
  */
2747
- Department: Department
2822
+ Cancel: number
2823
+ }
2748
2824
 
2825
+ /**
2826
+ * ChannelCreateBatchCancelFlowUrl返回参数结构体
2827
+ */
2828
+ export interface ChannelCreateBatchCancelFlowUrlResponse {
2749
2829
  /**
2750
- * 员工是否实名
2830
+ * 批量撤销url
2751
2831
  */
2752
- Verified: boolean
2832
+ BatchCancelFlowUrl: string
2753
2833
 
2754
2834
  /**
2755
- * 员工创建时间戳
2835
+ * 签署流程批量撤销失败原因
2756
2836
  */
2757
- CreatedOn: number
2837
+ FailMessages: Array<string>
2758
2838
 
2759
2839
  /**
2760
- * 员工实名时间戳
2840
+ * 签署撤销url过期时间-年月日-时分秒
2761
2841
  */
2762
- VerifiedOn: number
2763
- }
2842
+ UrlExpireOn: string
2764
2843
 
2765
- /**
2766
- * 抄送信息
2767
- */
2768
- export interface CcInfo {
2769
2844
  /**
2770
- * 被抄送人手机号,大陆11位手机号
2845
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
2771
2846
  */
2772
- Mobile?: string
2847
+ RequestId?: string
2773
2848
  }
2774
2849
 
2775
2850
  /**
2776
- * ChannelCancelMultiFlowSignQRCode返回参数结构体
2851
+ * OperateChannelTemplate请求参数结构体
2777
2852
  */
2778
- export interface ChannelCancelMultiFlowSignQRCodeResponse {
2853
+ export interface OperateChannelTemplateRequest {
2779
2854
  /**
2780
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
2855
+ * 渠道应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 均必填。
2781
2856
  */
2782
- RequestId?: string
2783
- }
2857
+ Agent: Agent
2784
2858
 
2785
- /**
2786
- * DescribeFlowDetailInfo返回参数结构体
2787
- */
2788
- export interface DescribeFlowDetailInfoResponse {
2789
2859
  /**
2790
- * 渠道侧应用号Id
2860
+ * 操作类型,查询:"SELECT",删除:"DELETE",更新:"UPDATE"
2791
2861
  */
2792
- ApplicationId: string
2862
+ OperateType: string
2793
2863
 
2794
2864
  /**
2795
- * 渠道侧企业第三方Id
2865
+ * 渠道方模板库模板唯一标识
2796
2866
  */
2797
- ProxyOrganizationOpenId: string
2867
+ TemplateId: string
2798
2868
 
2799
2869
  /**
2800
- * 合同(签署流程)的具体详细描述信息
2870
+ * 合作企业方第三方机构唯一标识数据,支持多个, 用","进行分隔
2871
+ */
2872
+ ProxyOrganizationOpenIds?: string
2873
+
2874
+ /**
2875
+ * 模板可见性, 全部可见-"all", 部分可见-"part"
2876
+ */
2877
+ AuthTag?: string
2878
+
2879
+ /**
2880
+ * 操作者的信息
2881
+ */
2882
+ Operator?: UserInfo
2883
+ }
2884
+
2885
+ /**
2886
+ * 同步经办人失败原因
2887
+ */
2888
+ export interface SyncFailReason {
2889
+ /**
2890
+ * 经办人Id
2891
+ */
2892
+ Id: string
2893
+
2894
+ /**
2895
+ * 失败原因
2896
+ 例如:Id不符合规范、证件号码不合法等
2801
2897
  注意:此字段可能返回 null,表示取不到有效值。
2802
2898
  */
2803
- FlowInfo: Array<FlowDetailInfo>
2899
+ Message: string
2900
+ }
2804
2901
 
2902
+ /**
2903
+ * ChannelDescribeEmployees返回参数结构体
2904
+ */
2905
+ export interface ChannelDescribeEmployeesResponse {
2805
2906
  /**
2806
- * 合同组编号
2907
+ * 员工数据列表
2807
2908
  注意:此字段可能返回 null,表示取不到有效值。
2808
2909
  */
2809
- FlowGroupId: string
2910
+ Employees: Array<Staff>
2810
2911
 
2811
2912
  /**
2812
- * 合同组名称
2913
+ * 偏移量,默认为0,最大为20000
2813
2914
  注意:此字段可能返回 null,表示取不到有效值。
2814
2915
  */
2815
- FlowGroupName: string
2916
+ Offset: number
2917
+
2918
+ /**
2919
+ * 返回最大数量,最大为20
2920
+ */
2921
+ Limit: number
2922
+
2923
+ /**
2924
+ * 符合条件的员工数量
2925
+ */
2926
+ TotalCount: number
2816
2927
 
2817
2928
  /**
2818
2929
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
2819
2930
  */
2820
2931
  RequestId?: string
2821
2932
  }
2933
+
2934
+ /**
2935
+ * 抄送信息
2936
+ */
2937
+ export interface CcInfo {
2938
+ /**
2939
+ * 被抄送人手机号,大陆11位手机号
2940
+ */
2941
+ Mobile?: string
2942
+ }