1. 接口描述
接口请求域名: ocr.tencentcloudapi.com 。
本接口支持多种类型证件有效性检测告警,包括卡证复印件告警、卡证翻拍告警等功能。可以应用于各种证件信息有效性校验场景,例如银行开户、用户注册等场景。
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:RecognizeGeneralTextImageWarn。 |
Version | 是 | String | 公共参数,本接口取值:2018-11-19。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表,本接口仅支持其中的: ap-beijing, ap-guangzhou, ap-hongkong, ap-shanghai 。 |
ImageUrl | 否 | String | 图片的 Url 地址。 支持的图片格式:PNG、JPG、JPEG,暂不支持 GIF 格式。 支持的图片大小:所下载图片经 Base64 编码后不超过 7M。图片下载时间不超过 3 秒。 支持的图片像素:需介于20-10000px之间。 图片存储于腾讯云的 Url 可保障更高的下载速度和稳定性,建议图片存储于腾讯云。 非腾讯云存储的 Url 速度和稳定性可能受一定影响。 示例值:https://ocr-demo-1254418846.cos.ap-guangzhou.myqcloud.com/docume |
ImageBase64 | 否 | String | 图片的 Base64 值。 支持的图片格式:PNG、JPG、JPEG,暂不支持 GIF 格式。 支持的图片大小:所下载图片经Base64编码后不超过 7M。图片下载时间不超过 3 秒。 支持的图片像素:需介于20-10000px之间。 图片的 ImageUrl、ImageBase64 必须提供一个,如果都提供,只使用 ImageUrl。 |
EnablePdf | 否 | Boolean | 是否开启PDF识别,默认值为true,开启后可同时支持图片和PDF的识别。 示例值:false 示例值:true |
PdfPageNumber | 否 | Integer | 需要识别的PDF页面的对应页码,传入时仅支持PDF单页识别,当上传文件为PDF且EnablePdf参数值为true时有效,默认值为1。 示例值:1 示例值:1 |
Type | 否 | String | 支持的模板类型 - General 通用告警(支持所有类型告警) - LicensePlate 车牌告警(支持翻拍告警) |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
Copy | GeneralWarnInfo | 复印告警信息 |
Reprint | GeneralWarnInfo | 翻拍告警信息 |
Blur | GeneralWarnInfo | 模糊告警信息 |
Reflection | GeneralWarnInfo | 反光告警信息 |
BorderIncomplete | GeneralWarnInfo | 边框不完整告警信息 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 通用文本图像告警示例代码
通用文本图像告警示例
输入示例
POST / HTTP/1.1
Host: ocr.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: RecognizeGeneralTextImageWarn
<公共请求参数>
{
"ImageUrl": "https://xx/a.jpg"
}
输出示例
{
"Response": {
"Blur": {
"IsWarn": false,
"Polygon": [],
"SpecificMatter": ""
},
"BorderIncomplete": {
"IsWarn": false,
"Polygon": [],
"SpecificMatter": ""
},
"Copy": {
"IsWarn": true,
"Polygon": [
{
"LeftBottom": {
"X": 0,
"Y": 0
},
"LeftTop": {
"X": 0,
"Y": 0
},
"RightBottom": {
"X": 0,
"Y": 0
},
"RightTop": {
"X": 0,
"Y": 0
}
}
],
"SpecificMatter": ""
},
"Reflection": {
"IsWarn": false,
"Polygon": [],
"SpecificMatter": ""
},
"Reprint": {
"IsWarn": true,
"Polygon": [
{
"LeftBottom": {
"X": 0,
"Y": 0
},
"LeftTop": {
"X": 0,
"Y": 0
},
"RightBottom": {
"X": 0,
"Y": 0
},
"RightTop": {
"X": 0,
"Y": 0
}
}
],
"SpecificMatter": ""
},
"RequestId": "d8b2bf40-091e-43f1-a075-d98a5c9b2e1e"
}
}
5. 开发者资源
腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python: GitHub Gitee
- Tencent Cloud SDK 3.0 for Java: GitHub Gitee
- Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
- Tencent Cloud SDK 3.0 for Go: GitHub Gitee
- Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
- Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
- Tencent Cloud SDK 3.0 for C++: GitHub Gitee
- Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
FailedOperation.DownLoadError | 文件下载失败。 |
FailedOperation.ImageDecodeFailed | 图片解码失败。 |
FailedOperation.OcrFailed | OCR识别失败。 |
FailedOperation.UnKnowError | 未知错误。 |
FailedOperation.UnOpenError | 服务未开通。 |
InvalidParameterValue.InvalidParameterValueLimit | 参数值错误。 |
LimitExceeded.TooLargeFileError | 文件内容太大。 |
ResourceUnavailable.InArrears | 账号已欠费。 |
ResourceUnavailable.ResourcePackageRunOut | 账号资源包耗尽。 |
ResourcesSoldOut.ChargeStatusException | 计费状态异常。 |