Extract Barcode & QR Code Data with DetectImageCodes API - Intelligent Media Management - Alibaba Cloud - Intelligent Media Management

Operation description

For supported image encoding formats, see Limits on images.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

imm:DetectImageCodes

none

*Project

acs:imm:{#regionId}:{#accountId}:project/{#ProjectName}

None

Request parameters

Parameter	Type	Required	Description	Example
ProjectName	string	Yes	The name of the project. You can obtain it from the response of the CreateProject operation.	test-project
SourceURI	string	Yes	The OSS URI of the image file. Format: oss://${Bucket}/${Object}. `${Bucket}` is the name of an OSS bucket in the same region as the current project. `${Object}` is the complete path to the file, including the extension.	oss://test-bucket/test-object.jpg
CredentialConfig	CredentialConfig	No	Leave this parameter empty unless you have specific requirements. Authorization chain settings. For more information, see Use authorization chains to access resources of other entities.

Response elements

Element	Type	Description	Example
	object	The response parameters.
Codes	array	The barcodes or QR codes.
	Codes	The barcode or QR code information.
RequestId	string	The request ID.	6E93D6C9-5AC0-49F9-914D-E02678D3****

Examples

Success response

JSON format

{
  "Codes": [
    {
      "Content": "https://www.example.com",
      "Confidence": 0.9,
      "Boundary": {
        "Width": 200,
        "Height": 300,
        "Left": 10,
        "Top": 30,
        "Polygon": [
          {
            "X": 10,
            "Y": 10
          }
        ]
      },
      "Type": "qrcode"
    }
  ],
  "RequestId": "6E93D6C9-5AC0-49F9-914D-E02678D3****"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.