一、快递面单OCR识别接口
识别电子面单图片，提取包括收件人和寄件人的姓名、电话、地址以及运单号等字段的信息。
1.1 接口格式
POST application/x-www-form-urlencoded
1.2 请求地址
http://api.kuaidi100.com/elec/detocr
1.3 请求参数
请求参数（header）
| 名称 | 类型 | 默认值 |
|---|---|---|
| Content-Type | string | application/x-www-form-urlencoded |
请求参数（body）
| 参数名称 | 数据类型 | 是否必填 | 参数描述 |
|---|---|---|---|
| key | string | 是 | 授权码，请申请企业版获取 |
| param | Object | 是 | 由其他参数拼接 |
param数据结构
| 参数名称 | 数据类型 | 是否必填 | 参数描述 |
|---|---|---|---|
| image | string | 否 | 图像数据，base64编码，要求base64编码后大小不超过4M,支持jpg/jpeg/png/bmp格式，image、imageUrl、pdfUrl、htmlUrl必填其一，优先顺序：image>imageUrl>pdfUrl>htmlUrl 。注：图片base64编码后需去除图片头，如（data:image/jpg;base64,） |
| imageUrl | string | 否 | 图片URL。image、imageUrl、pdfUrl、htmlUrl必填其一，优先顺序：image>imageUrl>padUrl>htmlUrl，最大长度不超过1024，下载超时默认为2s |
| pdfUrl | string | 否 | PDF文件URL。image、imageUrl、pdfUrl、htmlUrl必填其一，优先顺序：image>imageUrl>padUrl>htmlUrl，最大长度不超过1024，下载超时默认为2s |
| htmlUrl | string | 否 | 自动把html转换成图片。image、imageUrl、pdfUrl、htmlUrl必填其一，优先顺序：image>imageUrl>padUrl>htmlUrl，最大长度不超过1024，下载超时默认为2s |
| enableTilt | bool | 否 | 是否兼容图像倾斜、旋转以及拍照场景中背景干扰内容过多的复杂场景，true：是；false：否，默认不检测，即：false。 |
| include | string [] | 否 | 需要检测识别的面单元素。取值范围：barcode,qrcode,receiver,sender,bulkpen,expType,collectPoint,endPoint。不传或者 null 则默认为 ["barcode", "receiver", "sender"] |
1.4 请求参数示例
key = ** *
param = {
"enableTilt": false,
"include": [
"barcode",
"receiver",
"sender"
],
"image": null,
"imageUrl": "https://cdn.kuaidi100.com/images/openapi/document/ocr_tem.png",
"pdfUrl": null,
"htmlUrl": null
}
提供面单样式示例
1.5 返回结果
| 参数名称 | 数据类型 | 是否必填 | 参数描述 |
|---|---|---|---|
| code | number | 否 | 状态代码，200为成功，具体参考1.7 信息代码含义 |
| data | Object | 否 | 返回数据明细 |
| taskId | string | 否 | 任务ID |
| message | string | 否 | 错误信息 |
data数据结构
| 参数名称 | 数据类型 | 是否必填 | 参数描述 |
|---|---|---|---|
| barcode | string[] | 否 | 条形码值 |
| qrcode | string[] | 否 | 二维码值 |
| Θreceiver | Object | 否 | 收件人信息，明细项目请展开 |
| └ address | string | 否 | 详细地址 |
| └province | string | 否 | 省 |
| └ city | string | 否 | 市 |
| └ county | string | 否 | 县/区 |
| └ mobile | string | 否 | 电话 |
| └ name | string | 否 | 姓名 |
| └ text | string | 否 | 原始文本 |
| └confidence | number | 否 | 可信度，仅供参考 |
| Θsender | Object | 否 | 寄件人信息，明细项目请展开 |
| └ address | string | 否 | 详细地址 |
| └province | string | 否 | 省 |
| └ city | string | 否 | 市 |
| └ county | string | 否 | 县/区 |
| └ mobile | string | 否 | 电话 |
| └ name | string | 否 | 姓名 |
| └ text | string | 否 | 原始文本 |
| └confidence | number | 否 | 可信度 |
| Θbulkpen | array[Object] | 否 | 大头笔信息，明细项目请展开 |
| └confidence | number | 否 | 可信度 |
| └ text | string | 否 | 原始文本 |
| ΘexpType | Object | 否 | 业务类型 |
| └confidence | number | 否 | 可信度 |
| └ text | string | 否 | 原始文本 |
| waybill | string | 否 | 运单号 |
| ΘcollectPoint | Object | 否 | 集包地 |
| └confidence | number | 否 | 可信度 |
| └ text | string | 否 | 原始文本 |
| ΘendPoint | Object | 否 | 末端承运商 |
| └confidence | number | 否 | 可信度 |
| └ text | string | 否 | 原始文本 |
1.6 返回参数示例
{
"code": 200,
"data": {
"barcode": [
"TB0478895170"
],
"receiver": {
"address": "科技南十二路金蝶软件园",
"city": "深圳市",
"confidence": 0.93,
"county": "南山区",
"mobile": "13888888888",
"name": "张三",
"province": "广东",
"text": "张三13888888888广东深圳市深圳市南山区科技南十二路金蝶软件园"
},
"sender": {
"address": "科技南十二路金蝶软件园B10",
"city": "深圳市",
"confidence": 0.93,
"county": "南山区",
"mobile": "13888888888",
"name": "李四",
"province": "广东",
"text": "李四13888888888广东深圳市深圳市南山区科技南十二路金蝶软件园B10"
},
"waybill": "TB0478895170"
},
"message": "SUCCESS",
"taskId": "e6fb8cac3afa42d3908c633179ed3d9a"
}
1.7 信息代码含义
| 信息代码 | 信息内容描述 | 原因及建议处理方式 |
|---|---|---|
| 200 | 成功 | 成功 |
| 601 | key已过期 | 没有可用单量，账号不存在或者没有该接口权限 |
| 400 | 请求参数错误 | 详情见message提示 |
| 500 | 识别错误，请稍后重试 | 识别错误，请稍后重试 |
