ListChatappTemplate - Chat App Message Service - Alibaba Cloud Documentation Center

Queries message templates.

Operation description

QPS limit

You can call this operation up to five times per second per account. If the number of calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation.

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.

Debug

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.

Operation	Access level	Resource type	Condition key	Associated operation
cams:ListChatappTemplate	list	All Resources ``	none	none

Request parameters

Parameter	Type	Required	Description	Example
Name	string	No	The name of the message template.	hello_whatsapp
Language	string	No	The language that is used in the message template. For more information, see Language codes.	en
AuditStatus	string	No	The review status of the message template. Valid values: pass: The message template is approved. fail: The message template is rejected. auditing: The message template is being reviewed. unaudit: The review is suspended.	pass
Page	object	No	The pagination settings.
Index	integer	Yes	The page number. Default value: 1.	1
Size	integer	Yes	The number of entries per page. Default value: 10.	10
CustWabaId`deprecated`	string	No	The WhatsApp Business account (WABA) ID of the user within the independent software vendor (ISV) account. Note CustWabaId is an obsolete parameter. Use CustSpaceId instead.	65921621816****
IsvCode	string	No	The independent software vendor (ISV) verification code, which is used to verify whether the user is authorized by the ISV account.	skdi3kksloslikdkkdk
CustSpaceId	string	No	The space ID of the user under the ISV account.	28251486512358****
TemplateType	string	No	The type of the message template. WHATSAPP VIBER LINE: the Line message template. This type of message template will be released later.	WHATSAPP
Code	string	No	Template encoding.	838888822*****

Response parameters

Parameter	Type	Description	Example
	object	The response parameters.
RequestId	string	The ID of the request.	90E63D28-E31D-1EB2-8939-A9486641****
Code	string	The HTTP status code returned. A value of OK indicates that the call is successful. Other values indicate that the call fails. For more information, see Error codes.	OK
Message	string	The error message returned.	User not authorized to operate on the specified resource.
ListTemplate	array<object>	The list of the templates.
template	object	The list of the templates.
TemplateName	string	The name of the message template.	hello_whatsapp
TemplateCode	string	The code of the message template.	744c4b5c79c9432497a075bdfca3****
AuditStatus	string	The review state of the message template. Valid values: pass: The message template is approved. fail: The message template is rejected. auditing: The message template is being reviewed. unaudit: The review is suspended.	pass
Language	string	The language that is used in the message template. For more information, see Language codes.	en
Category	string	The category of the WhatsApp template. Valid values: UTILITY: utility template MARKETING: marketing template AUTHENTICATION: authentication template The category of the Viber template. Valid values: text: template that contains only text image: template that contains only an image text_image_button: template that contains text, an image, and a button text_button: template that contains text and a button document: template that contains only a document video: template that contains only a video text_video: template that contains text and a video text_video_button: template that contains text, a video, and a button text_image: template that contains text and an image	TRANSACTIONAL
TemplateType	string	The type of the template. Valid values: WHATSAPP and VIBER.	WHATSAPP
Reason	string	The reason for the review failure.	None
LastUpdateTime	long	The time when the template was last modified. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.	1711006633000
Total	integer	The total number of entries returned.	1
AccessDeniedDetail	string	The details about the access denial.	None

Examples

Sample success responses

JSONformat

{
  "RequestId": "90E63D28-E31D-1EB2-8939-A9486641****",
  "Code": "OK",
  "Message": "User not authorized to operate on the specified resource.",
  "ListTemplate": [
    {
      "TemplateName": "hello_whatsapp",
      "TemplateCode": "744c4b5c79c9432497a075bdfca3****",
      "AuditStatus": "pass",
      "Language": "en",
      "Category": "TRANSACTIONAL",
      "TemplateType": "WHATSAPP",
      "Reason": "None",
      "LastUpdateTime": 1711006633000
    }
  ],
  "Total": 1,
  "AccessDeniedDetail": "None"
}

Error codes

HTTP status code	Error code	Error message
400	Product.Unsubscript	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.
400	Unknown.ResourceOwnerId	The resource does not belong to the current user.

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

Change history

Change time	Summary of changes	Operation
2024-07-24	The Error code has changed. The response structure of the API has changed	View Change Details
2024-05-29	The Error code has changed. The request parameters of the API has changed	View Change Details
2023-09-14	The Error code has changed. The response structure of the API has changed	View Change Details
2023-07-04	The Error code has changed. The response structure of the API has changed	View Change Details
2023-03-29	The Error code has changed. The response structure of the API has changed	View Change Details