全部產品
Search

搜尋本產品

    Chat App Message Service：GetChatappTemplateMetric

    文件中心

    Chat App Message Service：GetChatappTemplateMetric

    更新時間：Jul 07, 2026

    取得行銷類型範本的相關指標。

    介面說明

    • 此介面只能查詢 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

    *All Resource

    *

    		 無 無

    請求參數

    名稱

    類型

    必填

    描述

    樣本值
    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>

    返回資料列表。

    array<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

    按鈕文本。

    reply
    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": "reply",
          "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.

    訪問錯誤中心查看更多錯誤碼。

    變更歷史

    更多資訊，參考變更詳情。