All Products
Search

This Product

    Chat App Message Service:ListChatappTemplate

    Document Center

    Chat App Message Service:ListChatappTemplate

    Last Updated:Aug 10, 2026

    Retrieves a list of message templates.

    Operation description

    QPS limit

    The single-user QPS limit for this operation is 5 calls per second. If this limit is exceeded, the API calls are throttled, which may affect your business. Call this operation appropriately.

    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 None

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    Name

    string

    No

    The name of the template.

    hello_whatsapp
    Language

    string

    No

    The language of the template. For more information about language codes, see Language codes.

    en
    AuditStatus

    string

    No

    The review status. Valid values:

    • pass: Approved.

    • fail: Rejected.

    • auditing: Under review.

    • unaudit: Review suspended.

    pass
    Page

    object

    No

    The pagination settings.

    "page": "{\"index\": 1,\"size\": 20}
    Size

    integer

    Yes

    The number of templates to query per page. Default value: 10.

    10
    Index

    integer

    Yes

    The page number. Default value: 1.

    1
    CustWabaId deprecated

    string

    No

    The WabaId of the ISV customer.

    Note

    This is a deprecated parameter. Use CustSpaceId instead.

    65921621816****

    CustSpaceId

    string

    No

    The space ID of the ISV sub-customer, or the instance ID of a direct customer.

    28251486512358****
    TemplateType

    string

    No

    The templatetype. Valid values:

    • WHATSAPP

    • VIBER

    WHATSAPP
    Code

    string

    No

    The code of the template.

    838888822*****
    Category

    string

    No

    The category of the template.

    AUTHENTICATION
    IsvCode

    string

    No

    The ISV verification code, which is used to verify whether the RAM user is authorized by the ISV.

    skdi3kksloslikdkkdk

    Response elements

    Element

    Type

    Description

    Example

    object

    The response parameters.

    AccessDeniedDetail

    string

    The details about the access denial.

    None
    Message

    string

    The error message.

    User not authorized to operate on the specified resource.
    RequestId

    string

    The request ID.

    90E63D28-E31D-1EB2-8939-A9486641****
    ListTemplate

    array<object>

    The list data.

    object

    The template list.

    TemplateCode

    string

    The code of the template.

    744c4b5c79c9432497a075bdfca3****
    AuditStatus

    string

    The review status. Valid values:

    • pass: Approved.

    • fail: Rejected.

    • auditing: Under review.

    • unaudit: Review suspended.

    pass
    Category

    string

    The WhatsApp template category. Valid values:

    • UTILITY: Transaction-related.

    • MARKETING: Marketing template.

    • AUTHENTICATION: Identity verification.

    Viber template category. Valid values:

    • UTILITY: Transaction-related.

    • MARKETING: Marketing template.

    • AUTHENTICATION: Identity verification.

    UTILITY
    Language

    string

    The language of the template. For more information about language codes, see Language codes.

    en
    LastUpdateTime

    integer

    The time when the template was last updated.

    1711006633000
    TemplateName

    string

    The name of the template.

    hello_whatsapp
    TemplateType

    string

    The templatetype. Valid values: WHATSAPP and VIBER.

    WHATSAPP
    Reason

    string

    The reason why the template was rejected during review.

    None
    Total

    integer

    The total number of records.

    1
    Code

    string

    The response code.

    • A value of OK indicates that the request was successful.

    • For other error codes, see Error codes.

    OK
    Success

    boolean

    Indicates whether the request was successful. Valid values:

    • true: The request was successful.

    • false: The request failed.

    false

    Examples

    Success response

    JSON format

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

    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.