服务端 API 文档

健康码识别

最近更新时间:2022-05-16 06:12:54

我的收藏

1. 接口描述

接口请求域名: ocr.tencentcloudapi.com 。

本接口支持北京、上海、广东、江苏、吉林、黑龙江省市健康码的识别,包括持码人姓名、持码人身份证号、健康码更新时间、健康码颜色、核酸检测结果、核酸检测间隔时长、核酸检测时间,七个字段的识别结果输出。不同省市健康码显示的字段信息有所不同,上述字段的识别结果可能为空,以图片上具体展示的信息为准。

默认接口请求频率限制:5次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:RecognizeHealthCodeOCR。
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 速度和稳定性可能受一定影响。
Type Integer 需要识别的健康码类型列表,为空或不填表示默认为自动识别。
0:自动识别

3. 输出参数

参数名称 类型 描述
Name String 持码人姓名,如:王*(允许返回空值)
IDNumber String 持码人身份证号,如:11**01(允许返回空值)
Time String 健康码更新时间(允许返回空值)
Color String 健康码颜色:绿色、黄色、红色(允许返回空值)
TestingInterval String 核酸检测间隔时长(允许返回空值)
TestingResult String 核酸检测结果:阴性、阳性、暂无核酸检测记录(允许返回空值)
TestingTime String 核酸检测时间(允许返回空值)
RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 健康码识别示例代码

输入示例

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

输出示例

{
  "Response": {
    "Name": "京XX",
    "Time": "XX - XX XX: XX: XX",
    "Color": "绿色",
    "TestingResult": "48小时阴性",
    "TestingInterval": "xx",
    "TestingTime": "xx",
    "IDNumber": "xx",
    "RequestId": "210103d3-db06-4691-abe0-c0853aae606b"
  }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

SDK

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

命令行工具

6. 错误码

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

错误码 描述
FailedOperation.DownLoadError 文件下载失败。
FailedOperation.EmptyImageError 图片内容为空。
FailedOperation.ImageDecodeFailed 图片解码失败。
FailedOperation.ImageNoText 图片中未检测到文本。
FailedOperation.ImageSizeTooLarge 图片尺寸过大,请参考输出参数中关于图片大小限制的说明。
FailedOperation.OcrFailed OCR识别失败。
FailedOperation.UnKnowError 未知错误。
FailedOperation.UnOpenError 服务未开通。
InvalidParameterValue.InvalidParameterValueLimit 参数值错误。
LimitExceeded.TooLargeFileError 文件内容太大。
ResourcesSoldOut.ChargeStatusException 计费状态异常。
目录