服务端 API 文档

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

1. 接口描述

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

本接口支持 单张、多张、多类型 票据的混合识别,同时支持自选需要识别的票据类型,已支持票种包括:增值税发票(专票、普票、卷票)、全电发票、非税发票、定额发票、通用机打发票、购车发票、火车票、出租车发票、机票行程单、汽车票、轮船票、过路过桥费发票共14种标准报销发票,并支持其他类发票的识别。

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:MixedInvoiceOCR。
Version String 公共参数,本接口取值:2018-11-19。
Region String 公共参数,详见产品支持的 地域列表,本接口仅支持其中的: ap-beijing, ap-guangzhou, ap-hongkong, ap-shanghai, na-toronto 。
ImageBase64 String 图片的 Base64 值。
支持的图片格式:PNG、JPG、JPEG、PDF,暂不支持 GIF 格式。
支持的图片大小:所下载图片经Base64编码后不超过 7M。图片下载时间不超过 3 秒。
图片的 ImageUrl、ImageBase64 必须提供一个,如果都提供,只使用 ImageUrl。
ImageUrl String 图片的 Url 地址。
支持的图片格式:PNG、JPG、JPEG、PDF,暂不支持 GIF 格式。
支持的图片大小:所下载图片经 Base64 编码后不超过 7M。图片下载时间不超过 3 秒。
图片存储于腾讯云的 Url 可保障更高的下载速度和稳定性,建议图片存储于腾讯云。
非腾讯云存储的 Url 速度和稳定性可能受一定影响。
Types.N Array of Integer 需要识别的票据类型列表,为空或不填表示识别全部类型。
0:出租车发票
1:定额发票
2:火车票
3:增值税发票
5:机票行程单
8:通用机打发票
9:汽车票
10:轮船票
11:增值税发票(卷票 )
12:购车发票
13:过路过桥费发票
15:非税发票
16:全电发票
----------------------
-1:其他发票,(只传入此类型时,图片均采用其他票类型进行识别)
ReturnOther String 是否识别其他类型发票,默认为Yes
Yes:识别其他类型发票
No:不识别其他类型发票
IsPdf Boolean 是否开启PDF识别,默认值为true,开启后可同时支持图片和PDF的识别。
PdfPageNumber Integer 需要识别的PDF页面的对应页码,仅支持PDF单页识别,当上传文件为PDF且IsPdf参数值为true时有效,默认值为1。
ReturnMultiplePage Boolean 是否开启PDF多页识别,默认值为false,开启后可同时支持多页PDF的识别返回,仅支持返回文件前30页。开启后IsPDF和PdfPageNumber入参不进行控制。

3. 输出参数

参数名称 类型 描述
MixedInvoiceItems Array of MixedInvoiceItem 混贴票据识别结果,具体内容请点击左侧链接。
RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 混贴票据识别示例代码(识别全部类型)

混贴票据识别示例代码(识别全部类型)

输入示例

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

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

输出示例

{
    "Response": {
        "MixedInvoiceItems": [
            {
                "Type": 13,
                "Rect": {
                    "X": 20,
                    "Y": 891,
                    "Width": 479,
                    "Height": 597
                },
                "Angle": 0,
                "SingleInvoiceInfos": [
                    {
                        "Name": "发票号码",
                        "Value": "27357827",
                        "Row": 0
                    },
                    {
                        "Name": "日期",
                        "Value": "2016年04月11日",
                        "Row": 0
                    },
                    {
                        "Name": "发票代码",
                        "Value": "440300708461",
                        "Row": 0
                    },
                    {
                        "Name": "金额",
                        "Value": "778",
                        "Row": 0
                    }
                ],
                "Code": "OK"
            },
            {
                "Type": 2,
                "Rect": {
                    "X": 520,
                    "Y": 904,
                    "Width": 455,
                    "Height": 286
                },
                "Angle": 0,
                "SingleInvoiceInfos": [
                    {
                        "Name": "编号",
                        "Value": "Z96X809511",
                        "Row": 0
                    },
                    {
                        "Name": "出发站",
                        "Value": "上海",
                        "Row": 0
                    },
                    {
                        "Name": "到达站",
                        "Value": "南京",
                        "Row": 0
                    },
                    {
                        "Name": "出发时间",
                        "Value": "2018年03月06日18:51",
                        "Row": 0
                    },
                    {
                        "Name": "车次",
                        "Value": "Z196",
                        "Row": 0
                    },
                    {
                        "Name": "座位号",
                        "Value": "",
                        "Row": 0
                    },
                    {
                        "Name": "姓名",
                        "Value": "周周",
                        "Row": 0
                    },
                    {
                        "Name": "票价",
                        "Value": "46.5",
                        "Row": 0
                    },
                    {
                        "Name": "席别",
                        "Value": "新空调硬座",
                        "Row": 0
                    }
                ],
                "Code": "OK"
            }
        ],
        "RequestId": "d5202318-7dfa-4b34-9f1f-f21f36f43d67"
    }
}

示例2 混贴票据识别示例代码(识别指定类型)

混贴票据识别示例代码(识别指定类型)

输入示例

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

{
    "ImageUrl": "https://xx/a.jpg",
    "Types": [
        "2"
    ]
}

输出示例

{
    "Response": {
        "MixedInvoiceItems": [
            {
                "Rect": {
                    "X": 31,
                    "Y": 34,
                    "Width": 1327,
                    "Height": 866
                },
                "Angle": 0,
                "SingleInvoiceInfos": [],
                "Code": "OK",
                "Type": 3
            },
            {
                "Rect": {
                    "X": 18,
                    "Y": 887,
                    "Width": 484,
                    "Height": 607
                },
                "Angle": 0,
                "SingleInvoiceInfos": [],
                "Code": "OK",
                "Type": 13
            },
            {
                "Rect": {
                    "X": 517,
                    "Y": 931,
                    "Width": 464,
                    "Height": 306
                },
                "Angle": 0,
                "SingleInvoiceInfos": [
                    {
                        "Name": "编号",
                        "Value": "Z96X089511",
                        "Row": 0
                    },
                    {
                        "Name": "出发站",
                        "Value": "上海",
                        "Row": 0
                    },
                    {
                        "Name": "车次",
                        "Value": "Z196",
                        "Row": 0
                    },
                    {
                        "Name": "到达站",
                        "Value": "南京",
                        "Row": 0
                    },
                    {
                        "Name": "出发时间",
                        "Value": "2018年03月06日18:51",
                        "Row": 0
                    },
                    {
                        "Name": "座位号",
                        "Value": "02车016号",
                        "Row": 0
                    },
                    {
                        "Name": "票价",
                        "Value": "46.50",
                        "Row": 0
                    },
                    {
                        "Name": "席别",
                        "Value": "新空调硬座",
                        "Row": 0
                    },
                    {
                        "Name": "身份证号",
                        "Value": "3210231991****6666",
                        "Row": 0
                    },
                    {
                        "Name": "姓名",
                        "Value": "周周",
                        "Row": 0
                    }
                ],
                "Code": "OK",
                "Type": 2
            }
        ],
        "RequestId": "6b261226-7255-4f56-ab51-a641106618ff"
    }
}

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