文档中心
快递面单OCR识别接口文档 API调试工具

一、快递面单OCR识别接口

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

1.1 接口格式

POST application/x-www-form-urlencoded

1.2 请求地址

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

1.3 请求参数

请求参数(header)

名称类型默认值
Content-Typestringapplication/x-www-form-urlencoded

请求参数(body)

参数名称数据类型是否必填参数描述
keystring授权码,请申请企业版获取
paramObject由其他参数拼接

param数据结构

参数名称数据类型是否必填参数描述
imagestring图像数据,base64编码,要求base64编码后大小不超过4M,支持jpg/jpeg/png/bmp格式,image、imageUrl、pdfUrl三者必填其一,优先顺序:image>imageUrl>padUrl
enableTiltbool是否兼容图像倾斜,true:是;false:否,默认不检测,即:false
includestring []需要检测识别的面单元素。取值范围:barcode,qrcode,receiver,sender,bulkpen。不传或者 null 则默认为 ["barcode", "receiver", "sender"]
imageUrlstring图片URL。image、imageUrl、pdfUrl三者必填其一,优先顺序:image>imageUrl>padUrl,最大长度不超过1024b,下载超时默认为2s
pdfUrlstringPDF文件URL。image、imageUrl、pdfUrl三者必填其一,优先顺序:image>imageUrl>padUrl,最大长度不超过1024b,下载超时默认为2s

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
}

提供面单样式示例

1.5 返回结果

参数名称数据类型是否必填参数描述
codenumber状态代码,200为成功,具体参考1.7 信息代码含义
dataObject返回数据明细

data数据结构

参数名称数据类型是否必填参数描述
barcodestring[]条形码值
qrcodestring[]二维码值
ΘreceiverObject收件人信息,明细项目请展开
└ addressstring详细地址
└provincestring
└ citystring
└ countystring县/区
└ mobilestring电话
└ namestring姓名
└ textstring原始文本
└confidencenumber可信度,仅供参考
ΘsenderObject寄件人信息,明细项目请展开
└ addressstring详细地址
└provincestring
└ citystring
└ countystring县/区
└ mobilestring电话
└ namestring姓名
└ textstring原始文本
└confidencenumber可信度
ΘbulkpenObject大头笔信息,明细项目请展开
└confidencenumber可信度
└ textstring原始文本
taskIdstring任务ID
messagestring错误信息

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"
		}
	},
	"message": "SUCCESS",
	"taskId": "e6fb8cac3afa42d3908c633179ed3d9a"
}

1.7 信息代码含义

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