本文档介绍二维码识别RecognizeQrCode的语法及示例。

功能描述

RecognizeQrCode可以识别图像中是否含有二维码信息，输出图像中二维码包含的文本信息（每个二维码对应的URL或文本），可支持图像中含有多个二维码识别。

前提条件

请确保您已开通文字识别服务，详情请参见服务开通。

输入限制

  • 图片格式：PNG、JPG、JPEG、BMP、GIF、WEBP。
  • 图片大小：大小不超过10MB。如您有大图需求，请提工单申请。
  • 图片像素：建议不低于256×256，像素过低可能会影响识别效果。
  • URL地址中不能包含中文字符。

检测说明

  • 最长检测时间是6秒，如果在该时间限制内没有完成检测，系统会强制返回超时错误码。
  • 图片下载时间限制为3秒，如果下载时间超过3秒，返回下载超时。
  • 图片检测接口响应时间依赖图片的下载时间。请保证被检测图片所在的存储服务稳定可靠，建议您使用阿里云OSS存储或者CDN缓存等。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称 类型 是否必选 示例值 描述
Action String 是 RecognizeQrCode

要执行的操作。取值：RecognizeQrCode。
Tasks.N.ImageURL String 是 https://xxx.jpg

待检测图像的URL地址。JSON数组中的每个元素是一个图片检测任务结构体（image表）。最多支持10个元素，即最多同时对10张图片进行检测。当前仅支持上海地域的OSS链接，如何生成URL请参见生成URL。

返回数据

名称 类型 示例值 描述
Data Struct

返回的结果数据内容。
Elements Array

识别返回的元素信息。
ImageURL String https://timgsa.baidu.com/timg?image&quality=80&size=b9999_10000&sec=1581673386305&di=23d9a0a85bf0dbd3a6779d0bf878474a&imgtype=0&src=http%3A%2F%2Fpicapi.zhituad.com%2Fphoto%2F486%2F65%2F53ECA.jpg

对应请求中的图像URL地址。
Results Array

返回结果。调用成功时返回结果中包含一个或多个元素。
Label String qrcode

检测结果的分类，取值包括：

  • normal：正常图片。
  • qrcode：含二维码的图片。
  • programCode：含小程序码的图片。
说明 默认不识别小程序码。如果需要识别，请提工单申请。
QrCodesData List http://weixin.qq.com/r/_UwoMKDEDP1zreRT9xnr

图片中含有二维码时，返回图片中二维码包含的文本信息（每个二维码对应的URL或者文本）。
Rate Float 99.91

结果为该分类的概率，取值范围为[0.00-100.00]。值越高，表示越有可能属于该分类。

Suggestion String review

建议您执行的操作，取值包括：

  • pass：图片正常，无需进行其余操作
  • review：检测结果不确定，需要进行人工审核
  • block：图片违规，建议执行进一步操作（如直接删除或做限制处理）
TaskId String img18Uu1GBIkOp4V1pJa0SLI$-1s827C

该检测任务的ID。
RequestId String A53DC437-F883-4968-86D5-EB21FB044692

请求ID。

示例

请求示例

http(s)://ocr.cn-shanghai.aliyuncs.com/?Action=RecognizeQrCode
&Tasks.1.ImageURL=https://timgsa.baidu.com/timg?image&quality=80&size=b9999_10000&sec=1581673386305&di=23d9a0a85bf0dbd3a6779d0bf878474a&imgtype=0&src=http%3A%2F%2Fpicapi.zhituad.com%2Fphoto%2F486%2F65%2F53ECA.jpg
&<公共请求参数>

正常返回示例

XML 格式 

<RequestId>A53DC437-F883-4968-86D5-EB21FB044692</RequestId>
<Data>
    <Elements>
        <TaskId>img18Uu1GBIkOp4V1pJa0SLI$-1s827C</TaskId>
        <Results>
            <Suggestion>review</Suggestion>
            <Rate>99.91</Rate>
            <QrCodesData>http://weixin.qq.com/r/_UwoMKDEDP1zreRT9xnr</QrCodesData>
            <Label>qrcode</Label>
        </Results>
        <ImageURL>https://timgsa.baidu.com/timg?image&amp;quality=80&amp;size=b9999_10000&amp;sec=1581673386305&amp;di=23d9a0a85bf0dbd3a6779d0bf878474a&amp;imgtype=0&amp;src=http%3A%2F%2Fpicapi.zhituad.com%2Fphoto%2F486%2F65%2F53ECA.jpg</ImageURL>
    </Elements>
</Data>

JSON 格式 

{
  "RequestId": "A53DC437-F883-4968-86D5-EB21FB044692",
  "Data": {
    "Elements": [
      {
        "TaskId": "img18Uu1GBIkOp4V1pJa0SLI$-1s827C",
        "Results": [
          {
            "Suggestion": "review",
            "Rate": 99.91,
            "QrCodesData": [
              "http://weixin.qq.com/r/_UwoMKDEDP1zreRT9xnr"
            ],
            "Label": "qrcode"
          }
        ],
        "ImageURL": "https://timgsa.baidu.com/timg?image&quality=80&size=b9999_10000&sec=1581673386305&di=23d9a0a85bf0dbd3a6779d0bf878474a&imgtype=0&src=http%3A%2F%2Fpicapi.zhituad.com%2Fphoto%2F486%2F65%2F53ECA.jpg"
      }
    ]
  }
}

错误码

关于二维码识别的错误码，详情请参见常见错误码。