tencentcloud-sdk-nodejs 4.0.201 → 4.0.205

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