You need to enable JavaScript to run this app.
导航
文字识别
  • 文档首页
    • /
  • 文字识别

调用方式

最近更新时间：2023.08.18 18:00:47

首次发布时间：2022.07.21 17:01:20

我的收藏
接口简介

支持对增值税卷票所有关键字段的自动定位与识别。

限制条件
名称内容
输入要求1. 文件格式：支持JPG、JPEG、PNG、BMP、PDF等常见格式，建议使用JPG格式。
2. 文件大小：
a.要求Base64编码和urlencode之后不超过 8 MB。
b.如果传图片及PDF完整URL，URL对应文件大小建议不要超过8MB。
3. 输入文件过大时，返回的HttpCode如下：400/413/502。
4. 输入多页PDF时，默认只识别第一页。
请求说明

基本信息

名称内容
接口地址https://visual.volcengineapi.com
请求方式POST
Content-Typeapplication/x-www-form-urlencoded
是否需要鉴权是

请求参数

header请求参数

以下请求参数列表仅列出了接口请求参数和必要公共参数，完整公共参数列表见 公共参数。

名称类型是否必填描述
X-DateString是使用UTC时间，精确到秒。请使用格式：YYYYMMDD'T'HHMMSS'Z' ，例如：20201103T104027Z

Authorization

String

是

HMAC-SHA256：签名方法
-Credential为签名凭证，其中:
-AccessKeyId为访问密钥ID，可在 访问密钥（Access Key） 获取；
-ShortDate为请求的短时间，使用UTC时间，精确到日。请使用格式：YYYYMMDD，例如：20180201；
-Region为请求地区，国内一般为为cn-north-1；
-Service为请求的服务，文字识别一般为cv；
-SignedHeaders为参与签名计算的头部信息，content-type 和 host 为必选头部；
-Signature为签名，可在 签名方法 获取。
注：我们提供了SDK及签名示例供您实现服务快速接入，具体可参考 快速接入
例如：HMAC-SHA256 Credential={AccessKeyId}/{ShortDate}/{Region}/{Service}/request, SignedHeaders={SignedHeaders}, Signature={Signature}

X-Security-TokenString否指安全令牌服务（Security Token Service，STS） 颁发的临时安全凭证中的SessionToken，使用长期密钥时无需填写该参数。

Query请求参数

参数可选/必选类型说明
Action必选String接口名，取值：OcrRollInvoice
Version必选String版本号，取值：2021-08-23

Body参数

参数可选/必选类型说明
image_base64与image_url二选一String图片文件，base64编码
注意: 只需要传图片的base64值，类似data:image/png;base64的图片头不要传入
image_url与image_base64二选一String图片/PDF文件的URL链接
注意: 要求image_base64与image_url二选一，如果2个字段都有，优先解析image_base64。
输出说明

通用输出参数

请参考通用返回字段及错误码 |

业务输出参数

data 字段说明

字段类型说明备注
license_mainmain_info主页面信息字段说明见下方

main_info 字段说明

字段类型说明备注
seller_nameString销售方名称主页信息
buyer_nameString购买方名称主页信息
entryList of Entry发票条目字段说明见下方
invoice_headerString发票名称主页信息
invoice_couponString发票联主页信息
invoice_codeString发票代码主页信息
invoice_numberString发票号码主页信息
machine_codeString机器编号主页信息
typed_invoice_noString机打号码主页信息
seller_taxpayer_noString销售方纳税人识别号主页信息
invoice_dateString开票日期主页信息
payeeString收款员主页信息
buyer_taxpayer_noString购买方纳税人识别号主页信息
lowercase_total_amountString合计金额（小写）主页信息
capital_total_amountString合计金额（大写）主页信息
check_codeString校验码主页信息
seller_name_in_sealString印章中销售方名称主页信息
seller_taxpayer_no_in_sealString印章中销售方纳税人识别号主页信息

Entry 明细字段说明

字段类型说明备注
entry_nameString项目主页信息
quantityString数量主页信息
price_amountString金额主页信息
unit_priceString单价主页信息

输出示例

主页面图片返回值示例

{
   "code":10000,
   "data":{
      "license_main":{
         "seller_name":"中国石化销售有限公司滨江石油分公司",
         "buyer_name":"滨江明日头条科技有限公司",
         "entry": [{
				    "entry_name":"*预付卡销售*加油充值款",
				    "quantity":"1.00",
				    "price_amount":"500.00",
				    "unit_price":"500.00",
         }],
         "invoice_header":"滨江增值税普通发票",
         "invoice_coupon":"发票联",
         "invoice_code":"031001750107",
         "invoice_number":"03574125",
         "machine_code":"661712116595",
         "typed_invoice_no":"03574125",
         "seller_taxpayer_no":"91310000834486035U",
         "invoice_date":"2019年1月14日",
         "payee":"高红英",
         "buyer_taxpayer_no":"91310104MA1FR7C72G",
         "lowercase_total_amount":"¥500.00",
         "capital_total_amount":"伍佰元整",
         "check_code":"70497 71434 15541 89588"
      }
   },
   "message":"Success",
   "request_id":"68885192694164377721603858375",
   "status":10000,
   "time_elapsed":"418.017944ms"
}
错误码

通用错误码

请参考通用返回字段及错误码

业务错误码

HttpCode错误码错误消息描述
20010000"Success"请求成功
40050204"Parse Request Parameters Error"缺少参数
40050205"Image Size Exceeds Maximum Limit: please compress the image"输入文件过大
40050206"Invalid Input Image: image is empty"输入图片为空
40050207"Image Decode Error: image format unsupported"图片解码错误
40050217"Process PDF File Error."处理PDF文件错误
40050208"Invalid Input Image: No object detected in input image, bad input image"输入图片没有检测到卷式发票
40150400见下方鉴权错误信息鉴权失败
40450402"Request URL Error"无效的请求路径
50050500"Internal Error: please contact with bytedance engineering team"内部错误，需要联系开发人员

鉴权错误信息

HttpCode错误码错误消息描述
40150400"Access Denied: api forbidden"api_key缺失或者错误
40150400"Access Denied: bad timestamp. Make sure your clock is correct"timestamp错误
40150400"Access Denied: timestamp is an invalid integer"timestamp缺失或格式错误
40150400"Access Denied: nonce is not a 32-bit signed integer"nonce缺失或格式错误
40150400"Access Denied: bad signature"sign缺失或格式错误