All Products
Search
Document Center

Chat App Message Service:CreatePhoneMessageQrdl

Last Updated:Nov 18, 2024

Creates a quick-response (QR) code that contains a message.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
cams:CreatePhoneMessageQrdlget
*All Resources
*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
PhoneNumberstringYes

The phone number. Add the country code before the phone number.

861380000
GenerateQrImagestringYes

Produce QR code image format.

Enumeration Value:
  • SVG: SVG.
  • PNG: PNG.
PNG
PrefilledMessagestringYes

Message content.

Hello
CustSpaceIdstringNo

The space ID of the RAM user within the independent software vendor (ISV) account.

838833

Response parameters

ParameterTypeDescriptionExample
object

The response parameters.

RequestIdstring

The request ID.

90E63D28-E31D-1EB2-8939-A94866411B2O
Codestring

If OK is returned, the request was successful.

OK
Messagestring

The error message.

none
Dataobject

The returned data.

PhoneNumberstring

The phone number.

8613800
QrdlCodestring

The mode of the quick-response (QR) code.

D9II3***
GenerateQrImagestring

The format of the generated image.

PNG
PrefilledMessagestring

The message content.

Hello
DeepLinkUrlstring

The URL of the deep link.

https://wa.qrdl/
QrImageUrlstring

The URL of the QR code.

http://img.png

Examples

Sample success responses

JSONformat

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

Error codes

HTTP status codeError codeError message
400Product.UnsubscriptYou have not subscribed to the specified product.
400Ram.PermissionDenyYou are not authorized to perform the operation.
400System.LimitControlThe system is under flow control.
400Unknown.ResourceOwnerIdThe resource does not belong to the current user.

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
No change history