img.scanQRCode

本接口应在服务器端调用，详细说明参见服务端API。

本接口支持云调用。需开发者工具版本 >= 1.02.1904090（最新稳定版下载），wx-server-sdk >= 0.4.0

本接口提供基于小程序的条码/二维码识别的API。

调用方式：

HTTPS 调用

请求地址

  1. POST https://api.weixin.qq.com/cv/img/qrcode?img_url=ENCODE_URL&access_token=ACCESS_TOCKEN

请求参数

属性类型默认值必填说明
access_tokenstring是接口调用凭证
img_urlstring是要检测的图片 url，传这个则不用传 img 参数。
imgFormData是form-data 中媒体文件标识，有filename、filelength、content-type等信息，传这个则不用传 img_url。

返回值

Object

返回的 JSON 数据包

属性类型说明
errcodestring错误码
errmsgstring错误信息

使用说明

图片说明文件大小限制：小于2M

二维码说明支持条码、二维码、DataMatrix和PDF417的识别。二维码、DataMatrix会返回位置坐标，条码和PDF417暂不返回位置坐标。

请求数据示例

示例1：

  1. curl https://api.weixin.qq.com/cv/img/qrcode?img_url=ENCODE_URL&access_token=ACCESS_TOCKEN

示例2：

  1. curl -F 'img=@test.jpg' 'https://api.weixin.qq.com/cv/img/qrcode?access_token=ACCESS_TOCKEN'

返回数据示例

  1. {
  2.     "errcode": 0,
  3.     "errmsg": "ok",
  4.     "code_results": [
  5.         {
  6.             "type_name": "QR_CODE",
  7.             "data": "http://www.qq.com",
  8.             "pos": {
  9.                 "left_top": {
  10.                     "x": 585,
  11.                     "y": 378
  12.                 },
  13.                 "right_top": {
  14.                     "x": 828,
  15.                     "y": 378
  16.                 },
  17.                 "right_bottom": {
  18.                     "x": 828,
  19.                     "y": 618
  20.                 },
  21.                 "left_bottom": {
  22.                     "x": 585,
  23.                     "y": 618
  24.                 }
  25.             }
  26.         },
  27.         {
  28.             "type_name": "QR_CODE",
  29.             "data": "https://mp.weixin.qq.com",
  30.             "pos": {
  31.                 "left_top": {
  32.                     "x": 185,
  33.                     "y": 142
  34.                 },
  35.                 "right_top": {
  36.                     "x": 396,
  37.                     "y": 142
  38.                 },
  39.                 "right_bottom": {
  40.                     "x": 396,
  41.                     "y": 353
  42.                 },
  43.                 "left_bottom": {
  44.                     "x": 185,
  45.                     "y": 353
  46.                 }
  47.             }
  48.         },
  49.         {
  50.             "type_name": "EAN_13",
  51.             "data": "5906789678957"
  52.         },
  53.         {
  54.             "type_name": "CODE_128",
  55.             "data": "50090500019191"
  56.         }
  57.     ],
  58.     "img_size": {
  59.         "w": 1000,
  60.         "h": 900
  61.     }
  62. }

云调用

云调用是小程序·云开发提供的在云函数中调用微信开放接口的能力，需要在云函数中通过 wx-server-sdk 使用。

接口方法

  1. openapi.img.scanQRCode

需在 config.json 中配置 img.scanQRCode API 的权限，详情

请求参数

属性类型默认值必填说明
imgUrlstring是要检测的图片 url，传这个则不用传 img 参数。
imgFormData是form-data 中媒体文件标识，有filename、filelength、content-type等信息，传这个则不用传 img_url。

img 的结构

属性类型默认值必填说明
contentTypestring是数据类型，传入 MIME Type
valueBuffer是文件 Buffer

返回值

Object

返回的 JSON 数据包

属性类型说明
errCodestring错误码
errMsgstring错误信息

异常

Object

抛出的异常

属性类型说明
errCodestring错误码
errMsgstring错误信息

errCode 的合法值

值说明最低版本

使用说明

图片说明文件大小限制：小于2M

二维码说明支持条码、二维码、DataMatrix和PDF417的识别。二维码、DataMatrix会返回位置坐标，条码和PDF417暂不返回位置坐标。

返回数据示例

  1. {
  2.     "errcode": 0,
  3.     "errmsg": "ok",
  4.     "code_results": [
  5.         {
  6.             "type_name": "QR_CODE",
  7.             "data": "http://www.qq.com",
  8.             "pos": {
  9.                 "left_top": {
  10.                     "x": 585,
  11.                     "y": 378
  12.                 },
  13.                 "right_top": {
  14.                     "x": 828,
  15.                     "y": 378
  16.                 },
  17.                 "right_bottom": {
  18.                     "x": 828,
  19.                     "y": 618
  20.                 },
  21.                 "left_bottom": {
  22.                     "x": 585,
  23.                     "y": 618
  24.                 }
  25.             }
  26.         },
  27.         {
  28.             "type_name": "QR_CODE",
  29.             "data": "https://mp.weixin.qq.com",
  30.             "pos": {
  31.                 "left_top": {
  32.                     "x": 185,
  33.                     "y": 142
  34.                 },
  35.                 "right_top": {
  36.                     "x": 396,
  37.                     "y": 142
  38.                 },
  39.                 "right_bottom": {
  40.                     "x": 396,
  41.                     "y": 353
  42.                 },
  43.                 "left_bottom": {
  44.                     "x": 185,
  45.                     "y": 353
  46.                 }
  47.             }
  48.         },
  49.         {
  50.             "type_name": "EAN_13",
  51.             "data": "5906789678957"
  52.         },
  53.         {
  54.             "type_name": "CODE_128",
  55.             "data": "50090500019191"
  56.         }
  57.     ],
  58.     "img_size": {
  59.         "w": 1000,
  60.         "h": 900
  61.     }
  62. }