GetChatappTemplateDetail-阿里云帮助中心

Retrieves the details of a Chat App Message Service message template.

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 as needed.

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:GetChatappTemplateDetail

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
TemplateCode	string	No	The code of the template.	****4b5c79c9432497a075bdfca36bf5
Language	string	Yes	The language of the template. For detailed language codes, see Language codes.	en_US
CustWabaId`deprecated`	string	No	The WabaId of the ISV customer. Note This parameter is deprecated. Use CustSpaceId instead.	65921621816****
IsvCode	string	No	The ISV verification code, which is used to verify whether the sub-account is authorized by the ISV.	skdi3kksloslikdkkdk
CustSpaceId	string	Yes	The SpaceId of the ISV sub-customer or the instance ID of a direct customer.	28251486512358****
TemplateType	string	No	The templatetype. WHATSAPP VIBER	WHATSAPP
TemplateName	string	No	The name of the template.	test_name

Response elements

Element	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID.	744c4b5c79c9432497a075bdfca3****
Code	string	The response code. OK indicates that the request was successful. For other error codes, see Error codes.	OK
Message	string	The error message.	User not authorized to operate on the specified resource.
Data	object	The returned data.	{ "category": "ACCOUNT_UPDATE", "name": "account_notice", "language": "en_US", "templateCode": "744c4b5c79c9432497a075bdfca3**", "auditStatus": "APPROVED", "components": "[{\"type\":\"BODY\",\"text\":\"body_text$(textVariable)\"},{\"type\":\"HEADER\",\"formate\":\"IMAGE\",\"url\":\"$(linkVariable)\"},{\"type\":\"FOOTER\",\"text\":\"footer-text\"},{\"type\":\"BUTTONS\",\"buttons\":[{\"type\":\"PHONE_NUMBER\",\"text\":\"phone-button-text\",\"phone_number\":\"+861388888**\"},{\"type\":\"URL\",\"text\":\"url-button-text\",\"url\":\"https://www.website.com/\"}]}]", "example": "{\"textVariable\": \"text\", \"linkVariable\": \"link\"}" }
Category	string	The WhatsApp template category. Valid values: UTILITY: transaction-related. MARKETING: marketing template. AUTHENTICATION: identity verification. Viber template category. Valid values: text: text only image: image only text_image_button: text + image + button text_button: text + button document: file video: video text_video: text + video text_video_button: text + video + button text_image: text + image Note When the Viber template value is text_video_button, the button does not open a web page. Instead, it opens the video of the current message within the web page. Therefore, you do not need to enter any address information in the URL of the button.	UTILITY
TemplateCode	string	The code of the template.	744c4b5c79c9432497a075bdfca3****
Name	string	The name of the template.	hello_whatsapp
Language	string	The language of the template. For detailed language codes, see Language codes.	en_US
Example	object	The variable examples.
	string	The actual values corresponding to the template variables. The parameter format is JSON.	{\"textVariable\":\"text\",\"linkVariable\":\"https://image.developer.aliy\"}
AuditStatus	string	The audit status. Valid values: pass: Approved. fail: Rejected. auditing: Under review. unaudit: Review suspended.	pass
Components	array<object>	The list of message template components.
	array<object>	The message template component.
Type	string	The component type. BODY HEADER FOOTER BUTTONS CAROUSEL LIMITED_TIME_OFFER Note For WhatsApp templates, the BODY component has a maximum length of 1024 characters. The HEADER and FOOTER components have a maximum length of 60 characters. For Viber templates, the FOOTER, CAROUSEL, and LIMITED_TIME_OFFER types are invalid. For Viber templates, images, videos, and files are placed in the HEADER (the device displays images below the text).	BODY
Url	string	The media URL.	https://image.developer.aliyundoc.com
Text	string	The text of the message to be sent.	hello
Caption	string	The file description.	example
FileName	string	The file name.	example
Format	string	The format.	TEXT
Buttons	array<object>	The button list. Applicable only to the BUTTONS component. Note WhatsApp button quantity rules: For MARKETING/UTILITY categories, a maximum of 10 buttons are allowed. Only 1 PHONE_NUMBER button is allowed. A maximum of 2 URL buttons are allowed. QUICK_REPLY buttons cannot be mixed in random order with PHONE_NUMBER/URL buttons.
	array<object>	The component list.
Type	string	The button type. PHONE_NUMBER: phone call button URL: web page button QUICK_REPLY: quick reply button COPY_CODE: copy verification code or coupon code ONE_TAP: autofill button for AUTHENTICATION templates ZERO_TAP: autofill button for AUTHENTICATION templates MPM: multi-product catalog CATALOG: catalog FLOW: open WhatsApp flow Note For WhatsApp templates with Category set to AUTHENTICATION, only one button is allowed, and the type must be COPY_CODE or ONE_TAP. If the type is COPY_CODE, Text is required. If the type is ONE_TAP, Text (displayed when the target app is not installed, indicating the name of the copy verification code button), SignatureHash, PackageName, and AutofillText are required. Viber templates allow only one button, and it must be of the URL type.	PHONE_NUMBER
Text	string	The display name of the button.	example
PhoneNumber	string	The phone number. Valid only when the button type is PHONE_NUMBER.	+861398745****
Url	string	The URL that is accessed when the link button is clicked.	https://example.com
UrlType	string	The URL type. static: Static. dynamic: Dynamic.	static
SignatureHash	string	Required when the WhatsApp template Category is Authentication and Button Type is ONE_TAP. The signature hash value for WhatsApp to launch the application.	2993839
PackageName	string	Required when the WhatsApp template Category is Authentication and Button Type is ONE_TAP. The package name for WhatsApp to launch the application.	com.aliyun
AutofillText	string	Required when the WhatsApp template Category is Authentication and Button Type is ONE_TAP. The button text for the WhatsApp Autofill operation.	Autofill
IsOptOut	boolean	Valid for WhatsApp templates when Category is Marketing and Button type is QUICK_REPLY. Indicates the button is a marketing opt-out button. If a customer clicks this button and the send control operation is configured on the Chat App Message Service platform, subsequent marketing messages will not be sent to the customer.	false
ExtendAttrs	object	The extended attributes.
NextTemplateCode	string	The next template code.	20939920093993
NextTemplateName	string	The next template name.	abc
NextLanguageCode	string	The next template language.	en
Action	string	The event type.	nextCard
IntentCode	string	The intent code.	test
CouponCode	string	The coupon code.	202039ksjs
FlowId	string	Flow ID.	3838292983
FlowAction	string	The flow data event type. Valid values: NAVIGATE: navigation DATA_EXCHANGE: data exchange	NAVIGATE
NavigateScreen	string	The navigate screen. Required when FlowAction is NAVIGATE.	DETAILS
SupportedApps	array<object>	The applications supported by ONE_TAP/ZERO_TAP verification code.
	object	The applications supported by ONE_TAP/ZERO_TAP verification code.
SignatureHash	string	The package signature hash.	29kdkeik939
PackageName	string	The package name.	com.test
ThumbUrl	string	The thumbnail for Viber video messages.	https://img.png
Duration	integer	The video duration for Viber video messages. Valid values: 0 to 600.	50
FileType	string	The file type for Viber file messages.	docx
Latitude	string	The location latitude.	28.001
Longitude	string	The location longitude.	120.002
LocationName	string	The location name.	hangzhou
LocationAddress	string	The location address.	hangzhou
AddSecretRecommendation	boolean	Valid for WhatsApp templates when Category is Authentication and Component Type is Body. Displays a message above the Body advising not to share the verification code with others.	false
CodeExpirationMinutes	integer	The verification code validity period in minutes for WhatsApp Authentication templates. Valid only when Category is Authentication and Component Type is Footer. This information is displayed in the Footer position.	5
hasExpiration	boolean	Indicates whether the coupon code has an expiration time in LTO templates.	true
OfferExpirationTimeMs	string	The coupon code expiration variable for LTO templates.	$(offerExpirationTimeMs)
Cards	array<object>	The carousel card list.
	array<object>	The carousel template card list.
CardComponents	array<object>	The card component list.
	array<object>	The component list within a carousel card.
Type	string	The component type.	HEADER
Text	string	The card text content.	Body
Url	string	The web URL.	https://aliyun.com
Format	string	The header type in carousel templates. Only IMAGE and VIDEO are supported. All cards must have the same header type.	HEADER
Buttons	array<object>	The card button list.
	object	The button object.
Type	string	The button type for carousel templates. Valid values: URL, PHONE_NUMBER, and QUICK_REPLY.	URL
Text	string	The button content.	example
Url	string	The URL accessed when the button is clicked.	https://aliyun.com
UrlType	string	The URL type. Valid values: static: Static. dynamic: Dynamic.	static
PhoneNumber	string	The phone number.	+861380005****
TemplateType	string	The templatetype. WHATSAPP VIBER	WHATSAPP
QualityScore	string	The template quality. RED (low quality) YELLOW (medium quality) UNKNOWN (unknown quality) GREEN (high quality)	GREEN
MessageSendTtlSeconds	integer	The message validity period when sending messages with WhatsApp Authentication templates.	120
Reason	string	The reason why the template was rejected during review.	None
AccessDeniedDetail	string	The access denied details.	None

Examples

Success response

JSON format

{
  "RequestId": "744c4b5c79c9432497a075bdfca3****",
  "Code": "OK",
  "Message": "User not authorized to operate on the specified resource.",
  "Data": {
    "Category": "UTILITY",
    "TemplateCode": "744c4b5c79c9432497a075bdfca3****",
    "Name": "hello_whatsapp",
    "Language": "en_US",
    "Example": {
      "key": "{\\\"textVariable\\\":\\\"text\\\",\\\"linkVariable\\\":\\\"https://image.developer.aliy\\\"}"
    },
    "AuditStatus": "pass",
    "Components": [
      {
        "Type": "BODY",
        "Url": "https://image.developer.aliyundoc.com",
        "Text": "hello",
        "Caption": "example",
        "FileName": "example",
        "Format": "TEXT",
        "Buttons": [
          {
            "Type": "PHONE_NUMBER",
            "Text": "example",
            "PhoneNumber": "+861398745****",
            "Url": "https://example.com\n",
            "UrlType": "static",
            "SignatureHash": "2993839",
            "PackageName": "com.aliyun",
            "AutofillText": "Autofill",
            "IsOptOut": false,
            "ExtendAttrs": {
              "NextTemplateCode": "20939920093993",
              "NextTemplateName": "abc",
              "NextLanguageCode": "en",
              "Action": "nextCard",
              "IntentCode": "test"
            },
            "CouponCode": "202039ksjs",
            "FlowId": "3838292983",
            "FlowAction": "NAVIGATE",
            "NavigateScreen": "DETAILS",
            "SupportedApps": [
              {
                "SignatureHash": "29kdkeik939",
                "PackageName": "com.test"
              }
            ]
          }
        ],
        "ThumbUrl": "https://img.png",
        "Duration": 50,
        "FileType": "docx",
        "Latitude": "28.001",
        "Longitude": "120.002",
        "LocationName": "hangzhou",
        "LocationAddress": "hangzhou",
        "AddSecretRecommendation": false,
        "CodeExpirationMinutes": 5,
        "hasExpiration": true,
        "OfferExpirationTimeMs": "$(offerExpirationTimeMs)",
        "Cards": [
          {
            "CardComponents": [
              {
                "Type": "HEADER",
                "Text": "Body",
                "Url": "https://aliyun.com",
                "Format": "HEADER",
                "Buttons": [
                  {
                    "Type": "URL",
                    "Text": "example",
                    "Url": "https://aliyun.com",
                    "UrlType": "static",
                    "PhoneNumber": "+861380005****"
                  }
                ]
              }
            ]
          }
        ]
      }
    ],
    "TemplateType": "WHATSAPP",
    "QualityScore": "GREEN",
    "MessageSendTtlSeconds": 120,
    "Reason": "None"
  },
  "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.