快递100 API

快递面单OCR识别接口

POSThttp://api.kuaidi100.com/elec/detocr

识别电子面单图片，提取包括收件人和寄件人的姓名、电话、地址以及运单号等字段的信息。

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"]
提供面单样式示例

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.7 信息代码含义

信息代码	信息内容描述	原因及建议处理方式
200	成功	成功
601	key已过期	没有可用单量，账号不存在或者没有该接口权限
400	请求参数错误	详情见message提示
500	识别错误，请稍后重试	识别错误，请稍后重试

请求参数

Body 参数application/x-www-form-urlencoded

key

string

可选

授权码，请申请企业版获取

param

string

由其他参数拼接

可选

示例代码

返回响应

成功(200)

HTTP 状态码: 200

内容格式: JSONapplication/json

code

integer

状态代码，200为成功，具体参考1.7 信息代码含义

可选

data

object

返回数据明细

可选

barcode

array[string]

错误信息

可选

receiver

object

收件人信息，明细项目请展开

可选

sender

object

寄件人信息，明细项目请展开

可选

waybill

string

必需

message

string

错误信息

可选

taskId

string

任务ID

可选

{
  "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"
}

最后修改时间： 2 年前