调用DetectQRCodes接口检测图片中二维码的位置和内容。
接口说明
建议使用DetectImageQRCodes接口来替代此接口,以获得统一、便捷的使用体验。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | DetectQRCodes |
操作接口名称,固定取值为DetectQRCodes。 |
Project | String | 是 | immimagetest |
项目名称。 |
SrcUris | String | 是 | [“oss://imm-test/testcases/QRcodetest.jpg”] |
图片的OSS URI,以JSON格式的字符串表示。当前仅支持1张图片。 OSS地址规则为 |
RegionId | String | 否 | cn-hangzhou |
项目所在地域的ID。 地域Endpoint格式为 |
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
FailDetails | Array of FailDetails |
失败项目列表。 |
|
ErrorCode | String | InvalidSrcUris |
错误码。 |
ErrorMessage | String | The resource SrcUris is not valid. Please check. |
错误信息。 |
SrcUri | String | oss://imm-test/testcases/QRcodetest.jpg |
图片的OSS URI。 |
RequestId | String | E6A558B8-87C1-45BE-90B9-26049B0BAB01 |
当次请求的Request ID。 |
SuccessDetails | Array of SuccessDetails |
成功项目列表。 |
|
QRCodes | Array of QRCodes |
识别出的二维码信息。 目前最多只能返回一个二维码。 |
|
Content | String | https://www.aliyun.com/product/imm |
二维码内容。 |
QRCodesRectangle | Struct |
二维码位置框信息。 |
|
Height | String | 706 |
二维码位置框高度。单位为px。 |
Left | String | 460 |
顶点X坐标,距离左端距离。单位为px。 |
Top | String | 295 |
顶点Y坐标,距离顶端距离。单位为px。 |
Width | String | 741 |
二维码位置框宽度。单位为px。 |
SrcUri | String | oss://imm-test/testcases/QRcodetest.jpg |
图片的OSS URI。 |
示例
请求示例
http(s)://[Endpoint]/?Action=DetectQRCodes
&Project=immimagetest
&SrcUris=[“oss://imm-test/testcases/QRcodetest.jpg”]
&<公共请求参数>
正常返回示例
XML
格式
<SuccessDetails>
<SrcUri>oss://imm-test/testcases/QRcodetest.jpg</SrcUri>
<QRCodes>
<QRCodesRectangle>
<Left>460</Left>
<Top>295</Top>
<Height>706</Height>
<Width>741</Width>
</QRCodesRectangle>
<Content>https://www.aliyun.com/product/imm</Content>
</QRCodes>
</SuccessDetails>
<RequestId>E6A558B8-87C1-45BE-90B9-26049B0BAB01</RequestId>
JSON
格式
{
"SuccessDetails": [
{
"SrcUri": "oss://imm-test/testcases/QRcodetest.jpg",
"QRCodes": [
{
"QRCodesRectangle": {
"Left": 460,
"Top": 295,
"Height": 706,
"Width": 741
},
"Content": "https://www.aliyun.com/product/imm"
}
]
}
],
"RequestId": "E6A558B8-87C1-45BE-90B9-26049B0BAB01",
"FailDetails": []
}
错误码
HTTP状态码 |
错误码 |
错误信息 |
描述 |
---|---|---|---|
400 |
InvalidSrcUris |
The resource SrcUris is not valid. Please check. |
图片资源无效、文件格式错误或文件不存在。 |
400 |
InvalidParameter.SrcUris.NotSupported |
The input parameter SrcUris is not supported. Support valid OSS uri in same region. |
SrcUri文件路径错误,需要使用正确的OSS格式的路径。 |