GetChatappTemplateMetric - 获取Marketing类型模板的相关指标

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

接口说明

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

调试

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

授权信息

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

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
cams:GetChatappTemplateMetricget
*全部资源
*

请求参数

名称类型必填描述示例值
TemplateCodestring

模板 Code。

744c4b5c79c9432497a075bdfca3****
Languagestring

模板语言。

en
IsvCodestring

ISV 校验码,用于校验子账号是否由 ISV 授权。

skdi3kksloslikd****
CustSpaceIdstring

ISV 子客户的 SpaceId。

29348393884****
TemplateTypestring

模板的模板类型。 当未传递此值时,默认值为 WHATSAPP。

枚举值:
  • VIBERVIBER
  • WHATSAPPWHATSAPP
WHATSAPP
Granularitystring

指标粒度。

枚举值:
  • DAILYDAILY
  • HALF_HOURHALF_HOUR
DAILY
Startlong

查询开始时间。

1693107714687
Endlong

查询结束时间。

1693407714687

返回参数

名称类型描述示例值
object

返回数据。

RequestIdstring

请求 ID。

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

返回结果 OK 为正常。

OK
Messagestring

错误提示信息。

None
Dataarray<object>

返回数据。

返回数据object

返回数据。

TemplateCodestring

模板编码。

83837774838*****
Languagestring

模板语言。

en
SentCountinteger

发送量。

10
ReadCountinteger

阅读量。

3
DeliveredCountinteger

到达量。

6
Clientedarray<object>

按钮点击统计。

按钮点击数据object

按钮点击统计。

Typestring

按钮类型。

枚举值:
  • phone_number_buttonphone_number_button
  • url_buttonurl_button
  • quick_relpy_buttonquick_relpy_button
quick_reply_button
ButtonContentstring

按钮文本。

回复
Countinteger

点击次数。

20
Startlong

指标统计开始时间。

1673919240001
Endlong

指标统计结束时间。

1668138331485
AccessDeniedDetailstring

访问被拒绝详细信息。

示例

正常返回示例

JSON格式

{
  "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": "回复",
          "Count": 20
        }
      ],
      "Start": 1673919240001,
      "End": 1668138331485
    }
  ],
  "AccessDeniedDetail": "无"
}

错误码

HTTP status code错误码错误信息
400Product.UnsubscriptYou have not subscribed to the specified product.
400Ram.PermissionDenyYou are not authorized to perform the operation.
400System.LimitControlThe system is under flow control.
400Unknown.ResourceOwnerIdThe resource does not belong to the current user.

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

变更历史

变更时间变更内容概要操作
暂无变更历史