服务端 API 文档

文档捉虫大赛火热进行中,好礼多多> HOT

1. 接口描述

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

本接口支持对增值税发票(卷票)的发票代码、发票号码、日期、校验码、合计金额(小写)等关键字段的识别。

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:VatRollInvoiceOCR。
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 速度和稳定性可能受一定影响。
IsPdf Boolean 是否开启PDF识别,默认值为true,开启后可同时支持图片和PDF的识别。
PdfPageNumber Integer 需要识别的PDF页面的对应页码,仅支持PDF单页识别,当上传文件为PDF且IsPdf参数值为true时有效,默认值为1。

3. 输出参数

参数名称 类型 描述
VatRollInvoiceInfos Array of VatRollInvoiceInfo 增值税发票(卷票)识别结果,具体内容请点击左侧链接。
Angle Float 图片旋转角度(角度制),文本的水平方向为0°,顺时针为正,逆时针为负。
RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 增值税发票(卷票)识别示例代码

增值税发票(卷票)识别

输入示例

POST / HTTP/1.1
Host: ocr.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: VatRollInvoiceOCR
<公共请求参数>

{
    "ImageUrl": "https://xx/a.jpg "
}

输出示例

{
    "Response": {
        "VatRollInvoiceInfos": [
            {
                "Name": "发票代码",
                "Value": "033000101",
                "Rect": {
                    "X": 67,
                    "Y": 246,
                    "Width": 324,
                    "Height": 25
                }
            },
            {
                "Name": "发票号码",
                "Value": "14547954",
                "Rect": {
                    "X": 67,
                    "Y": 281,
                    "Width": 253,
                    "Height": 27
                }
            },
            {
                "Name": "销售方识别号",
                "Value": "9133974410525",
                "Rect": {
                    "X": 216,
                    "Y": 404,
                    "Width": 202,
                    "Height": 21
                }
            },
            {
                "Name": "开票日期",
                "Value": "2019-07-14",
                "Rect": {
                    "X": 168,
                    "Y": 428,
                    "Width": 193,
                    "Height": 22
                }
            },
            {
                "Name": "购买方识别号",
                "Value": "913302572467",
                "Rect": {
                    "X": 215,
                    "Y": 513,
                    "Width": 203,
                    "Height": 21
                }
            },
            {
                "Name": "合计金额(小写)",
                "Value": "¥200.00",
                "Rect": {
                    "X": 203,
                    "Y": 1022,
                    "Width": 87,
                    "Height": 23
                }
            },
            {
                "Name": "合计金额(大写)",
                "Value": "贰佰圆整",
                "Rect": {
                    "X": 201,
                    "Y": 1051,
                    "Width": 87,
                    "Height": 23
                }
            },
            {
                "Name": "校验码",
                "Value": "839310540000",
                "Rect": {
                    "X": 183,
                    "Y": 1081,
                    "Width": 220,
                    "Height": 20
                }
            }
        ],
        "Angle": 0,
        "RequestId": "a0513eeb-6747-4a35-91ad-addcd1392896"
    }
}

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.ImageDecodeFailed 图片解码失败。
FailedOperation.OcrFailed OCR识别失败。
FailedOperation.UnKnowError 未知错误。
FailedOperation.UnOpenError 服务未开通。
InvalidParameterValue.InvalidParameterValueLimit 参数值错误。
LimitExceeded.TooLargeFileError 文件内容太大。
ResourcesSoldOut.ChargeStatusException 计费状态异常。
目录