All Products
Search
Document Center

Chat App Message Service:ListChatappTemplate

Last Updated:Aug 13, 2025

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.

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:
    • For mandatory resource types, indicate with a prefix of * .
    • 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:ListChatappTemplatelist
*All Resources
*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
NamestringNo

The name of the template.

hello_whatsapp
LanguagestringNo

The language that is used in the message template. For more information, see Language codes.

en
AuditStatusstringNo

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
PageobjectNo

The pagination settings.

SizeintegerYes

The number of entries per page. Default value: 10.

10
IndexintegerYes

The page number. Default value: 1.

1
CustWabaIddeprecatedstringNo

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****
CustSpaceIdstringYes

The space ID of the RAM user within the ISV account.

28251486512358****
TemplateTypestringNo

The type of the message template.

  • WHATSAPP
  • VIBER
WHATSAPP
CodestringNo

The code of the message template.

838888822*****
CategorystringNo

The category of the message template.

AUTHENTICATION
IsvCodestringNo

The ISV verification code. This parameter is used to verify whether the RAM user is authorized by the ISV account.

skdi3kksloslikdkkdk

Response parameters

ParameterTypeDescriptionExample
object

The response parameters.

AccessDeniedDetailstring

The details about the access denial.

None
Messagestring

The error message returned.

User not authorized to operate on the specified resource.
RequestIdstring

The ID of the request.

90E63D28-E31D-1EB2-8939-A9486641****
ListTemplatearray<object>

The message templates.

templateobject

The queried templates.

TemplateCodestring

The code of the message template.

744c4b5c79c9432497a075bdfca3****
AuditStatusstring

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
Categorystring

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
TRANSACTIONAL
Languagestring

The language that is used in the message template. For more information, see Language codes.

en
LastUpdateTimelong

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
TemplateNamestring

The name of the message template.

hello_whatsapp
TemplateTypestring

The type of the template. Valid values: WHATSAPP and VIBER.

WHATSAPP
Reasonstring

The reason why the template was rejected.

None
Totalinteger

The total number of returned entries.

1
Codestring

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
Successboolean

Indicates whether the request was successful. Valid values:

  • true: The request was successful.
  • false: The request failed.
false

Examples

Sample success responses

JSONformat

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

Error codes

HTTP status codeError codeError messageDescription
400Product.UnsubscriptYou have not subscribed to the specified product.You have not subscribed to the specified product.
400Ram.PermissionDenyYou are not authorized to perform the operation.-
400System.LimitControlThe system is under flow control.The system is under flow control.
400Unknown.ResourceOwnerIdThe resource does not belong to the current user.The 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
2024-07-24The Error code has changed. The response structure of the API has changedView Change Details
2024-05-29The Error code has changed. The request parameters of the API has changedView Change Details
2023-09-14The Error code has changed. The response structure of the API has changedView Change Details
2023-07-04The Error code has changed. The response structure of the API has changedView Change Details
2023-03-29The Error code has changed. The response structure of the API has changedView Change Details