CreatePhoneMessageQrdl-阿里云帮助中心

Creates a message QR code.

Operation description

After a QR code is created, users can scan it with WhatsApp to start a chat with your business number.
Before calling this API, make sure you have a WhatsApp channel.
If you do not have a WhatsApp channel, create one on the Channel Management page.

QPS limit

This API is limited to 5 queries per second (QPS) for each user. If you exceed this limit, API calls are throttled, which can affect your business. Call this API within the specified limit.

Try it now

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

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

cams:CreatePhoneMessageQrdl

create

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
PhoneNumber	string	Yes	The phone number. To view phone numbers, go to the Channel Management, select a WhatsApp channel, then choose WABA Management. The phone numbers are Phone Number Management page.	86138009****
GenerateQrImage	string	Yes	The type of the image to generate. Valid values: SVG : SVG PNG : PNG	PNG
PrefilledMessage	string	Yes	The message content.	test
CustSpaceId	string	No	The space ID of the ISV sub-customer or the instance ID of a direct customer. View the space ID on the Channel Management page.	cams-kei****

Response elements

Element	Type	Description	Example
	object
AccessDeniedDetail	string	The details about the access denial.	None
RequestId	string	The request ID.	90E63D28-E31D-1EB2-8939-A94866411B2O
Message	string	The error message.	None
Data	object	The returned data.
QrImageUrl	string	The URL of the QR code.	http://img.png
PhoneNumber	string	The phone number.	86138009****
QrdlCode	string	The code.	D9II3***
DeepLinkUrl	string	The deep link URL.	https://wa.qrdl/
GenerateQrImage	string	The type of the generated image.	PNG
PrefilledMessage	string	The message content.	Hello
Code	string	The error code. For more information, see Error codes.	OK

Examples

Success response

JSON format

{
  "AccessDeniedDetail": "None",
  "RequestId": "90E63D28-E31D-1EB2-8939-A94866411B2O\n",
  "Message": "None",
  "Data": {
    "QrImageUrl": "http://img.png",
    "PhoneNumber": "86138009****",
    "QrdlCode": "D9II3***",
    "DeepLinkUrl": "https://wa.qrdl/",
    "GenerateQrImage": "PNG",
    "PrefilledMessage": "Hello"
  },
  "Code": "OK"
}

Error codes

HTTP status code	Error code	Error message	Description
400	Product.Unsubscript	You have not subscribed to the specified product.	You have not subscribed to the specified product.
400	Ram.PermissionDeny	You are not authorized to perform the operation.
400	System.LimitControl	The system is under flow control.	The system is under flow control.
400	Unknown.ResourceOwnerId	The resource does not belong to the current user.	The resource does not belong to the current user.

See for a complete list.

Release notes

See 变更详情 for a complete list.