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