Use ListChatappTemplate to query message templates - Chat App Message Service

Queries message templates.

Operation description

QPS limit

This operation allows a maximum of 5 requests per second per account. Excess requests are throttled, which may affect your business. Stay within the specified limit.

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

cams:ListChatappTemplate

list

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
Name	string	No	The name of the 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 state of the template. Valid values: pass: The template is approved. fail: The template is rejected. auditing: The template is being reviewed. unaudit: The review is suspended.	pass
Page	object	No	The pagination settings.	"page": "{\"index\": 1,\"size\": 20}
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 RAM user within the independent software vendor (ISV) account. Note CustWabaId is an obsolete parameter. Use CustSpaceId instead.	65921621816****
IsvCode	string	No	The ISV verification code. This parameter is used to verify whether the RAM user is authorized by the ISV account.	skdi3kksloslikdkkdk
CustSpaceId	string	Yes	The space ID of the RAM user within the ISV account.	28251486512358****
TemplateType	string	No	The type of the message template. WHATSAPP VIBER	WHATSAPP
Code	string	No	The code of the message template.	838888822*****

Response elements

Element	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 message templates.
	object	The queried 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 template. Valid values: pass: The template is approved. fail: The template is rejected. auditing: The 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 message template. Valid values: UTILITY MARKETING AUTHENTICATION The category of the Viber template. Valid values: text: template that contains only text image: template that contains only images text_image_button: template that contains text, images, and buttons text_button: template that contains text and buttons document: template that contains only documents video: template that contains only videos text_video: template that contains text and videos text_video_button: template that contains text, videos, and buttons text_image: template that contains text and images	UTILITY
TemplateType	string	The type of the template. Valid values: WHATSAPP and VIBER.	WHATSAPP
Reason	string	The reason why the template was rejected.	None
LastUpdateTime	integer	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 returned entries.	1
AccessDeniedDetail	string	The details about the access denial.	None

Examples

Success response

JSON format

{
  "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": "UTILITY",
      "TemplateType": "WHATSAPP",
      "Reason": "None",
      "LastUpdateTime": 1711006633000
    }
  ],
  "Total": 1,
  "AccessDeniedDetail": "None"
}

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 Error Codes for a complete list.

Release notes

See Release Notes for a complete list.