You need to enable JavaScript to run this app.
导航

调用方式

最近更新时间2023.08.07 16:49:35

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

接口简介

支持识别飞机行程单关键字段,返回结构化信息。

限制条件
名称内容
输入要求1. 文件格式:支持JPG、JPEG、PNG、BMP、PDF等常见格式,建议使用JPG格式。
2. 图片像素尺寸:为了保证文字识别效果,推荐图片中行程单最短边长不低于256像素。
3. 文件大小:
a.要求Base64编码和urlencode之后不超过 8 MB。行程单主体尽量占据图片主要区域。
b.如果传图片及PDF完整URL,URL对应文件大小建议不要超过8MB。
4. 输入文件过大时,返回的HttpCode如下:400/413/502。
5. 注意图片质量:保证行程单图片足够清晰,不应该有因为压缩导致的噪声,避免对行程单正反面的遮挡、不当的光照(强光、暗光、逆光)等,否则会降低结果准确度。
6. 图片需要有版权,有肖像权,没有法律或者政策风险的。相关风险请注意评估。
7. 输入多页PDF时,默认只识别第一页。
请求说明

基本信息

名称内容
接口地址https://visual.volcengineapi.com
请求方式POST
Content-Typeapplication/x-www-form-urlencoded (传入参数不包含类型File)
是否需要鉴权

请求参数

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-typehost 为必选头部;
-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接口名,取值:OcrFlightInvoice
Version必选String版本号,取值:2020-08-26

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 字段说明

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

main_info 字段说明

字段类型说明备注
titleString发票抬头主页信息
nameString姓名主页信息
id_noString身份证号主页信息
fareString票价主页信息
civil_aviation_development_fundString民航发展基金主页信息
fuel_surchargeString燃油附加税主页信息
other_taxesString其他税费主页信息
totalString合计费用主页信息
e_ticket_noString电子客票号主页信息
ckString验证码主页信息
insuranceString保险费主页信息
date_of_issueString填开日期主页信息
agent_codeString销售单位代号主页信息
issued_byString填开单位主页信息
internationString国际主页信息
fromString起始站主页信息
toString终点站主页信息
carrierString承运人主页信息
flightString航班号主页信息
classString座位等级主页信息
dateString日期主页信息
timeString时间主页信息
fare_basisString客票等级主页信息

输出示例

主页面图片返回值示例

{
   "code":10000,
   "data":{
      "invoice_main":{
         "title":"航空运输电子客票行程单",
         "name":"李XX",
         "id_no":"640103********0336",
         "fuel_surcharge":"40.00",
         "fare":"1130",
         "civil_aviation_development_fund":"CY50.",
         "total":"1220.00",
         "e_ticket_no":"8803****1619",
         "date_of_issue":"2010-06-14",
         "agent_code":"WTR****SXY",
         "issued_by":"苏州快平航空票务服务",
         "from":"上海浦东",
         "to":"西安 XIY",
         "time":"19JUN",
         "fare_basis":"562"
      }
   },
   "message":"Success",
   "request_id":"68985943324423639171606204159",
   "status":10000,
   "time_elapsed":"371.220366ms"
}
错误码

通用错误码

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

业务错误码

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"内部错误,需要联系开发人员