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