GetChatappTemplateMetric - ChatApp Message Service - Alibaba Cloud Documentation Center

Queries the metrics about a marketing template.

Operation description

You can call this operation up to 50 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

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

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:GetChatappTemplateMetric	get	All Resources *	none	none

Request parameters

Parameter	Type	Required	Description	Example
TemplateCode	string	Yes	The template code.	744c4b5c79c9432497a075bdfca36bf5
Language	string	No	The template language.	en
IsvCode	string	No	The verification code used to verify whether the RAM user is authorized by the independent software vendor (ISV) account.	skdi3kksloslikdkkdk
CustSpaceId	string	No	The space ID of the user within the ISV account.	293483938849493
TemplateType	string	No	The template type. Valid values: WHATSAPP and VIBER. If you do not specify this parameter, WHATSAPP is used by default.	WHATSAPP
Granularity	string	No	The metric granularity. Note Valid values: DAILY	DAILY
Start	long	Yes	The beginning of the time range to query.	1693107714687
End	long	Yes	The end of the time range to query.	1693407714687

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	The request ID.	90E63D28-E31D-1EB2-8939-A9486641****
Code	string	The value OK indicates that the request was successful.	OK
Message	string	The error message.	None
Data	array<object>	The returned data.
	object	The data returned.
TemplateCode	string	The template code.	83837774838*****
Language	string	The template language.	en
SentCount	integer	The number of sent messages.	10
ReadCount	integer	The number of read messages.	3
DeliveredCount	integer	The number of delivered messages.	6
Cliented	array<object>	The statistics on button clicks.
	object
Type	string	The button type. Note Valid values: url_button quick_relpy_button phone_number_button	quick_reply_button
ButtonContent	string	The text on the button.	Open url
Count	integer	The number of clicks.	20
Start	long	The beginning of the time range you queried.	1673919240001
End	long	The end of the time range you queried.	1668138331485
AccessDeniedDetail	string	The details about the access denial.	None

Examples

Sample success responses

JSONformat

{
  "RequestId": "90E63D28-E31D-1EB2-8939-A9486641****",
  "Code": "OK",
  "Message": "None",
  "Data": [
    {
      "TemplateCode": "83837774838*****",
      "Language": "en",
      "SentCount": 10,
      "ReadCount": 3,
      "DeliveredCount": 6,
      "Cliented": [
        {
          "Type": "quick_reply_button",
          "ButtonContent": "Open url",
          "Count": 20
        }
      ],
      "Start": 1673919240001,
      "End": 1668138331485
    }
  ],
  "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

No change history