服务端 API

名片识别

最近更新时间:2020-08-03 08:17:16

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, na-toronto
ImageBase64 String 图片的 Base64 值。
支持的图片格式:PNG、JPG、JPEG,暂不支持 GIF 格式。
支持的图片大小:所下载图片经Base64编码后不超过 7M。图片下载时间不超过 3 秒。
图片的 ImageUrl、ImageBase64 必须提供一个,如果都提供,只使用 ImageUrl。
ImageUrl String 图片的 Url 地址。
支持的图片格式:PNG、JPG、JPEG,暂不支持 GIF 格式。
支持的图片大小:所下载图片经 Base64 编码后不超过 7M。图片下载时间不超过 3 秒。
图片存储于腾讯云的 Url 可保障更高的下载速度和稳定性,建议图片存储于腾讯云。
非腾讯云存储的 Url 速度和稳定性可能受一定影响。
Config String 可选字段,根据需要选择是否请求对应字段。
目前支持的字段为:
RetImageType-“PROPROCESS” 图像预处理,string 类型。
图像预处理功能为,检测图片倾斜的角度,将原本倾斜的图片围绕中心点转正,最终输出一张正的名片抠图。

SDK 设置方式参考:
Config = Json.stringify({"RetImageType":"PROPROCESS"})
API 3.0 Explorer 设置方式参考:
Config = {"RetImageType":"PROPROCESS"}

3. 输出参数

参数名称 类型 描述
BusinessCardInfos Array of BusinessCardInfo 名片识别结果,具体内容请点击左侧链接。
RetImageBase64 String 返回图像预处理后的图片,图像预处理未开启时返回内容为空。
RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 名片识别示例代码

输入示例

https://ocr.tencentcloudapi.com/?Action=BusinessCardOCR
&ImageUrl=https://xx/a.jpg 
&<公共请求参数>

输出示例

{
  "Response": {
    "BusinessCardInfos": [
      {
        "Name": "姓名",
        "Value": "艾米",
        "ItemCoord": {
          "X": 59,
          "Y": 0,
          "Width": 54,
          "Height": 26
        }
      },
      {
        "Name": "职位",
        "Value": "视觉设计师",
        "ItemCoord": {
          "X": 60,
          "Y": 0,
          "Width": 76,
          "Height": 17
        }
      },
      {
        "Name": "部门",
        "Value": "社交平台部",
        "ItemCoord": {
          "X": 60,
          "Y": 0,
          "Width": 76,
          "Height": 15
        }
      },
      {
        "Name": "公司",
        "Value": "Tencent腾讯",
        "ItemCoord": {
          "X": 61,
          "Y": 0,
          "Width": 164,
          "Height": 26
        }
      },
      {
        "Name": "地址",
        "Value": "深圳市南山区高新技术园科技中一路腾讯大厦",
        "ItemCoord": {
          "X": 59,
          "Y": 0,
          "Width": 321,
          "Height": 17
        }
      },
      {
        "Name": "邮箱",
        "Value": "abcdefg@tencent.com",
        "ItemCoord": {
          "X": 214,
          "Y": 0,
          "Width": 208,
          "Height": 19
        }
      },
      {
        "Name": "手机",
        "Value": "+86-13312345678",
        "ItemCoord": {
          "X": 100,
          "Y": 0,
          "Width": 165,
          "Height": 18
        }
      },
      {
        "Name": "QQ",
        "Value": "1234567",
        "ItemCoord": {
          "X": 78,
          "Y": 0,
          "Width": 89,
          "Height": 17
        }
      },
      {
        "Name": "微信",
        "Value": "amy001",
        "ItemCoord": {
          "X": 314,
          "Y": 0,
          "Width": 89,
          "Height": 18
        }
      }
    ],
    "RetImageBase64": "",
    "Angle": 0,
    "RequestId": "98f8fcbf-933a-4e95-ac48-6f1a9308fs6h"
  }
}

5. 开发者资源

API Explorer

该工具提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力,能显著降低使用云 API 的难度,推荐使用。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码

错误码 描述
FailedOperation.DownLoadError 文件下载失败。
FailedOperation.ImageDecodeFailed 图片解码失败。
FailedOperation.ImageNoBusinessCard 照片未检测到名片。
FailedOperation.OcrFailed OCR识别失败。
FailedOperation.UnKnowError 未知错误。
FailedOperation.UnOpenError 服务未开通。
InvalidParameter.ConfigFormatError Config不是有效的JSON格式。
InvalidParameterValue.InvalidParameterValueLimit 参数值错误。
LimitExceeded.TooLargeFileError 文件内容太大。
ResourcesSoldOut.ChargeStatusException 计费状态异常。
目录