GetChatappTemplateMetric - 获取营销类型模板的相关指标_Chat App 消息服务(Chat App)-阿里云帮助中心

获取营销类型模板的相关指标。

接口说明

此接口只能查询 WhatsApp 类型通道营销模板的相关指标。
在调用此接口前，请先调用 EnableWhatsAppROIMetric 接口开启 WhatsApp ROI 指标统计，开启后至少需一天才会有统计数据，开启前的营销模板相关指标将不进行统计。
开启 WhatsApp ROI 指标统计后，请确保您创建的通道的营销模板已有成功发送的消息。您可在通道管理>管理>消息发送界面发送消息，或通过 SendChatappMessage 、 SendChatappMassMessage 接口发送消息。

QPS 限制

本接口的单用户 QPS 限制为 50 次/秒。超过限制，API 调用会被限流，这可能会影响您的业务，请合理调用。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

cams:GetChatappTemplateMetric

get

*全部资源

*

无

请求参数

名称	类型	必填	描述	示例值
TemplateCode	string	是	模板 Code。在通道管理>管理>模板设计界面查看模板编码。	1100***************
Language	string	否	模板语言。更多语言请参见语言代码。	en
IsvCode	string	否	ISV 校验码，用于校验子账号是否由 ISV 授权。	skdi3kksloslikd****
CustSpaceId	string	否	ISV 子客户的 SpaceId/实例 ID。即通道 ID，在通道管理界面查看。	cams-************
TemplateType	string	否	模板类型。取值： WHATSAPP 说明当未传递此值时，默认值为 WHATSAPP。	WHATSAPP
Granularity	string	否	指标粒度。取值： DAILY：按天统计指标。 HALF_HOUR：按每半小时统计指标。	DAILY
Start	integer	是	查询开始时间。时间戳，单位：毫秒。	1693107714687
End	integer	是	查询结束时间。时间戳，单位：毫秒。	1693407714687

返回参数

名称	类型	描述	示例值
	object	返回数据。
AccessDeniedDetail	string	访问被拒绝详细信息。	None
RequestId	string	请求 ID。	608F9CCA-B5EB-3D72-8047-B25D6D75BDEC
Message	string	错误提示信息。	None
Data	array<object>	返回数据列表。
	object	返回数据。
TemplateCode	string	模板编码。	1100***************
DeliveredCount	integer	到达量。	6
Language	string	模板语言。	en
Cliented	array<object>	按钮点击统计列表。
	object	按钮点击统计。
Type	string	按钮类型。取值： phone_number_button：拨打电话按钮。 url_button：链接按钮。 quick_relpy_button：自动回复按钮。	quick_reply_button
ButtonContent	string	按钮文本。	回复
Count	integer	点击次数。	20
Start	integer	指标统计开始时间。时间戳，单位：毫秒。	1673919240001
End	integer	指标统计结束时间。时间戳，单位：毫秒。	1668138331485
SentCount	integer	发送量。	10
ReadCount	integer	阅读量。	3
Code	string	请求状态码。取值： OK：代表请求成功。其他错误码，请参见 API 错误码。	OK

示例

正常返回示例

JSON格式

{
  "AccessDeniedDetail": "None",
  "RequestId": "608F9CCA-B5EB-3D72-8047-B25D6D75BDEC\n",
  "Message": "None",
  "Data": [
    {
      "TemplateCode": "1100***************",
      "DeliveredCount": 6,
      "Language": "en",
      "Cliented": [
        {
          "Type": "quick_reply_button",
          "ButtonContent": "回复",
          "Count": 20
        }
      ],
      "Start": 1673919240001,
      "End": 1668138331485,
      "SentCount": 10,
      "ReadCount": 3
    }
  ],
  "Code": "OK"
}

错误码

HTTP status code	错误码	错误信息	描述
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.	资源不属于当前用户。

访问错误中心查看更多错误码。

变更历史

更多信息，参考变更详情。