条形码识别
接口应在服务器端调用,详细说明参见服务端API。
本接口支持云调用。需开发者工具版本 >=
1.02.1904090
(最新稳定版下载),wx-server-sdk
>=0.4.0
接口说明
接口英文名
scanQRCode
功能描述
该接口用于小程序的条码/二维码识别
注意事项
- 文件大小限制:小于2M
- 支持条码、二维码、DataMatrix和PDF417的识别。 二维码、DataMatrix会返回位置坐标,条码和PDF417暂不返回位置坐标。
调用方式
HTTPS 调用
POST https://api.weixin.qq.com/cv/img/qrcode?access_token=ACCESS_TOKEN
云调用
- 出入参和HTTPS调用相同,调用方式可查看云调用说明文档
- 接口方法为: openapi.img.scanQRCode
请求参数
属性 | 类型 | 必填 | 说明 |
---|---|---|---|
access_token / cloudbase_access_token | string | 是 | 接口调用凭证,该参数为 URL 参数,非 Body 参数。access_token和cloudbase_access_token二选一 其中access_token可通过getAccessToken接口获得; cloudbase_access_token可通过getOpenData接口获得 |
img_url | string | 是 | 要检测的图片 url,传这个则不用传 img 参数。 |
img | FormData | 是 | form-data 中媒体文件标识,有filename、filelength、content-type等信息,传这个则不用传 img_url。 |
返回参数
属性 | 类型 | 说明 | |
---|---|---|---|
errcode | number | 错误码 | |
errmsg | string | 错误信息 | |
code_results | array | 处理结果 | |
属性类型说明type_namestring码的类型datastring码的信息posobject码的坐标属性类型说明left_topobject左上角位置属性类型说明xnumberx坐标ynumbery坐标right_topobject右上角位置属性类型说明xnumberx坐标ynumbery坐标right_bottomobject右下角位置属性类型说明xnumberx坐标ynumbery坐标left_bottomobject左下角位置属性类型说明xnumberx坐标ynumbery坐标 | |||
img_size | object | 图片大小 | |
属性类型说明wnumber宽度hnumber高度 |
调用示例
示例说明: HTTPS请求示例
请求数据示例
curl -F 'img=@test.jpg' 'https://api.weixin.qq.com/cv/img/qrcode?access_token=ACCESS_TOCKEN'
返回数据示例
{
"errcode": 0,
"errmsg": "ok",
"code_results": [
{
"type_name": "QR_CODE",
"data": "http://www.qq.com",
"pos": {
"left_top": {
"x": 585,
"y": 378
},
"right_top": {
"x": 828,
"y": 378
},
"right_bottom": {
"x": 828,
"y": 618
},
"left_bottom": {
"x": 585,
"y": 618
}
}
},
{
"type_name": "QR_CODE",
"data": "https://mp.weixin.qq.com",
"pos": {
"left_top": {
"x": 185,
"y": 142
},
"right_top": {
"x": 396,
"y": 142
},
"right_bottom": {
"x": 396,
"y": 353
},
"left_bottom": {
"x": 185,
"y": 353
}
}
},
{
"type_name": "EAN_13",
"data": "5906789678957"
},
{
"type_name": "CODE_128",
"data": "50090500019191"
}
],
"img_size": {
"w": 1000,
"h": 900
}
}
错误码
错误码 | 错误码取值 | 解决方案 |
---|---|---|
-1 | system error | 系统繁忙,此时请开发者稍候再试 |
40001 | invalid credential access_token isinvalid or not latest | 获取 access_token 时 AppSecret 错误,或者 access_token 无效。请开发者认真比对 AppSecret 的正确性,或查看是否正在为恰当的公众号调用接口 |
101000 | invalid image url |