tencentcloud-sdk-nodejs-essbasic 4.0.1054 → 4.1.2
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/README.md +18 -4
- package/es/index.js +1 -0
- package/es/services/essbasic/index.js +6 -0
- package/es/services/essbasic/v20201222/essbasic_client.js +165 -0
- package/es/services/essbasic/v20201222/essbasic_models.js +0 -0
- package/es/services/essbasic/v20201222/index.js +6 -0
- package/es/services/essbasic/v20210526/essbasic_client.js +273 -0
- package/es/services/essbasic/v20210526/essbasic_models.js +0 -0
- package/es/services/essbasic/v20210526/index.js +6 -0
- package/es/services/index.js +1 -0
- package/package.json +16 -5
- package/tencentcloud/services/essbasic/v20201222/essbasic_client.js +2 -1
- package/tencentcloud/services/essbasic/v20201222/index.js +2 -1
- package/tencentcloud/services/essbasic/v20210526/essbasic_client.js +2 -1
- package/tencentcloud/services/essbasic/v20210526/essbasic_models.d.ts +2 -1
- package/tencentcloud/services/essbasic/v20210526/index.js +2 -1
- package/index.d.ts +0 -2
- package/index.js +0 -6
- package/prettier.config.js +0 -38
- package/src/index.ts +0 -1
- package/src/services/essbasic/index.ts +0 -7
- package/src/services/essbasic/v20201222/essbasic_client.ts +0 -735
- package/src/services/essbasic/v20201222/essbasic_models.ts +0 -3354
- package/src/services/essbasic/v20201222/index.ts +0 -6
- package/src/services/essbasic/v20210526/essbasic_client.ts +0 -2192
- package/src/services/essbasic/v20210526/essbasic_models.ts +0 -9426
- package/src/services/essbasic/v20210526/index.ts +0 -6
- package/src/services/index.ts +0 -1
- package/tsconfig.json +0 -33
- package/typings/index.d.ts +0 -2
|
@@ -1,3354 +0,0 @@
|
|
|
1
|
-
/*
|
|
2
|
-
* Copyright (c) 2018 THL A29 Limited, a Tencent company. All Rights Reserved.
|
|
3
|
-
*
|
|
4
|
-
* Licensed under the Apache License, Version 2.0 (the "License");
|
|
5
|
-
* you may not use this file except in compliance with the License.
|
|
6
|
-
* You may obtain a copy of the License at
|
|
7
|
-
*
|
|
8
|
-
* http://www.apache.org/licenses/LICENSE-2.0
|
|
9
|
-
*
|
|
10
|
-
* Unless required by applicable law or agreed to in writing,
|
|
11
|
-
* software distributed under the License is distributed on an
|
|
12
|
-
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
|
|
13
|
-
* KIND, either express or implied. See the License for the
|
|
14
|
-
* specific language governing permissions and limitations
|
|
15
|
-
* under the License.
|
|
16
|
-
*/
|
|
17
|
-
|
|
18
|
-
/**
|
|
19
|
-
* DescribeFaceIdResults请求参数结构体
|
|
20
|
-
*/
|
|
21
|
-
export interface DescribeFaceIdResultsRequest {
|
|
22
|
-
/**
|
|
23
|
-
* 调用方信息
|
|
24
|
-
*/
|
|
25
|
-
Caller: Caller
|
|
26
|
-
/**
|
|
27
|
-
* 慧眼业务ID
|
|
28
|
-
*/
|
|
29
|
-
WbAppId: string
|
|
30
|
-
/**
|
|
31
|
-
* 订单号(orderNo); 限制在3个或以内
|
|
32
|
-
*/
|
|
33
|
-
OrderNumbers: Array<string>
|
|
34
|
-
/**
|
|
35
|
-
* 1:视频+照片,2:照片,3:视频,0(或其他数字):无; 可选
|
|
36
|
-
*/
|
|
37
|
-
FileType?: number
|
|
38
|
-
}
|
|
39
|
-
|
|
40
|
-
/**
|
|
41
|
-
* CreateSubOrganization请求参数结构体
|
|
42
|
-
*/
|
|
43
|
-
export interface CreateSubOrganizationRequest {
|
|
44
|
-
/**
|
|
45
|
-
* 调用方信息
|
|
46
|
-
*/
|
|
47
|
-
Caller: Caller
|
|
48
|
-
/**
|
|
49
|
-
* 机构证件号码类型可选值:
|
|
50
|
-
1. USCC - 统一社会信用代码
|
|
51
|
-
2. BIZREGISTNO - 营业执照注册号
|
|
52
|
-
*/
|
|
53
|
-
IdCardType: string
|
|
54
|
-
/**
|
|
55
|
-
* 机构证件号码
|
|
56
|
-
*/
|
|
57
|
-
IdCardNumber: string
|
|
58
|
-
/**
|
|
59
|
-
* 机构类型可选值:
|
|
60
|
-
1. ENTERPRISE - 企业
|
|
61
|
-
2. INDIVIDUALBIZ - 个体工商户
|
|
62
|
-
3. PUBLICINSTITUTION - 政府/事业单位
|
|
63
|
-
4. OTHERS - 其他组织
|
|
64
|
-
*/
|
|
65
|
-
OrganizationType: string
|
|
66
|
-
/**
|
|
67
|
-
* 机构法人/经营者姓名
|
|
68
|
-
*/
|
|
69
|
-
LegalName: string
|
|
70
|
-
/**
|
|
71
|
-
* 机构法人/经营者证件类型可选值:
|
|
72
|
-
1. ID_CARD - 居民身份证
|
|
73
|
-
2. PASSPORT - 护照
|
|
74
|
-
3. MAINLAND_TRAVEL_PERMIT_FOR_HONGKONG_AND_MACAO_RESIDENTS - 港澳居民来往内地通行证
|
|
75
|
-
4. MAINLAND_TRAVEL_PERMIT_FOR_TAIWAN_RESIDENTS - 台湾居民来往大陆通行证
|
|
76
|
-
5. HOUSEHOLD_REGISTER - 户口本
|
|
77
|
-
6. TEMP_ID_CARD - 临时居民身份证
|
|
78
|
-
*/
|
|
79
|
-
LegalIdCardType: string
|
|
80
|
-
/**
|
|
81
|
-
* 机构法人/经营者证件号码;
|
|
82
|
-
OrganizationType 为 ENTERPRISE时,INDIVIDUALBIZ 时必填,其他情况选填
|
|
83
|
-
*/
|
|
84
|
-
LegalIdCardNumber: string
|
|
85
|
-
/**
|
|
86
|
-
* 机构名称全称
|
|
87
|
-
*/
|
|
88
|
-
Name: string
|
|
89
|
-
/**
|
|
90
|
-
* 机构在第三方的唯一标识,32位以内标识符
|
|
91
|
-
*/
|
|
92
|
-
OpenId?: string
|
|
93
|
-
/**
|
|
94
|
-
* 是否使用OpenId作为数据主键,如果为true,请确保OpenId在当前应用号唯一
|
|
95
|
-
*/
|
|
96
|
-
UseOpenId?: boolean
|
|
97
|
-
/**
|
|
98
|
-
* 机构证件文件类型可选值:
|
|
99
|
-
1. USCCFILE - 统一社会信用代码证书
|
|
100
|
-
2. LICENSEFILE - 营业执照
|
|
101
|
-
*/
|
|
102
|
-
IdCardFileType?: string
|
|
103
|
-
/**
|
|
104
|
-
* 机构证件照片文件,base64编码,支持jpg、jpeg、png格式
|
|
105
|
-
*/
|
|
106
|
-
BizLicenseFile?: string
|
|
107
|
-
/**
|
|
108
|
-
* 机构证件照片文件名
|
|
109
|
-
*/
|
|
110
|
-
BizLicenseFileName?: string
|
|
111
|
-
/**
|
|
112
|
-
* 机构法人/经营者/联系人手机号码
|
|
113
|
-
*/
|
|
114
|
-
LegalMobile?: string
|
|
115
|
-
/**
|
|
116
|
-
* 组织联系人姓名
|
|
117
|
-
*/
|
|
118
|
-
ContactName?: string
|
|
119
|
-
/**
|
|
120
|
-
* 实名认证的客户端IP
|
|
121
|
-
*/
|
|
122
|
-
VerifyClientIp?: string
|
|
123
|
-
/**
|
|
124
|
-
* 实名认证的服务器IP
|
|
125
|
-
*/
|
|
126
|
-
VerifyServerIp?: string
|
|
127
|
-
/**
|
|
128
|
-
* 企业联系地址
|
|
129
|
-
*/
|
|
130
|
-
ContactAddress?: Address
|
|
131
|
-
/**
|
|
132
|
-
* 机构电子邮箱
|
|
133
|
-
*/
|
|
134
|
-
Email?: string
|
|
135
|
-
}
|
|
136
|
-
|
|
137
|
-
/**
|
|
138
|
-
* 此结构体 (Component) 用于描述控件属性。
|
|
139
|
-
*/
|
|
140
|
-
export interface Component {
|
|
141
|
-
/**
|
|
142
|
-
* 控件编号
|
|
143
|
-
|
|
144
|
-
注:
|
|
145
|
-
当GenerateMode=3时,通过"^"来决定是否使用关键字整词匹配能力。
|
|
146
|
-
例:
|
|
147
|
-
当GenerateMode=3时,如果传入关键字"^甲方签署^",则会在PDF文件中有且仅有"甲方签署"关键字的地方进行对应操作。
|
|
148
|
-
如传入的关键字为"甲方签署",则PDF文件中每个出现关键字的位置都会执行相应操作。
|
|
149
|
-
*/
|
|
150
|
-
ComponentId?: string
|
|
151
|
-
/**
|
|
152
|
-
* 如果是Component控件类型,则可选的字段为:
|
|
153
|
-
TEXT - 普通文本控件;
|
|
154
|
-
DATE - 普通日期控件;
|
|
155
|
-
SELECT- 勾选框控件;
|
|
156
|
-
如果是SignComponent控件类型,则可选的字段为
|
|
157
|
-
SIGN_SEAL- 签署印章控件;
|
|
158
|
-
SIGN_DATE- 签署日期控件;
|
|
159
|
-
SIGN_SIGNATURE - 用户签名控件;
|
|
160
|
-
*/
|
|
161
|
-
ComponentType?: string
|
|
162
|
-
/**
|
|
163
|
-
* 控件名称
|
|
164
|
-
*/
|
|
165
|
-
ComponentName?: string
|
|
166
|
-
/**
|
|
167
|
-
* 定义控件是否为必填项,默认为false
|
|
168
|
-
*/
|
|
169
|
-
ComponentRequired?: boolean
|
|
170
|
-
/**
|
|
171
|
-
* 控件所属文件的序号 (模板中的resourceId排列序号)
|
|
172
|
-
*/
|
|
173
|
-
FileIndex?: number
|
|
174
|
-
/**
|
|
175
|
-
* 控件生成的方式:
|
|
176
|
-
0 - 普通控件
|
|
177
|
-
1 - 表单域
|
|
178
|
-
2 - html 控件
|
|
179
|
-
3 - 关键字
|
|
180
|
-
*/
|
|
181
|
-
GenerateMode?: number
|
|
182
|
-
/**
|
|
183
|
-
* 参数控件宽度,单位px
|
|
184
|
-
*/
|
|
185
|
-
ComponentWidth?: number
|
|
186
|
-
/**
|
|
187
|
-
* 参数控件高度,单位px
|
|
188
|
-
*/
|
|
189
|
-
ComponentHeight?: number
|
|
190
|
-
/**
|
|
191
|
-
* 参数控件所在页码
|
|
192
|
-
*/
|
|
193
|
-
ComponentPage?: number
|
|
194
|
-
/**
|
|
195
|
-
* 参数控件X位置,单位px
|
|
196
|
-
*/
|
|
197
|
-
ComponentPosX?: number
|
|
198
|
-
/**
|
|
199
|
-
* 参数控件Y位置,单位px
|
|
200
|
-
*/
|
|
201
|
-
ComponentPosY?: number
|
|
202
|
-
/**
|
|
203
|
-
* 参数控件样式
|
|
204
|
-
*/
|
|
205
|
-
ComponentExtra?: string
|
|
206
|
-
/**
|
|
207
|
-
* 印章ID,如果是手写签名则为jpg或png格式的base64图片
|
|
208
|
-
|
|
209
|
-
SIGN_SEAL控件,可以用ORG_DEFAULT_SEAL表示主企业的默认印章
|
|
210
|
-
SIGN_SEAL控件,可以用SUBORG_DEFAULT_SEAL表示子企业的默认印章
|
|
211
|
-
SIGN_SEAL控件,可以用USER_DEFAULT_SEAL表示个人默认印章
|
|
212
|
-
*/
|
|
213
|
-
ComponentValue?: string
|
|
214
|
-
/**
|
|
215
|
-
* 如果是SIGN_SEAL类型的签署控件, 参数标识H5签署界面是否在该签署区上进行放置展示, 1为放置,其他为不放置
|
|
216
|
-
*/
|
|
217
|
-
SealOperate?: number
|
|
218
|
-
/**
|
|
219
|
-
* 不同GenerateMode对应的额外信息
|
|
220
|
-
*/
|
|
221
|
-
GenerateExtra?: string
|
|
222
|
-
}
|
|
223
|
-
|
|
224
|
-
/**
|
|
225
|
-
* CreateSeal请求参数结构体
|
|
226
|
-
*/
|
|
227
|
-
export interface CreateSealRequest {
|
|
228
|
-
/**
|
|
229
|
-
* 调用方信息
|
|
230
|
-
*/
|
|
231
|
-
Caller: Caller
|
|
232
|
-
/**
|
|
233
|
-
* 印章类型:
|
|
234
|
-
1. PERSONAL - 个人私章
|
|
235
|
-
2. OFFICIAL - 公章
|
|
236
|
-
3. SPECIAL_FINANCIAL - 财务专用章
|
|
237
|
-
4. CONTRACT - 合同专用章
|
|
238
|
-
5. LEGAL_REPRESENTATIVE - 法定代表人章
|
|
239
|
-
6. SPECIAL_NATIONWIDE_INVOICE - 发票专用章
|
|
240
|
-
7. OTHER-其他
|
|
241
|
-
*/
|
|
242
|
-
SealType: string
|
|
243
|
-
/**
|
|
244
|
-
* 印章名称
|
|
245
|
-
*/
|
|
246
|
-
SealName: string
|
|
247
|
-
/**
|
|
248
|
-
* 请求创建印章的客户端IP
|
|
249
|
-
*/
|
|
250
|
-
SourceIp: string
|
|
251
|
-
/**
|
|
252
|
-
* 印章图片,base64编码(与FileId参数二选一,同时传入参数时优先使用Image参数)
|
|
253
|
-
*/
|
|
254
|
-
Image?: string
|
|
255
|
-
/**
|
|
256
|
-
* 印章文件图片ID(与Image参数二选一,同时传入参数时优先使用Image参数)
|
|
257
|
-
*/
|
|
258
|
-
FileId?: string
|
|
259
|
-
/**
|
|
260
|
-
* 需要创建印章的用户ID
|
|
261
|
-
*/
|
|
262
|
-
UserId?: string
|
|
263
|
-
/**
|
|
264
|
-
* 是否是默认印章 true:是,false:否
|
|
265
|
-
*/
|
|
266
|
-
IsDefault?: boolean
|
|
267
|
-
}
|
|
268
|
-
|
|
269
|
-
/**
|
|
270
|
-
* CancelFlow返回参数结构体
|
|
271
|
-
*/
|
|
272
|
-
export interface CancelFlowResponse {
|
|
273
|
-
/**
|
|
274
|
-
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
275
|
-
*/
|
|
276
|
-
RequestId?: string
|
|
277
|
-
}
|
|
278
|
-
|
|
279
|
-
/**
|
|
280
|
-
* 此结构体 (FaceIdPhoto) 用于描述慧眼人脸核身照片信息。
|
|
281
|
-
*/
|
|
282
|
-
export interface FaceIdPhoto {
|
|
283
|
-
/**
|
|
284
|
-
* 核身结果:
|
|
285
|
-
0 - 通过;
|
|
286
|
-
1 - 未通过
|
|
287
|
-
*/
|
|
288
|
-
Result: number
|
|
289
|
-
/**
|
|
290
|
-
* 核身失败描述
|
|
291
|
-
*/
|
|
292
|
-
Description: string
|
|
293
|
-
/**
|
|
294
|
-
* 照片数据 (base64编码, 一般为JPG或PNG)
|
|
295
|
-
*/
|
|
296
|
-
Photo: string
|
|
297
|
-
/**
|
|
298
|
-
* 订单号 (orderNo)
|
|
299
|
-
*/
|
|
300
|
-
OrderNumber: string
|
|
301
|
-
}
|
|
302
|
-
|
|
303
|
-
/**
|
|
304
|
-
* VerifySubOrganization请求参数结构体
|
|
305
|
-
*/
|
|
306
|
-
export interface VerifySubOrganizationRequest {
|
|
307
|
-
/**
|
|
308
|
-
* 调用方信息,该接口SubOrganizationId必填
|
|
309
|
-
*/
|
|
310
|
-
Caller: Caller
|
|
311
|
-
/**
|
|
312
|
-
* 机构在第三方的唯一标识,32位定长字符串,与 Caller 中 SubOrgnizationId 二者至少需要传入一个,全部传入时则使用 SubOrganizationId 信息
|
|
313
|
-
*/
|
|
314
|
-
OpenId?: string
|
|
315
|
-
}
|
|
316
|
-
|
|
317
|
-
/**
|
|
318
|
-
* VerifyUser请求参数结构体
|
|
319
|
-
*/
|
|
320
|
-
export interface VerifyUserRequest {
|
|
321
|
-
/**
|
|
322
|
-
* 调用方信息
|
|
323
|
-
*/
|
|
324
|
-
Caller: Caller
|
|
325
|
-
/**
|
|
326
|
-
* 电子签平台用户ID
|
|
327
|
-
*/
|
|
328
|
-
UserId: string
|
|
329
|
-
/**
|
|
330
|
-
* 是否需要下发个人长效证书,默认为false
|
|
331
|
-
注:如您有下发个人长效证书需求,请提前邮件至e-contract@oa.com进行申请。
|
|
332
|
-
*/
|
|
333
|
-
CertificateRequired?: boolean
|
|
334
|
-
}
|
|
335
|
-
|
|
336
|
-
/**
|
|
337
|
-
* DescribeFaceIdPhotos返回参数结构体
|
|
338
|
-
*/
|
|
339
|
-
export interface DescribeFaceIdPhotosResponse {
|
|
340
|
-
/**
|
|
341
|
-
* 照片信息列表
|
|
342
|
-
*/
|
|
343
|
-
Photos?: Array<FaceIdPhoto>
|
|
344
|
-
/**
|
|
345
|
-
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
346
|
-
*/
|
|
347
|
-
RequestId?: string
|
|
348
|
-
}
|
|
349
|
-
|
|
350
|
-
/**
|
|
351
|
-
* CheckVerifyCodeMatchFlowId请求参数结构体
|
|
352
|
-
*/
|
|
353
|
-
export interface CheckVerifyCodeMatchFlowIdRequest {
|
|
354
|
-
/**
|
|
355
|
-
* 调用方信息
|
|
356
|
-
*/
|
|
357
|
-
Caller: Caller
|
|
358
|
-
/**
|
|
359
|
-
* 手机号
|
|
360
|
-
*/
|
|
361
|
-
Mobile: string
|
|
362
|
-
/**
|
|
363
|
-
* 验证码
|
|
364
|
-
*/
|
|
365
|
-
VerifyCode: string
|
|
366
|
-
/**
|
|
367
|
-
* 流程(目录) id
|
|
368
|
-
*/
|
|
369
|
-
FlowId: string
|
|
370
|
-
}
|
|
371
|
-
|
|
372
|
-
/**
|
|
373
|
-
* CheckBankCard2EVerification请求参数结构体
|
|
374
|
-
*/
|
|
375
|
-
export interface CheckBankCard2EVerificationRequest {
|
|
376
|
-
/**
|
|
377
|
-
* 调用方信息; 必选
|
|
378
|
-
*/
|
|
379
|
-
Caller: Caller
|
|
380
|
-
/**
|
|
381
|
-
* 银行卡号
|
|
382
|
-
*/
|
|
383
|
-
BankCard: string
|
|
384
|
-
/**
|
|
385
|
-
* 姓名
|
|
386
|
-
*/
|
|
387
|
-
Name: string
|
|
388
|
-
}
|
|
389
|
-
|
|
390
|
-
/**
|
|
391
|
-
* DescribeFileIdsByCustomIds返回参数结构体
|
|
392
|
-
*/
|
|
393
|
-
export interface DescribeFileIdsByCustomIdsResponse {
|
|
394
|
-
/**
|
|
395
|
-
* <自定义Id,文件id>数组
|
|
396
|
-
*/
|
|
397
|
-
CustomIdList: Array<CustomFileIdMap>
|
|
398
|
-
/**
|
|
399
|
-
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
400
|
-
*/
|
|
401
|
-
RequestId?: string
|
|
402
|
-
}
|
|
403
|
-
|
|
404
|
-
/**
|
|
405
|
-
* ModifySubOrganizationInfo返回参数结构体
|
|
406
|
-
*/
|
|
407
|
-
export interface ModifySubOrganizationInfoResponse {
|
|
408
|
-
/**
|
|
409
|
-
* 子机构ID
|
|
410
|
-
*/
|
|
411
|
-
SubOrganizationId: string
|
|
412
|
-
/**
|
|
413
|
-
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
414
|
-
*/
|
|
415
|
-
RequestId?: string
|
|
416
|
-
}
|
|
417
|
-
|
|
418
|
-
/**
|
|
419
|
-
* DescribeCatalogApprovers请求参数结构体
|
|
420
|
-
*/
|
|
421
|
-
export interface DescribeCatalogApproversRequest {
|
|
422
|
-
/**
|
|
423
|
-
* 调用方信息
|
|
424
|
-
*/
|
|
425
|
-
Caller: Caller
|
|
426
|
-
/**
|
|
427
|
-
* 目录ID
|
|
428
|
-
*/
|
|
429
|
-
CatalogId: string
|
|
430
|
-
/**
|
|
431
|
-
* 查询指定用户是否为参与者,为空表示查询所有参与者
|
|
432
|
-
*/
|
|
433
|
-
UserId?: string
|
|
434
|
-
}
|
|
435
|
-
|
|
436
|
-
/**
|
|
437
|
-
* CheckFaceIdentify请求参数结构体
|
|
438
|
-
*/
|
|
439
|
-
export interface CheckFaceIdentifyRequest {
|
|
440
|
-
/**
|
|
441
|
-
* 调用方信息; 必选
|
|
442
|
-
*/
|
|
443
|
-
Caller: Caller
|
|
444
|
-
/**
|
|
445
|
-
* 人脸核身渠道; 必选; WEIXINAPP:腾讯电子签小程序,FACEID:腾讯电子签慧眼,None:白名单中的客户直接通过
|
|
446
|
-
*/
|
|
447
|
-
VerifyChannel: string
|
|
448
|
-
/**
|
|
449
|
-
* 核身订单号; 必选; 对于WEIXINAPP,直接取响应的{VerifyResult};对于FACEID,使用{WbAppId}:{OrderNo}拼接
|
|
450
|
-
*/
|
|
451
|
-
VerifyResult: string
|
|
452
|
-
/**
|
|
453
|
-
* 要对比的姓名; 可选; 未填写时对比caller.OperatorId的实名信息
|
|
454
|
-
*/
|
|
455
|
-
Name?: string
|
|
456
|
-
/**
|
|
457
|
-
* 要对比的身份证号码; 可选; 未填写时对比caller.OperatorId的实名信息
|
|
458
|
-
*/
|
|
459
|
-
IdCardNumber?: string
|
|
460
|
-
/**
|
|
461
|
-
* 是否取认证时的照片
|
|
462
|
-
*/
|
|
463
|
-
GetPhoto?: boolean
|
|
464
|
-
}
|
|
465
|
-
|
|
466
|
-
/**
|
|
467
|
-
* CreateServerFlowSign返回参数结构体
|
|
468
|
-
*/
|
|
469
|
-
export interface CreateServerFlowSignResponse {
|
|
470
|
-
/**
|
|
471
|
-
* 任务状态:
|
|
472
|
-
0:失败
|
|
473
|
-
1:成功
|
|
474
|
-
*/
|
|
475
|
-
SignStatus: number
|
|
476
|
-
/**
|
|
477
|
-
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
478
|
-
*/
|
|
479
|
-
RequestId?: string
|
|
480
|
-
}
|
|
481
|
-
|
|
482
|
-
/**
|
|
483
|
-
* ModifyUser返回参数结构体
|
|
484
|
-
*/
|
|
485
|
-
export interface ModifyUserResponse {
|
|
486
|
-
/**
|
|
487
|
-
* 腾讯电子签平台用户唯一标识
|
|
488
|
-
*/
|
|
489
|
-
UserId: string
|
|
490
|
-
/**
|
|
491
|
-
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
492
|
-
*/
|
|
493
|
-
RequestId?: string
|
|
494
|
-
}
|
|
495
|
-
|
|
496
|
-
/**
|
|
497
|
-
* CheckBankCard4EVerification返回参数结构体
|
|
498
|
-
*/
|
|
499
|
-
export interface CheckBankCard4EVerificationResponse {
|
|
500
|
-
/**
|
|
501
|
-
* 检测结果
|
|
502
|
-
计费结果码:
|
|
503
|
-
0: 认证通过
|
|
504
|
-
1: 认证未通过
|
|
505
|
-
2: 持卡人信息有误
|
|
506
|
-
3: 未开通无卡支付
|
|
507
|
-
4: 此卡被没收
|
|
508
|
-
5: 无效卡号
|
|
509
|
-
6: 此卡无对应发卡行
|
|
510
|
-
7: 该卡未初始化或睡眠卡
|
|
511
|
-
8: 作弊卡、吞卡
|
|
512
|
-
9: 此卡已挂失
|
|
513
|
-
10: 该卡已过期
|
|
514
|
-
11: 受限制的卡
|
|
515
|
-
12: 密码错误次数超限
|
|
516
|
-
13: 发卡行不支持此交易
|
|
517
|
-
不收费结果码:
|
|
518
|
-
101: 姓名校验不通过
|
|
519
|
-
102: 银行卡号码有误
|
|
520
|
-
103: 验证中心服务繁忙
|
|
521
|
-
104: 身份证号码有误
|
|
522
|
-
105: 手机号码不合法
|
|
523
|
-
*/
|
|
524
|
-
Result?: number
|
|
525
|
-
/**
|
|
526
|
-
* 结果描述; 未通过时必选
|
|
527
|
-
*/
|
|
528
|
-
Description?: string
|
|
529
|
-
/**
|
|
530
|
-
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
531
|
-
*/
|
|
532
|
-
RequestId?: string
|
|
533
|
-
}
|
|
534
|
-
|
|
535
|
-
/**
|
|
536
|
-
* DescribeFileUrls请求参数结构体
|
|
537
|
-
*/
|
|
538
|
-
export interface DescribeFileUrlsRequest {
|
|
539
|
-
/**
|
|
540
|
-
* 调用方信息
|
|
541
|
-
*/
|
|
542
|
-
Caller: Caller
|
|
543
|
-
/**
|
|
544
|
-
* 业务编号数组,如模板编号、文档编号、印章编号、流程编号、目录编号
|
|
545
|
-
*/
|
|
546
|
-
BusinessIds: Array<string>
|
|
547
|
-
/**
|
|
548
|
-
* 业务类型:
|
|
549
|
-
1. TEMPLATE - 模板
|
|
550
|
-
2. SEAL - 印章
|
|
551
|
-
3. FLOW - 流程
|
|
552
|
-
4.CATALOG - 目录
|
|
553
|
-
*/
|
|
554
|
-
BusinessType: string
|
|
555
|
-
/**
|
|
556
|
-
* 下载后的文件命名,只有FileType为“ZIP”时生效
|
|
557
|
-
*/
|
|
558
|
-
FileName?: string
|
|
559
|
-
/**
|
|
560
|
-
* 单个业务ID多个资源情况下,指定资源起始偏移量
|
|
561
|
-
*/
|
|
562
|
-
ResourceOffset?: number
|
|
563
|
-
/**
|
|
564
|
-
* 单个业务ID多个资源情况下,指定资源数量
|
|
565
|
-
*/
|
|
566
|
-
ResourceLimit?: number
|
|
567
|
-
/**
|
|
568
|
-
* 文件类型,支持"JPG", "PDF","ZIP"等,默认为上传的文件类型
|
|
569
|
-
*/
|
|
570
|
-
FileType?: string
|
|
571
|
-
}
|
|
572
|
-
|
|
573
|
-
/**
|
|
574
|
-
* 此结构体 (FlowFileInfo) 用于描述流程文档信息。
|
|
575
|
-
*/
|
|
576
|
-
export interface FlowFileInfo {
|
|
577
|
-
/**
|
|
578
|
-
* 文件序号
|
|
579
|
-
*/
|
|
580
|
-
FileIndex: number
|
|
581
|
-
/**
|
|
582
|
-
* 文件类型
|
|
583
|
-
*/
|
|
584
|
-
FileType: string
|
|
585
|
-
/**
|
|
586
|
-
* 文件的MD5码
|
|
587
|
-
*/
|
|
588
|
-
FileMd5: string
|
|
589
|
-
/**
|
|
590
|
-
* 文件名
|
|
591
|
-
*/
|
|
592
|
-
FileName: string
|
|
593
|
-
/**
|
|
594
|
-
* 文件大小,单位为Byte
|
|
595
|
-
*/
|
|
596
|
-
FileSize: number
|
|
597
|
-
/**
|
|
598
|
-
* 文件创建时间戳
|
|
599
|
-
*/
|
|
600
|
-
CreatedOn: number
|
|
601
|
-
/**
|
|
602
|
-
* 文件的下载地址
|
|
603
|
-
*/
|
|
604
|
-
Url: string
|
|
605
|
-
}
|
|
606
|
-
|
|
607
|
-
/**
|
|
608
|
-
* 此结构体 (SmsTemplate) 用于描述短信模板。
|
|
609
|
-
*/
|
|
610
|
-
export interface SmsTemplate {
|
|
611
|
-
/**
|
|
612
|
-
* 模板ID,必须填写已审核通过的模板ID。模板ID可登录短信控制台查看。
|
|
613
|
-
*/
|
|
614
|
-
TemplateId: string
|
|
615
|
-
/**
|
|
616
|
-
* 短信签名内容,使用UTF-8编码,必须填写已审核通过的签名,签名信息可登录短信控制台查看。
|
|
617
|
-
*/
|
|
618
|
-
Sign: string
|
|
619
|
-
}
|
|
620
|
-
|
|
621
|
-
/**
|
|
622
|
-
* 此结构体 (Address) 用于描述住址或通讯地址。
|
|
623
|
-
*/
|
|
624
|
-
export interface Address {
|
|
625
|
-
/**
|
|
626
|
-
* 省份
|
|
627
|
-
*/
|
|
628
|
-
Province: string
|
|
629
|
-
/**
|
|
630
|
-
* 城市
|
|
631
|
-
*/
|
|
632
|
-
City: string
|
|
633
|
-
/**
|
|
634
|
-
* 区县
|
|
635
|
-
*/
|
|
636
|
-
County: string
|
|
637
|
-
/**
|
|
638
|
-
* 详细地址
|
|
639
|
-
*/
|
|
640
|
-
Details: string
|
|
641
|
-
/**
|
|
642
|
-
* 国家,默认中国
|
|
643
|
-
*/
|
|
644
|
-
Country?: string
|
|
645
|
-
}
|
|
646
|
-
|
|
647
|
-
/**
|
|
648
|
-
* ModifyUserDefaultSeal请求参数结构体
|
|
649
|
-
*/
|
|
650
|
-
export interface ModifyUserDefaultSealRequest {
|
|
651
|
-
/**
|
|
652
|
-
* 调用方信息
|
|
653
|
-
*/
|
|
654
|
-
Caller: Caller
|
|
655
|
-
/**
|
|
656
|
-
* 用户唯一标识,需要重新指定默认印章的用户ID
|
|
657
|
-
*/
|
|
658
|
-
UserId: string
|
|
659
|
-
/**
|
|
660
|
-
* 重新指定的默认印章ID
|
|
661
|
-
*/
|
|
662
|
-
SealId: string
|
|
663
|
-
/**
|
|
664
|
-
* 请求重新指定个人默认印章的客户端IP
|
|
665
|
-
*/
|
|
666
|
-
SourceIp: string
|
|
667
|
-
}
|
|
668
|
-
|
|
669
|
-
/**
|
|
670
|
-
* GenerateUserSeal请求参数结构体
|
|
671
|
-
*/
|
|
672
|
-
export interface GenerateUserSealRequest {
|
|
673
|
-
/**
|
|
674
|
-
* 调用方信息
|
|
675
|
-
*/
|
|
676
|
-
Caller: Caller
|
|
677
|
-
/**
|
|
678
|
-
* 用户ID
|
|
679
|
-
*/
|
|
680
|
-
UserId: string
|
|
681
|
-
/**
|
|
682
|
-
* 请求生成个人印章的客户端IP
|
|
683
|
-
*/
|
|
684
|
-
SourceIp: string
|
|
685
|
-
/**
|
|
686
|
-
* 电子印章名称
|
|
687
|
-
*/
|
|
688
|
-
SealName?: string
|
|
689
|
-
/**
|
|
690
|
-
* 是否是默认印章 true:是,false:否
|
|
691
|
-
*/
|
|
692
|
-
IsDefault?: boolean
|
|
693
|
-
}
|
|
694
|
-
|
|
695
|
-
/**
|
|
696
|
-
* CheckIdCardVerification返回参数结构体
|
|
697
|
-
*/
|
|
698
|
-
export interface CheckIdCardVerificationResponse {
|
|
699
|
-
/**
|
|
700
|
-
* 检测结果;
|
|
701
|
-
收费错误码:
|
|
702
|
-
0: 通过,
|
|
703
|
-
1: 姓名和身份证号不一致,
|
|
704
|
-
免费错误码:
|
|
705
|
-
101: 非法身份证号(长度,格式等不正确),
|
|
706
|
-
102: 非法姓名(长度,格式等不正确),
|
|
707
|
-
103: 验证平台异常,
|
|
708
|
-
104: 证件库中无此身份证记录
|
|
709
|
-
*/
|
|
710
|
-
Result?: number
|
|
711
|
-
/**
|
|
712
|
-
* 结果描述; 未通过时必选
|
|
713
|
-
*/
|
|
714
|
-
Description?: string
|
|
715
|
-
/**
|
|
716
|
-
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
717
|
-
*/
|
|
718
|
-
RequestId?: string
|
|
719
|
-
}
|
|
720
|
-
|
|
721
|
-
/**
|
|
722
|
-
* DescribeFlow返回参数结构体
|
|
723
|
-
*/
|
|
724
|
-
export interface DescribeFlowResponse {
|
|
725
|
-
/**
|
|
726
|
-
* 流程创建者信息
|
|
727
|
-
*/
|
|
728
|
-
Creator: Caller
|
|
729
|
-
/**
|
|
730
|
-
* 流程编号
|
|
731
|
-
*/
|
|
732
|
-
FlowId: string
|
|
733
|
-
/**
|
|
734
|
-
* 流程名称
|
|
735
|
-
*/
|
|
736
|
-
FlowName: string
|
|
737
|
-
/**
|
|
738
|
-
* 流程描述
|
|
739
|
-
*/
|
|
740
|
-
FlowDescription: string
|
|
741
|
-
/**
|
|
742
|
-
* 流程的类型: ”劳务合同“,”租赁合同“,”销售合同“,”其他“
|
|
743
|
-
*/
|
|
744
|
-
FlowType: string
|
|
745
|
-
/**
|
|
746
|
-
* 流程状态:
|
|
747
|
-
0-创建;
|
|
748
|
-
1-签署中;
|
|
749
|
-
2-拒签;
|
|
750
|
-
3-撤回;
|
|
751
|
-
4-签完存档完成;
|
|
752
|
-
5-已过期;
|
|
753
|
-
6-已销毁
|
|
754
|
-
7-签署完成未归档
|
|
755
|
-
*/
|
|
756
|
-
FlowStatus: number
|
|
757
|
-
/**
|
|
758
|
-
* 流程创建时间
|
|
759
|
-
*/
|
|
760
|
-
CreatedOn: number
|
|
761
|
-
/**
|
|
762
|
-
* 流程完成时间
|
|
763
|
-
*/
|
|
764
|
-
UpdatedOn: number
|
|
765
|
-
/**
|
|
766
|
-
* 流程截止日期
|
|
767
|
-
*/
|
|
768
|
-
Deadline: number
|
|
769
|
-
/**
|
|
770
|
-
* 回调地址
|
|
771
|
-
*/
|
|
772
|
-
CallbackUrl: string
|
|
773
|
-
/**
|
|
774
|
-
* 流程中止原因
|
|
775
|
-
*/
|
|
776
|
-
FlowMessage: string
|
|
777
|
-
/**
|
|
778
|
-
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
779
|
-
*/
|
|
780
|
-
RequestId?: string
|
|
781
|
-
}
|
|
782
|
-
|
|
783
|
-
/**
|
|
784
|
-
* CreateSubOrganizationAndSeal请求参数结构体
|
|
785
|
-
*/
|
|
786
|
-
export interface CreateSubOrganizationAndSealRequest {
|
|
787
|
-
/**
|
|
788
|
-
* 调用方信息
|
|
789
|
-
*/
|
|
790
|
-
Caller: Caller
|
|
791
|
-
/**
|
|
792
|
-
* 机构名称全称
|
|
793
|
-
*/
|
|
794
|
-
Name: string
|
|
795
|
-
/**
|
|
796
|
-
* 机构证件号码类型可选值:
|
|
797
|
-
1. USCC - 统一社会信用代码
|
|
798
|
-
2. BIZREGISTNO - 营业执照注册号
|
|
799
|
-
*/
|
|
800
|
-
IdCardType: string
|
|
801
|
-
/**
|
|
802
|
-
* 机构证件号码
|
|
803
|
-
*/
|
|
804
|
-
IdCardNumber: string
|
|
805
|
-
/**
|
|
806
|
-
* 机构类型可选值:
|
|
807
|
-
1. ENTERPRISE - 企业
|
|
808
|
-
2. INDIVIDUALBIZ - 个体工商户
|
|
809
|
-
3. PUBLICINSTITUTION - 政府/事业单位
|
|
810
|
-
4. OTHERS - 其他组织
|
|
811
|
-
*/
|
|
812
|
-
OrganizationType: string
|
|
813
|
-
/**
|
|
814
|
-
* 机构法人/经营者姓名
|
|
815
|
-
*/
|
|
816
|
-
LegalName: string
|
|
817
|
-
/**
|
|
818
|
-
* 机构法人/经营者证件类型可选值:
|
|
819
|
-
1. ID_CARD - 居民身份证
|
|
820
|
-
2. PASSPORT - 护照
|
|
821
|
-
3. MAINLAND_TRAVEL_PERMIT_FOR_HONGKONG_AND_MACAO_RESIDENTS - 港澳居民来往内地通行证
|
|
822
|
-
4. MAINLAND_TRAVEL_PERMIT_FOR_TAIWAN_RESIDENTS - 台湾居民来往大陆通行证
|
|
823
|
-
5. HOUSEHOLD_REGISTER - 户口本
|
|
824
|
-
6. TEMP_ID_CARD - 临时居民身份证
|
|
825
|
-
*/
|
|
826
|
-
LegalIdCardType: string
|
|
827
|
-
/**
|
|
828
|
-
* 机构法人/经营者证件号码;
|
|
829
|
-
OrganizationType 为 ENTERPRISE时,INDIVIDUALBIZ 时必填,其他情况选填
|
|
830
|
-
*/
|
|
831
|
-
LegalIdCardNumber: string
|
|
832
|
-
/**
|
|
833
|
-
* 实名认证的客户端IP/请求生成企业印章的客户端Ip
|
|
834
|
-
*/
|
|
835
|
-
VerifyClientIp: string
|
|
836
|
-
/**
|
|
837
|
-
* 机构电子邮箱
|
|
838
|
-
*/
|
|
839
|
-
Email?: string
|
|
840
|
-
/**
|
|
841
|
-
* 机构证件文件类型可选值:
|
|
842
|
-
1. USCCFILE - 统一社会信用代码证书
|
|
843
|
-
2. LICENSEFILE - 营业执照
|
|
844
|
-
*/
|
|
845
|
-
IdCardFileType?: string
|
|
846
|
-
/**
|
|
847
|
-
* 机构证件照片文件,base64编码,支持jpg、jpeg、png格式
|
|
848
|
-
*/
|
|
849
|
-
BizLicenseFile?: string
|
|
850
|
-
/**
|
|
851
|
-
* 机构证件照片文件名
|
|
852
|
-
*/
|
|
853
|
-
BizLicenseFileName?: string
|
|
854
|
-
/**
|
|
855
|
-
* 机构法人/经营者/联系人手机号码
|
|
856
|
-
*/
|
|
857
|
-
LegalMobile?: string
|
|
858
|
-
/**
|
|
859
|
-
* 组织联系人姓名
|
|
860
|
-
*/
|
|
861
|
-
ContactName?: string
|
|
862
|
-
/**
|
|
863
|
-
* 实名认证的服务器IP
|
|
864
|
-
*/
|
|
865
|
-
VerifyServerIp?: string
|
|
866
|
-
/**
|
|
867
|
-
* 企业联系地址
|
|
868
|
-
*/
|
|
869
|
-
ContactAddress?: Address
|
|
870
|
-
/**
|
|
871
|
-
* 电子印章名称
|
|
872
|
-
*/
|
|
873
|
-
SealName?: string
|
|
874
|
-
/**
|
|
875
|
-
* 印章类型:默认: CONTRACT
|
|
876
|
-
1. OFFICIAL-公章
|
|
877
|
-
2. SPECIAL_FINANCIAL-财务专用章
|
|
878
|
-
3. CONTRACT-合同专用章
|
|
879
|
-
4. LEGAL_REPRESENTATIVE-法定代表人章
|
|
880
|
-
5. SPECIAL_NATIONWIDE_INVOICE-发票专用章
|
|
881
|
-
6. OTHER-其他
|
|
882
|
-
*/
|
|
883
|
-
SealType?: string
|
|
884
|
-
/**
|
|
885
|
-
* 企业印章横向文字,最多可填8个汉字(可为空,默认为"电子签名专用章")
|
|
886
|
-
*/
|
|
887
|
-
SealHorizontalText?: string
|
|
888
|
-
/**
|
|
889
|
-
* 机构在第三方的唯一标识,32位以内标识符
|
|
890
|
-
*/
|
|
891
|
-
OpenId?: string
|
|
892
|
-
/**
|
|
893
|
-
* 是否使用OpenId作为数据主键,如果为true,请确保OpenId在当前应用号唯一
|
|
894
|
-
*/
|
|
895
|
-
UseOpenId?: boolean
|
|
896
|
-
}
|
|
897
|
-
|
|
898
|
-
/**
|
|
899
|
-
* CheckMobileVerification请求参数结构体
|
|
900
|
-
*/
|
|
901
|
-
export interface CheckMobileVerificationRequest {
|
|
902
|
-
/**
|
|
903
|
-
* 调用方信息; 必选
|
|
904
|
-
*/
|
|
905
|
-
Caller: Caller
|
|
906
|
-
/**
|
|
907
|
-
* 手机号
|
|
908
|
-
*/
|
|
909
|
-
Mobile: string
|
|
910
|
-
/**
|
|
911
|
-
* 姓名
|
|
912
|
-
*/
|
|
913
|
-
Name: string
|
|
914
|
-
/**
|
|
915
|
-
* 身份证件号码
|
|
916
|
-
*/
|
|
917
|
-
IdCardNumber: string
|
|
918
|
-
/**
|
|
919
|
-
* 身份证件类型; ID_CARD
|
|
920
|
-
*/
|
|
921
|
-
IdCardType?: string
|
|
922
|
-
}
|
|
923
|
-
|
|
924
|
-
/**
|
|
925
|
-
* SendFlowUrl返回参数结构体
|
|
926
|
-
*/
|
|
927
|
-
export interface SendFlowUrlResponse {
|
|
928
|
-
/**
|
|
929
|
-
* 签署任务ID,标识每一次的流程发送
|
|
930
|
-
*/
|
|
931
|
-
SignId: string
|
|
932
|
-
/**
|
|
933
|
-
* 签署链接
|
|
934
|
-
*/
|
|
935
|
-
SignUrl?: string
|
|
936
|
-
/**
|
|
937
|
-
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
938
|
-
*/
|
|
939
|
-
RequestId?: string
|
|
940
|
-
}
|
|
941
|
-
|
|
942
|
-
/**
|
|
943
|
-
* DescribeCatalogApprovers返回参数结构体
|
|
944
|
-
*/
|
|
945
|
-
export interface DescribeCatalogApproversResponse {
|
|
946
|
-
/**
|
|
947
|
-
* 参与者列表
|
|
948
|
-
*/
|
|
949
|
-
Approvers: Array<CatalogApprovers>
|
|
950
|
-
/**
|
|
951
|
-
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
952
|
-
*/
|
|
953
|
-
RequestId?: string
|
|
954
|
-
}
|
|
955
|
-
|
|
956
|
-
/**
|
|
957
|
-
* <自定义Id,文件id>映射对象
|
|
958
|
-
*/
|
|
959
|
-
export interface CustomFileIdMap {
|
|
960
|
-
/**
|
|
961
|
-
* 用户自定义ID
|
|
962
|
-
*/
|
|
963
|
-
CustomId: string
|
|
964
|
-
/**
|
|
965
|
-
* 文件id
|
|
966
|
-
*/
|
|
967
|
-
FileId: string
|
|
968
|
-
}
|
|
969
|
-
|
|
970
|
-
/**
|
|
971
|
-
* SendFlow返回参数结构体
|
|
972
|
-
*/
|
|
973
|
-
export interface SendFlowResponse {
|
|
974
|
-
/**
|
|
975
|
-
* 签署任务ID,标识每一次的流程发送
|
|
976
|
-
*/
|
|
977
|
-
SignId: string
|
|
978
|
-
/**
|
|
979
|
-
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
980
|
-
*/
|
|
981
|
-
RequestId?: string
|
|
982
|
-
}
|
|
983
|
-
|
|
984
|
-
/**
|
|
985
|
-
* 目录流程参与者
|
|
986
|
-
*/
|
|
987
|
-
export interface CatalogApprovers {
|
|
988
|
-
/**
|
|
989
|
-
* 流程ID
|
|
990
|
-
*/
|
|
991
|
-
FlowId: string
|
|
992
|
-
/**
|
|
993
|
-
* 参与者列表
|
|
994
|
-
*/
|
|
995
|
-
Approvers: Array<FlowApproverInfo>
|
|
996
|
-
}
|
|
997
|
-
|
|
998
|
-
/**
|
|
999
|
-
* DescribeSeals请求参数结构体
|
|
1000
|
-
*/
|
|
1001
|
-
export interface DescribeSealsRequest {
|
|
1002
|
-
/**
|
|
1003
|
-
* 调用方信息
|
|
1004
|
-
*/
|
|
1005
|
-
Caller: Caller
|
|
1006
|
-
/**
|
|
1007
|
-
* 印章ID列表
|
|
1008
|
-
*/
|
|
1009
|
-
SealIds: Array<string>
|
|
1010
|
-
/**
|
|
1011
|
-
* 用户唯一标识
|
|
1012
|
-
*/
|
|
1013
|
-
UserId?: string
|
|
1014
|
-
}
|
|
1015
|
-
|
|
1016
|
-
/**
|
|
1017
|
-
* 此结构体 (FlowApproverInfo) 用于描述流程参与者信息。
|
|
1018
|
-
*/
|
|
1019
|
-
export interface FlowApproverInfo {
|
|
1020
|
-
/**
|
|
1021
|
-
* 用户ID
|
|
1022
|
-
*/
|
|
1023
|
-
UserId: string
|
|
1024
|
-
/**
|
|
1025
|
-
* 认证方式:
|
|
1026
|
-
WEIXINAPP - 微信小程序;
|
|
1027
|
-
FACEID - 慧眼 (默认);
|
|
1028
|
-
VERIFYCODE - 验证码;
|
|
1029
|
-
THIRD - 第三方 (暂不支持)
|
|
1030
|
-
*/
|
|
1031
|
-
VerifyChannel: Array<string>
|
|
1032
|
-
/**
|
|
1033
|
-
* 签署状态:
|
|
1034
|
-
0 - 待签署;
|
|
1035
|
-
1- 已签署;
|
|
1036
|
-
2 - 拒绝;
|
|
1037
|
-
3 - 过期未处理;
|
|
1038
|
-
4 - 流程已撤回,
|
|
1039
|
-
12-审核中,
|
|
1040
|
-
13-审核驳回
|
|
1041
|
-
注意:此字段可能返回 null,表示取不到有效值。
|
|
1042
|
-
*/
|
|
1043
|
-
ApproveStatus: number
|
|
1044
|
-
/**
|
|
1045
|
-
* 拒签/签署/审核驳回原因
|
|
1046
|
-
注意:此字段可能返回 null,表示取不到有效值。
|
|
1047
|
-
*/
|
|
1048
|
-
ApproveMessage: string
|
|
1049
|
-
/**
|
|
1050
|
-
* 签约时间的时间戳
|
|
1051
|
-
注意:此字段可能返回 null,表示取不到有效值。
|
|
1052
|
-
*/
|
|
1053
|
-
ApproveTime: number
|
|
1054
|
-
/**
|
|
1055
|
-
* 签署企业ID
|
|
1056
|
-
注意:此字段可能返回 null,表示取不到有效值。
|
|
1057
|
-
*/
|
|
1058
|
-
SubOrganizationId: string
|
|
1059
|
-
/**
|
|
1060
|
-
* 签署完成后跳转的URL
|
|
1061
|
-
注意:此字段可能返回 null,表示取不到有效值。
|
|
1062
|
-
*/
|
|
1063
|
-
JumpUrl: string
|
|
1064
|
-
/**
|
|
1065
|
-
* 用户签署区ID到印章ID的映射集合
|
|
1066
|
-
注意:此字段可能返回 null,表示取不到有效值。
|
|
1067
|
-
*/
|
|
1068
|
-
ComponentSeals: Array<ComponentSeal>
|
|
1069
|
-
/**
|
|
1070
|
-
* 签署前置条件:是否强制用户全文阅读,即阅读到待签署文档的最后一页。默认FALSE
|
|
1071
|
-
*/
|
|
1072
|
-
IsFullText: boolean
|
|
1073
|
-
/**
|
|
1074
|
-
* 签署前置条件:强制阅读时长,页面停留时长不足则不允许签署。默认不限制
|
|
1075
|
-
*/
|
|
1076
|
-
PreReadTime: number
|
|
1077
|
-
/**
|
|
1078
|
-
* 签署人手机号,脱敏显示
|
|
1079
|
-
*/
|
|
1080
|
-
Mobile: string
|
|
1081
|
-
/**
|
|
1082
|
-
* 签署链接截止时间,默认签署流程发起后7天失效
|
|
1083
|
-
*/
|
|
1084
|
-
Deadline: number
|
|
1085
|
-
/**
|
|
1086
|
-
* 是否为最后一个签署人, 若为最后一人,则其签署完成后自动归档
|
|
1087
|
-
*/
|
|
1088
|
-
IsLastApprover: boolean
|
|
1089
|
-
/**
|
|
1090
|
-
* 短信模板
|
|
1091
|
-
注意:此字段可能返回 null,表示取不到有效值。
|
|
1092
|
-
*/
|
|
1093
|
-
SmsTemplate: SmsTemplate
|
|
1094
|
-
/**
|
|
1095
|
-
* 身份证号,脱敏显示
|
|
1096
|
-
*/
|
|
1097
|
-
IdCardNumber: string
|
|
1098
|
-
/**
|
|
1099
|
-
* 用户姓名
|
|
1100
|
-
*/
|
|
1101
|
-
Name: string
|
|
1102
|
-
/**
|
|
1103
|
-
* 是否支持线下核身
|
|
1104
|
-
*/
|
|
1105
|
-
CanOffLine: boolean
|
|
1106
|
-
/**
|
|
1107
|
-
* 证件号码类型:ID_CARD - 身份证,PASSPORT - 护照,MAINLAND_TRAVEL_PERMIT_FOR_HONGKONG_AND_MACAO_RESIDENTS - 港澳居民来往内地通行证; 暂不支持用于电子签自有平台实名认证,MAINLAND_TRAVEL_PERMIT_FOR_TAIWAN_RESIDENTS - 台湾居民来往大陆通行证; 暂不支持用于电子签自有平台实名认证,HOUSEHOLD_REGISTER - 户口本; 暂不支持用于电子签自有平台实名认证,TEMP_ID_CARD - 临时居民身份证; 暂不支持用于电子签自有平台实名认证
|
|
1108
|
-
注意:此字段可能返回 null,表示取不到有效值。
|
|
1109
|
-
*/
|
|
1110
|
-
IdCardType: string
|
|
1111
|
-
/**
|
|
1112
|
-
* 签署回调地址
|
|
1113
|
-
注意:此字段可能返回 null,表示取不到有效值。
|
|
1114
|
-
*/
|
|
1115
|
-
CallbackUrl: string
|
|
1116
|
-
/**
|
|
1117
|
-
* 签署任务ID,标识每一次的流程发送
|
|
1118
|
-
注意:此字段可能返回 null,表示取不到有效值。
|
|
1119
|
-
*/
|
|
1120
|
-
SignId: string
|
|
1121
|
-
}
|
|
1122
|
-
|
|
1123
|
-
/**
|
|
1124
|
-
* DescribeFlowFiles请求参数结构体
|
|
1125
|
-
*/
|
|
1126
|
-
export interface DescribeFlowFilesRequest {
|
|
1127
|
-
/**
|
|
1128
|
-
* 调用方信息; 必选
|
|
1129
|
-
*/
|
|
1130
|
-
Caller: Caller
|
|
1131
|
-
/**
|
|
1132
|
-
* 需要查询的流程ID
|
|
1133
|
-
*/
|
|
1134
|
-
FlowId: string
|
|
1135
|
-
}
|
|
1136
|
-
|
|
1137
|
-
/**
|
|
1138
|
-
* DescribeCustomFlowIds返回参数结构体
|
|
1139
|
-
*/
|
|
1140
|
-
export interface DescribeCustomFlowIdsResponse {
|
|
1141
|
-
/**
|
|
1142
|
-
* 自定义流程 id 映射列表
|
|
1143
|
-
*/
|
|
1144
|
-
CustomIdList: Array<CustomFlowIdMap>
|
|
1145
|
-
/**
|
|
1146
|
-
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
1147
|
-
*/
|
|
1148
|
-
RequestId?: string
|
|
1149
|
-
}
|
|
1150
|
-
|
|
1151
|
-
/**
|
|
1152
|
-
* 此结构体 (SubOrganizationDetail) 用于描述子机构或子企业的详情信息。
|
|
1153
|
-
*/
|
|
1154
|
-
export interface SubOrganizationDetail {
|
|
1155
|
-
/**
|
|
1156
|
-
* 组织ID
|
|
1157
|
-
*/
|
|
1158
|
-
Id: string
|
|
1159
|
-
/**
|
|
1160
|
-
* 机构名称全称
|
|
1161
|
-
*/
|
|
1162
|
-
Name: string
|
|
1163
|
-
/**
|
|
1164
|
-
* 机构电子邮箱
|
|
1165
|
-
*/
|
|
1166
|
-
Email: string
|
|
1167
|
-
/**
|
|
1168
|
-
* 机构证件号码类型
|
|
1169
|
-
*/
|
|
1170
|
-
IdCardType: string
|
|
1171
|
-
/**
|
|
1172
|
-
* 机构证件号码
|
|
1173
|
-
*/
|
|
1174
|
-
IdCardNumber: string
|
|
1175
|
-
/**
|
|
1176
|
-
* 机构类型
|
|
1177
|
-
*/
|
|
1178
|
-
OrganizationType: string
|
|
1179
|
-
/**
|
|
1180
|
-
* 机构证件文件类型
|
|
1181
|
-
注意:此字段可能返回 null,表示取不到有效值。
|
|
1182
|
-
*/
|
|
1183
|
-
IdCardFileType: string
|
|
1184
|
-
/**
|
|
1185
|
-
* 机构证件照片文件,base64编码
|
|
1186
|
-
注意:此字段可能返回 null,表示取不到有效值。
|
|
1187
|
-
*/
|
|
1188
|
-
BizLicenseFile: string
|
|
1189
|
-
/**
|
|
1190
|
-
* 机构证件照片文件名
|
|
1191
|
-
*/
|
|
1192
|
-
BizLicenseFileName: string
|
|
1193
|
-
/**
|
|
1194
|
-
* 机构法人/经营者姓名
|
|
1195
|
-
*/
|
|
1196
|
-
LegalName: string
|
|
1197
|
-
/**
|
|
1198
|
-
* 机构法人/经营者证件类型
|
|
1199
|
-
*/
|
|
1200
|
-
LegalIdCardType: string
|
|
1201
|
-
/**
|
|
1202
|
-
* 机构法人/经营者证件号码
|
|
1203
|
-
*/
|
|
1204
|
-
LegalIdCardNumber: string
|
|
1205
|
-
/**
|
|
1206
|
-
* 机构法人/经营者/联系人手机号码
|
|
1207
|
-
*/
|
|
1208
|
-
LegalMobile: string
|
|
1209
|
-
/**
|
|
1210
|
-
* 组织联系人姓名
|
|
1211
|
-
注意:此字段可能返回 null,表示取不到有效值。
|
|
1212
|
-
*/
|
|
1213
|
-
ContactName: string
|
|
1214
|
-
/**
|
|
1215
|
-
* 机构实名状态
|
|
1216
|
-
*/
|
|
1217
|
-
VerifyStatus: string
|
|
1218
|
-
/**
|
|
1219
|
-
* 机构通过实名时间
|
|
1220
|
-
注意:此字段可能返回 null,表示取不到有效值。
|
|
1221
|
-
*/
|
|
1222
|
-
VerifiedOn: number
|
|
1223
|
-
/**
|
|
1224
|
-
* 机构创建时间
|
|
1225
|
-
*/
|
|
1226
|
-
CreatedOn: number
|
|
1227
|
-
/**
|
|
1228
|
-
* 机构更新时间
|
|
1229
|
-
注意:此字段可能返回 null,表示取不到有效值。
|
|
1230
|
-
*/
|
|
1231
|
-
UpdatedOn: number
|
|
1232
|
-
/**
|
|
1233
|
-
* 实名认证的客户端IP
|
|
1234
|
-
注意:此字段可能返回 null,表示取不到有效值。
|
|
1235
|
-
*/
|
|
1236
|
-
VerifyClientIp: string
|
|
1237
|
-
/**
|
|
1238
|
-
* 实名认证的服务器IP
|
|
1239
|
-
注意:此字段可能返回 null,表示取不到有效值。
|
|
1240
|
-
*/
|
|
1241
|
-
VerifyServerIp: string
|
|
1242
|
-
/**
|
|
1243
|
-
* 企业联系地址
|
|
1244
|
-
注意:此字段可能返回 null,表示取不到有效值。
|
|
1245
|
-
*/
|
|
1246
|
-
ContactAddress: Address
|
|
1247
|
-
}
|
|
1248
|
-
|
|
1249
|
-
/**
|
|
1250
|
-
* CheckIdCardVerification请求参数结构体
|
|
1251
|
-
*/
|
|
1252
|
-
export interface CheckIdCardVerificationRequest {
|
|
1253
|
-
/**
|
|
1254
|
-
* 调用方信息; 必选
|
|
1255
|
-
*/
|
|
1256
|
-
Caller: Caller
|
|
1257
|
-
/**
|
|
1258
|
-
* 姓名
|
|
1259
|
-
*/
|
|
1260
|
-
Name: string
|
|
1261
|
-
/**
|
|
1262
|
-
* 身份证件号码
|
|
1263
|
-
*/
|
|
1264
|
-
IdCardNumber: string
|
|
1265
|
-
/**
|
|
1266
|
-
* 身份证件类型; ID_CARD
|
|
1267
|
-
*/
|
|
1268
|
-
IdCardType?: string
|
|
1269
|
-
}
|
|
1270
|
-
|
|
1271
|
-
/**
|
|
1272
|
-
* CreateSignUrl返回参数结构体
|
|
1273
|
-
*/
|
|
1274
|
-
export interface CreateSignUrlResponse {
|
|
1275
|
-
/**
|
|
1276
|
-
* 合同签署链接
|
|
1277
|
-
*/
|
|
1278
|
-
SignUrl: string
|
|
1279
|
-
/**
|
|
1280
|
-
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
1281
|
-
*/
|
|
1282
|
-
RequestId?: string
|
|
1283
|
-
}
|
|
1284
|
-
|
|
1285
|
-
/**
|
|
1286
|
-
* ModifySubOrganizationInfo请求参数结构体
|
|
1287
|
-
*/
|
|
1288
|
-
export interface ModifySubOrganizationInfoRequest {
|
|
1289
|
-
/**
|
|
1290
|
-
* 调用方信息,该接口 SubOrganizationId 字段与 OpenId 字段二者至少需要传入一个,全部传入时则使用 SubOrganizationId 信息
|
|
1291
|
-
*/
|
|
1292
|
-
Caller: Caller
|
|
1293
|
-
/**
|
|
1294
|
-
* 机构在第三方的唯一标识,32位定长字符串,与 Caller 中 SubOrgnizationId 二者至少需要传入一个,全部传入时则使用 SubOrganizationId 信息
|
|
1295
|
-
*/
|
|
1296
|
-
OpenId?: string
|
|
1297
|
-
/**
|
|
1298
|
-
* 机构名称全称,修改后机构状态将变为未实名,需要调用实名接口重新实名。
|
|
1299
|
-
*/
|
|
1300
|
-
Name?: string
|
|
1301
|
-
/**
|
|
1302
|
-
* 机构类型可选值:
|
|
1303
|
-
1. ENTERPRISE - 企业;
|
|
1304
|
-
2. INDIVIDUALBIZ - 个体工商户;
|
|
1305
|
-
3. PUBLICINSTITUTION - 政府/事业单位
|
|
1306
|
-
4. OTHERS - 其他组织
|
|
1307
|
-
*/
|
|
1308
|
-
OrganizationType?: string
|
|
1309
|
-
/**
|
|
1310
|
-
* 机构证件照片文件,base64编码。支持jpg,jpeg,png格式;如果传值,则重新上传文件后,机构状态将变为未实名,需要调用实名接口重新实名。
|
|
1311
|
-
*/
|
|
1312
|
-
BizLicenseFile?: string
|
|
1313
|
-
/**
|
|
1314
|
-
* 机构证件照片文件名
|
|
1315
|
-
*/
|
|
1316
|
-
BizLicenseFileName?: string
|
|
1317
|
-
/**
|
|
1318
|
-
* 机构法人/经营者姓名
|
|
1319
|
-
*/
|
|
1320
|
-
LegalName?: string
|
|
1321
|
-
/**
|
|
1322
|
-
* 机构法人/经营者证件类型,可选值:ID_CARD - 居民身份证。OrganizationType 为 ENTERPRISE、INDIVIDUALBIZ 时,此项必填,其他情况选填。
|
|
1323
|
-
*/
|
|
1324
|
-
LegalIdCardType?: string
|
|
1325
|
-
/**
|
|
1326
|
-
* 机构法人/经营者证件号码。OrganizationType 为 ENTERPRISE、INDIVIDUALBIZ 时,此项必填,其他情况选填
|
|
1327
|
-
*/
|
|
1328
|
-
LegalIdCardNumber?: string
|
|
1329
|
-
/**
|
|
1330
|
-
* 机构法人/经营者/联系人手机号码
|
|
1331
|
-
*/
|
|
1332
|
-
LegalMobile?: string
|
|
1333
|
-
/**
|
|
1334
|
-
* 组织联系人姓名
|
|
1335
|
-
*/
|
|
1336
|
-
ContactName?: string
|
|
1337
|
-
/**
|
|
1338
|
-
* 企业联系地址
|
|
1339
|
-
*/
|
|
1340
|
-
ContactAddress?: Address
|
|
1341
|
-
/**
|
|
1342
|
-
* 机构电子邮箱
|
|
1343
|
-
*/
|
|
1344
|
-
Email?: string
|
|
1345
|
-
}
|
|
1346
|
-
|
|
1347
|
-
/**
|
|
1348
|
-
* SendSignInnerVerifyCode返回参数结构体
|
|
1349
|
-
*/
|
|
1350
|
-
export interface SendSignInnerVerifyCodeResponse {
|
|
1351
|
-
/**
|
|
1352
|
-
* true: 验证码正确,false: 验证码错误
|
|
1353
|
-
*/
|
|
1354
|
-
Result: boolean
|
|
1355
|
-
/**
|
|
1356
|
-
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
1357
|
-
*/
|
|
1358
|
-
RequestId?: string
|
|
1359
|
-
}
|
|
1360
|
-
|
|
1361
|
-
/**
|
|
1362
|
-
* DescribeFaceIdPhotos请求参数结构体
|
|
1363
|
-
*/
|
|
1364
|
-
export interface DescribeFaceIdPhotosRequest {
|
|
1365
|
-
/**
|
|
1366
|
-
* 调用方信息
|
|
1367
|
-
*/
|
|
1368
|
-
Caller: Caller
|
|
1369
|
-
/**
|
|
1370
|
-
* 慧眼业务ID
|
|
1371
|
-
*/
|
|
1372
|
-
WbAppId: string
|
|
1373
|
-
/**
|
|
1374
|
-
* 订单号(orderNo); 限制在3个或以内
|
|
1375
|
-
*/
|
|
1376
|
-
OrderNumbers: Array<string>
|
|
1377
|
-
}
|
|
1378
|
-
|
|
1379
|
-
/**
|
|
1380
|
-
* 此结构体 (FileUrl) 用于描述下载文件的URL信息。
|
|
1381
|
-
*/
|
|
1382
|
-
export interface FileUrl {
|
|
1383
|
-
/**
|
|
1384
|
-
* 下载文件的URL
|
|
1385
|
-
*/
|
|
1386
|
-
Url: string
|
|
1387
|
-
/**
|
|
1388
|
-
* 下载文件的附加信息
|
|
1389
|
-
*/
|
|
1390
|
-
Option: string
|
|
1391
|
-
/**
|
|
1392
|
-
* 下载文件所属的资源序号
|
|
1393
|
-
*/
|
|
1394
|
-
Index: number
|
|
1395
|
-
/**
|
|
1396
|
-
* 目录业务下,文件对应的流程
|
|
1397
|
-
*/
|
|
1398
|
-
FlowId: string
|
|
1399
|
-
}
|
|
1400
|
-
|
|
1401
|
-
/**
|
|
1402
|
-
* CreateUser返回参数结构体
|
|
1403
|
-
*/
|
|
1404
|
-
export interface CreateUserResponse {
|
|
1405
|
-
/**
|
|
1406
|
-
* 用户ID,按应用号隔离
|
|
1407
|
-
*/
|
|
1408
|
-
UserId: string
|
|
1409
|
-
/**
|
|
1410
|
-
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
1411
|
-
*/
|
|
1412
|
-
RequestId?: string
|
|
1413
|
-
}
|
|
1414
|
-
|
|
1415
|
-
/**
|
|
1416
|
-
* CheckVerifyCodeMatchFlowId返回参数结构体
|
|
1417
|
-
*/
|
|
1418
|
-
export interface CheckVerifyCodeMatchFlowIdResponse {
|
|
1419
|
-
/**
|
|
1420
|
-
* true: 验证码正确,false: 验证码错误
|
|
1421
|
-
*/
|
|
1422
|
-
Success: boolean
|
|
1423
|
-
/**
|
|
1424
|
-
* 0: 验证码正确 1:验证码错误或过期 2:验证码错误 3:验证码和流程不匹配 4:验证码输入错误超过次数 5:内部错误
|
|
1425
|
-
6:参数错误
|
|
1426
|
-
*/
|
|
1427
|
-
Result: number
|
|
1428
|
-
/**
|
|
1429
|
-
* 结果描述
|
|
1430
|
-
*/
|
|
1431
|
-
Description: string
|
|
1432
|
-
/**
|
|
1433
|
-
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
1434
|
-
*/
|
|
1435
|
-
RequestId?: string
|
|
1436
|
-
}
|
|
1437
|
-
|
|
1438
|
-
/**
|
|
1439
|
-
* ModifyOrganizationDefaultSeal请求参数结构体
|
|
1440
|
-
*/
|
|
1441
|
-
export interface ModifyOrganizationDefaultSealRequest {
|
|
1442
|
-
/**
|
|
1443
|
-
* 调用方信息
|
|
1444
|
-
*/
|
|
1445
|
-
Caller: Caller
|
|
1446
|
-
/**
|
|
1447
|
-
* 重新指定的默认印章ID
|
|
1448
|
-
*/
|
|
1449
|
-
SealId: string
|
|
1450
|
-
/**
|
|
1451
|
-
* 请求重新指定企业默认印章的客户端IP
|
|
1452
|
-
*/
|
|
1453
|
-
SourceIp: string
|
|
1454
|
-
}
|
|
1455
|
-
|
|
1456
|
-
/**
|
|
1457
|
-
* CreateFaceIdSign返回参数结构体
|
|
1458
|
-
*/
|
|
1459
|
-
export interface CreateFaceIdSignResponse {
|
|
1460
|
-
/**
|
|
1461
|
-
* 慧眼API签名
|
|
1462
|
-
*/
|
|
1463
|
-
Sign?: string
|
|
1464
|
-
/**
|
|
1465
|
-
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
1466
|
-
*/
|
|
1467
|
-
RequestId?: string
|
|
1468
|
-
}
|
|
1469
|
-
|
|
1470
|
-
/**
|
|
1471
|
-
* DescribeFlowApprovers返回参数结构体
|
|
1472
|
-
*/
|
|
1473
|
-
export interface DescribeFlowApproversResponse {
|
|
1474
|
-
/**
|
|
1475
|
-
* 流程编号
|
|
1476
|
-
*/
|
|
1477
|
-
FlowId: string
|
|
1478
|
-
/**
|
|
1479
|
-
* 流程参与者信息
|
|
1480
|
-
*/
|
|
1481
|
-
Approvers: Array<FlowApproverInfo>
|
|
1482
|
-
/**
|
|
1483
|
-
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
1484
|
-
*/
|
|
1485
|
-
RequestId?: string
|
|
1486
|
-
}
|
|
1487
|
-
|
|
1488
|
-
/**
|
|
1489
|
-
* CheckMobileAndName请求参数结构体
|
|
1490
|
-
*/
|
|
1491
|
-
export interface CheckMobileAndNameRequest {
|
|
1492
|
-
/**
|
|
1493
|
-
* 调用方信息; 必选
|
|
1494
|
-
*/
|
|
1495
|
-
Caller: Caller
|
|
1496
|
-
/**
|
|
1497
|
-
* 手机号
|
|
1498
|
-
*/
|
|
1499
|
-
Mobile: string
|
|
1500
|
-
/**
|
|
1501
|
-
* 姓名
|
|
1502
|
-
*/
|
|
1503
|
-
Name: string
|
|
1504
|
-
}
|
|
1505
|
-
|
|
1506
|
-
/**
|
|
1507
|
-
* DeleteSeal请求参数结构体
|
|
1508
|
-
*/
|
|
1509
|
-
export interface DeleteSealRequest {
|
|
1510
|
-
/**
|
|
1511
|
-
* 调用方信息
|
|
1512
|
-
*/
|
|
1513
|
-
Caller: Caller
|
|
1514
|
-
/**
|
|
1515
|
-
* 印章ID
|
|
1516
|
-
*/
|
|
1517
|
-
SealId: string
|
|
1518
|
-
/**
|
|
1519
|
-
* 请求删除印章的客户端IP
|
|
1520
|
-
*/
|
|
1521
|
-
SourceIp: string
|
|
1522
|
-
/**
|
|
1523
|
-
* 用户唯一标识,默认为空时删除企业印章,如非空则删除个人印章
|
|
1524
|
-
*/
|
|
1525
|
-
UserId?: string
|
|
1526
|
-
}
|
|
1527
|
-
|
|
1528
|
-
/**
|
|
1529
|
-
* CheckBankCardVerification返回参数结构体
|
|
1530
|
-
*/
|
|
1531
|
-
export interface CheckBankCardVerificationResponse {
|
|
1532
|
-
/**
|
|
1533
|
-
* 检测结果
|
|
1534
|
-
计费结果码:
|
|
1535
|
-
0: 认证通过
|
|
1536
|
-
1: 认证未通过
|
|
1537
|
-
2: 持卡人信息有误
|
|
1538
|
-
3: 未开通无卡支付
|
|
1539
|
-
4: 此卡被没收
|
|
1540
|
-
5: 无效卡号
|
|
1541
|
-
6: 此卡无对应发卡行
|
|
1542
|
-
7: 该卡未初始化或睡眠卡
|
|
1543
|
-
8: 作弊卡、吞卡
|
|
1544
|
-
9: 此卡已挂失
|
|
1545
|
-
10: 该卡已过期
|
|
1546
|
-
11: 受限制的卡
|
|
1547
|
-
12: 密码错误次数超限
|
|
1548
|
-
13: 发卡行不支持此交易
|
|
1549
|
-
不收费结果码:
|
|
1550
|
-
101: 姓名校验不通过
|
|
1551
|
-
102: 银行卡号码有误
|
|
1552
|
-
103: 验证中心服务繁忙
|
|
1553
|
-
104: 身份证号码有误
|
|
1554
|
-
105: 手机号码不合法
|
|
1555
|
-
*/
|
|
1556
|
-
Result?: number
|
|
1557
|
-
/**
|
|
1558
|
-
* 结果描述; 未通过时必选
|
|
1559
|
-
*/
|
|
1560
|
-
Description?: string
|
|
1561
|
-
/**
|
|
1562
|
-
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
1563
|
-
*/
|
|
1564
|
-
RequestId?: string
|
|
1565
|
-
}
|
|
1566
|
-
|
|
1567
|
-
/**
|
|
1568
|
-
* ArchiveFlow请求参数结构体
|
|
1569
|
-
*/
|
|
1570
|
-
export interface ArchiveFlowRequest {
|
|
1571
|
-
/**
|
|
1572
|
-
* 调用方信息
|
|
1573
|
-
*/
|
|
1574
|
-
Caller: Caller
|
|
1575
|
-
/**
|
|
1576
|
-
* 流程ID
|
|
1577
|
-
*/
|
|
1578
|
-
FlowId: string
|
|
1579
|
-
}
|
|
1580
|
-
|
|
1581
|
-
/**
|
|
1582
|
-
* CreateUserAndSeal返回参数结构体
|
|
1583
|
-
*/
|
|
1584
|
-
export interface CreateUserAndSealResponse {
|
|
1585
|
-
/**
|
|
1586
|
-
* 用户唯一标识,按应用号隔离
|
|
1587
|
-
*/
|
|
1588
|
-
UserId: string
|
|
1589
|
-
/**
|
|
1590
|
-
* 默认印章ID
|
|
1591
|
-
*/
|
|
1592
|
-
SealId: string
|
|
1593
|
-
/**
|
|
1594
|
-
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
1595
|
-
*/
|
|
1596
|
-
RequestId?: string
|
|
1597
|
-
}
|
|
1598
|
-
|
|
1599
|
-
/**
|
|
1600
|
-
* 此结构体 (FaceIdResult) 用于描述慧眼人脸核身结果。
|
|
1601
|
-
*/
|
|
1602
|
-
export interface FaceIdResult {
|
|
1603
|
-
/**
|
|
1604
|
-
* 核身结果:
|
|
1605
|
-
0 - 通过;
|
|
1606
|
-
1 - 未通过
|
|
1607
|
-
*/
|
|
1608
|
-
Result: number
|
|
1609
|
-
/**
|
|
1610
|
-
* 核身失败描述
|
|
1611
|
-
*/
|
|
1612
|
-
Description: string
|
|
1613
|
-
/**
|
|
1614
|
-
* 订单号 (orderNo)
|
|
1615
|
-
*/
|
|
1616
|
-
OrderNumber: string
|
|
1617
|
-
/**
|
|
1618
|
-
* 姓名
|
|
1619
|
-
注意:此字段可能返回 null,表示取不到有效值。
|
|
1620
|
-
*/
|
|
1621
|
-
Name: string
|
|
1622
|
-
/**
|
|
1623
|
-
* 身份证件类型:
|
|
1624
|
-
ID_CARD - 居民身份证
|
|
1625
|
-
注意:此字段可能返回 null,表示取不到有效值。
|
|
1626
|
-
*/
|
|
1627
|
-
IdCardType: string
|
|
1628
|
-
/**
|
|
1629
|
-
* 身份证件号码
|
|
1630
|
-
注意:此字段可能返回 null,表示取不到有效值。
|
|
1631
|
-
*/
|
|
1632
|
-
IdCardNumber: string
|
|
1633
|
-
/**
|
|
1634
|
-
* 活体检测得分 (百分制)
|
|
1635
|
-
注意:此字段可能返回 null,表示取不到有效值。
|
|
1636
|
-
*/
|
|
1637
|
-
LiveRate: number
|
|
1638
|
-
/**
|
|
1639
|
-
* 人脸检测得分 (百分制)
|
|
1640
|
-
注意:此字段可能返回 null,表示取不到有效值。
|
|
1641
|
-
*/
|
|
1642
|
-
Similarity: number
|
|
1643
|
-
/**
|
|
1644
|
-
* 刷脸时间 (UNIX时间戳)
|
|
1645
|
-
注意:此字段可能返回 null,表示取不到有效值。
|
|
1646
|
-
*/
|
|
1647
|
-
OccurredTime: number
|
|
1648
|
-
/**
|
|
1649
|
-
* 照片数据 (base64编码, 一般为JPG或PNG)
|
|
1650
|
-
注意:此字段可能返回 null,表示取不到有效值。
|
|
1651
|
-
*/
|
|
1652
|
-
Photo: string
|
|
1653
|
-
/**
|
|
1654
|
-
* 视频数据 (base64编码, 一般为MP4)
|
|
1655
|
-
注意:此字段可能返回 null,表示取不到有效值。
|
|
1656
|
-
*/
|
|
1657
|
-
Video: string
|
|
1658
|
-
}
|
|
1659
|
-
|
|
1660
|
-
/**
|
|
1661
|
-
* CreateSignUrl请求参数结构体
|
|
1662
|
-
*/
|
|
1663
|
-
export interface CreateSignUrlRequest {
|
|
1664
|
-
/**
|
|
1665
|
-
* 调用方信息
|
|
1666
|
-
*/
|
|
1667
|
-
Caller: Caller
|
|
1668
|
-
/**
|
|
1669
|
-
* 签署人ID
|
|
1670
|
-
*/
|
|
1671
|
-
UserId: string
|
|
1672
|
-
/**
|
|
1673
|
-
* 文件签署截止时间戳
|
|
1674
|
-
*/
|
|
1675
|
-
Deadline: number
|
|
1676
|
-
/**
|
|
1677
|
-
* 目录ID。当 SignUrlType 为 CATALOG 时必填
|
|
1678
|
-
*/
|
|
1679
|
-
CatalogId?: string
|
|
1680
|
-
/**
|
|
1681
|
-
* 流程ID。当 SignUrlType 为 FLOW 时必填
|
|
1682
|
-
*/
|
|
1683
|
-
FlowId?: string
|
|
1684
|
-
/**
|
|
1685
|
-
* 签署链接类型:
|
|
1686
|
-
1. FLOW - 单流程签署 (默认)
|
|
1687
|
-
2. CATALOG - 目录签署
|
|
1688
|
-
*/
|
|
1689
|
-
SignUrlType?: string
|
|
1690
|
-
/**
|
|
1691
|
-
* 发送流程或目录时生成的签署任务ID
|
|
1692
|
-
*/
|
|
1693
|
-
SignId?: string
|
|
1694
|
-
}
|
|
1695
|
-
|
|
1696
|
-
/**
|
|
1697
|
-
* 此结构体 (ComponentSeal) 用于描述“签署区ID”到“印章ID”的映射。
|
|
1698
|
-
*/
|
|
1699
|
-
export interface ComponentSeal {
|
|
1700
|
-
/**
|
|
1701
|
-
* 签署区ID
|
|
1702
|
-
*/
|
|
1703
|
-
ComponentId: string
|
|
1704
|
-
/**
|
|
1705
|
-
* 印章ID
|
|
1706
|
-
*/
|
|
1707
|
-
SealId: string
|
|
1708
|
-
}
|
|
1709
|
-
|
|
1710
|
-
/**
|
|
1711
|
-
* DeleteSeal返回参数结构体
|
|
1712
|
-
*/
|
|
1713
|
-
export interface DeleteSealResponse {
|
|
1714
|
-
/**
|
|
1715
|
-
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
1716
|
-
*/
|
|
1717
|
-
RequestId?: string
|
|
1718
|
-
}
|
|
1719
|
-
|
|
1720
|
-
/**
|
|
1721
|
-
* UploadFiles请求参数结构体
|
|
1722
|
-
*/
|
|
1723
|
-
export interface UploadFilesRequest {
|
|
1724
|
-
/**
|
|
1725
|
-
* 调用方信息
|
|
1726
|
-
*/
|
|
1727
|
-
Caller: Caller
|
|
1728
|
-
/**
|
|
1729
|
-
* 文件对应业务类型,用于区分文件存储路径:
|
|
1730
|
-
1. TEMPLATE - 模版; 文件类型:.pdf/.html
|
|
1731
|
-
2. DOCUMENT - 签署过程及签署后的合同文档 文件类型:.pdf/.html
|
|
1732
|
-
3. FLOW - 签署过程 文件类型:.pdf/.html
|
|
1733
|
-
4. SEAL - 印章; 文件类型:.jpg/.jpeg/.png
|
|
1734
|
-
5. BUSINESSLICENSE - 营业执照 文件类型:.jpg/.jpeg/.png
|
|
1735
|
-
6. IDCARD - 身份证 文件类型:.jpg/.jpeg/.png
|
|
1736
|
-
*/
|
|
1737
|
-
BusinessType: string
|
|
1738
|
-
/**
|
|
1739
|
-
* 上传文件内容数组,最多支持20个文件
|
|
1740
|
-
*/
|
|
1741
|
-
FileInfos?: Array<UploadFile>
|
|
1742
|
-
/**
|
|
1743
|
-
* 上传文件链接数组,最多支持20个URL
|
|
1744
|
-
*/
|
|
1745
|
-
FileUrls?: Array<string>
|
|
1746
|
-
/**
|
|
1747
|
-
* 是否将pdf灰色矩阵置白
|
|
1748
|
-
true--是,处理置白
|
|
1749
|
-
false--否,不处理
|
|
1750
|
-
*/
|
|
1751
|
-
CoverRect?: boolean
|
|
1752
|
-
/**
|
|
1753
|
-
* 特殊文件类型需要指定文件类型:
|
|
1754
|
-
HTML-- .html文件
|
|
1755
|
-
*/
|
|
1756
|
-
FileType?: string
|
|
1757
|
-
/**
|
|
1758
|
-
* 用户自定义ID数组,与上传文件一一对应
|
|
1759
|
-
*/
|
|
1760
|
-
CustomIds?: Array<string>
|
|
1761
|
-
}
|
|
1762
|
-
|
|
1763
|
-
/**
|
|
1764
|
-
* DescribeUsers请求参数结构体
|
|
1765
|
-
*/
|
|
1766
|
-
export interface DescribeUsersRequest {
|
|
1767
|
-
/**
|
|
1768
|
-
* 调用方信息
|
|
1769
|
-
*/
|
|
1770
|
-
Caller: Caller
|
|
1771
|
-
/**
|
|
1772
|
-
* UserId列表,最多支持100个UserId
|
|
1773
|
-
*/
|
|
1774
|
-
UserIds: Array<string>
|
|
1775
|
-
}
|
|
1776
|
-
|
|
1777
|
-
/**
|
|
1778
|
-
* CreateFlowByFiles请求参数结构体
|
|
1779
|
-
*/
|
|
1780
|
-
export interface CreateFlowByFilesRequest {
|
|
1781
|
-
/**
|
|
1782
|
-
* 调用方信息
|
|
1783
|
-
*/
|
|
1784
|
-
Caller: Caller
|
|
1785
|
-
/**
|
|
1786
|
-
* 流程创建信息
|
|
1787
|
-
*/
|
|
1788
|
-
FlowInfo: FlowInfo
|
|
1789
|
-
/**
|
|
1790
|
-
* 文件资源列表 (支持多文件)
|
|
1791
|
-
*/
|
|
1792
|
-
FileIds: Array<string>
|
|
1793
|
-
/**
|
|
1794
|
-
* 自定义流程id
|
|
1795
|
-
*/
|
|
1796
|
-
CustomId?: string
|
|
1797
|
-
}
|
|
1798
|
-
|
|
1799
|
-
/**
|
|
1800
|
-
* 目录流程签署区
|
|
1801
|
-
*/
|
|
1802
|
-
export interface CatalogComponents {
|
|
1803
|
-
/**
|
|
1804
|
-
* 流程ID
|
|
1805
|
-
*/
|
|
1806
|
-
FlowId: string
|
|
1807
|
-
/**
|
|
1808
|
-
* 签署区列表
|
|
1809
|
-
*/
|
|
1810
|
-
SignComponents: Array<Component>
|
|
1811
|
-
/**
|
|
1812
|
-
* 签署任务ID
|
|
1813
|
-
*/
|
|
1814
|
-
SignId: string
|
|
1815
|
-
}
|
|
1816
|
-
|
|
1817
|
-
/**
|
|
1818
|
-
* ArchiveFlow返回参数结构体
|
|
1819
|
-
*/
|
|
1820
|
-
export interface ArchiveFlowResponse {
|
|
1821
|
-
/**
|
|
1822
|
-
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
1823
|
-
*/
|
|
1824
|
-
RequestId?: string
|
|
1825
|
-
}
|
|
1826
|
-
|
|
1827
|
-
/**
|
|
1828
|
-
* 此结构体 (FlowInfo) 用于描述流程信息。
|
|
1829
|
-
*/
|
|
1830
|
-
export interface FlowInfo {
|
|
1831
|
-
/**
|
|
1832
|
-
* 合同名字
|
|
1833
|
-
*/
|
|
1834
|
-
FlowName: string
|
|
1835
|
-
/**
|
|
1836
|
-
* 签署截止时间戳,超过有效签署时间则该签署流程失败
|
|
1837
|
-
*/
|
|
1838
|
-
Deadline: number
|
|
1839
|
-
/**
|
|
1840
|
-
* 合同描述
|
|
1841
|
-
*/
|
|
1842
|
-
FlowDescription?: string
|
|
1843
|
-
/**
|
|
1844
|
-
* 合同类型:
|
|
1845
|
-
1. “劳务”
|
|
1846
|
-
2. “销售”
|
|
1847
|
-
3. “租赁”
|
|
1848
|
-
4. “其他”
|
|
1849
|
-
*/
|
|
1850
|
-
FlowType?: string
|
|
1851
|
-
/**
|
|
1852
|
-
* 回调地址
|
|
1853
|
-
*/
|
|
1854
|
-
CallbackUrl?: string
|
|
1855
|
-
/**
|
|
1856
|
-
* 用户自定义数据
|
|
1857
|
-
*/
|
|
1858
|
-
UserData?: string
|
|
1859
|
-
}
|
|
1860
|
-
|
|
1861
|
-
/**
|
|
1862
|
-
* 此结构体 (UserDescribe) 用于描述个人帐号查询结果。
|
|
1863
|
-
*/
|
|
1864
|
-
export interface UserDescribe {
|
|
1865
|
-
/**
|
|
1866
|
-
* 用户ID
|
|
1867
|
-
*/
|
|
1868
|
-
UserId: string
|
|
1869
|
-
/**
|
|
1870
|
-
* 手机号,隐藏中间4位数字,用*代替
|
|
1871
|
-
*/
|
|
1872
|
-
Mobile: string
|
|
1873
|
-
/**
|
|
1874
|
-
* 注册时间点 (UNIX时间戳)
|
|
1875
|
-
*/
|
|
1876
|
-
CreatedOn: number
|
|
1877
|
-
/**
|
|
1878
|
-
* 实名认证状态:
|
|
1879
|
-
0 - 未实名;
|
|
1880
|
-
1 - 通过实名
|
|
1881
|
-
*/
|
|
1882
|
-
VerifyStatus: number
|
|
1883
|
-
/**
|
|
1884
|
-
* 真实姓名
|
|
1885
|
-
*/
|
|
1886
|
-
Name: string
|
|
1887
|
-
/**
|
|
1888
|
-
* 实名认证通过时间 (UNIX时间戳)
|
|
1889
|
-
*/
|
|
1890
|
-
VerifiedOn: number
|
|
1891
|
-
/**
|
|
1892
|
-
* 身份证件类型;
|
|
1893
|
-
ID_CARD - 居民身份证;
|
|
1894
|
-
PASSPORT - 护照;
|
|
1895
|
-
MAINLAND_TRAVEL_PERMIT_FOR_HONGKONG_AND_MACAO_RESIDENTS - 港澳居民来往内地通行证;
|
|
1896
|
-
MAINLAND_TRAVEL_PERMIT_FOR_TAIWAN_RESIDENTS - 台湾居民来往大陆通行证;
|
|
1897
|
-
HOUSEHOLD_REGISTER - 户口本;
|
|
1898
|
-
TEMP_ID_CARD - 临时居民身份证
|
|
1899
|
-
*/
|
|
1900
|
-
IdCardType: string
|
|
1901
|
-
/**
|
|
1902
|
-
* 身份证件号码 (脱敏)
|
|
1903
|
-
*/
|
|
1904
|
-
IdCardNumber: string
|
|
1905
|
-
}
|
|
1906
|
-
|
|
1907
|
-
/**
|
|
1908
|
-
* CheckBankCard2EVerification返回参数结构体
|
|
1909
|
-
*/
|
|
1910
|
-
export interface CheckBankCard2EVerificationResponse {
|
|
1911
|
-
/**
|
|
1912
|
-
* 检测结果
|
|
1913
|
-
计费结果码:
|
|
1914
|
-
0: 认证通过
|
|
1915
|
-
1: 认证未通过
|
|
1916
|
-
2: 持卡人信息有误
|
|
1917
|
-
3: 未开通无卡支付
|
|
1918
|
-
4: 此卡被没收
|
|
1919
|
-
5: 无效卡号
|
|
1920
|
-
6: 此卡无对应发卡行
|
|
1921
|
-
7: 该卡未初始化或睡眠卡
|
|
1922
|
-
8: 作弊卡、吞卡
|
|
1923
|
-
9: 此卡已挂失
|
|
1924
|
-
10: 该卡已过期
|
|
1925
|
-
11: 受限制的卡
|
|
1926
|
-
12: 密码错误次数超限
|
|
1927
|
-
13: 发卡行不支持此交易
|
|
1928
|
-
不收费结果码:
|
|
1929
|
-
101: 姓名校验不通过
|
|
1930
|
-
102: 银行卡号码有误
|
|
1931
|
-
103: 验证中心服务繁忙
|
|
1932
|
-
104: 身份证号码有误
|
|
1933
|
-
105: 手机号码不合法
|
|
1934
|
-
*/
|
|
1935
|
-
Result?: number
|
|
1936
|
-
/**
|
|
1937
|
-
* 结果描述; 未通过时必选
|
|
1938
|
-
*/
|
|
1939
|
-
Description?: string
|
|
1940
|
-
/**
|
|
1941
|
-
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
1942
|
-
*/
|
|
1943
|
-
RequestId?: string
|
|
1944
|
-
}
|
|
1945
|
-
|
|
1946
|
-
/**
|
|
1947
|
-
* VerifySubOrganization返回参数结构体
|
|
1948
|
-
*/
|
|
1949
|
-
export interface VerifySubOrganizationResponse {
|
|
1950
|
-
/**
|
|
1951
|
-
* 子机构ID
|
|
1952
|
-
*/
|
|
1953
|
-
SubOrganizationId: string
|
|
1954
|
-
/**
|
|
1955
|
-
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
1956
|
-
*/
|
|
1957
|
-
RequestId?: string
|
|
1958
|
-
}
|
|
1959
|
-
|
|
1960
|
-
/**
|
|
1961
|
-
* DescribeSeals返回参数结构体
|
|
1962
|
-
*/
|
|
1963
|
-
export interface DescribeSealsResponse {
|
|
1964
|
-
/**
|
|
1965
|
-
* 印章信息
|
|
1966
|
-
*/
|
|
1967
|
-
Seals: Array<Seal>
|
|
1968
|
-
/**
|
|
1969
|
-
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
1970
|
-
*/
|
|
1971
|
-
RequestId?: string
|
|
1972
|
-
}
|
|
1973
|
-
|
|
1974
|
-
/**
|
|
1975
|
-
* DescribeFileUrls返回参数结构体
|
|
1976
|
-
*/
|
|
1977
|
-
export interface DescribeFileUrlsResponse {
|
|
1978
|
-
/**
|
|
1979
|
-
* 文件下载URL数组
|
|
1980
|
-
*/
|
|
1981
|
-
FileUrls: Array<FileUrl>
|
|
1982
|
-
/**
|
|
1983
|
-
* URL数量
|
|
1984
|
-
*/
|
|
1985
|
-
TotalCount: number
|
|
1986
|
-
/**
|
|
1987
|
-
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
1988
|
-
*/
|
|
1989
|
-
RequestId?: string
|
|
1990
|
-
}
|
|
1991
|
-
|
|
1992
|
-
/**
|
|
1993
|
-
* ModifySeal请求参数结构体
|
|
1994
|
-
*/
|
|
1995
|
-
export interface ModifySealRequest {
|
|
1996
|
-
/**
|
|
1997
|
-
* 调用方信息
|
|
1998
|
-
*/
|
|
1999
|
-
Caller: Caller
|
|
2000
|
-
/**
|
|
2001
|
-
* 请求更新印章的客户端IP
|
|
2002
|
-
*/
|
|
2003
|
-
SourceIp: string
|
|
2004
|
-
/**
|
|
2005
|
-
* 电子印章ID。若为空,则修改个人/机构的默认印章。
|
|
2006
|
-
*/
|
|
2007
|
-
SealId?: string
|
|
2008
|
-
/**
|
|
2009
|
-
* 电子印章名称
|
|
2010
|
-
*/
|
|
2011
|
-
SealName?: string
|
|
2012
|
-
/**
|
|
2013
|
-
* 印章图片,base64编码(与FileId参数二选一,同时传入参数时优先使用Image参数)
|
|
2014
|
-
*/
|
|
2015
|
-
Image?: string
|
|
2016
|
-
/**
|
|
2017
|
-
* 印章图片文件ID(与Image参数二选一,同时传入参数时优先使用Image参数)
|
|
2018
|
-
*/
|
|
2019
|
-
FileId?: string
|
|
2020
|
-
/**
|
|
2021
|
-
* 需要更新印章的用户ID
|
|
2022
|
-
*/
|
|
2023
|
-
UserId?: string
|
|
2024
|
-
}
|
|
2025
|
-
|
|
2026
|
-
/**
|
|
2027
|
-
* CheckBankCard3EVerification请求参数结构体
|
|
2028
|
-
*/
|
|
2029
|
-
export interface CheckBankCard3EVerificationRequest {
|
|
2030
|
-
/**
|
|
2031
|
-
* 调用方信息; 必选
|
|
2032
|
-
*/
|
|
2033
|
-
Caller: Caller
|
|
2034
|
-
/**
|
|
2035
|
-
* 银行卡号
|
|
2036
|
-
*/
|
|
2037
|
-
BankCard: string
|
|
2038
|
-
/**
|
|
2039
|
-
* 姓名
|
|
2040
|
-
*/
|
|
2041
|
-
Name: string
|
|
2042
|
-
/**
|
|
2043
|
-
* 身份证件号码
|
|
2044
|
-
*/
|
|
2045
|
-
IdCardNumber: string
|
|
2046
|
-
/**
|
|
2047
|
-
* 身份证件类型; ID_CARD
|
|
2048
|
-
*/
|
|
2049
|
-
IdCardType?: string
|
|
2050
|
-
}
|
|
2051
|
-
|
|
2052
|
-
/**
|
|
2053
|
-
* CheckBankCardVerification请求参数结构体
|
|
2054
|
-
*/
|
|
2055
|
-
export interface CheckBankCardVerificationRequest {
|
|
2056
|
-
/**
|
|
2057
|
-
* 调用方信息; 必选
|
|
2058
|
-
*/
|
|
2059
|
-
Caller: Caller
|
|
2060
|
-
/**
|
|
2061
|
-
* 银行卡号
|
|
2062
|
-
*/
|
|
2063
|
-
BankCard: string
|
|
2064
|
-
/**
|
|
2065
|
-
* 姓名
|
|
2066
|
-
*/
|
|
2067
|
-
Name: string
|
|
2068
|
-
/**
|
|
2069
|
-
* 身份证件号码
|
|
2070
|
-
*/
|
|
2071
|
-
IdCardNumber?: string
|
|
2072
|
-
/**
|
|
2073
|
-
* 手机号
|
|
2074
|
-
*/
|
|
2075
|
-
Mobile?: string
|
|
2076
|
-
/**
|
|
2077
|
-
* 身份证件类型; ID_CARD
|
|
2078
|
-
*/
|
|
2079
|
-
IdCardType?: string
|
|
2080
|
-
}
|
|
2081
|
-
|
|
2082
|
-
/**
|
|
2083
|
-
* RejectFlow请求参数结构体
|
|
2084
|
-
*/
|
|
2085
|
-
export interface RejectFlowRequest {
|
|
2086
|
-
/**
|
|
2087
|
-
* 调用方信息
|
|
2088
|
-
*/
|
|
2089
|
-
Caller: Caller
|
|
2090
|
-
/**
|
|
2091
|
-
* 流程编号
|
|
2092
|
-
*/
|
|
2093
|
-
FlowId: string
|
|
2094
|
-
/**
|
|
2095
|
-
* 意愿确认票据。
|
|
2096
|
-
1. VerifyChannel 为 WEIXINAPP,使用响应的VerifyResult;
|
|
2097
|
-
2. VerifyChannel 为 FACEID时,使用OrderNo;
|
|
2098
|
-
3. VerifyChannel 为 VERIFYCODE,使用短信验证码
|
|
2099
|
-
4. VerifyChannel 为 NONE,传空值
|
|
2100
|
-
(注:普通情况下,VerifyResult不能为None,如您不希望腾讯电子签对用户签署意愿做校验,请提前与客户经理或邮件至e-contract@tencent.com与我们联系)
|
|
2101
|
-
*/
|
|
2102
|
-
VerifyResult: string
|
|
2103
|
-
/**
|
|
2104
|
-
* 意愿确认渠道:
|
|
2105
|
-
1. WEIXINAPP - 微信小程序
|
|
2106
|
-
2. FACEID - 慧眼 (默认)
|
|
2107
|
-
3. VERIFYCODE - 验证码
|
|
2108
|
-
4. THIRD - 第三方 (暂不支持)
|
|
2109
|
-
5. NONE - 无需电子签系统验证
|
|
2110
|
-
(注:普通情况下,VerifyChannel不能为None,如您不希望腾讯电子签对用户签署意愿做校验,请提前与客户经理或邮件至e-contract@tencent.com与我们联系)
|
|
2111
|
-
*/
|
|
2112
|
-
VerifyChannel: string
|
|
2113
|
-
/**
|
|
2114
|
-
* 客户端来源IP
|
|
2115
|
-
*/
|
|
2116
|
-
SourceIp: string
|
|
2117
|
-
/**
|
|
2118
|
-
* 拒签原因
|
|
2119
|
-
*/
|
|
2120
|
-
RejectMessage?: string
|
|
2121
|
-
/**
|
|
2122
|
-
* 签署参与者编号
|
|
2123
|
-
*/
|
|
2124
|
-
SignId?: string
|
|
2125
|
-
}
|
|
2126
|
-
|
|
2127
|
-
/**
|
|
2128
|
-
* DescribeSubOrganizations请求参数结构体
|
|
2129
|
-
*/
|
|
2130
|
-
export interface DescribeSubOrganizationsRequest {
|
|
2131
|
-
/**
|
|
2132
|
-
* 调用方信息
|
|
2133
|
-
*/
|
|
2134
|
-
Caller: Caller
|
|
2135
|
-
/**
|
|
2136
|
-
* 子机构ID数组
|
|
2137
|
-
*/
|
|
2138
|
-
SubOrganizationIds: Array<string>
|
|
2139
|
-
}
|
|
2140
|
-
|
|
2141
|
-
/**
|
|
2142
|
-
* 此结构体 (SignSeal) 用于描述签名/印章信息。
|
|
2143
|
-
*/
|
|
2144
|
-
export interface SignSeal {
|
|
2145
|
-
/**
|
|
2146
|
-
* 签署控件ID
|
|
2147
|
-
*/
|
|
2148
|
-
ComponentId: string
|
|
2149
|
-
/**
|
|
2150
|
-
* 签署印章类型:
|
|
2151
|
-
SIGN_SIGNATURE - 签名
|
|
2152
|
-
SIGN_SEAL - 印章
|
|
2153
|
-
SIGN_DATE - 日期
|
|
2154
|
-
SIGN_IMAGE - 图片
|
|
2155
|
-
*/
|
|
2156
|
-
SignType: string
|
|
2157
|
-
/**
|
|
2158
|
-
* 合同文件ID
|
|
2159
|
-
*/
|
|
2160
|
-
FileIndex: number
|
|
2161
|
-
/**
|
|
2162
|
-
* 印章ID,仅当 SignType 为 SIGN_SEAL 时必填
|
|
2163
|
-
*/
|
|
2164
|
-
SealId?: string
|
|
2165
|
-
/**
|
|
2166
|
-
* 签名内容,仅当 SignType 为SIGN_SIGNATURE或SIGN_IMAGE 时必填,base64编码
|
|
2167
|
-
*/
|
|
2168
|
-
SealContent?: string
|
|
2169
|
-
}
|
|
2170
|
-
|
|
2171
|
-
/**
|
|
2172
|
-
* DescribeCatalogSignComponents请求参数结构体
|
|
2173
|
-
*/
|
|
2174
|
-
export interface DescribeCatalogSignComponentsRequest {
|
|
2175
|
-
/**
|
|
2176
|
-
* 调用方信息
|
|
2177
|
-
*/
|
|
2178
|
-
Caller: Caller
|
|
2179
|
-
/**
|
|
2180
|
-
* 目录ID
|
|
2181
|
-
*/
|
|
2182
|
-
CatalogId: string
|
|
2183
|
-
}
|
|
2184
|
-
|
|
2185
|
-
/**
|
|
2186
|
-
* ModifyOrganizationDefaultSeal返回参数结构体
|
|
2187
|
-
*/
|
|
2188
|
-
export interface ModifyOrganizationDefaultSealResponse {
|
|
2189
|
-
/**
|
|
2190
|
-
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
2191
|
-
*/
|
|
2192
|
-
RequestId?: string
|
|
2193
|
-
}
|
|
2194
|
-
|
|
2195
|
-
/**
|
|
2196
|
-
* CreateFlowByFiles返回参数结构体
|
|
2197
|
-
*/
|
|
2198
|
-
export interface CreateFlowByFilesResponse {
|
|
2199
|
-
/**
|
|
2200
|
-
* 流程ID
|
|
2201
|
-
*/
|
|
2202
|
-
FlowId: string
|
|
2203
|
-
/**
|
|
2204
|
-
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
2205
|
-
*/
|
|
2206
|
-
RequestId?: string
|
|
2207
|
-
}
|
|
2208
|
-
|
|
2209
|
-
/**
|
|
2210
|
-
* ModifyUserDefaultSeal返回参数结构体
|
|
2211
|
-
*/
|
|
2212
|
-
export interface ModifyUserDefaultSealResponse {
|
|
2213
|
-
/**
|
|
2214
|
-
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
2215
|
-
*/
|
|
2216
|
-
RequestId?: string
|
|
2217
|
-
}
|
|
2218
|
-
|
|
2219
|
-
/**
|
|
2220
|
-
* UploadFiles返回参数结构体
|
|
2221
|
-
*/
|
|
2222
|
-
export interface UploadFilesResponse {
|
|
2223
|
-
/**
|
|
2224
|
-
* 文件id数组
|
|
2225
|
-
*/
|
|
2226
|
-
FileIds: Array<string>
|
|
2227
|
-
/**
|
|
2228
|
-
* 上传成功文件数量
|
|
2229
|
-
*/
|
|
2230
|
-
TotalCount: number
|
|
2231
|
-
/**
|
|
2232
|
-
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
2233
|
-
*/
|
|
2234
|
-
RequestId?: string
|
|
2235
|
-
}
|
|
2236
|
-
|
|
2237
|
-
/**
|
|
2238
|
-
* CheckBankCard3EVerification返回参数结构体
|
|
2239
|
-
*/
|
|
2240
|
-
export interface CheckBankCard3EVerificationResponse {
|
|
2241
|
-
/**
|
|
2242
|
-
* 检测结果
|
|
2243
|
-
计费结果码:
|
|
2244
|
-
0: 认证通过
|
|
2245
|
-
1: 认证未通过
|
|
2246
|
-
2: 持卡人信息有误
|
|
2247
|
-
3: 未开通无卡支付
|
|
2248
|
-
4: 此卡被没收
|
|
2249
|
-
5: 无效卡号
|
|
2250
|
-
6: 此卡无对应发卡行
|
|
2251
|
-
7: 该卡未初始化或睡眠卡
|
|
2252
|
-
8: 作弊卡、吞卡
|
|
2253
|
-
9: 此卡已挂失
|
|
2254
|
-
10: 该卡已过期
|
|
2255
|
-
11: 受限制的卡
|
|
2256
|
-
12: 密码错误次数超限
|
|
2257
|
-
13: 发卡行不支持此交易
|
|
2258
|
-
不收费结果码:
|
|
2259
|
-
101: 姓名校验不通过
|
|
2260
|
-
102: 银行卡号码有误
|
|
2261
|
-
103: 验证中心服务繁忙
|
|
2262
|
-
104: 身份证号码有误
|
|
2263
|
-
105: 手机号码不合法
|
|
2264
|
-
*/
|
|
2265
|
-
Result?: number
|
|
2266
|
-
/**
|
|
2267
|
-
* 结果描述; 未通过时必选
|
|
2268
|
-
*/
|
|
2269
|
-
Description?: string
|
|
2270
|
-
/**
|
|
2271
|
-
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
2272
|
-
*/
|
|
2273
|
-
RequestId?: string
|
|
2274
|
-
}
|
|
2275
|
-
|
|
2276
|
-
/**
|
|
2277
|
-
* SignFlow请求参数结构体
|
|
2278
|
-
*/
|
|
2279
|
-
export interface SignFlowRequest {
|
|
2280
|
-
/**
|
|
2281
|
-
* 调用方信息
|
|
2282
|
-
*/
|
|
2283
|
-
Caller: Caller
|
|
2284
|
-
/**
|
|
2285
|
-
* 流程编号
|
|
2286
|
-
*/
|
|
2287
|
-
FlowId: string
|
|
2288
|
-
/**
|
|
2289
|
-
* 意愿确认票据。
|
|
2290
|
-
1. VerifyChannel 为 WEIXINAPP,使用响应的VerifyResult;
|
|
2291
|
-
2. VerifyChannel 为 FACEID时,使用OrderNo;
|
|
2292
|
-
3. VerifyChannel 为 VERIFYCODE,使用短信验证码
|
|
2293
|
-
4. VerifyChannel 为 NONE,传空值
|
|
2294
|
-
(注:普通情况下,VerifyResult不能为None,如您不希望腾讯电子签对用户签署意愿做校验,请提前与客户经理或邮件至e-contract@tencent.com与我们联系)
|
|
2295
|
-
*/
|
|
2296
|
-
VerifyResult: string
|
|
2297
|
-
/**
|
|
2298
|
-
* 意愿确认渠道:
|
|
2299
|
-
1. WEIXINAPP - 微信小程序
|
|
2300
|
-
2. FACEID - 慧眼 (默认)
|
|
2301
|
-
3. VERIFYCODE - 验证码
|
|
2302
|
-
4. THIRD - 第三方 (暂不支持)
|
|
2303
|
-
5. NONE - 无需电子签系统验证
|
|
2304
|
-
(注:普通情况下,VerifyChannel不能为None,如您不希望腾讯电子签对用户签署意愿做校验,请提前与客户经理或邮件至e-contract@tencent.com与我们联系)
|
|
2305
|
-
*/
|
|
2306
|
-
VerifyChannel: string
|
|
2307
|
-
/**
|
|
2308
|
-
* 客户端来源IP
|
|
2309
|
-
*/
|
|
2310
|
-
SourceIp: string
|
|
2311
|
-
/**
|
|
2312
|
-
* 签署内容
|
|
2313
|
-
*/
|
|
2314
|
-
SignSeals: Array<SignSeal>
|
|
2315
|
-
/**
|
|
2316
|
-
* 签署备注
|
|
2317
|
-
*/
|
|
2318
|
-
ApproveMessage?: string
|
|
2319
|
-
/**
|
|
2320
|
-
* 签署参与者编号
|
|
2321
|
-
*/
|
|
2322
|
-
SignId?: string
|
|
2323
|
-
}
|
|
2324
|
-
|
|
2325
|
-
/**
|
|
2326
|
-
* 自定义流程id映射关系
|
|
2327
|
-
*/
|
|
2328
|
-
export interface CustomFlowIdMap {
|
|
2329
|
-
/**
|
|
2330
|
-
* 自定义id
|
|
2331
|
-
*/
|
|
2332
|
-
CustomId: string
|
|
2333
|
-
/**
|
|
2334
|
-
* 流程id
|
|
2335
|
-
*/
|
|
2336
|
-
FlowId: string
|
|
2337
|
-
}
|
|
2338
|
-
|
|
2339
|
-
/**
|
|
2340
|
-
* DescribeCustomFlowIdsByFlowId请求参数结构体
|
|
2341
|
-
*/
|
|
2342
|
-
export interface DescribeCustomFlowIdsByFlowIdRequest {
|
|
2343
|
-
/**
|
|
2344
|
-
* 调用方信息
|
|
2345
|
-
*/
|
|
2346
|
-
Caller: Caller
|
|
2347
|
-
/**
|
|
2348
|
-
* 流程 id 列表,最多同时查询 10 个流程 id
|
|
2349
|
-
*/
|
|
2350
|
-
FlowIds: Array<string>
|
|
2351
|
-
}
|
|
2352
|
-
|
|
2353
|
-
/**
|
|
2354
|
-
* 此结构体 (UploadFile) 用于描述多文件上传的文件信息。
|
|
2355
|
-
*/
|
|
2356
|
-
export interface UploadFile {
|
|
2357
|
-
/**
|
|
2358
|
-
* Base64编码后的文件内容
|
|
2359
|
-
*/
|
|
2360
|
-
FileBody: string
|
|
2361
|
-
/**
|
|
2362
|
-
* 文件名
|
|
2363
|
-
*/
|
|
2364
|
-
FileName?: string
|
|
2365
|
-
}
|
|
2366
|
-
|
|
2367
|
-
/**
|
|
2368
|
-
* DescribeUsers返回参数结构体
|
|
2369
|
-
*/
|
|
2370
|
-
export interface DescribeUsersResponse {
|
|
2371
|
-
/**
|
|
2372
|
-
* 用户信息查询结果
|
|
2373
|
-
*/
|
|
2374
|
-
Users: Array<UserDescribe>
|
|
2375
|
-
/**
|
|
2376
|
-
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
2377
|
-
*/
|
|
2378
|
-
RequestId?: string
|
|
2379
|
-
}
|
|
2380
|
-
|
|
2381
|
-
/**
|
|
2382
|
-
* CreateH5FaceIdUrl请求参数结构体
|
|
2383
|
-
*/
|
|
2384
|
-
export interface CreateH5FaceIdUrlRequest {
|
|
2385
|
-
/**
|
|
2386
|
-
* 调用方信息; 必选
|
|
2387
|
-
*/
|
|
2388
|
-
Caller: Caller
|
|
2389
|
-
/**
|
|
2390
|
-
* 慧眼业务ID; 不填写时后台使用Caller反查
|
|
2391
|
-
*/
|
|
2392
|
-
WbAppId?: string
|
|
2393
|
-
/**
|
|
2394
|
-
* 姓名; 可选(未通过实名认证的用户必选)
|
|
2395
|
-
*/
|
|
2396
|
-
Name?: string
|
|
2397
|
-
/**
|
|
2398
|
-
* 用户证件类型; 可选; 默认ID_CARD:中国居民身份证
|
|
2399
|
-
*/
|
|
2400
|
-
IdCardType?: string
|
|
2401
|
-
/**
|
|
2402
|
-
* 用户证件号; 可选(未通过实名认证的用户必选)
|
|
2403
|
-
*/
|
|
2404
|
-
IdCardNumber?: string
|
|
2405
|
-
/**
|
|
2406
|
-
* H5人脸核身完成后回调的第三方Url; 可选; 不需要做Encode, 跳转的参数: ?code=XX&orderNo=XX&liveRate=xx, code=0表示成功,orderNo为订单号,liveRate为百分制活体检测得分
|
|
2407
|
-
*/
|
|
2408
|
-
JumpUrl?: string
|
|
2409
|
-
/**
|
|
2410
|
-
* 参数值为"1":直接跳转到url回调地址; 可选; 其他值:跳转提供的结果页面
|
|
2411
|
-
*/
|
|
2412
|
-
JumpType?: string
|
|
2413
|
-
/**
|
|
2414
|
-
* browser:表示在浏览器启动刷脸, app:表示在App里启动刷脸,默认值为browser; 可选
|
|
2415
|
-
*/
|
|
2416
|
-
OpenFrom?: string
|
|
2417
|
-
/**
|
|
2418
|
-
* 跳转类型; 可选; 参数值为"1"时,刷脸页面使用replace方式跳转,不在浏览器history中留下记录;不传或其他值则正常跳转
|
|
2419
|
-
*/
|
|
2420
|
-
RedirectType?: string
|
|
2421
|
-
}
|
|
2422
|
-
|
|
2423
|
-
/**
|
|
2424
|
-
* CheckMobileVerification返回参数结构体
|
|
2425
|
-
*/
|
|
2426
|
-
export interface CheckMobileVerificationResponse {
|
|
2427
|
-
/**
|
|
2428
|
-
* 检测结果
|
|
2429
|
-
计费结果码:
|
|
2430
|
-
0: 验证结果一致
|
|
2431
|
-
1: 手机号未实名
|
|
2432
|
-
2: 姓名和手机号不一致
|
|
2433
|
-
3: 信息不一致(手机号已实名,但姓名和身份证号与实名信息不一致)
|
|
2434
|
-
不收费结果码:
|
|
2435
|
-
101: 查无记录
|
|
2436
|
-
102: 非法姓名(长度,格式等不正确)
|
|
2437
|
-
103: 非法手机号(长度,格式等不正确)
|
|
2438
|
-
104: 非法身份证号(长度,校验位等不正确)
|
|
2439
|
-
105: 认证未通过
|
|
2440
|
-
106: 验证平台异常
|
|
2441
|
-
*/
|
|
2442
|
-
Result?: number
|
|
2443
|
-
/**
|
|
2444
|
-
* 结果描述; 未通过时必选
|
|
2445
|
-
*/
|
|
2446
|
-
Description?: string
|
|
2447
|
-
/**
|
|
2448
|
-
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
2449
|
-
*/
|
|
2450
|
-
RequestId?: string
|
|
2451
|
-
}
|
|
2452
|
-
|
|
2453
|
-
/**
|
|
2454
|
-
* DescribeFlowFiles返回参数结构体
|
|
2455
|
-
*/
|
|
2456
|
-
export interface DescribeFlowFilesResponse {
|
|
2457
|
-
/**
|
|
2458
|
-
* 流程编号
|
|
2459
|
-
*/
|
|
2460
|
-
FlowId?: string
|
|
2461
|
-
/**
|
|
2462
|
-
* 流程文件列表
|
|
2463
|
-
*/
|
|
2464
|
-
FlowFileInfos?: Array<FlowFileInfo>
|
|
2465
|
-
/**
|
|
2466
|
-
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
2467
|
-
*/
|
|
2468
|
-
RequestId?: string
|
|
2469
|
-
}
|
|
2470
|
-
|
|
2471
|
-
/**
|
|
2472
|
-
* CreateUser请求参数结构体
|
|
2473
|
-
*/
|
|
2474
|
-
export interface CreateUserRequest {
|
|
2475
|
-
/**
|
|
2476
|
-
* 调用方信息
|
|
2477
|
-
*/
|
|
2478
|
-
Caller: Caller
|
|
2479
|
-
/**
|
|
2480
|
-
* 第三方平台唯一标识;要求应用内OpenId唯一; len<=32
|
|
2481
|
-
*/
|
|
2482
|
-
OpenId: string
|
|
2483
|
-
/**
|
|
2484
|
-
* 用户姓名
|
|
2485
|
-
*/
|
|
2486
|
-
Name: string
|
|
2487
|
-
/**
|
|
2488
|
-
* 用户证件类型:
|
|
2489
|
-
1. ID_CARD - 居民身份证
|
|
2490
|
-
2. PASSPORT - 护照
|
|
2491
|
-
3. MAINLAND_TRAVEL_PERMIT_FOR_HONGKONG_AND_MACAO_RESIDENTS - 港澳居民来往内地通行证
|
|
2492
|
-
4. MAINLAND_TRAVEL_PERMIT_FOR_TAIWAN_RESIDENTS - 台湾居民来往大陆通行证
|
|
2493
|
-
5. HOUSEHOLD_REGISTER - 户口本
|
|
2494
|
-
6. TEMP_ID_CARD - 临时居民身份证
|
|
2495
|
-
*/
|
|
2496
|
-
IdCardType: string
|
|
2497
|
-
/**
|
|
2498
|
-
* 用户证件号
|
|
2499
|
-
*/
|
|
2500
|
-
IdCardNumber: string
|
|
2501
|
-
/**
|
|
2502
|
-
* 是否以OpenId作为UserId (为true时将直接以OpenId生成腾讯电子签平台的UserId)
|
|
2503
|
-
*/
|
|
2504
|
-
UseOpenId?: boolean
|
|
2505
|
-
/**
|
|
2506
|
-
* 用户邮箱,不要求唯一
|
|
2507
|
-
*/
|
|
2508
|
-
Email?: string
|
|
2509
|
-
/**
|
|
2510
|
-
* 用户手机号码,不要求唯一
|
|
2511
|
-
*/
|
|
2512
|
-
Mobile?: string
|
|
2513
|
-
}
|
|
2514
|
-
|
|
2515
|
-
/**
|
|
2516
|
-
* CreatePreviewSignUrl请求参数结构体
|
|
2517
|
-
*/
|
|
2518
|
-
export interface CreatePreviewSignUrlRequest {
|
|
2519
|
-
/**
|
|
2520
|
-
* 调用方信息
|
|
2521
|
-
*/
|
|
2522
|
-
Caller: Caller
|
|
2523
|
-
/**
|
|
2524
|
-
* URL过期时间戳
|
|
2525
|
-
*/
|
|
2526
|
-
Deadline: number
|
|
2527
|
-
/**
|
|
2528
|
-
* 目录ID。当 SignUrlType 为 CATALOG 时必填
|
|
2529
|
-
*/
|
|
2530
|
-
CatalogId?: string
|
|
2531
|
-
/**
|
|
2532
|
-
* 流程ID。当 SignUrlType 为 FLOW 时必填
|
|
2533
|
-
*/
|
|
2534
|
-
FlowId?: string
|
|
2535
|
-
/**
|
|
2536
|
-
* 签署链接类型:
|
|
2537
|
-
1. FLOW - 单流程签署 (默认)
|
|
2538
|
-
2. CATALOG - 目录签署
|
|
2539
|
-
*/
|
|
2540
|
-
SignUrlType?: string
|
|
2541
|
-
}
|
|
2542
|
-
|
|
2543
|
-
/**
|
|
2544
|
-
* CreateUserAndSeal请求参数结构体
|
|
2545
|
-
*/
|
|
2546
|
-
export interface CreateUserAndSealRequest {
|
|
2547
|
-
/**
|
|
2548
|
-
* 调用方信息
|
|
2549
|
-
*/
|
|
2550
|
-
Caller: Caller
|
|
2551
|
-
/**
|
|
2552
|
-
* 第三方平台唯一标识,要求应用内OpenId唯一
|
|
2553
|
-
*/
|
|
2554
|
-
OpenId: string
|
|
2555
|
-
/**
|
|
2556
|
-
* 用户姓名
|
|
2557
|
-
*/
|
|
2558
|
-
Name: string
|
|
2559
|
-
/**
|
|
2560
|
-
* 用户证件类型:
|
|
2561
|
-
1. ID_CARD - 居民身份证
|
|
2562
|
-
5. HOUSEHOLD_REGISTER - 户口本
|
|
2563
|
-
6. TEMP_ID_CARD - 临时居民身份证
|
|
2564
|
-
*/
|
|
2565
|
-
IdCardType: string
|
|
2566
|
-
/**
|
|
2567
|
-
* 用户证件号
|
|
2568
|
-
*/
|
|
2569
|
-
IdCardNumber: string
|
|
2570
|
-
/**
|
|
2571
|
-
* 请求生成个人印章的客户端IP
|
|
2572
|
-
*/
|
|
2573
|
-
SourceIp: string
|
|
2574
|
-
/**
|
|
2575
|
-
* 用户手机号码,不要求唯一
|
|
2576
|
-
*/
|
|
2577
|
-
Mobile?: string
|
|
2578
|
-
/**
|
|
2579
|
-
* 用户邮箱,不要求唯一
|
|
2580
|
-
*/
|
|
2581
|
-
Email?: string
|
|
2582
|
-
/**
|
|
2583
|
-
* 默认印章名称
|
|
2584
|
-
*/
|
|
2585
|
-
SealName?: string
|
|
2586
|
-
/**
|
|
2587
|
-
* 是否以OpenId作为UserId (为true时将直接以OpenId生成腾讯电子签平台的UserId)
|
|
2588
|
-
*/
|
|
2589
|
-
UseOpenId?: boolean
|
|
2590
|
-
}
|
|
2591
|
-
|
|
2592
|
-
/**
|
|
2593
|
-
* CreatePreviewSignUrl返回参数结构体
|
|
2594
|
-
*/
|
|
2595
|
-
export interface CreatePreviewSignUrlResponse {
|
|
2596
|
-
/**
|
|
2597
|
-
* 合同预览URL
|
|
2598
|
-
*/
|
|
2599
|
-
PreviewSignUrl: string
|
|
2600
|
-
/**
|
|
2601
|
-
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
2602
|
-
*/
|
|
2603
|
-
RequestId?: string
|
|
2604
|
-
}
|
|
2605
|
-
|
|
2606
|
-
/**
|
|
2607
|
-
* CreateFaceIdSign请求参数结构体
|
|
2608
|
-
*/
|
|
2609
|
-
export interface CreateFaceIdSignRequest {
|
|
2610
|
-
/**
|
|
2611
|
-
* 调用方信息; 必选
|
|
2612
|
-
*/
|
|
2613
|
-
Caller: Caller
|
|
2614
|
-
/**
|
|
2615
|
-
* 除api_ticket之外的其它要参与签名的参数值,包括UserId
|
|
2616
|
-
*/
|
|
2617
|
-
Values: Array<string>
|
|
2618
|
-
}
|
|
2619
|
-
|
|
2620
|
-
/**
|
|
2621
|
-
* DescribeCustomFlowIdsByFlowId返回参数结构体
|
|
2622
|
-
*/
|
|
2623
|
-
export interface DescribeCustomFlowIdsByFlowIdResponse {
|
|
2624
|
-
/**
|
|
2625
|
-
* 自定义流程 id 映射列表
|
|
2626
|
-
*/
|
|
2627
|
-
CustomIdList: Array<CustomFlowIdMap>
|
|
2628
|
-
/**
|
|
2629
|
-
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
2630
|
-
*/
|
|
2631
|
-
RequestId?: string
|
|
2632
|
-
}
|
|
2633
|
-
|
|
2634
|
-
/**
|
|
2635
|
-
* SignFlow返回参数结构体
|
|
2636
|
-
*/
|
|
2637
|
-
export interface SignFlowResponse {
|
|
2638
|
-
/**
|
|
2639
|
-
* 签署任务状态。签署成功 - SUCCESS、提交审核 - REVIEW
|
|
2640
|
-
*/
|
|
2641
|
-
Status: string
|
|
2642
|
-
/**
|
|
2643
|
-
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
2644
|
-
*/
|
|
2645
|
-
RequestId?: string
|
|
2646
|
-
}
|
|
2647
|
-
|
|
2648
|
-
/**
|
|
2649
|
-
* RejectFlow返回参数结构体
|
|
2650
|
-
*/
|
|
2651
|
-
export interface RejectFlowResponse {
|
|
2652
|
-
/**
|
|
2653
|
-
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
2654
|
-
*/
|
|
2655
|
-
RequestId?: string
|
|
2656
|
-
}
|
|
2657
|
-
|
|
2658
|
-
/**
|
|
2659
|
-
* DescribeFlow请求参数结构体
|
|
2660
|
-
*/
|
|
2661
|
-
export interface DescribeFlowRequest {
|
|
2662
|
-
/**
|
|
2663
|
-
* 调用方信息
|
|
2664
|
-
*/
|
|
2665
|
-
Caller: Caller
|
|
2666
|
-
/**
|
|
2667
|
-
* 需要查询的流程ID
|
|
2668
|
-
*/
|
|
2669
|
-
FlowId: string
|
|
2670
|
-
}
|
|
2671
|
-
|
|
2672
|
-
/**
|
|
2673
|
-
* DescribeFileIdsByCustomIds请求参数结构体
|
|
2674
|
-
*/
|
|
2675
|
-
export interface DescribeFileIdsByCustomIdsRequest {
|
|
2676
|
-
/**
|
|
2677
|
-
* 调用方信息, OrganizationId必填
|
|
2678
|
-
*/
|
|
2679
|
-
Caller: Caller
|
|
2680
|
-
/**
|
|
2681
|
-
* 用户自定义ID
|
|
2682
|
-
*/
|
|
2683
|
-
CustomIds?: Array<string>
|
|
2684
|
-
}
|
|
2685
|
-
|
|
2686
|
-
/**
|
|
2687
|
-
* CreateSeal返回参数结构体
|
|
2688
|
-
*/
|
|
2689
|
-
export interface CreateSealResponse {
|
|
2690
|
-
/**
|
|
2691
|
-
* 电子印章Id
|
|
2692
|
-
*/
|
|
2693
|
-
SealId: string
|
|
2694
|
-
/**
|
|
2695
|
-
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
2696
|
-
*/
|
|
2697
|
-
RequestId?: string
|
|
2698
|
-
}
|
|
2699
|
-
|
|
2700
|
-
/**
|
|
2701
|
-
* GenerateOrganizationSeal返回参数结构体
|
|
2702
|
-
*/
|
|
2703
|
-
export interface GenerateOrganizationSealResponse {
|
|
2704
|
-
/**
|
|
2705
|
-
* 电子印章Id
|
|
2706
|
-
*/
|
|
2707
|
-
SealId: string
|
|
2708
|
-
/**
|
|
2709
|
-
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
2710
|
-
*/
|
|
2711
|
-
RequestId?: string
|
|
2712
|
-
}
|
|
2713
|
-
|
|
2714
|
-
/**
|
|
2715
|
-
* DescribeSubOrganizations返回参数结构体
|
|
2716
|
-
*/
|
|
2717
|
-
export interface DescribeSubOrganizationsResponse {
|
|
2718
|
-
/**
|
|
2719
|
-
* 子机构信息列表
|
|
2720
|
-
*/
|
|
2721
|
-
SubOrganizationInfos: Array<SubOrganizationDetail>
|
|
2722
|
-
/**
|
|
2723
|
-
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
2724
|
-
*/
|
|
2725
|
-
RequestId?: string
|
|
2726
|
-
}
|
|
2727
|
-
|
|
2728
|
-
/**
|
|
2729
|
-
* DestroyFlowFile请求参数结构体
|
|
2730
|
-
*/
|
|
2731
|
-
export interface DestroyFlowFileRequest {
|
|
2732
|
-
/**
|
|
2733
|
-
* 调用方信息
|
|
2734
|
-
*/
|
|
2735
|
-
Caller: Caller
|
|
2736
|
-
/**
|
|
2737
|
-
* 流程ID
|
|
2738
|
-
*/
|
|
2739
|
-
FlowId: string
|
|
2740
|
-
}
|
|
2741
|
-
|
|
2742
|
-
/**
|
|
2743
|
-
* CheckFaceIdentify返回参数结构体
|
|
2744
|
-
*/
|
|
2745
|
-
export interface CheckFaceIdentifyResponse {
|
|
2746
|
-
/**
|
|
2747
|
-
* 核身结果; 0:通过,1:不通过
|
|
2748
|
-
*/
|
|
2749
|
-
Result?: number
|
|
2750
|
-
/**
|
|
2751
|
-
* 核身结果描述
|
|
2752
|
-
*/
|
|
2753
|
-
Description?: string
|
|
2754
|
-
/**
|
|
2755
|
-
* 渠道名
|
|
2756
|
-
*/
|
|
2757
|
-
ChannelName?: string
|
|
2758
|
-
/**
|
|
2759
|
-
* 认证通过时间
|
|
2760
|
-
注意:此字段可能返回 null,表示取不到有效值。
|
|
2761
|
-
*/
|
|
2762
|
-
VerifiedOn?: number
|
|
2763
|
-
/**
|
|
2764
|
-
* 核身流水号
|
|
2765
|
-
*/
|
|
2766
|
-
SerialNumber?: string
|
|
2767
|
-
/**
|
|
2768
|
-
* 渠道核身服务器IP
|
|
2769
|
-
注意:此字段可能返回 null,表示取不到有效值。
|
|
2770
|
-
*/
|
|
2771
|
-
VerifyServerIp?: string
|
|
2772
|
-
/**
|
|
2773
|
-
* 核身照片文件名
|
|
2774
|
-
注意:此字段可能返回 null,表示取不到有效值。
|
|
2775
|
-
*/
|
|
2776
|
-
PhotoFileName?: string
|
|
2777
|
-
/**
|
|
2778
|
-
* 核身照片内容base64(文件格式见文件名后缀,一般为jpg)
|
|
2779
|
-
注意:此字段可能返回 null,表示取不到有效值。
|
|
2780
|
-
*/
|
|
2781
|
-
PhotoFileData?: string
|
|
2782
|
-
/**
|
|
2783
|
-
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
2784
|
-
*/
|
|
2785
|
-
RequestId?: string
|
|
2786
|
-
}
|
|
2787
|
-
|
|
2788
|
-
/**
|
|
2789
|
-
* 此结构体 (Seal) 用于描述电子印章的信息。
|
|
2790
|
-
*/
|
|
2791
|
-
export interface Seal {
|
|
2792
|
-
/**
|
|
2793
|
-
* 电子印章ID
|
|
2794
|
-
*/
|
|
2795
|
-
SealId: string
|
|
2796
|
-
/**
|
|
2797
|
-
* 电子印章名称
|
|
2798
|
-
*/
|
|
2799
|
-
SealName: string
|
|
2800
|
-
/**
|
|
2801
|
-
* 电子印章类型
|
|
2802
|
-
*/
|
|
2803
|
-
SealType: string
|
|
2804
|
-
/**
|
|
2805
|
-
* 电子印章来源:
|
|
2806
|
-
CREATE - 通过图片上传
|
|
2807
|
-
GENERATE - 通过文字生成
|
|
2808
|
-
*/
|
|
2809
|
-
SealSource: string
|
|
2810
|
-
/**
|
|
2811
|
-
* 电子印章创建者
|
|
2812
|
-
*/
|
|
2813
|
-
Creator: Caller
|
|
2814
|
-
/**
|
|
2815
|
-
* 电子印章创建时间戳
|
|
2816
|
-
*/
|
|
2817
|
-
CreatedOn: number
|
|
2818
|
-
/**
|
|
2819
|
-
* 电子印章所有人
|
|
2820
|
-
*/
|
|
2821
|
-
UserId: string
|
|
2822
|
-
/**
|
|
2823
|
-
* 电子印章URL
|
|
2824
|
-
*/
|
|
2825
|
-
FileUrl: FileUrl
|
|
2826
|
-
/**
|
|
2827
|
-
* 是否为默认印章,false-非默认,true-默认
|
|
2828
|
-
*/
|
|
2829
|
-
DefaultSeal: boolean
|
|
2830
|
-
}
|
|
2831
|
-
|
|
2832
|
-
/**
|
|
2833
|
-
* SendFlowUrl请求参数结构体
|
|
2834
|
-
*/
|
|
2835
|
-
export interface SendFlowUrlRequest {
|
|
2836
|
-
/**
|
|
2837
|
-
* 调用方信息
|
|
2838
|
-
*/
|
|
2839
|
-
Caller: Caller
|
|
2840
|
-
/**
|
|
2841
|
-
* 需要推送合同的流程ID
|
|
2842
|
-
*/
|
|
2843
|
-
FlowId: string
|
|
2844
|
-
/**
|
|
2845
|
-
* 签署人ID
|
|
2846
|
-
*/
|
|
2847
|
-
UserId: string
|
|
2848
|
-
/**
|
|
2849
|
-
* 签署控件信息 (支持添加多个控件)
|
|
2850
|
-
*/
|
|
2851
|
-
SignComponents: Array<Component>
|
|
2852
|
-
/**
|
|
2853
|
-
* 签署人手机号 (如果选择短信验证码签署,则此字段必填)
|
|
2854
|
-
*/
|
|
2855
|
-
Mobile?: string
|
|
2856
|
-
/**
|
|
2857
|
-
* 签署人对应的子机构ID,个人签署者此字段不填
|
|
2858
|
-
*/
|
|
2859
|
-
SubOrganizationId?: string
|
|
2860
|
-
/**
|
|
2861
|
-
* 签名后校验方式:
|
|
2862
|
-
1. WEIXINAPP - 微信小程序;
|
|
2863
|
-
2. FACEID - 慧眼 (默认) ;
|
|
2864
|
-
3. VERIFYCODE - 验证码;
|
|
2865
|
-
4. NONE - 无。此选项为白名单参数,暂不支持公开调用。如需开通权限,请通过客户经理或邮件至e-contract@tencent.com与我们联系;
|
|
2866
|
-
5. THIRD - 第三方 (暂不支持)
|
|
2867
|
-
6. OFFLINE - 线下人工审核
|
|
2868
|
-
*/
|
|
2869
|
-
VerifyChannel?: Array<string>
|
|
2870
|
-
/**
|
|
2871
|
-
* 签署链接失效截止时间,默认为7天
|
|
2872
|
-
*/
|
|
2873
|
-
Deadline?: number
|
|
2874
|
-
/**
|
|
2875
|
-
* 是否为最后一个签署人。若为最后一人,本次签署完成以后自动归档
|
|
2876
|
-
*/
|
|
2877
|
-
IsLastApprover?: boolean
|
|
2878
|
-
/**
|
|
2879
|
-
* 签署完成后,前端跳转的url
|
|
2880
|
-
*/
|
|
2881
|
-
JumpUrl?: string
|
|
2882
|
-
/**
|
|
2883
|
-
* 短信模板
|
|
2884
|
-
默认使用腾讯电子签官方短信模板,如有自定义需求,请通过客户经理或邮件至e-contract@tencent.com与我们联系。
|
|
2885
|
-
*/
|
|
2886
|
-
SmsTemplate?: SmsTemplate
|
|
2887
|
-
/**
|
|
2888
|
-
* 签署前置条件:是否要全文阅读,默认否
|
|
2889
|
-
*/
|
|
2890
|
-
IsFullText?: boolean
|
|
2891
|
-
/**
|
|
2892
|
-
* 签署前置条件:强制用户阅读待签署文件时长,默认不限制
|
|
2893
|
-
*/
|
|
2894
|
-
PreReadTime?: number
|
|
2895
|
-
/**
|
|
2896
|
-
* 当前参与者是否支持线下核身,默认为不支持
|
|
2897
|
-
*/
|
|
2898
|
-
CanOffLine?: boolean
|
|
2899
|
-
/**
|
|
2900
|
-
* 签署任务的回调地址
|
|
2901
|
-
*/
|
|
2902
|
-
CallbackUrl?: string
|
|
2903
|
-
}
|
|
2904
|
-
|
|
2905
|
-
/**
|
|
2906
|
-
* CancelFlow请求参数结构体
|
|
2907
|
-
*/
|
|
2908
|
-
export interface CancelFlowRequest {
|
|
2909
|
-
/**
|
|
2910
|
-
* 调用方信息
|
|
2911
|
-
*/
|
|
2912
|
-
Caller: Caller
|
|
2913
|
-
/**
|
|
2914
|
-
* 流程ID
|
|
2915
|
-
*/
|
|
2916
|
-
FlowId: string
|
|
2917
|
-
/**
|
|
2918
|
-
* 撤销原因
|
|
2919
|
-
*/
|
|
2920
|
-
CancelMessage?: string
|
|
2921
|
-
}
|
|
2922
|
-
|
|
2923
|
-
/**
|
|
2924
|
-
* CreateH5FaceIdUrl返回参数结构体
|
|
2925
|
-
*/
|
|
2926
|
-
export interface CreateH5FaceIdUrlResponse {
|
|
2927
|
-
/**
|
|
2928
|
-
* 跳转到人脸核身页面的链接
|
|
2929
|
-
*/
|
|
2930
|
-
Url?: string
|
|
2931
|
-
/**
|
|
2932
|
-
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
2933
|
-
*/
|
|
2934
|
-
RequestId?: string
|
|
2935
|
-
}
|
|
2936
|
-
|
|
2937
|
-
/**
|
|
2938
|
-
* DescribeCustomFlowIds请求参数结构体
|
|
2939
|
-
*/
|
|
2940
|
-
export interface DescribeCustomFlowIdsRequest {
|
|
2941
|
-
/**
|
|
2942
|
-
* 调用方信息
|
|
2943
|
-
*/
|
|
2944
|
-
Caller: Caller
|
|
2945
|
-
/**
|
|
2946
|
-
* 自定义 id 列表,最多同时查询 10 个自定义 id
|
|
2947
|
-
*/
|
|
2948
|
-
CustomIds: Array<string>
|
|
2949
|
-
}
|
|
2950
|
-
|
|
2951
|
-
/**
|
|
2952
|
-
* DescribeFlowApprovers请求参数结构体
|
|
2953
|
-
*/
|
|
2954
|
-
export interface DescribeFlowApproversRequest {
|
|
2955
|
-
/**
|
|
2956
|
-
* 调用方信息
|
|
2957
|
-
*/
|
|
2958
|
-
Caller: Caller
|
|
2959
|
-
/**
|
|
2960
|
-
* 需要查询的流程ID
|
|
2961
|
-
*/
|
|
2962
|
-
FlowId: string
|
|
2963
|
-
/**
|
|
2964
|
-
* 需要查询的用户ID,为空则默认查询所有用户信息
|
|
2965
|
-
*/
|
|
2966
|
-
UserId?: string
|
|
2967
|
-
/**
|
|
2968
|
-
* 需要查询的签署ID,为空则不按签署ID过滤
|
|
2969
|
-
*/
|
|
2970
|
-
SignId?: string
|
|
2971
|
-
}
|
|
2972
|
-
|
|
2973
|
-
/**
|
|
2974
|
-
* DescribeFaceIdResults返回参数结构体
|
|
2975
|
-
*/
|
|
2976
|
-
export interface DescribeFaceIdResultsResponse {
|
|
2977
|
-
/**
|
|
2978
|
-
* 核身结果列表
|
|
2979
|
-
*/
|
|
2980
|
-
Results?: Array<FaceIdResult>
|
|
2981
|
-
/**
|
|
2982
|
-
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
2983
|
-
*/
|
|
2984
|
-
RequestId?: string
|
|
2985
|
-
}
|
|
2986
|
-
|
|
2987
|
-
/**
|
|
2988
|
-
* CheckBankCard4EVerification请求参数结构体
|
|
2989
|
-
*/
|
|
2990
|
-
export interface CheckBankCard4EVerificationRequest {
|
|
2991
|
-
/**
|
|
2992
|
-
* 调用方信息; 必选
|
|
2993
|
-
*/
|
|
2994
|
-
Caller: Caller
|
|
2995
|
-
/**
|
|
2996
|
-
* 银行卡号
|
|
2997
|
-
*/
|
|
2998
|
-
BankCard: string
|
|
2999
|
-
/**
|
|
3000
|
-
* 姓名
|
|
3001
|
-
*/
|
|
3002
|
-
Name: string
|
|
3003
|
-
/**
|
|
3004
|
-
* 身份证件号码
|
|
3005
|
-
*/
|
|
3006
|
-
IdCardNumber?: string
|
|
3007
|
-
/**
|
|
3008
|
-
* 手机号
|
|
3009
|
-
*/
|
|
3010
|
-
Mobile?: string
|
|
3011
|
-
/**
|
|
3012
|
-
* 身份证件类型; ID_CARD
|
|
3013
|
-
*/
|
|
3014
|
-
IdCardType?: string
|
|
3015
|
-
}
|
|
3016
|
-
|
|
3017
|
-
/**
|
|
3018
|
-
* GenerateUserSeal返回参数结构体
|
|
3019
|
-
*/
|
|
3020
|
-
export interface GenerateUserSealResponse {
|
|
3021
|
-
/**
|
|
3022
|
-
* 电子印章Id
|
|
3023
|
-
*/
|
|
3024
|
-
SealId: string
|
|
3025
|
-
/**
|
|
3026
|
-
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
3027
|
-
*/
|
|
3028
|
-
RequestId?: string
|
|
3029
|
-
}
|
|
3030
|
-
|
|
3031
|
-
/**
|
|
3032
|
-
* DescribeCatalogSignComponents返回参数结构体
|
|
3033
|
-
*/
|
|
3034
|
-
export interface DescribeCatalogSignComponentsResponse {
|
|
3035
|
-
/**
|
|
3036
|
-
* 签署区列表
|
|
3037
|
-
*/
|
|
3038
|
-
SignComponents: Array<CatalogComponents>
|
|
3039
|
-
/**
|
|
3040
|
-
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
3041
|
-
*/
|
|
3042
|
-
RequestId?: string
|
|
3043
|
-
}
|
|
3044
|
-
|
|
3045
|
-
/**
|
|
3046
|
-
* GenerateOrganizationSeal请求参数结构体
|
|
3047
|
-
*/
|
|
3048
|
-
export interface GenerateOrganizationSealRequest {
|
|
3049
|
-
/**
|
|
3050
|
-
* 调用方信息
|
|
3051
|
-
*/
|
|
3052
|
-
Caller: Caller
|
|
3053
|
-
/**
|
|
3054
|
-
* 印章类型:
|
|
3055
|
-
OFFICIAL-公章
|
|
3056
|
-
SPECIAL_FINANCIAL-财务专用章
|
|
3057
|
-
CONTRACT-合同专用章
|
|
3058
|
-
LEGAL_REPRESENTATIVE-法定代表人章
|
|
3059
|
-
SPECIAL_NATIONWIDE_INVOICE-发票专用章
|
|
3060
|
-
OTHER-其他
|
|
3061
|
-
*/
|
|
3062
|
-
SealType: string
|
|
3063
|
-
/**
|
|
3064
|
-
* 请求生成企业印章的客户端Ip
|
|
3065
|
-
*/
|
|
3066
|
-
SourceIp: string
|
|
3067
|
-
/**
|
|
3068
|
-
* 电子印章名称
|
|
3069
|
-
*/
|
|
3070
|
-
SealName?: string
|
|
3071
|
-
/**
|
|
3072
|
-
* 企业印章横向文字,最多可填8个汉字(可不填,默认为"电子签名专用章")
|
|
3073
|
-
*/
|
|
3074
|
-
SealHorizontalText?: string
|
|
3075
|
-
/**
|
|
3076
|
-
* 是否是默认印章 true:是,false:否
|
|
3077
|
-
*/
|
|
3078
|
-
IsDefault?: boolean
|
|
3079
|
-
}
|
|
3080
|
-
|
|
3081
|
-
/**
|
|
3082
|
-
* CreateServerFlowSign请求参数结构体
|
|
3083
|
-
*/
|
|
3084
|
-
export interface CreateServerFlowSignRequest {
|
|
3085
|
-
/**
|
|
3086
|
-
* 调用方信息
|
|
3087
|
-
*/
|
|
3088
|
-
Caller: Caller
|
|
3089
|
-
/**
|
|
3090
|
-
* 流程ID
|
|
3091
|
-
*/
|
|
3092
|
-
FlowId: string
|
|
3093
|
-
/**
|
|
3094
|
-
* 签署区域信息
|
|
3095
|
-
*/
|
|
3096
|
-
SignComponents: Array<Component>
|
|
3097
|
-
/**
|
|
3098
|
-
* 客户端IP
|
|
3099
|
-
*/
|
|
3100
|
-
SourceIp: string
|
|
3101
|
-
}
|
|
3102
|
-
|
|
3103
|
-
/**
|
|
3104
|
-
* 此结构体 (Caller) 用于描述调用方属性。
|
|
3105
|
-
*/
|
|
3106
|
-
export interface Caller {
|
|
3107
|
-
/**
|
|
3108
|
-
* 应用号
|
|
3109
|
-
*/
|
|
3110
|
-
ApplicationId: string
|
|
3111
|
-
/**
|
|
3112
|
-
* 下属机构ID
|
|
3113
|
-
*/
|
|
3114
|
-
SubOrganizationId?: string
|
|
3115
|
-
/**
|
|
3116
|
-
* 经办人的用户ID
|
|
3117
|
-
*/
|
|
3118
|
-
OperatorId?: string
|
|
3119
|
-
}
|
|
3120
|
-
|
|
3121
|
-
/**
|
|
3122
|
-
* VerifyUser返回参数结构体
|
|
3123
|
-
*/
|
|
3124
|
-
export interface VerifyUserResponse {
|
|
3125
|
-
/**
|
|
3126
|
-
* 电子签平台用户ID
|
|
3127
|
-
*/
|
|
3128
|
-
UserId?: string
|
|
3129
|
-
/**
|
|
3130
|
-
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
3131
|
-
*/
|
|
3132
|
-
RequestId?: string
|
|
3133
|
-
}
|
|
3134
|
-
|
|
3135
|
-
/**
|
|
3136
|
-
* SendFlow请求参数结构体
|
|
3137
|
-
*/
|
|
3138
|
-
export interface SendFlowRequest {
|
|
3139
|
-
/**
|
|
3140
|
-
* 调用方信息
|
|
3141
|
-
*/
|
|
3142
|
-
Caller: Caller
|
|
3143
|
-
/**
|
|
3144
|
-
* 需要推送合同的流程ID
|
|
3145
|
-
*/
|
|
3146
|
-
FlowId: string
|
|
3147
|
-
/**
|
|
3148
|
-
* 签署人用户ID
|
|
3149
|
-
*/
|
|
3150
|
-
UserId: string
|
|
3151
|
-
/**
|
|
3152
|
-
* 签署控件信息 (支持添加多个控件)
|
|
3153
|
-
*/
|
|
3154
|
-
SignComponents: Array<Component>
|
|
3155
|
-
/**
|
|
3156
|
-
* 签署人手机号 (如果选择短信验证码签署,则此字段必填)
|
|
3157
|
-
*/
|
|
3158
|
-
Mobile?: string
|
|
3159
|
-
/**
|
|
3160
|
-
* 签署人对应的子机构ID,个人签署者此字段不填
|
|
3161
|
-
*/
|
|
3162
|
-
SubOrganizationId?: string
|
|
3163
|
-
/**
|
|
3164
|
-
* 签名后校验方式:
|
|
3165
|
-
1. WEIXINAPP - 微信小程序;
|
|
3166
|
-
2. FACEID - 慧眼 (默认) ;
|
|
3167
|
-
3. VERIFYCODE - 验证码;
|
|
3168
|
-
4. NONE - 无。此选项为白名单参数,暂不支持公开调用。如需开通权限,请通过客户经理或邮件至e-contract@tencent.com与我们联系;
|
|
3169
|
-
5. THIRD - 第三方 (暂不支持)
|
|
3170
|
-
*/
|
|
3171
|
-
VerifyChannel?: Array<string>
|
|
3172
|
-
/**
|
|
3173
|
-
* 签署链接失效截止时间,默认为7天
|
|
3174
|
-
*/
|
|
3175
|
-
Deadline?: number
|
|
3176
|
-
/**
|
|
3177
|
-
* 是否为最后一个签署人。若为最后一人,本次签署完成以后自动归档。
|
|
3178
|
-
*/
|
|
3179
|
-
IsLastApprover?: boolean
|
|
3180
|
-
/**
|
|
3181
|
-
* 签署完成后,前端跳转的URL
|
|
3182
|
-
*/
|
|
3183
|
-
JumpUrl?: string
|
|
3184
|
-
/**
|
|
3185
|
-
* 短信模板。默认使用腾讯电子签官方短信模板,如有自定义需求,请通过客户经理或邮件至e-contract@tencent.com与我们联系。
|
|
3186
|
-
*/
|
|
3187
|
-
SmsTemplate?: SmsTemplate
|
|
3188
|
-
/**
|
|
3189
|
-
* 签署前置条件:是否要全文阅读,默认否
|
|
3190
|
-
*/
|
|
3191
|
-
IsFullText?: boolean
|
|
3192
|
-
/**
|
|
3193
|
-
* 签署前置条件:强制用户阅读待签署文件时长,默认不限制
|
|
3194
|
-
*/
|
|
3195
|
-
PreReadTime?: number
|
|
3196
|
-
/**
|
|
3197
|
-
* 当前参与者是否支持线下核身,默认为不支持
|
|
3198
|
-
*/
|
|
3199
|
-
CanOffLine?: boolean
|
|
3200
|
-
/**
|
|
3201
|
-
* 签署任务的回调地址
|
|
3202
|
-
*/
|
|
3203
|
-
CallbackUrl?: string
|
|
3204
|
-
}
|
|
3205
|
-
|
|
3206
|
-
/**
|
|
3207
|
-
* SendSignInnerVerifyCode请求参数结构体
|
|
3208
|
-
*/
|
|
3209
|
-
export interface SendSignInnerVerifyCodeRequest {
|
|
3210
|
-
/**
|
|
3211
|
-
* 调用方信息
|
|
3212
|
-
*/
|
|
3213
|
-
Caller: Caller
|
|
3214
|
-
/**
|
|
3215
|
-
* 手机号
|
|
3216
|
-
*/
|
|
3217
|
-
Mobile: string
|
|
3218
|
-
/**
|
|
3219
|
-
* 验证码类型,取值(SIGN)
|
|
3220
|
-
*/
|
|
3221
|
-
VerifyType: string
|
|
3222
|
-
/**
|
|
3223
|
-
* 用户 id
|
|
3224
|
-
*/
|
|
3225
|
-
UserId?: string
|
|
3226
|
-
/**
|
|
3227
|
-
* 模板 id
|
|
3228
|
-
*/
|
|
3229
|
-
VerifyTemplateId?: string
|
|
3230
|
-
/**
|
|
3231
|
-
* 签名
|
|
3232
|
-
*/
|
|
3233
|
-
VerifySign?: string
|
|
3234
|
-
/**
|
|
3235
|
-
* 流程(目录) id
|
|
3236
|
-
*/
|
|
3237
|
-
FlowId?: string
|
|
3238
|
-
/**
|
|
3239
|
-
* 三要素检测结果
|
|
3240
|
-
*/
|
|
3241
|
-
CheckThreeElementResult?: number
|
|
3242
|
-
}
|
|
3243
|
-
|
|
3244
|
-
/**
|
|
3245
|
-
* DestroyFlowFile返回参数结构体
|
|
3246
|
-
*/
|
|
3247
|
-
export interface DestroyFlowFileResponse {
|
|
3248
|
-
/**
|
|
3249
|
-
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
3250
|
-
*/
|
|
3251
|
-
RequestId?: string
|
|
3252
|
-
}
|
|
3253
|
-
|
|
3254
|
-
/**
|
|
3255
|
-
* CreateSubOrganization返回参数结构体
|
|
3256
|
-
*/
|
|
3257
|
-
export interface CreateSubOrganizationResponse {
|
|
3258
|
-
/**
|
|
3259
|
-
* 子机构ID
|
|
3260
|
-
*/
|
|
3261
|
-
SubOrganizationId: string
|
|
3262
|
-
/**
|
|
3263
|
-
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
3264
|
-
*/
|
|
3265
|
-
RequestId?: string
|
|
3266
|
-
}
|
|
3267
|
-
|
|
3268
|
-
/**
|
|
3269
|
-
* CreateSubOrganizationAndSeal返回参数结构体
|
|
3270
|
-
*/
|
|
3271
|
-
export interface CreateSubOrganizationAndSealResponse {
|
|
3272
|
-
/**
|
|
3273
|
-
* 子机构在电子文件签署平台唯一标识
|
|
3274
|
-
*/
|
|
3275
|
-
SubOrganizationId: string
|
|
3276
|
-
/**
|
|
3277
|
-
* 电子印章ID
|
|
3278
|
-
*/
|
|
3279
|
-
SealId: string
|
|
3280
|
-
/**
|
|
3281
|
-
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
3282
|
-
*/
|
|
3283
|
-
RequestId?: string
|
|
3284
|
-
}
|
|
3285
|
-
|
|
3286
|
-
/**
|
|
3287
|
-
* ModifyUser请求参数结构体
|
|
3288
|
-
*/
|
|
3289
|
-
export interface ModifyUserRequest {
|
|
3290
|
-
/**
|
|
3291
|
-
* 调用方信息
|
|
3292
|
-
*/
|
|
3293
|
-
Caller: Caller
|
|
3294
|
-
/**
|
|
3295
|
-
* 第三方平台用户唯一标识; OpenId 和 UserId 二选一填写, 两个都不为空则优先使用UserId
|
|
3296
|
-
*/
|
|
3297
|
-
OpenId?: string
|
|
3298
|
-
/**
|
|
3299
|
-
* 腾讯电子签平台用户唯一标识; OpenId 和 UserId 二选一填写, 两个都不为空则优先使用UserId
|
|
3300
|
-
*/
|
|
3301
|
-
UserId?: string
|
|
3302
|
-
/**
|
|
3303
|
-
* 用户手机号码,不要求唯一
|
|
3304
|
-
*/
|
|
3305
|
-
Mobile?: string
|
|
3306
|
-
/**
|
|
3307
|
-
* 用户邮箱,不要求唯一
|
|
3308
|
-
*/
|
|
3309
|
-
Email?: string
|
|
3310
|
-
/**
|
|
3311
|
-
* 用户姓名
|
|
3312
|
-
*/
|
|
3313
|
-
Name?: string
|
|
3314
|
-
}
|
|
3315
|
-
|
|
3316
|
-
/**
|
|
3317
|
-
* CheckMobileAndName返回参数结构体
|
|
3318
|
-
*/
|
|
3319
|
-
export interface CheckMobileAndNameResponse {
|
|
3320
|
-
/**
|
|
3321
|
-
* 检测结果
|
|
3322
|
-
计费结果码:
|
|
3323
|
-
0: 验证结果一致
|
|
3324
|
-
1: 手机号未实名
|
|
3325
|
-
2: 姓名和手机号不一致
|
|
3326
|
-
3: 信息不一致(手机号已实名,但姓名和身份证号与实名信息不一致)
|
|
3327
|
-
不收费结果码:
|
|
3328
|
-
101: 查无记录
|
|
3329
|
-
102: 非法姓名(长度,格式等不正确)
|
|
3330
|
-
103: 非法手机号(长度,格式等不正确)
|
|
3331
|
-
104: 非法身份证号(长度,校验位等不正确)
|
|
3332
|
-
105: 认证未通过
|
|
3333
|
-
106: 验证平台异常
|
|
3334
|
-
*/
|
|
3335
|
-
Result?: number
|
|
3336
|
-
/**
|
|
3337
|
-
* 结果描述; 未通过时必选
|
|
3338
|
-
*/
|
|
3339
|
-
Description?: string
|
|
3340
|
-
/**
|
|
3341
|
-
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
3342
|
-
*/
|
|
3343
|
-
RequestId?: string
|
|
3344
|
-
}
|
|
3345
|
-
|
|
3346
|
-
/**
|
|
3347
|
-
* ModifySeal返回参数结构体
|
|
3348
|
-
*/
|
|
3349
|
-
export interface ModifySealResponse {
|
|
3350
|
-
/**
|
|
3351
|
-
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
3352
|
-
*/
|
|
3353
|
-
RequestId?: string
|
|
3354
|
-
}
|