本接口应在服务器端调用,详细说明参见 服务端API。
本接口支持 云调用。需开发者工具版本 >= 1.02.1904090(最新 稳定版下载)
wx-server-sdk >= 0.4.0
本接口提供基于小程序的条码/二维码识别的API。
调用方式:
POST https://api.weixin.qq.com/cv/img/qrcode?img_url=ENCODE_URL&access_token=ACCESS_TOCKEN
| 属性 | 类型 | 默认值 | 必填 | 说明 | 
|---|---|---|---|---|
| access_token | string | 是 | 接口调用凭证 | |
| img_url | string | 是 | 要检测的图片 url,传这个则不用传 img 参数。 | |
| img | FormData | 是 | form-data 中媒体文件标识,有filename、filelength、content-type等信息,传这个则不用传 img_url。 | 
返回的 JSON 数据包
| 属性 | 类型 | 说明 | 
|---|---|---|
| errcode | string | 错误码 | 
| errmsg | string | 错误信息 | 
图片说明 文件大小限制:小于2M
二维码说明 支持条码、二维码、DataMatrix和PDF417的识别。 二维码、DataMatrix会返回位置坐标,条码和PDF417暂不返回位置坐标。
示例1:
curl https://api.weixin.qq.com/cv/img/qrcode?img_url=ENCODE_URL&access_token=ACCESS_TOCKEN
示例2:
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
    }
}
云调用是小程序·云开发提供的在云函数中调用微信开放接口的能力,需要在云函数中通过 wx-server-sdk 使用。
openapi.img.scanQRCode
需在 config.json 中配置 img.scanQRCode API 的权限, 详情
| 属性 | 类型 | 默认值 | 必填 | 说明 | 
|---|---|---|---|---|
| imgUrl | string | 是 | 要检测的图片 url,传这个则不用传 img 参数。 | |
| img | FormData | 是 | form-data 中媒体文件标识,有filename、filelength、content-type等信息,传这个则不用传 img_url。 | 
img 的结构
| 属性 | 类型 | 默认值 | 必填 | 说明 | 
|---|---|---|---|---|
| contentType | string | 是 | 数据类型,传入 MIME Type | |
| value | Buffer | 是 | 文件 Buffer | 
返回的 JSON 数据包
| 属性 | 类型 | 说明 | 
|---|---|---|
| errCode | string | 错误码 | 
| errMsg | string | 错误信息 | 
抛出的异常
| 属性 | 类型 | 说明 | 
|---|---|---|
| errCode | string | 错误码 | 
| errMsg | string | 错误信息 | 
errCode 的合法值
| 值 | 说明 | 最低版本 | 
|---|
图片说明 文件大小限制:小于2M
二维码说明 支持条码、二维码、DataMatrix和PDF417的识别。 二维码、DataMatrix会返回位置坐标,条码和PDF417暂不返回位置坐标。
{
    "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
    }
}