本文介绍文字识别(ocr)类目下的二维码识别RecognizeQrCode的语法及示例。

功能描述

二维码识别能力可以识别图像中是否含有二维码信息,输出图像中二维码包含的文本信息(每个二维码对应的URL或文本),可支持图像中含有多个二维码识别。

说明
  • 在同时检测多个Task的情况下,将按照Task的个数进行累计计费。
  • 您可以进入在线咨询获取在线人工帮助。
  • 当前能力可在视觉智能开放平台有完整的免费产品体验,您可以单击立即试用对该能力进行更直观试用以及在线购买。
  • 阿里云视觉智能开放平台视觉AI能力API接入、接口使用或问题咨询等,请通过钉钉群(23109592)加入阿里云视觉智能开放平台咨询群联系我们。

接入指引

1. 注册阿里云账号:打开阿里云官网,在阿里云官网右上角,单击立即注册,按照操作提示完成账号注册。

2. 开通能力:请确保您已开通文字识别服务,若未开通服务请立即开通

3. 创建AccessKey:请确保您已创建AccessKey,如果您使用的是子账号AccessKey,您需要给子账号赋予AliyunVIAPIFullAccess权限,具体操作,请参见RAM授权

4. 在线调试(可选):您可以通过OpenAPI Explorer在线调试能力,查看完整的调用示例代码及SDK依赖信息,也可以下载完整的工程。

5. 开发接入步骤:

  • SDK总览中选择您要接入使用的SDK语言。
  • 在对应语言的SDK文档中找到AI类目为文字识别(ocr)的SDK包进行安装。
  • 参考文档中提供的示例代码进行适当修改后调用。

6. 示例代码:该能力常用语言的示例代码,请参见二维码识别示例代码

7. 客户端直接调用:该能力常用的客户端调用方式包括以下几种。

输入限制

  • 图像格式:PNG、JPG、JPEG、BMP、GIF、WEBP。
  • 图像大小:不超过10 MB。如您有大图需求,请通过钉钉群(23109592)联系我们。
  • 图像分辨率:建议不低于256×256像素,分辨率过低可能会影响识别效果。
  • URL地址中不能包含中文字符。
  • 仅支持二维码图片识别,其他类型的码不支持。

检测说明

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

计费说明

关于二维码识别的计费方式及报价,请参见计费介绍

说明 下方调试接口为付费接口,如需免费体验调试请前往体验中心

调试

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

请求参数

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

系统规定参数。取值:RecognizeQrCode

Tasks.N.ImageURL String http://viapi-test.oss-cn-shanghai.aliyuncs.com/viapi-3.0domepic/ocr/RecognizeQrCode/RecognizeQrCode6.jpg

待检测图像的URL地址。JSON数组中的每个元素是一个图片检测任务结构体(image表)。最多支持10个元素,即最多同时对10张图片进行检测。推荐使用上海地域的OSS链接,对于文件在本地或者非上海地域OSS链接的情况,请参见文件URL处理

返回数据

名称 类型 示例值 描述
RequestId String A53DC437-F883-4968-86D5-EB21FB044692

请求ID。

Data Object

返回的结果数据内容。

Elements Array of Element

识别返回的元素信息。

ImageURL String http://viapi-test.oss-cn-shanghai.aliyuncs.com/viapi-3.0domepic/ocr/RecognizeQrCode/RecognizeQrCode6.jpg

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

TaskId String img5iGtwVIxQzc4Nqy$L84yHd-1v****

该检测任务的ID。

Results Array of Result

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

Suggestion String review

建议您执行的操作,取值包括:

  • pass:图片正常,无需进行其余操作。
  • review:检测结果不确定,需要进行人工审核。
  • block:图片违规,建议执行进一步操作(如直接删除或做限制处理)。
QrCodesData Array of String https://yqh.aliyun.com/live/detail/23798

图片中含有二维码时,返回图片中二维码包含的文本信息(每个二维码对应的URL或者文本)。

说明 不是所有的二维码图片都能识别返回出对应的URL或文本。
  • Suggestionreview时说明识别到的二维码不含对应的URL或文本信息,QrCodesData不会透出对应信息。
  • Suggestionblock时会携带识别到的对应二维码的URL或文本信息进行透出。
Label String qrcode

检测结果的分类,取值包括:

  • normal:正常图片。
  • qrcode:含二维码的图片。
  • programCode:含小程序码的图片。
说明 默认不识别小程序码。如果需要识别,请通过钉钉群(23109592)联系我们。
Rate Float 99.91

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

SDK参考

阿里云视觉AI文字识别类目下的二维码识别能力推荐使用SDK调用,支持多种编程语言,调用时请选择AI类目为文字识别(ocr)的SDK包,文件参数通过SDK调用可支持本地文件及任意URL,具体可参见SDK总览

示例代码

该能力常用语言的示例代码,请参见二维码识别示例代码

示例

请求示例

http(s)://ocr.cn-shanghai.aliyuncs.com/?Action=RecognizeQrCode      //更多关于访问域名(Endpoint)信息,请参见:https://help.aliyun.com/document_detail/143103.html
&Tasks=[{"ImageURL":"http://viapi-test.oss-cn-shanghai.aliyuncs.com/viapi-3.0domepic/ocr/RecognizeQrCode/RecognizeQrCode6.jpg"}]
&公共请求参数

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<RecognizeQrCodeResponse>
    <RequestId>A53DC437-F883-4968-86D5-EB21FB044692</RequestId>
    <Data>
        <Elements>
            <ImageURL>http://viapi-test.oss-cn-shanghai.aliyuncs.com/viapi-3.0domepic/ocr/RecognizeQrCode/RecognizeQrCode6.jpg</ImageURL>
            <TaskId>img5iGtwVIxQzc4Nqy$L84yHd-1v****</TaskId>
            <Results>
                <Suggestion>review</Suggestion>
                <QrCodesData>https://yqh.aliyun.com/live/detail/23798</QrCodesData>
                <Label>qrcode</Label>
                <Rate>99.91</Rate>
            </Results>
        </Elements>
    </Data>
</RecognizeQrCodeResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "A53DC437-F883-4968-86D5-EB21FB044692",
  "Data" : {
    "Elements" : [ {
      "ImageURL" : "http://viapi-test.oss-cn-shanghai.aliyuncs.com/viapi-3.0domepic/ocr/RecognizeQrCode/RecognizeQrCode6.jpg",
      "TaskId" : "img5iGtwVIxQzc4Nqy$L84yHd-1v****",
      "Results" : [ {
        "Suggestion" : "review",
        "QrCodesData" : [ "https://yqh.aliyun.com/live/detail/23798" ],
        "Label" : "qrcode",
        "Rate" : 99.91
      } ]
    } ]
  }
}

错误码

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

安全声明

  • 请确保上传的图片或文件来源符合相应的法律法规。
  • 通过体验调试上传的临时文件有效期为1小时,在24小时后会被系统自动清理删除。