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 。 |
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 速度和稳定性可能受一定影响。 示例值:https://xx/a.jpg |
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的识别。 示例值:false |
PdfPageNumber | 否 | Integer | 需要识别的PDF页面的对应页码,仅支持PDF单页识别,当上传文件为PDF且IsPdf参数值为true时有效,默认值为1。 示例值:1 |
ReturnMultiplePage | 否 | Boolean | 是否开启PDF多页识别,默认值为false,开启后可同时支持多页PDF的识别返回,仅支持返回文件前30页。开启后IsPDF和PdfPageNumber入参不进行控制。 示例值:true |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
MixedInvoiceItems | Array of MixedInvoiceItem | 混贴票据识别结果,具体内容请点击左侧链接。 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 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": [
{
"Rect": {
"X": -19,
"Y": 34,
"Width": 1399,
"Height": 845
},
"Angle": 0,
"Type": 3,
"Code": "OK",
"Page": 1,
"SingleInvoiceInfos": [
{
"Name": "销售方识别号",
"Value": "440300094040109",
"Row": -1
},
{
"Name": "销售方名称",
"Value": "深圳市游戏科技有限公司",
"Row": -1
},
{
"Name": "购买方识别号",
"Value": "440300708461136",
"Row": -1
},
{
"Name": "购买方名称",
"Value": "深圳市腾讯计算机系统有限公司",
"Row": -1
},
{
"Name": "发票名称",
"Value": "深圳增值税专用发票",
"Row": -1
},
{
"Name": "发票代码",
"Value": "4403152130",
"Row": -1
},
{
"Name": "发票号码",
"Value": "No14998456",
"Row": -1
},
{
"Name": "打印发票代码",
"Value": "4403152130",
"Row": -1
},
{
"Name": "打印发票号码",
"Value": "No14998456",
"Row": -1
},
{
"Name": "开票日期",
"Value": "2016年04月11日",
"Row": -1
},
{
"Name": "密码区1",
"Value": "*7-0<84019---5+68315-99->/51",
"Row": -1
},
{
"Name": "密码区2",
"Value": ">814<1/7922/<-23/908+>7474+3",
"Row": -1
},
{
"Name": "购买方地址、电话",
"Value": "深圳市南山区高新区高新南一路飞亚达大厦5-10楼0755-86013388",
"Row": -1
},
{
"Name": "密码区3",
"Value": "78312-072<3<729-+4<6*315-094",
"Row": -1
},
{
"Name": "密码区4",
"Value": "->/5>18493/1-60*6-43/90<--78",
"Row": -1
},
{
"Name": "购买方开户行及账号",
"Value": "招商银行深圳分行振兴支行817282299619961",
"Row": -1
},
{
"Name": "货物或应税劳务、服务名称",
"Value": "技术服务费",
"Row": 0
},
{
"Name": "金额",
"Value": "778.44",
"Row": 0
},
{
"Name": "税率",
"Value": "6%",
"Row": 0
},
{
"Name": "税额",
"Value": "46.71",
"Row": 0
},
{
"Name": "合计金额",
"Value": "¥778.44",
"Row": -1
},
{
"Name": "合计税额",
"Value": "46.71",
"Row": -1
},
{
"Name": "价税合计(大写)",
"Value": "捌佰贰拾伍圆壹角伍分",
"Row": -1
},
{
"Name": "小写金额",
"Value": "¥825.15",
"Row": -1
},
{
"Name": "销售方地址、电话",
"Value": "深圳市南山区高新南一道3号赋安科技大楼A座301室0755-86315454",
"Row": -1
},
{
"Name": "销售方开户行及账号",
"Value": "浦发行深圳科技园支行79210154740015474",
"Row": -1
},
{
"Name": "收款人",
"Value": "李明",
"Row": -1
},
{
"Name": "复核",
"Value": "晓艾",
"Row": -1
},
{
"Name": "开票人",
"Value": "张三",
"Row": -1
},
{
"Name": "是否有公司印章",
"Value": "1",
"Row": -1
},
{
"Name": "联次",
"Value": "三",
"Row": -1
},
{
"Name": "省",
"Value": "广东省",
"Row": -1
},
{
"Name": "市",
"Value": "深圳市",
"Row": -1
},
{
"Name": "发票消费类型",
"Value": "服务",
"Row": -1
},
{
"Name": "发票类型",
"Value": "增值税专用发票",
"Row": -1
},
{
"Name": "机器编号",
"Value": "",
"Row": -1
},
{
"Name": "校验码",
"Value": "",
"Row": -1
},
{
"Name": "单价",
"Value": "",
"Row": -1
},
{
"Name": "备注",
"Value": "",
"Row": -1
},
{
"Name": "单位",
"Value": "",
"Row": -1
},
{
"Name": "数量",
"Value": "",
"Row": -1
},
{
"Name": "规格型号",
"Value": "",
"Row": -1
},
{
"Name": "是否代开",
"Value": "",
"Row": -1
},
{
"Name": "成品油标志",
"Value": "",
"Row": -1
},
{
"Name": "服务类型",
"Value": "",
"Row": -1
},
{
"Name": "通行费标志",
"Value": "",
"Row": -1
},
{
"Name": "车船税",
"Value": "",
"Row": -1
},
{
"Name": "车牌号",
"Value": "",
"Row": -1
},
{
"Name": "类型",
"Value": "",
"Row": -1
},
{
"Name": "通行日期起",
"Value": "",
"Row": -1
},
{
"Name": "通行日期止",
"Value": "",
"Row": -1
}
]
}
],
"RequestId": "3a850dbc-2de1-4dfb-9ecd-7ae57f2fe666"
}
}
示例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": -19,
"Y": 34,
"Width": 1399,
"Height": 845
},
"Angle": 0,
"Type": 3,
"Code": "OK",
"Page": 1,
"SingleInvoiceInfos": [
{
"Name": "销售方识别号",
"Value": "440300094040109",
"Row": -1
},
{
"Name": "销售方名称",
"Value": "深圳市游戏科技有限公司",
"Row": -1
},
{
"Name": "购买方识别号",
"Value": "440300708461136",
"Row": -1
},
{
"Name": "购买方名称",
"Value": "深圳市腾讯计算机系统有限公司",
"Row": -1
},
{
"Name": "发票名称",
"Value": "深圳增值税专用发票",
"Row": -1
},
{
"Name": "发票代码",
"Value": "4403152130",
"Row": -1
},
{
"Name": "发票号码",
"Value": "No14998456",
"Row": -1
},
{
"Name": "打印发票代码",
"Value": "4403152130",
"Row": -1
},
{
"Name": "打印发票号码",
"Value": "No14998456",
"Row": -1
},
{
"Name": "开票日期",
"Value": "2016年04月11日",
"Row": -1
},
{
"Name": "密码区1",
"Value": "*7-0<84019---5+68315-99->/51",
"Row": -1
},
{
"Name": "密码区2",
"Value": ">814<1/7922/<-23/908+>7474+3",
"Row": -1
},
{
"Name": "购买方地址、电话",
"Value": "深圳市南山区高新区高新南一路飞亚达大厦5-10楼0755-86013388",
"Row": -1
},
{
"Name": "密码区3",
"Value": "78312-072<3<729-+4<6*315-094",
"Row": -1
},
{
"Name": "密码区4",
"Value": "->/5>18493/1-60*6-43/90<--78",
"Row": -1
},
{
"Name": "购买方开户行及账号",
"Value": "招商银行深圳分行振兴支行817282299619961",
"Row": -1
},
{
"Name": "货物或应税劳务、服务名称",
"Value": "技术服务费",
"Row": 0
},
{
"Name": "金额",
"Value": "778.44",
"Row": 0
},
{
"Name": "税率",
"Value": "6%",
"Row": 0
},
{
"Name": "税额",
"Value": "46.71",
"Row": 0
},
{
"Name": "合计金额",
"Value": "¥778.44",
"Row": -1
},
{
"Name": "合计税额",
"Value": "46.71",
"Row": -1
},
{
"Name": "价税合计(大写)",
"Value": "捌佰贰拾伍圆壹角伍分",
"Row": -1
},
{
"Name": "小写金额",
"Value": "¥825.15",
"Row": -1
},
{
"Name": "销售方地址、电话",
"Value": "深圳市南山区高新南一道3号赋安科技大楼A座301室0755-86315454",
"Row": -1
},
{
"Name": "销售方开户行及账号",
"Value": "浦发行深圳科技园支行79210154740015474",
"Row": -1
},
{
"Name": "收款人",
"Value": "李明",
"Row": -1
},
{
"Name": "复核",
"Value": "晓艾",
"Row": -1
},
{
"Name": "开票人",
"Value": "张三",
"Row": -1
},
{
"Name": "是否有公司印章",
"Value": "1",
"Row": -1
},
{
"Name": "联次",
"Value": "三",
"Row": -1
},
{
"Name": "省",
"Value": "广东省",
"Row": -1
},
{
"Name": "市",
"Value": "深圳市",
"Row": -1
},
{
"Name": "发票消费类型",
"Value": "服务",
"Row": -1
},
{
"Name": "发票类型",
"Value": "增值税专用发票",
"Row": -1
},
{
"Name": "机器编号",
"Value": "",
"Row": -1
},
{
"Name": "校验码",
"Value": "",
"Row": -1
},
{
"Name": "单价",
"Value": "",
"Row": -1
},
{
"Name": "备注",
"Value": "",
"Row": -1
},
{
"Name": "单位",
"Value": "",
"Row": -1
},
{
"Name": "数量",
"Value": "",
"Row": -1
},
{
"Name": "规格型号",
"Value": "",
"Row": -1
},
{
"Name": "是否代开",
"Value": "",
"Row": -1
},
{
"Name": "成品油标志",
"Value": "",
"Row": -1
},
{
"Name": "服务类型",
"Value": "",
"Row": -1
},
{
"Name": "通行费标志",
"Value": "",
"Row": -1
},
{
"Name": "车船税",
"Value": "",
"Row": -1
},
{
"Name": "车牌号",
"Value": "",
"Row": -1
},
{
"Name": "类型",
"Value": "",
"Row": -1
},
{
"Name": "通行日期起",
"Value": "",
"Row": -1
},
{
"Name": "通行日期止",
"Value": "",
"Row": -1
}
]
}
],
"RequestId": "3a850dbc-2de1-4dfb-9ecd-7ae57f2fe666"
}
}
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.ImageBlur | 图片模糊。 |
FailedOperation.ImageDecodeFailed | 图片解码失败。 |
FailedOperation.OcrFailed | OCR识别失败。 |
FailedOperation.UnKnowError | 未知错误。 |
FailedOperation.UnOpenError | 服务未开通。 |
InvalidParameterValue.InvalidParameterValueLimit | 参数值错误。 |
LimitExceeded.TooLargeFileError | 文件内容太大。 |
ResourceUnavailable.InArrears | 账号已欠费。 |
ResourceUnavailable.ResourcePackageRunOut | 账号资源包耗尽。 |
ResourcesSoldOut.ChargeStatusException | 计费状态异常。 |