tencentcloud-sdk-nodejs 4.0.781 → 4.0.783
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +345 -0
- package/SERVICE_CHANGELOG.md +473 -6
- package/package.json +1 -1
- package/products.md +20 -20
- package/src/common/sdk_version.ts +1 -1
- package/src/services/cdn/v20180606/cdn_client.ts +1 -1
- package/src/services/cdn/v20180606/cdn_models.ts +1 -1
- package/src/services/dasb/v20191018/dasb_models.ts +4 -0
- package/src/services/dbbrain/v20210527/dbbrain_models.ts +15 -2
- package/src/services/eb/v20210416/eb_client.ts +2 -2
- package/src/services/eb/v20210416/eb_models.ts +4 -4
- package/src/services/ess/v20201111/ess_client.ts +65 -10
- package/src/services/ess/v20201111/ess_models.ts +68 -12
- package/src/services/essbasic/v20210526/essbasic_client.ts +5 -6
- package/src/services/essbasic/v20210526/essbasic_models.ts +53 -9
- package/src/services/monitor/v20180724/monitor_models.ts +22 -3
- package/src/services/ocr/v20181119/ocr_client.ts +21 -9
- package/src/services/ocr/v20181119/ocr_models.ts +71 -0
- package/src/services/organization/v20210331/organization_client.ts +216 -77
- package/src/services/organization/v20210331/organization_models.ts +1351 -830
- package/src/services/sqlserver/v20180328/sqlserver_models.ts +3 -3
- package/src/services/sts/v20180813/sts_models.ts +3 -4
- package/src/services/vpc/v20170312/vpc_models.ts +4 -0
- package/src/services/wedata/v20210820/wedata_client.ts +0 -14
- package/src/services/wedata/v20210820/wedata_models.ts +74 -35
- package/src/services/weilingwith/v20230427/weilingwith_models.ts +4 -0
- package/tencentcloud/common/sdk_version.d.ts +1 -1
- package/tencentcloud/common/sdk_version.js +1 -1
- package/tencentcloud/services/cdn/v20180606/cdn_client.d.ts +1 -1
- package/tencentcloud/services/cdn/v20180606/cdn_client.js +1 -1
- package/tencentcloud/services/cdn/v20180606/cdn_models.d.ts +1 -1
- package/tencentcloud/services/dasb/v20191018/dasb_models.d.ts +4 -0
- package/tencentcloud/services/dbbrain/v20210527/dbbrain_models.d.ts +15 -2
- package/tencentcloud/services/eb/v20210416/eb_client.d.ts +2 -2
- package/tencentcloud/services/eb/v20210416/eb_client.js +2 -2
- package/tencentcloud/services/eb/v20210416/eb_models.d.ts +4 -4
- package/tencentcloud/services/ess/v20201111/ess_client.d.ts +64 -9
- package/tencentcloud/services/ess/v20201111/ess_client.js +64 -9
- package/tencentcloud/services/ess/v20201111/ess_models.d.ts +68 -12
- package/tencentcloud/services/essbasic/v20210526/essbasic_client.d.ts +5 -6
- package/tencentcloud/services/essbasic/v20210526/essbasic_client.js +5 -6
- package/tencentcloud/services/essbasic/v20210526/essbasic_models.d.ts +53 -9
- package/tencentcloud/services/monitor/v20180724/monitor_models.d.ts +22 -3
- package/tencentcloud/services/ocr/v20181119/ocr_client.d.ts +9 -5
- package/tencentcloud/services/ocr/v20181119/ocr_client.js +11 -5
- package/tencentcloud/services/ocr/v20181119/ocr_models.d.ts +69 -0
- package/tencentcloud/services/organization/v20210331/organization_client.d.ts +51 -7
- package/tencentcloud/services/organization/v20210331/organization_client.js +75 -9
- package/tencentcloud/services/organization/v20210331/organization_models.d.ts +1326 -834
- package/tencentcloud/services/sqlserver/v20180328/sqlserver_models.d.ts +3 -3
- package/tencentcloud/services/sts/v20180813/sts_models.d.ts +3 -4
- package/tencentcloud/services/vpc/v20170312/vpc_models.d.ts +4 -0
- package/tencentcloud/services/wedata/v20210820/wedata_client.d.ts +1 -7
- package/tencentcloud/services/wedata/v20210820/wedata_client.js +0 -8
- package/tencentcloud/services/wedata/v20210820/wedata_models.d.ts +74 -33
- package/tencentcloud/services/weilingwith/v20230427/weilingwith_models.d.ts +4 -0
- package/test/ocr.v20181119.test.js +12 -2
- package/test/organization.v20210331.test.js +116 -6
- package/test/wedata.v20210820.test.js +0 -10
|
@@ -609,15 +609,14 @@ httpProfile.setEndpoint("file.test.ess.tencent.cn");
|
|
|
609
609
|
return this.request("DescribeIntegrationEmployees", req, cb);
|
|
610
610
|
}
|
|
611
611
|
/**
|
|
612
|
-
*
|
|
612
|
+
* 该接口用于发起合同后,生成用户的签署链接 <br/>
|
|
613
613
|
|
|
614
614
|
**注意**
|
|
615
|
-
1.
|
|
616
|
-
2.
|
|
617
|
-
3.
|
|
618
|
-
4. 该接口返回的签署链接适用于APP集成的场景,支持APP打开或浏览器直接打开,**不支持微信小程序嵌入**。
|
|
615
|
+
1. 该接口可生成签署链接的签署人必须仅有手写签名、时间类型和印章类型的签署控件,**不支持填写控件** 。
|
|
616
|
+
2. 该签署**链接有效期为30分钟**,过期后将失效,如需签署可重新创建签署链接 。
|
|
617
|
+
3. 该接口返回的签署链接适用于APP集成的场景,支持APP打开或浏览器直接打开,**不支持微信小程序嵌入**。
|
|
619
618
|
跳转到小程序的实现,参考微信官方文档(分为<a href="https://developers.weixin.qq.com/miniprogram/dev/api/navigate/wx.navigateToMiniProgram.html">全屏</a>、<a href="https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/openEmbeddedMiniProgram.html">半屏</a>两种方式),如何配置也可以请参考: <a href="https://qian.tencent.com/developers/company/openwxminiprogram">跳转电子签小程序配置</a>。
|
|
620
|
-
|
|
619
|
+
4. 因h5涉及人脸身份认证能力基于慧眼人脸核身,对Android和iOS系统均有一定要求, 因此<font color='red'>App嵌入H5签署合同需要按照慧眼提供的<a href="https://cloud.tencent.com/document/product/1007/61076">慧眼人脸核身兼容性文档</a>做兼容性适配</font>。
|
|
621
620
|
*/
|
|
622
621
|
async CreateFlowSignUrl(req, cb) {
|
|
623
622
|
return this.request("CreateFlowSignUrl", req, cb);
|
|
@@ -893,14 +892,70 @@ httpProfile.setEndpoint("file.test.ess.tencent.cn");
|
|
|
893
892
|
return this.request("DeleteExtendedServiceAuthInfos", req, cb);
|
|
894
893
|
}
|
|
895
894
|
/**
|
|
896
|
-
* 此接口(CreateIntegrationEmployees
|
|
895
|
+
* 此接口(CreateIntegrationEmployees)用于创建企业员工。
|
|
896
|
+
支持以下场景
|
|
897
|
+
<table>
|
|
898
|
+
<tbody>
|
|
899
|
+
<tr>
|
|
900
|
+
<td>生成端</td>
|
|
901
|
+
<td >入参</td>
|
|
902
|
+
<td>提醒方式</td>
|
|
903
|
+
</tr>
|
|
904
|
+
<tr>
|
|
905
|
+
<td>普通saas员工</td>
|
|
906
|
+
<td>不需要传递 InvitationNotifyType</td>
|
|
907
|
+
<td>短信</td>
|
|
908
|
+
</tr>
|
|
909
|
+
<tr>
|
|
910
|
+
<td>企微员工</td>
|
|
911
|
+
<td>不需要传递 InvitationNotifyType,将Employees 中的WeworkOpenId字段设置为企微员工明文的openid,但需确保该企微员工在应用的可见范围内</td>
|
|
912
|
+
<td>企微内部实名消息</td>
|
|
913
|
+
</tr>
|
|
914
|
+
<tr>
|
|
915
|
+
<td>H5端 saas员工</td>
|
|
916
|
+
<td>传递 InvitationNotifyType = H5,不支持企微</td>
|
|
917
|
+
<td>生成H5链接</td>
|
|
918
|
+
</tr>
|
|
919
|
+
</tbody>
|
|
920
|
+
</table>
|
|
921
|
+
注意:
|
|
922
|
+
|
|
923
|
+
- <b>若通过手机号发现员工已经创建,则不会重复创建,但会发送短信或者生成链接提醒员工实名。</b>
|
|
924
|
+
- jumpUrl 仅支持H5的邀请方式,回跳的url,使用前请联系对接的客户经理沟通,进行域名的配置。
|
|
897
925
|
*/
|
|
898
926
|
async CreateIntegrationEmployees(req, cb) {
|
|
899
927
|
return this.request("CreateIntegrationEmployees", req, cb);
|
|
900
928
|
}
|
|
901
929
|
/**
|
|
902
|
-
*
|
|
903
|
-
|
|
930
|
+
* 此接口(UpdateIntegrationEmployees)用于修改未实名企业员工信息(姓名,手机号,邮件、部门)。
|
|
931
|
+
修改手机号的时候,支持以下场景进行提醒通知
|
|
932
|
+
<table>
|
|
933
|
+
<tbody>
|
|
934
|
+
<tr>
|
|
935
|
+
<td>生成端</td>
|
|
936
|
+
<td>入参</td>
|
|
937
|
+
<td>提醒方式</td>
|
|
938
|
+
</tr>
|
|
939
|
+
<tr>
|
|
940
|
+
<td>普通saas员工</td>
|
|
941
|
+
<td>不需要传递 InvitationNotifyType</td>
|
|
942
|
+
<td>短信</td>
|
|
943
|
+
</tr>
|
|
944
|
+
<tr>
|
|
945
|
+
<td>企微员工</td>
|
|
946
|
+
<td>不需要传递 InvitationNotifyType,将Employees 中的WeworkOpenId字段设置为企微员工明文的openid,但需确保该企微员工在应用的可见范围内</td>
|
|
947
|
+
<td>企微内部实名消息</td>
|
|
948
|
+
</tr>
|
|
949
|
+
<tr>
|
|
950
|
+
<td>H5端 saas员工</td>
|
|
951
|
+
<td>传递 InvitationNotifyType = H5,不支持企微</td>
|
|
952
|
+
<td>生成H5链接</td>
|
|
953
|
+
</tr>
|
|
954
|
+
</tbody>
|
|
955
|
+
</table>
|
|
956
|
+
注意:
|
|
957
|
+
|
|
958
|
+
- jumpUrl 仅支持H5的邀请方式,回跳的url,使用前请联系对接的客户经理沟通,进行域名的配置。
|
|
904
959
|
*/
|
|
905
960
|
async UpdateIntegrationEmployees(req, cb) {
|
|
906
961
|
return this.request("UpdateIntegrationEmployees", req, cb);
|
|
@@ -755,6 +755,19 @@ export interface CreateIntegrationEmployeesRequest {
|
|
|
755
755
|
在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
|
|
756
756
|
*/
|
|
757
757
|
Agent?: Agent;
|
|
758
|
+
/**
|
|
759
|
+
* 员工邀请方式
|
|
760
|
+
如果是来自H5的,参数需要传递H5
|
|
761
|
+
短信或者企微 请传递SMS,或者不传递
|
|
762
|
+
*/
|
|
763
|
+
InvitationNotifyType?: string;
|
|
764
|
+
/**
|
|
765
|
+
* 回跳地址,
|
|
766
|
+
在认证成功之后,进行回跳,请保证回跳地址的可用性。
|
|
767
|
+
使用前请联系对接的客户经理沟通,提供回跳地址的域名,进行域名配置
|
|
768
|
+
|
|
769
|
+
*/
|
|
770
|
+
JumpUrl?: string;
|
|
758
771
|
}
|
|
759
772
|
/**
|
|
760
773
|
* 创建合同个性化参数
|
|
@@ -4545,14 +4558,6 @@ export interface CreateFlowSignUrlRequest {
|
|
|
4545
4558
|
可登录腾讯电子签控制台,在 "合同"->"合同中心" 中查看某个合同的FlowId(在页面中展示为合同ID)。
|
|
4546
4559
|
*/
|
|
4547
4560
|
FlowId: string;
|
|
4548
|
-
/**
|
|
4549
|
-
* 流程签署人列表,其中结构体的ApproverName,ApproverMobile和ApproverType必传,其他可不传,
|
|
4550
|
-
|
|
4551
|
-
注:
|
|
4552
|
-
`1. ApproverType目前只支持个人类型的签署人。`
|
|
4553
|
-
`2. 签署人只能有手写签名和时间类型的签署控件,其他类型的填写控件和签署控件暂时都未支持。`
|
|
4554
|
-
*/
|
|
4555
|
-
FlowApproverInfos: Array<FlowCreateApprover>;
|
|
4556
4561
|
/**
|
|
4557
4562
|
* 执行本接口操作的员工信息。
|
|
4558
4563
|
注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
|
|
@@ -4563,6 +4568,14 @@ export interface CreateFlowSignUrlRequest {
|
|
|
4563
4568
|
在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
|
|
4564
4569
|
*/
|
|
4565
4570
|
Agent?: Agent;
|
|
4571
|
+
/**
|
|
4572
|
+
* 流程签署人列表,其中结构体的ApproverName,ApproverMobile和ApproverType必传,企业签署人则需传OrganizationName,其他可不传。
|
|
4573
|
+
|
|
4574
|
+
注:
|
|
4575
|
+
`1. 签署人只能有手写签名、时间类型和印章类型的签署控件,其他类型的填写控件和签署控件暂时都未支持。`
|
|
4576
|
+
`2. 生成发起方预览链接时,该字段(FlowApproverInfos)传空或者不传`
|
|
4577
|
+
*/
|
|
4578
|
+
FlowApproverInfos?: Array<FlowCreateApprover>;
|
|
4566
4579
|
/**
|
|
4567
4580
|
* 机构信息,暂未开放
|
|
4568
4581
|
* @deprecated
|
|
@@ -4572,6 +4585,15 @@ export interface CreateFlowSignUrlRequest {
|
|
|
4572
4585
|
* 签署完之后的H5页面的跳转链接,此链接及支持http://和https://,最大长度1000个字符。(建议https协议)
|
|
4573
4586
|
*/
|
|
4574
4587
|
JumpUrl?: string;
|
|
4588
|
+
/**
|
|
4589
|
+
* 链接类型,支持指定以下类型
|
|
4590
|
+
<ul><li>0 : 签署链接 (默认值)</li>
|
|
4591
|
+
<li>1 : 预览链接</li></ul>
|
|
4592
|
+
注:
|
|
4593
|
+
`1. 当指定链接类型为1时,链接为预览链接,打开链接无法签署仅支持预览以及查看当前合同状态。`
|
|
4594
|
+
`2. 如需生成发起方预览链接,则签署方信息传空,即FlowApproverInfos传空或者不传。`
|
|
4595
|
+
*/
|
|
4596
|
+
UrlType?: number;
|
|
4575
4597
|
}
|
|
4576
4598
|
/**
|
|
4577
4599
|
* CreateReleaseFlow请求参数结构体
|
|
@@ -4689,7 +4711,9 @@ export interface FlowDetailInfo {
|
|
|
4689
4711
|
Creator?: string;
|
|
4690
4712
|
}
|
|
4691
4713
|
/**
|
|
4692
|
-
*
|
|
4714
|
+
* 更新员工信息成功返回的数据信息, 仅支持未实名的用户进行更新
|
|
4715
|
+
会通过短信、企微消息或者H5Url 链接
|
|
4716
|
+
如果是通过H5邀请加入的方式,会返回H5 链接
|
|
4693
4717
|
*/
|
|
4694
4718
|
export interface SuccessUpdateStaffData {
|
|
4695
4719
|
/**
|
|
@@ -4705,6 +4729,12 @@ export interface SuccessUpdateStaffData {
|
|
|
4705
4729
|
可登录腾讯电子签控制台,在 "更多能力"->"组织管理" 中查看某位员工的UserId(在页面中展示为用户ID)。
|
|
4706
4730
|
*/
|
|
4707
4731
|
UserId?: string;
|
|
4732
|
+
/**
|
|
4733
|
+
* H5端员工实名链接
|
|
4734
|
+
|
|
4735
|
+
只有入参 InvitationNotifyType = H5的时候才会进行返回。
|
|
4736
|
+
*/
|
|
4737
|
+
Url?: string;
|
|
4708
4738
|
}
|
|
4709
4739
|
/**
|
|
4710
4740
|
* CreatePersonAuthCertificateImage请求参数结构体
|
|
@@ -4794,7 +4824,8 @@ export interface UploadFilesResponse {
|
|
|
4794
4824
|
RequestId?: string;
|
|
4795
4825
|
}
|
|
4796
4826
|
/**
|
|
4797
|
-
*
|
|
4827
|
+
* 创建员工成功返回的信息
|
|
4828
|
+
支持saas/企微/H5端进行加入。
|
|
4798
4829
|
*/
|
|
4799
4830
|
export interface SuccessCreateStaffData {
|
|
4800
4831
|
/**
|
|
@@ -4818,6 +4849,12 @@ export interface SuccessCreateStaffData {
|
|
|
4818
4849
|
* 传入的企微账号id
|
|
4819
4850
|
*/
|
|
4820
4851
|
WeworkOpenId?: string;
|
|
4852
|
+
/**
|
|
4853
|
+
* H5端员工加入\实名链接
|
|
4854
|
+
|
|
4855
|
+
只有入参 InvitationNotifyType = H5的时候才会进行返回。
|
|
4856
|
+
*/
|
|
4857
|
+
Url?: string;
|
|
4821
4858
|
}
|
|
4822
4859
|
/**
|
|
4823
4860
|
* 流程中参与方的信息结构
|
|
@@ -6001,8 +6038,9 @@ export interface Component {
|
|
|
6001
6038
|
<li> <b>DATE</b> : 日期控件;默认是格式化为xxxx年xx月xx日字符串;</li>
|
|
6002
6039
|
<li> <b>DISTRICT</b> : 省市区行政区控件,ComponentValue填写省市区行政区字符串内容;</li></ul>
|
|
6003
6040
|
|
|
6004
|
-
**如果是SignComponent
|
|
6005
|
-
|
|
6041
|
+
**如果是SignComponent签署控件类型,
|
|
6042
|
+
需要根据签署人的类型可选的字段为**
|
|
6043
|
+
* 企业方
|
|
6006
6044
|
<ul><li> <b>SIGN_SEAL</b> : 签署印章控件;</li>
|
|
6007
6045
|
<li> <b>SIGN_DATE</b> : 签署日期控件;</li>
|
|
6008
6046
|
<li> <b>SIGN_SIGNATURE</b> : 用户签名控件;</li>
|
|
@@ -6010,6 +6048,12 @@ export interface Component {
|
|
|
6010
6048
|
<li> <b>SIGN_PAGING_SEAL</b> : 骑缝章;若文件发起,需要对应填充ComponentPosY、ComponentWidth、ComponentHeight</li>
|
|
6011
6049
|
<li> <b>SIGN_OPINION</b> : 签署意见控件,用户需要根据配置的签署意见内容,完成对意见内容的确认;</li>
|
|
6012
6050
|
<li> <b>SIGN_LEGAL_PERSON_SEAL</b> : 企业法定代表人控件。</li></ul>
|
|
6051
|
+
|
|
6052
|
+
* 个人方
|
|
6053
|
+
<ul><li> <b>SIGN_DATE</b> : 签署日期控件;</li>
|
|
6054
|
+
<li> <b>SIGN_SIGNATURE</b> : 用户签名控件;</li>
|
|
6055
|
+
<li> <b>SIGN_PERSONAL_SEAL</b> : 个人签署印章控件(使用文件发起暂不支持此类型);</li></ul>
|
|
6056
|
+
|
|
6013
6057
|
注:` 表单域的控件不能作为印章和签名控件`
|
|
6014
6058
|
*/
|
|
6015
6059
|
ComponentType: string;
|
|
@@ -6436,6 +6480,18 @@ export interface UpdateIntegrationEmployeesRequest {
|
|
|
6436
6480
|
在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
|
|
6437
6481
|
*/
|
|
6438
6482
|
Agent?: Agent;
|
|
6483
|
+
/**
|
|
6484
|
+
* 员工邀请方式
|
|
6485
|
+
如果是来自H5的,参数需要传递H5
|
|
6486
|
+
短信或者企微 请传递SMS,或者不传递
|
|
6487
|
+
*/
|
|
6488
|
+
InvitationNotifyType?: string;
|
|
6489
|
+
/**
|
|
6490
|
+
* 回跳地址,
|
|
6491
|
+
在认证成功之后,进行回跳,请保证回跳地址的可用性。
|
|
6492
|
+
使用前请联系对接的客户经理沟通,提供回跳地址的域名,进行域名配置。
|
|
6493
|
+
*/
|
|
6494
|
+
JumpUrl?: string;
|
|
6439
6495
|
}
|
|
6440
6496
|
/**
|
|
6441
6497
|
* DescribeFlowBriefs请求参数结构体
|
|
@@ -636,15 +636,14 @@ Web链接访问后,会根据子客企业(**Agent中ProxyOrganizationOpenId表
|
|
|
636
636
|
*/
|
|
637
637
|
ChannelCreateWebThemeConfig(req: ChannelCreateWebThemeConfigRequest, cb?: (error: string, rep: ChannelCreateWebThemeConfigResponse) => void): Promise<ChannelCreateWebThemeConfigResponse>;
|
|
638
638
|
/**
|
|
639
|
-
*
|
|
639
|
+
* 该接口用于发起合同后,生成用户的签署链接 <br/>
|
|
640
640
|
|
|
641
641
|
**注意**
|
|
642
|
-
1.
|
|
643
|
-
2.
|
|
644
|
-
3.
|
|
645
|
-
4. 该接口返回的签署链接适用于APP集成的场景,支持APP打开或浏览器直接打开,**不支持微信小程序嵌入**。
|
|
642
|
+
1. 该接口可生成签署链接的签署人必须仅有手写签名、时间类型和印章类型的签署控件,**不支持填写控件** 。
|
|
643
|
+
2. 该签署**链接有效期为30分钟**,过期后将失效,如需签署可重新创建签署链接 。
|
|
644
|
+
3. 该接口返回的签署链接适用于APP集成的场景,支持APP打开或浏览器直接打开,**不支持微信小程序嵌入**。
|
|
646
645
|
跳转到小程序的实现,参考微信官方文档(分为<a href="https://developers.weixin.qq.com/miniprogram/dev/api/navigate/wx.navigateToMiniProgram.html">全屏</a>、<a href="https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/openEmbeddedMiniProgram.html">半屏</a>两种方式),如何配置也可以请参考: <a href="https://qian.tencent.com/developers/company/openwxminiprogram">跳转电子签小程序配置</a>。
|
|
647
|
-
|
|
646
|
+
4. 因h5涉及人脸身份认证能力基于慧眼人脸核身,对Android和iOS系统均有一定要求, 因此<font color='red'>App嵌入H5签署合同需要按照慧眼提供的<a href="https://cloud.tencent.com/document/product/1007/61076">慧眼人脸核身兼容性文档</a>做兼容性适配</font>。
|
|
648
647
|
*/
|
|
649
648
|
ChannelCreateFlowSignUrl(req: ChannelCreateFlowSignUrlRequest, cb?: (error: string, rep: ChannelCreateFlowSignUrlResponse) => void): Promise<ChannelCreateFlowSignUrlResponse>;
|
|
650
649
|
/**
|
|
@@ -736,15 +736,14 @@ Web链接访问后,会根据子客企业(**Agent中ProxyOrganizationOpenId表
|
|
|
736
736
|
return this.request("ChannelCreateWebThemeConfig", req, cb);
|
|
737
737
|
}
|
|
738
738
|
/**
|
|
739
|
-
*
|
|
739
|
+
* 该接口用于发起合同后,生成用户的签署链接 <br/>
|
|
740
740
|
|
|
741
741
|
**注意**
|
|
742
|
-
1.
|
|
743
|
-
2.
|
|
744
|
-
3.
|
|
745
|
-
4. 该接口返回的签署链接适用于APP集成的场景,支持APP打开或浏览器直接打开,**不支持微信小程序嵌入**。
|
|
742
|
+
1. 该接口可生成签署链接的签署人必须仅有手写签名、时间类型和印章类型的签署控件,**不支持填写控件** 。
|
|
743
|
+
2. 该签署**链接有效期为30分钟**,过期后将失效,如需签署可重新创建签署链接 。
|
|
744
|
+
3. 该接口返回的签署链接适用于APP集成的场景,支持APP打开或浏览器直接打开,**不支持微信小程序嵌入**。
|
|
746
745
|
跳转到小程序的实现,参考微信官方文档(分为<a href="https://developers.weixin.qq.com/miniprogram/dev/api/navigate/wx.navigateToMiniProgram.html">全屏</a>、<a href="https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/openEmbeddedMiniProgram.html">半屏</a>两种方式),如何配置也可以请参考: <a href="https://qian.tencent.com/developers/company/openwxminiprogram">跳转电子签小程序配置</a>。
|
|
747
|
-
|
|
746
|
+
4. 因h5涉及人脸身份认证能力基于慧眼人脸核身,对Android和iOS系统均有一定要求, 因此<font color='red'>App嵌入H5签署合同需要按照慧眼提供的<a href="https://cloud.tencent.com/document/product/1007/61076">慧眼人脸核身兼容性文档</a>做兼容性适配</font>。
|
|
748
747
|
*/
|
|
749
748
|
async ChannelCreateFlowSignUrl(req, cb) {
|
|
750
749
|
return this.request("ChannelCreateFlowSignUrl", req, cb);
|
|
@@ -167,8 +167,9 @@ export interface Component {
|
|
|
167
167
|
<li> <b>DATE</b> : 日期控件;默认是格式化为xxxx年xx月xx日字符串;</li>
|
|
168
168
|
<li> <b>DISTRICT</b> : 省市区行政区控件,ComponentValue填写省市区行政区字符串内容;</li></ul>
|
|
169
169
|
|
|
170
|
-
**如果是SignComponent
|
|
171
|
-
|
|
170
|
+
**如果是SignComponent签署控件类型,
|
|
171
|
+
需要根据签署人的类型可选的字段为**
|
|
172
|
+
* 企业方
|
|
172
173
|
<ul><li> <b>SIGN_SEAL</b> : 签署印章控件;</li>
|
|
173
174
|
<li> <b>SIGN_DATE</b> : 签署日期控件;</li>
|
|
174
175
|
<li> <b>SIGN_SIGNATURE</b> : 用户签名控件;</li>
|
|
@@ -176,6 +177,12 @@ export interface Component {
|
|
|
176
177
|
<li> <b>SIGN_PAGING_SEAL</b> : 骑缝章;若文件发起,需要对应填充ComponentPosY、ComponentWidth、ComponentHeight</li>
|
|
177
178
|
<li> <b>SIGN_OPINION</b> : 签署意见控件,用户需要根据配置的签署意见内容,完成对意见内容的确认;</li>
|
|
178
179
|
<li> <b>SIGN_LEGAL_PERSON_SEAL</b> : 企业法定代表人控件。</li></ul>
|
|
180
|
+
|
|
181
|
+
* 个人方
|
|
182
|
+
<ul><li> <b>SIGN_DATE</b> : 签署日期控件;</li>
|
|
183
|
+
<li> <b>SIGN_SIGNATURE</b> : 用户签名控件;</li>
|
|
184
|
+
<li> <b>SIGN_PERSONAL_SEAL</b> : 个人签署印章控件(使用文件发起暂不支持此类型);</li></ul>
|
|
185
|
+
|
|
179
186
|
注:` 表单域的控件不能作为印章和签名控件`
|
|
180
187
|
*/
|
|
181
188
|
ComponentType?: string;
|
|
@@ -1151,7 +1158,8 @@ export interface ReleasedApprover {
|
|
|
1151
1158
|
export interface CreateConsoleLoginUrlResponse {
|
|
1152
1159
|
/**
|
|
1153
1160
|
* 跳转链接, 链接的有效期根据企业,员工状态和终端等有区别, 可以参考下表
|
|
1154
|
-
<table> <thead> <tr> <th>子客企业状态</th> <th>子客企业员工状态</th>
|
|
1161
|
+
<table> <thead> <tr> <th>子客企业状态</th> <th>子客企业员工状态</th>
|
|
1162
|
+
<th>Endpoint</th> <th>链接有效期限</th> </tr> </thead> <tbody> <tr> <td>企业未激活</td> <td>员工未认证</td> <td>PC/PC_SHORT_URL</td> <td>5分钟</td> </tr> <tr> <td>企业未激活</td> <td>员工未认证</td> <td>CHANNEL/APP/H5/SHORT_H5</td> <td>30天</td> </tr> <tr> <td>企业已激活</td> <td>员工未认证</td> <td>PC/PC_SHORT_URL</td> <td>5分钟</td> </tr> <tr> <td>企业已激活</td> <td>员工未认证</td> <td>PC/CHANNEL/APP/H5/SHORT_H5</td> <td>30天</td> </tr> <tr> <td>企业已激活</td> <td>员工已认证</td> <td>PC</td> <td>5分钟</td> </tr> <tr> <td>企业已激活</td> <td>员工已认证</td> <td>CHANNEL/APP/H5/SHORT_H5</td> <td>30天</td> </tr> </tbody> </table>
|
|
1155
1163
|
|
|
1156
1164
|
注:
|
|
1157
1165
|
1. <font color="red">链接仅单次有效</font>,每次登录需要需要重新创建新的链接
|
|
@@ -3151,7 +3159,9 @@ export interface CreateConsoleLoginUrlRequest {
|
|
|
3151
3159
|
<ul><li>**PC**:(默认)<font color="red">web控制台</font>链接, 需要在PC浏览器中打开</li>
|
|
3152
3160
|
<li>**CHANNEL**:H5跳转到电子签小程序链接, 一般用于发送短信中带的链接, 打开后进入腾讯电子签小程序</li>
|
|
3153
3161
|
<li>**SHORT_URL**:<font color="red">H5</font>跳转到电子签小程序链接的短链形式, 一般用于发送短信中带的链接, 打开后进入腾讯电子签小程序</li>
|
|
3154
|
-
<li>**APP**:<font color="red">APP或小程序</font>跳转电子签小程序链接, 一般用于贵方小程序或者APP跳转过来, 打开后进入腾讯电子签小程序</li
|
|
3162
|
+
<li>**APP**:<font color="red">APP或小程序</font>跳转电子签小程序链接, 一般用于贵方小程序或者APP跳转过来, 打开后进入腾讯电子签小程序</li>
|
|
3163
|
+
<li>**H5**:<font color="red">H5长链接</font>跳转H5链接, 一般用于贵方H5跳转过来, 打开后进入腾讯电子签H5页面</li>
|
|
3164
|
+
<li>**SHORT_H5**:<font color="red">H5短链</font>跳转H5的短链形式, 一般用于发送短信中带的链接, 打开后进入腾讯电子签H5页面</li></ul>
|
|
3155
3165
|
*/
|
|
3156
3166
|
Endpoint?: string;
|
|
3157
3167
|
/**
|
|
@@ -3176,6 +3186,16 @@ export interface CreateConsoleLoginUrlRequest {
|
|
|
3176
3186
|
* @deprecated
|
|
3177
3187
|
*/
|
|
3178
3188
|
Operator?: UserInfo;
|
|
3189
|
+
/**
|
|
3190
|
+
* 子客经办人身份证
|
|
3191
|
+
注意:`如果已同步,这里非空会更新同步的经办人身份证号,暂时只支持居民身份证类型`。
|
|
3192
|
+
*/
|
|
3193
|
+
ProxyOperatorIdCardNumber?: string;
|
|
3194
|
+
/**
|
|
3195
|
+
* 认证完成跳转链接
|
|
3196
|
+
注意:`只在H5生效,域名需要联系我们开白`。
|
|
3197
|
+
*/
|
|
3198
|
+
AutoJumpUrl?: string;
|
|
3179
3199
|
}
|
|
3180
3200
|
/**
|
|
3181
3201
|
* 机构信息
|
|
@@ -4496,6 +4516,18 @@ export interface RegistrationOrganizationInfo {
|
|
|
4496
4516
|
`2. 如果当前的企业类型是政府/事业单位, 则只支持上传授权书+对公打款`
|
|
4497
4517
|
*/
|
|
4498
4518
|
AuthorizationTypes?: Array<number | bigint>;
|
|
4519
|
+
/**
|
|
4520
|
+
* 经办人的证件类型,支持以下类型
|
|
4521
|
+
<ul><li>ID_CARD : 居民身份证 (默认值)</li>
|
|
4522
|
+
<li>HONGKONG_AND_MACAO : 港澳居民来往内地通行证</li>
|
|
4523
|
+
<li>HONGKONG_MACAO_AND_TAIWAN : 港澳台居民居住证(格式同居民身份证)</li></ul>
|
|
4524
|
+
|
|
4525
|
+
*/
|
|
4526
|
+
AdminIdCardType?: string;
|
|
4527
|
+
/**
|
|
4528
|
+
* 经办人的证件号
|
|
4529
|
+
*/
|
|
4530
|
+
AdminIdCardNumber?: string;
|
|
4499
4531
|
}
|
|
4500
4532
|
/**
|
|
4501
4533
|
* ChannelCreateMultiFlowSignQRCode请求参数结构体
|
|
@@ -5499,7 +5531,9 @@ export interface CreateBatchOrganizationRegistrationTasksRequest {
|
|
|
5499
5531
|
<ul><li>**PC**:(默认)web控制台链接, 需要在PC浏览器中打开</li>
|
|
5500
5532
|
<li>**CHANNEL**:H5跳转到电子签小程序链接, 一般用于发送短信中带的链接, 打开后进入腾讯电子签小程序</li>
|
|
5501
5533
|
<li>**SHORT_URL**:H5跳转到电子签小程序链接的短链形式, 一般用于发送短信中带的链接, 打开后进入腾讯电子签小程序</li>
|
|
5502
|
-
<li>**APP**:第三方APP或小程序跳转电子签小程序链接, 一般用于贵方小程序或者APP跳转过来, 打开后进入腾讯电子签小程序</li
|
|
5534
|
+
<li>**APP**:第三方APP或小程序跳转电子签小程序链接, 一般用于贵方小程序或者APP跳转过来, 打开后进入腾讯电子签小程序</li>
|
|
5535
|
+
<li>**H5**:第三方H5跳转到电子签H5长链接, 一般用于贵方H5跳转过来, 打开后进入腾讯电子签H5页面</li>
|
|
5536
|
+
<li>**SHORT_H5**:第三方H5跳转到电子签H5短链接, 一般用于贵方H5跳转过来, 打开后进入腾讯电子签H5页面</li></ul>
|
|
5503
5537
|
示例值:PC
|
|
5504
5538
|
|
|
5505
5539
|
*/
|
|
@@ -7232,12 +7266,13 @@ export interface ChannelCreateFlowSignUrlRequest {
|
|
|
7232
7266
|
*/
|
|
7233
7267
|
FlowId: string;
|
|
7234
7268
|
/**
|
|
7235
|
-
* 流程签署人列表,其中结构体的Name,Mobile和ApproverType
|
|
7269
|
+
* 流程签署人列表,其中结构体的Name,Mobile和ApproverType必传,企业签署人则还需传OrganizationName、OpenId、OrganizationOpenId,其他可不传。
|
|
7270
|
+
|
|
7236
7271
|
注:
|
|
7237
|
-
`1.
|
|
7238
|
-
`2.
|
|
7272
|
+
`1. 签署人只能有手写签名、时间类型和印章类型的签署控件,其他类型的填写控件和签署控件暂时都未支持。`
|
|
7273
|
+
`2. 生成发起方预览链接时,该字段(FlowApproverInfos)传空或者不传`
|
|
7239
7274
|
*/
|
|
7240
|
-
FlowApproverInfos
|
|
7275
|
+
FlowApproverInfos?: Array<FlowApproverInfo>;
|
|
7241
7276
|
/**
|
|
7242
7277
|
* 用户信息,暂未开放
|
|
7243
7278
|
* @deprecated
|
|
@@ -7252,6 +7287,15 @@ export interface ChannelCreateFlowSignUrlRequest {
|
|
|
7252
7287
|
* 签署完之后的H5页面的跳转链接,此链接及支持http://和https://,最大长度1000个字符。(建议https协议)
|
|
7253
7288
|
*/
|
|
7254
7289
|
JumpUrl?: string;
|
|
7290
|
+
/**
|
|
7291
|
+
* 链接类型,支持指定以下类型
|
|
7292
|
+
<ul><li>0 : 签署链接 (默认值)</li>
|
|
7293
|
+
<li>1 : 预览链接</li></ul>
|
|
7294
|
+
注:
|
|
7295
|
+
`1. 当指定链接类型为1时,链接为预览链接,打开链接无法签署仅支持预览以及查看当前合同状态。`
|
|
7296
|
+
`2. 如需生成发起方预览链接,则签署方信息传空,即FlowApproverInfos传空或者不传。`
|
|
7297
|
+
*/
|
|
7298
|
+
UrlType?: number;
|
|
7255
7299
|
}
|
|
7256
7300
|
/**
|
|
7257
7301
|
* DescribeTemplates请求参数结构体
|
|
@@ -3438,15 +3438,30 @@ export interface DataPoint {
|
|
|
3438
3438
|
/**
|
|
3439
3439
|
* 实例对象维度组合
|
|
3440
3440
|
*/
|
|
3441
|
-
Dimensions
|
|
3441
|
+
Dimensions?: Array<Dimension>;
|
|
3442
3442
|
/**
|
|
3443
3443
|
* 时间戳数组,表示那些时间点有数据,缺失的时间戳,没有数据点,可以理解为掉点了
|
|
3444
3444
|
*/
|
|
3445
|
-
Timestamps
|
|
3445
|
+
Timestamps?: Array<number>;
|
|
3446
|
+
/**
|
|
3447
|
+
* 监控值数组,该数组和Timestamps一一对应
|
|
3448
|
+
*/
|
|
3449
|
+
Values?: Array<number>;
|
|
3446
3450
|
/**
|
|
3447
3451
|
* 监控值数组,该数组和Timestamps一一对应
|
|
3452
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
3448
3453
|
*/
|
|
3449
|
-
|
|
3454
|
+
MaxValues?: Array<number>;
|
|
3455
|
+
/**
|
|
3456
|
+
* 监控值数组,该数组和Timestamps一一对应
|
|
3457
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
3458
|
+
*/
|
|
3459
|
+
MinValues?: Array<number>;
|
|
3460
|
+
/**
|
|
3461
|
+
* 监控值数组,该数组和Timestamps一一对应
|
|
3462
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
3463
|
+
*/
|
|
3464
|
+
AvgValues?: Array<number>;
|
|
3450
3465
|
}
|
|
3451
3466
|
/**
|
|
3452
3467
|
* DescribeAlarmPolicies返回参数结构体
|
|
@@ -5534,6 +5549,10 @@ export interface GetMonitorDataRequest {
|
|
|
5534
5549
|
* 结束时间,如2018-09-22T20:51:23+08:00,默认为当前时间。 EndTime不能小于StartTime
|
|
5535
5550
|
*/
|
|
5536
5551
|
EndTime?: string;
|
|
5552
|
+
/**
|
|
5553
|
+
* 返回多种统计方式数据。avg, max, min (1,2,4)可以自由组合
|
|
5554
|
+
*/
|
|
5555
|
+
SpecifyStatistics?: number;
|
|
5537
5556
|
}
|
|
5538
5557
|
/**
|
|
5539
5558
|
* CreateRecordingRule请求参数结构体
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import { AbstractClient } from "../../../common/abstract_client";
|
|
2
2
|
import { ClientConfig } from "../../../common/interface";
|
|
3
|
-
import { RecognizeOnlineTaxiItineraryOCRResponse, BankSlipOCRRequest, BusinessCardOCRResponse, HKIDCardOCRRequest, CarInvoiceOCRRequest, RecognizeTravelCardOCRRequest, TrainTicketOCRRequest, EstateCertOCRResponse, GeneralHandwritingOCRResponse, RecognizePhilippinesDrivingLicenseOCRRequest, MLIDPassportOCRRequest, SmartStructuralOCRV2Request, TextDetectResponse, TollInvoiceOCRResponse, FinanBillSliceOCRResponse, DriverLicenseOCRResponse, WaybillOCRResponse, CreateAIFormTaskRequest, PermitOCRResponse, InvoiceGeneralOCRRequest, RideHailingTransportLicenseOCRRequest, FlightInvoiceOCRRequest, HmtResidentPermitOCRResponse, IDCardOCRResponse, EnterpriseLicenseOCRResponse, RecognizePhilippinesVoteIDOCRRequest, InstitutionOCRResponse, DriverLicenseOCRRequest, RecognizeTableOCRResponse, QrcodeOCRResponse, MainlandPermitOCRRequest, SmartStructuralOCRV2Response, EnterpriseLicenseOCRRequest, BankCardOCRRequest, VehicleRegCertOCRRequest, PropOwnerCertOCRResponse, TrainTicketOCRResponse, RecognizePhilippinesTinIDOCRResponse, ArithmeticOCRResponse, FormulaOCRResponse, SmartStructuralOCRRequest, GeneralHandwritingOCRRequest, BizLicenseOCRRequest, MixedInvoiceDetectResponse, RecognizePhilippinesVoteIDOCRResponse, GeneralAccurateOCRResponse, TaxiInvoiceOCRResponse, RecognizeGeneralInvoiceRequest, GeneralBasicOCRResponse, RecognizeThaiIDCardOCRResponse, RecognizeMedicalInvoiceOCRResponse, MixedInvoiceOCRResponse, ClassifyDetectOCRResponse, VatInvoiceVerifyNewRequest, VehicleLicenseOCRResponse, RecognizePhilippinesSssIDOCRRequest, ClassifyDetectOCRRequest, DutyPaidProofOCRResponse, TollInvoiceOCRRequest, LicensePlateOCRResponse, HKIDCardOCRResponse, PermitOCRRequest, InvoiceGeneralOCRResponse, VatInvoiceVerifyNewResponse, RecognizePhilippinesSssIDOCRResponse, TaxiInvoiceOCRRequest, PropOwnerCertOCRRequest, RecognizeContainerOCRRequest, EduPaperOCRRequest, VatRollInvoiceOCRResponse, VatInvoiceVerifyRequest, EduPaperOCRResponse, RecognizeThaiIDCardOCRRequest, TableOCRRequest, ImageEnhancementResponse, PassportOCRResponse, TextDetectRequest, RecognizeTravelCardOCRResponse, LicensePlateOCRRequest, GeneralBasicOCRRequest, RecognizeIndonesiaIDCardOCRResponse, GeneralEfficientOCRRequest, RecognizePhilippinesUMIDOCRResponse, AdvertiseOCRRequest, RideHailingDriverLicenseOCRResponse, ImageEnhancementRequest, EnglishOCRRequest, VatInvoiceVerifyResponse, SmartStructuralOCRResponse, RecognizeIndonesiaIDCardOCRRequest, GeneralAccurateOCRRequest, OrgCodeCertOCRRequest, FlightInvoiceOCRResponse, InstitutionOCRRequest, RideHailingDriverLicenseOCRRequest, ArithmeticOCRRequest, VerifyOfdVatInvoiceOCRRequest, FinanBillSliceOCRRequest, MLIDPassportOCRResponse, VatRollInvoiceOCRRequest, RecognizeTableAccurateOCRRequest, SealOCRResponse, FinanBillOCRResponse, RecognizeHealthCodeOCRRequest, BankSlipOCRResponse, VinOCRResponse, GetTaskStateResponse, FormulaOCRRequest, PassportOCRRequest, DutyPaidProofOCRRequest, RecognizeHealthCodeOCRResponse, CreateAIFormTaskResponse, MixedInvoiceOCRRequest, ResidenceBookletOCRResponse, CarInvoiceOCRResponse, VehicleRegCertOCRResponse, GeneralFastOCRRequest, ShipInvoiceOCRResponse, RecognizeGeneralInvoiceResponse, GetTaskStateRequest, RecognizeMedicalInvoiceOCRRequest, InsuranceBillOCRResponse, GeneralEfficientOCRResponse, ShipInvoiceOCRRequest, SealOCRRequest, VerifyOfdVatInvoiceOCRResponse, HmtResidentPermitOCRRequest, RecognizeTableAccurateOCRResponse, ResidenceBookletOCRRequest, BusInvoiceOCRResponse, MainlandPermitOCRResponse, MLIDCardOCRRequest, EnglishOCRResponse, BusInvoiceOCRRequest, OrgCodeCertOCRResponse, RideHailingTransportLicenseOCRResponse, RecognizeContainerOCRResponse, InsuranceBillOCRRequest, QrcodeOCRRequest, TableOCRResponse, AdvertiseOCRResponse, VehicleLicenseOCRRequest, RecognizeOnlineTaxiItineraryOCRRequest, IDCardOCRRequest, MixedInvoiceDetectRequest, WaybillOCRRequest, VinOCRRequest, VatInvoiceOCRRequest, RecognizePhilippinesUMIDOCRRequest, MLIDCardOCRResponse, RecognizePhilippinesTinIDOCRRequest, RecognizeTableOCRRequest, EstateCertOCRRequest, BizLicenseOCRResponse, VatInvoiceOCRResponse, QuotaInvoiceOCRRequest, BankCardOCRResponse, BusinessCardOCRRequest, RecognizePhilippinesDrivingLicenseOCRResponse, FinanBillOCRRequest, QuotaInvoiceOCRResponse, GeneralFastOCRResponse } from "./ocr_models";
|
|
3
|
+
import { RecognizeOnlineTaxiItineraryOCRResponse, BankSlipOCRRequest, BusinessCardOCRResponse, HKIDCardOCRRequest, CarInvoiceOCRRequest, RecognizeTravelCardOCRRequest, TrainTicketOCRRequest, EstateCertOCRResponse, GeneralHandwritingOCRResponse, RecognizePhilippinesDrivingLicenseOCRRequest, MLIDPassportOCRRequest, SmartStructuralOCRV2Request, TextDetectResponse, TollInvoiceOCRResponse, FinanBillSliceOCRResponse, DriverLicenseOCRResponse, WaybillOCRResponse, CreateAIFormTaskRequest, PermitOCRResponse, InvoiceGeneralOCRRequest, RideHailingTransportLicenseOCRRequest, FlightInvoiceOCRRequest, HmtResidentPermitOCRResponse, IDCardOCRResponse, EnterpriseLicenseOCRResponse, RecognizePhilippinesVoteIDOCRRequest, InstitutionOCRResponse, DriverLicenseOCRRequest, RecognizeTableOCRResponse, QrcodeOCRResponse, MainlandPermitOCRRequest, SmartStructuralOCRV2Response, EnterpriseLicenseOCRRequest, BankCardOCRRequest, VehicleRegCertOCRRequest, PropOwnerCertOCRResponse, TrainTicketOCRResponse, RecognizePhilippinesTinIDOCRResponse, ArithmeticOCRResponse, FormulaOCRResponse, SmartStructuralOCRRequest, GeneralHandwritingOCRRequest, BizLicenseOCRRequest, MixedInvoiceDetectResponse, RecognizePhilippinesVoteIDOCRResponse, GeneralAccurateOCRResponse, TaxiInvoiceOCRResponse, RecognizeGeneralInvoiceRequest, GeneralBasicOCRResponse, RecognizeThaiIDCardOCRResponse, RecognizeMedicalInvoiceOCRResponse, MixedInvoiceOCRResponse, ClassifyDetectOCRResponse, VatInvoiceVerifyNewRequest, VehicleLicenseOCRResponse, RecognizePhilippinesSssIDOCRRequest, ClassifyDetectOCRRequest, DutyPaidProofOCRResponse, TollInvoiceOCRRequest, LicensePlateOCRResponse, HKIDCardOCRResponse, PermitOCRRequest, InvoiceGeneralOCRResponse, VatInvoiceVerifyNewResponse, RecognizePhilippinesSssIDOCRResponse, TaxiInvoiceOCRRequest, PropOwnerCertOCRRequest, RecognizeContainerOCRRequest, EduPaperOCRRequest, VatRollInvoiceOCRResponse, VatInvoiceVerifyRequest, EduPaperOCRResponse, RecognizeThaiIDCardOCRRequest, TableOCRRequest, ImageEnhancementResponse, PassportOCRResponse, TextDetectRequest, RecognizeTravelCardOCRResponse, LicensePlateOCRRequest, GeneralBasicOCRRequest, RecognizeIndonesiaIDCardOCRResponse, GeneralEfficientOCRRequest, RecognizePhilippinesUMIDOCRResponse, AdvertiseOCRRequest, RideHailingDriverLicenseOCRResponse, ImageEnhancementRequest, EnglishOCRRequest, VatInvoiceVerifyResponse, SmartStructuralOCRResponse, RecognizeIndonesiaIDCardOCRRequest, GeneralAccurateOCRRequest, OrgCodeCertOCRRequest, FlightInvoiceOCRResponse, InstitutionOCRRequest, RideHailingDriverLicenseOCRRequest, ArithmeticOCRRequest, VerifyOfdVatInvoiceOCRRequest, FinanBillSliceOCRRequest, MLIDPassportOCRResponse, VatRollInvoiceOCRRequest, RecognizeTableAccurateOCRRequest, SealOCRResponse, FinanBillOCRResponse, RecognizeHealthCodeOCRRequest, BankSlipOCRResponse, VinOCRResponse, GetTaskStateResponse, FormulaOCRRequest, PassportOCRRequest, DutyPaidProofOCRRequest, RecognizeHealthCodeOCRResponse, CreateAIFormTaskResponse, MixedInvoiceOCRRequest, ResidenceBookletOCRResponse, CarInvoiceOCRResponse, VehicleRegCertOCRResponse, GeneralFastOCRRequest, ShipInvoiceOCRResponse, RecognizeGeneralInvoiceResponse, GetTaskStateRequest, RecognizeMedicalInvoiceOCRRequest, InsuranceBillOCRResponse, GeneralEfficientOCRResponse, ShipInvoiceOCRRequest, SealOCRRequest, VerifyOfdVatInvoiceOCRResponse, HmtResidentPermitOCRRequest, RecognizeTableAccurateOCRResponse, ResidenceBookletOCRRequest, BusInvoiceOCRResponse, MainlandPermitOCRResponse, MLIDCardOCRRequest, EnglishOCRResponse, RecognizeForeignPermanentResidentIdCardResponse, BusInvoiceOCRRequest, OrgCodeCertOCRResponse, RideHailingTransportLicenseOCRResponse, RecognizeContainerOCRResponse, InsuranceBillOCRRequest, QrcodeOCRRequest, TableOCRResponse, AdvertiseOCRResponse, VehicleLicenseOCRRequest, RecognizeOnlineTaxiItineraryOCRRequest, IDCardOCRRequest, MixedInvoiceDetectRequest, WaybillOCRRequest, VinOCRRequest, VatInvoiceOCRRequest, RecognizePhilippinesUMIDOCRRequest, MLIDCardOCRResponse, RecognizePhilippinesTinIDOCRRequest, RecognizeTableOCRRequest, EstateCertOCRRequest, BizLicenseOCRResponse, VatInvoiceOCRResponse, QuotaInvoiceOCRRequest, BankCardOCRResponse, BusinessCardOCRRequest, RecognizePhilippinesDrivingLicenseOCRResponse, FinanBillOCRRequest, QuotaInvoiceOCRResponse, RecognizeForeignPermanentResidentIdCardRequest, GeneralFastOCRResponse } from "./ocr_models";
|
|
4
4
|
/**
|
|
5
5
|
* ocr client
|
|
6
6
|
* @class
|
|
@@ -226,6 +226,12 @@ export declare class Client extends AbstractClient {
|
|
|
226
226
|
默认接口请求频率限制:5次/秒。
|
|
227
227
|
*/
|
|
228
228
|
QuotaInvoiceOCR(req: QuotaInvoiceOCRRequest, cb?: (error: string, rep: QuotaInvoiceOCRResponse) => void): Promise<QuotaInvoiceOCRResponse>;
|
|
229
|
+
/**
|
|
230
|
+
* 本接口支持市面上主流版式电子运单的识别,包括收件人和寄件人的姓名、电话、地址以及运单号等字段。
|
|
231
|
+
|
|
232
|
+
默认接口请求频率限制:10次/秒。
|
|
233
|
+
*/
|
|
234
|
+
WaybillOCR(req: WaybillOCRRequest, cb?: (error: string, rep: WaybillOCRResponse) => void): Promise<WaybillOCRResponse>;
|
|
229
235
|
/**
|
|
230
236
|
* 菲律宾UMID识别
|
|
231
237
|
*/
|
|
@@ -263,11 +269,9 @@ export declare class Client extends AbstractClient {
|
|
|
263
269
|
*/
|
|
264
270
|
GeneralHandwritingOCR(req: GeneralHandwritingOCRRequest, cb?: (error: string, rep: GeneralHandwritingOCRResponse) => void): Promise<GeneralHandwritingOCRResponse>;
|
|
265
271
|
/**
|
|
266
|
-
*
|
|
267
|
-
|
|
268
|
-
默认接口请求频率限制:10次/秒。
|
|
272
|
+
* 外国人永久居留身份证识别
|
|
269
273
|
*/
|
|
270
|
-
|
|
274
|
+
RecognizeForeignPermanentResidentIdCard(req: RecognizeForeignPermanentResidentIdCardRequest, cb?: (error: string, rep: RecognizeForeignPermanentResidentIdCardResponse) => void): Promise<RecognizeForeignPermanentResidentIdCardResponse>;
|
|
271
275
|
/**
|
|
272
276
|
* 本接口支持增值税发票的准确性核验,您可以通过输入增值税发票的关键字段提供所需的验证信息,接口返回真实的票面相关信息,包括发票代码、发票号码、开票日期、金额、消费类型、购方名称、购方税号、销方名称、销方税号等多个常用字段。支持多种发票类型核验,包括增值税专用发票、增值税普通发票(含电子普通发票、卷式发票、通行费发票)、全电发票、机动车销售统一发票、货物运输业增值税专用发票、二手车销售统一发票。
|
|
273
277
|
|
|
@@ -284,6 +284,14 @@ class Client extends abstract_client_1.AbstractClient {
|
|
|
284
284
|
async QuotaInvoiceOCR(req, cb) {
|
|
285
285
|
return this.request("QuotaInvoiceOCR", req, cb);
|
|
286
286
|
}
|
|
287
|
+
/**
|
|
288
|
+
* 本接口支持市面上主流版式电子运单的识别,包括收件人和寄件人的姓名、电话、地址以及运单号等字段。
|
|
289
|
+
|
|
290
|
+
默认接口请求频率限制:10次/秒。
|
|
291
|
+
*/
|
|
292
|
+
async WaybillOCR(req, cb) {
|
|
293
|
+
return this.request("WaybillOCR", req, cb);
|
|
294
|
+
}
|
|
287
295
|
/**
|
|
288
296
|
* 菲律宾UMID识别
|
|
289
297
|
*/
|
|
@@ -333,12 +341,10 @@ class Client extends abstract_client_1.AbstractClient {
|
|
|
333
341
|
return this.request("GeneralHandwritingOCR", req, cb);
|
|
334
342
|
}
|
|
335
343
|
/**
|
|
336
|
-
*
|
|
337
|
-
|
|
338
|
-
默认接口请求频率限制:10次/秒。
|
|
344
|
+
* 外国人永久居留身份证识别
|
|
339
345
|
*/
|
|
340
|
-
async
|
|
341
|
-
return this.request("
|
|
346
|
+
async RecognizeForeignPermanentResidentIdCard(req, cb) {
|
|
347
|
+
return this.request("RecognizeForeignPermanentResidentIdCard", req, cb);
|
|
342
348
|
}
|
|
343
349
|
/**
|
|
344
350
|
* 本接口支持增值税发票的准确性核验,您可以通过输入增值税发票的关键字段提供所需的验证信息,接口返回真实的票面相关信息,包括发票代码、发票号码、开票日期、金额、消费类型、购方名称、购方税号、销方名称、销方税号等多个常用字段。支持多种发票类型核验,包括增值税专用发票、增值税普通发票(含电子普通发票、卷式发票、通行费发票)、全电发票、机动车销售统一发票、货物运输业增值税专用发票、二手车销售统一发票。
|
|
@@ -8455,6 +8455,43 @@ export interface EnglishOCRResponse {
|
|
|
8455
8455
|
*/
|
|
8456
8456
|
RequestId?: string;
|
|
8457
8457
|
}
|
|
8458
|
+
/**
|
|
8459
|
+
* RecognizeForeignPermanentResidentIdCard返回参数结构体
|
|
8460
|
+
*/
|
|
8461
|
+
export interface RecognizeForeignPermanentResidentIdCardResponse {
|
|
8462
|
+
/**
|
|
8463
|
+
* 中文姓名。
|
|
8464
|
+
*/
|
|
8465
|
+
CnName?: string;
|
|
8466
|
+
/**
|
|
8467
|
+
* 英文名。
|
|
8468
|
+
*/
|
|
8469
|
+
EnName?: string;
|
|
8470
|
+
/**
|
|
8471
|
+
* 性别。
|
|
8472
|
+
*/
|
|
8473
|
+
Sex?: string;
|
|
8474
|
+
/**
|
|
8475
|
+
* 出生日期。规范格式为 XXXX年XX月XX日。
|
|
8476
|
+
*/
|
|
8477
|
+
DateOfBirth?: string;
|
|
8478
|
+
/**
|
|
8479
|
+
* 国籍。
|
|
8480
|
+
*/
|
|
8481
|
+
Nationality?: string;
|
|
8482
|
+
/**
|
|
8483
|
+
* 有效期限。
|
|
8484
|
+
*/
|
|
8485
|
+
PeriodOfValidity?: string;
|
|
8486
|
+
/**
|
|
8487
|
+
* 证件号码。
|
|
8488
|
+
*/
|
|
8489
|
+
No?: string;
|
|
8490
|
+
/**
|
|
8491
|
+
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
8492
|
+
*/
|
|
8493
|
+
RequestId?: string;
|
|
8494
|
+
}
|
|
8458
8495
|
/**
|
|
8459
8496
|
* BusInvoiceOCR请求参数结构体
|
|
8460
8497
|
*/
|
|
@@ -9696,6 +9733,38 @@ export interface UsedCarPurchaseInvoice {
|
|
|
9696
9733
|
*/
|
|
9697
9734
|
MachineNumber?: string;
|
|
9698
9735
|
}
|
|
9736
|
+
/**
|
|
9737
|
+
* RecognizeForeignPermanentResidentIdCard请求参数结构体
|
|
9738
|
+
*/
|
|
9739
|
+
export interface RecognizeForeignPermanentResidentIdCardRequest {
|
|
9740
|
+
/**
|
|
9741
|
+
* 图片的 Url 地址。
|
|
9742
|
+
支持的图片格式:PNG、JPG、JPEG,暂不支持 GIF 格式。
|
|
9743
|
+
支持的图片大小:所下载图片经 Base64 编码后不超过 7M。图片下载时间不超过 3 秒。
|
|
9744
|
+
支持的图片像素:需介于20-10000px之间。
|
|
9745
|
+
图片存储于腾讯云的 Url 可保障更高的下载速度和稳定性,建议图片存储于腾讯云。
|
|
9746
|
+
非腾讯云存储的 Url 速度和稳定性可能受一定影响。
|
|
9747
|
+
示例值:https://ocr-demo-1254418846.cos.ap-guangzhou.myqcloud.com/docume
|
|
9748
|
+
*/
|
|
9749
|
+
ImageUrl?: string;
|
|
9750
|
+
/**
|
|
9751
|
+
* 图片的 Base64 值。
|
|
9752
|
+
支持的图片格式:PNG、JPG、JPEG,暂不支持 GIF 格式。
|
|
9753
|
+
支持的图片大小:所下载图片经Base64编码后不超过 7M。图片下载时间不超过 3 秒。
|
|
9754
|
+
支持的图片像素:需介于20-10000px之间。
|
|
9755
|
+
图片的 ImageUrl、ImageBase64 必须提供一个,如果都提供,只使用 ImageUrl。
|
|
9756
|
+
*/
|
|
9757
|
+
ImageBase64?: string;
|
|
9758
|
+
/**
|
|
9759
|
+
* 是否开启PDF识别,默认值为false,开启后可同时支持图片和PDF的识别。
|
|
9760
|
+
*/
|
|
9761
|
+
EnablePdf?: boolean;
|
|
9762
|
+
/**
|
|
9763
|
+
* 需要识别的PDF页面的对应页码,传入时仅支持PDF单页识别,当上传文件为PDF且EnablePdf参数值为true时有效,默认值为1。
|
|
9764
|
+
示例值:1
|
|
9765
|
+
*/
|
|
9766
|
+
PdfPageNumber?: number;
|
|
9767
|
+
}
|
|
9699
9768
|
/**
|
|
9700
9769
|
* GeneralFastOCR返回参数结构体
|
|
9701
9770
|
*/
|