文档简介:
接口描述
支持市面上常见版式的快递面单识别,包括申通/圆通/中通/百世汇通/韵达/顺丰/京东/邮政/极兔/天天等面单版式,结构化识别运单号、收/寄件人姓名、收/寄件人电话、收/寄件人地址等字段。同时支持识别隐私面单。
在线调试
您可以在 示例代码中心 中调试该接口,可进行签名验证、查看在线调用的请求内容和返回结果、示例代码的自动生成。
请求说明
请求示例
HTTP 方法:POST
请求URL: https://aip.baidubce.com/rest/2.0/ocr/v1/waybill
URL参数:
参数 | 值 |
---|---|
access_token | 通过API Key和Secret Key获取的access_token,参考“Access Token获取” |
Header如下:
参数 | 值 |
---|---|
Content-Type | application/x-www-form-urlencoded |
Body中放置请求参数,参数详情如下:
请求参数
参数 | 是否必选 | 类型 | 可选值范围 | 说明 |
---|---|---|---|---|
image | 和 url 二选一 | string | - | 图像数据,base64编码后进行urlencode,要求base64编码和urlencode后大小不超过4M,最短边至少15px,最长边最大4096px,支持jpg/jpeg/png/bmp格式 |
url | 和 image 二选一 | string | - |
图片完整url,url长度不超过1024字节,url对应的图片base64编码后大小不超过4M,最短边至少15px,最长边最大4096px,支持jpg/jpeg/png/bmp格式,当image字段存在时url字段失效 请注意关闭URL防盗链 |
is_identify_virtual_waybill | true/false | string | - |
是否需要识别隐私面单, - true:需要识别隐私面单,即此参数存在并填写为true的时候,会增加返回隐私面单的3个字段,详见下方返回参数列表; - false:不识别隐私面单 |
请求代码示例
提示一:使用示例代码前,请记得替换其中的示例Token、图片地址或Base64信息。
提示二:部分语言依赖的类或库,请在代码注释中查看下载地址。
curl -i -k 'https://aip.baidubce.com/rest/2.0/ocr/v1/waybill?access_
token=【调用鉴权接口获取的token】' --data 'image=【图片Base64编码,
需UrlEncode】' -H 'Content-Type:application/x-www-form-urlencoded'
返回说明
返回参数
字段 | 是否必输出 | 类型 | 说明 |
---|---|---|---|
log_id | 是 | uint64 | 调用日志id,用于问题定位 |
words_result | 是 | object | 识别结果 |
words_result_num | 是 | uint32 | 识别结果数,表示words_result的元素个数 |
+ image_info | 是 | object | 图像四方向 |
++ direction | 是 | string | 图像四方向,0表示正向,1/2/3依次表示逆时针旋转90度,180度,270度 |
+ bar_code | 是 | object | 条形码 |
+ waybill_number | 是 | object | 快递运单号 |
+ three_segment_code | 是 | object | 三段码 |
+ recipient_name | 是 | object | 收件人姓名 |
+ sender_name | 是 | object | 寄件人姓名 |
+ recipient_addr | 是 | object | 收件人地址 |
+ sender_addr | 是 | object | 寄件人地址 |
+ recipient_phone | 是 | object | 收件人电话 |
+ sender_phone | 是 | object | 寄件人电话 |
+ virtual_number | 是 | object | 虚拟面单号。当请求参数 is_identify_virtual_waybill = true 时返回该字段 |
+ virtual_number_last | 是 | object | 隐私面单的4位转接号。当请求参数 is_identify_virtual_waybill = true 时返回该字段 |
+ is_virtual_waybill | 是 | object | 此张快递面单是否为隐私面单,“true”代表“是”,“false”代表“否”。当请求参数 is_identify_virtual_waybill = true 时返回该字段 |
++ word | 是 | string | 字段识别结果,以上各字段均包含此参数 |
返回示例
{ "words_result_num": 10, "words_result": [ { "image_info": { "direction": "0" },
"bar_code": [ { "word": "" } ], "waybill_number": [ { "word": "J420222-2013-013228" }
], "three_segment_code": [ { "word": "" } ], "recipient_name": [ { "word": "" } ],
"sender_name": [ { "word": "中国" } ], "recipient_addr": [ { "word": "" } ], "sender_addr":
[ { "word": "" } ], "recipient_phone": [ { "word": "" } ], "sender_phone": [ { "word": "" }
] } ], "log_id": 1654092794470239194 }