1. 接口描述
接口请求域名: ocr.tencentcloudapi.com 。
本接口支持中英文名片各字段的自动定位与识别,包含姓名、电话、手机号、邮箱、公司、部门、职位、网址、地址、QQ、微信、MSN等。
默认接口请求频率限制:10次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:BusinessCardOCR。 |
Version | 是 | String | 公共参数,本接口取值:2018-11-19。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表,本接口仅支持其中的: ap-beijing, ap-guangzhou, ap-hongkong, ap-shanghai 。 |
ImageBase64 | 否 | String | 图片的 Base64 值。 支持的图片格式:PNG、JPG、JPEG,暂不支持 GIF 格式。 支持的图片大小:所下载图片经Base64编码后不超过 7M。图片下载时间不超过 3 秒。 图片的 ImageUrl、ImageBase64 必须提供一个,如果都提供,只使用 ImageUrl。 示例值:/9j/4AAQSkZJRg.....s97n//2Q== |
ImageUrl | 否 | String | 图片的 Url 地址。 支持的图片格式:PNG、JPG、JPEG,暂不支持 GIF 格式。 支持的图片大小:所下载图片经 Base64 编码后不超过 7M。图片下载时间不超过 3 秒。 图片存储于腾讯云的 Url 可保障更高的下载速度和稳定性,建议图片存储于腾讯云。 非腾讯云存储的 Url 速度和稳定性可能受一定影响。 示例值:https://ocr-demo-1254418846.cos.ap-guangzhou.myqcloud.com/card/BusinessCardOCR/BusinessCardOCR1.jpg |
Config | 否 | String | 可选字段,根据需要选择是否请求对应字段。 目前支持的字段为: RetImageType-“PROPROCESS” 图像预处理,string 类型。 图像预处理功能为,检测图片倾斜的角度,将原本倾斜的图片围绕中心点转正,最终输出一张正的名片抠图。 SDK 设置方式参考: Config = Json.stringify({"RetImageType":"PROPROCESS"}) API 3.0 Explorer 设置方式参考: Config = {"RetImageType":"PROPROCESS"} 示例值:{"RetImageType":"PROPROCESS"} |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
BusinessCardInfos | Array of BusinessCardInfo | 名片识别结果,具体内容请点击左侧链接。 示例值:[{"ItemCoord":{"Height":36,"Width":67,"X":68,"Y":47},"Name":"姓名","Value":"李明"},{"ItemCoord":{"Height":23,"Width":201,"X":67,"Y":103},"Name":"职位","Value":"优图研发中心工程师"},{"ItemCoord":{"Height":22,"Width":379,"X":103,"Y":302},"Name":"地址","Value":"上海市徐汇区田林路397号腾云大厦6F"},{"ItemCoord":{"Height":21,"Width":184,"X":290,"Y":270},"Name":"邮箱","Value":"abc8888@qq.com"},{"ItemCoord":{"Height":23,"Width":226,"X":118,"Y":233},"Name":"手机","Value":"+86-185-8907-2228"},{"ItemCoord":{"Height":21,"Width":101,"X":93,"Y":268},"Name":"QQ","Value":"888888"}] |
RetImageBase64 | String | 返回图像预处理后的图片,图像预处理未开启时返回内容为空。 示例值:/9j/4AAQSkZJRg.....s97n//2Q== |
Angle | Float | 图片旋转角度(角度制),文本的水平方向为0°;顺时针为正,逆时针为负。点击查看如何纠正倾斜文本 示例值:0 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 BusinessCardOCR调用
输入示例
POST / HTTP/1.1
Host: ocr.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: BusinessCardOCR
<公共请求参数>
{
"ImageUrl": "https://ocr-demo-1254418846.cos.ap-guangzhou.myqcloud.com/card/BusinessCardOCR/BusinessCardOCR1.jpg"
}
输出示例
{
"Response": {
"Angle": 0,
"BusinessCardInfos": [
{
"ItemCoord": {
"Height": 36,
"Width": 67,
"X": 68,
"Y": 47
},
"Name": "姓名",
"Value": "李明"
},
{
"ItemCoord": {
"Height": 23,
"Width": 201,
"X": 67,
"Y": 103
},
"Name": "职位",
"Value": "优图研发中心工程师"
},
{
"ItemCoord": {
"Height": 22,
"Width": 379,
"X": 103,
"Y": 302
},
"Name": "地址",
"Value": "上海市徐汇区田林路397号腾云大厦6F"
},
{
"ItemCoord": {
"Height": 21,
"Width": 184,
"X": 290,
"Y": 270
},
"Name": "邮箱",
"Value": "abc8888@qq.com"
},
{
"ItemCoord": {
"Height": 23,
"Width": 226,
"X": 118,
"Y": 233
},
"Name": "手机",
"Value": "+86-185-8907-2228"
},
{
"ItemCoord": {
"Height": 21,
"Width": 101,
"X": 93,
"Y": 268
},
"Name": "QQ",
"Value": "888888"
}
],
"RequestId": "83b207b2-b5e4-4084-b3fe-f9018d58bef0",
"RetImageBase64": ""
}
}
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.ImageNoBusinessCard | 照片未检测到名片。 |
FailedOperation.OcrFailed | OCR识别失败。 |
FailedOperation.UnKnowError | 未知错误。 |
FailedOperation.UnOpenError | 服务未开通。 |
InvalidParameter.ConfigFormatError | Config不是有效的JSON格式。 |
InvalidParameterValue.InvalidParameterValueLimit | 参数值错误。 |
LimitExceeded.TooLargeFileError | 文件内容太大。 |
ResourceUnavailable.InArrears | 账号已欠费。 |
ResourceUnavailable.ResourcePackageRunOut | 账号资源包耗尽。 |
ResourcesSoldOut.ChargeStatusException | 计费状态异常。 |