全部產品
Search
文件中心

Chat App Message Service:EnableWhatsappROIMetric

更新時間:Jul 07, 2026

啟用 WhatsApp 相關指標統計。

介面說明

  • 在透過 API 方式取得 WhatsApp 類型通道的號碼傳送量指標,或 Marketing 類型範本的相關指標之前,您需要先呼叫此介面啟用 WhatsApp ROI 指標統計。

  • 啟用 WhatsApp ROI 指標統計後,至少需一天才會有指標統計資料,啟用前的訊息傳送量指標和 Marketing 類型範本的相關指標將不進行統計。

  • 啟用 WhatsApp ROI 指標統計後,您可呼叫 GetChatappPhoneNumberMetric 介面查詢號碼的傳送量指標、呼叫 GetChatappTemplateMetric 介面查詢 Marketing 類型範本的相關指標。

QPS 限制

本介面的單一使用者 QPS 限制為 5 次/秒。超過限制,API 呼叫會被限流,這可能會影響您的業務,請合理呼叫。

調試

您可以在OpenAPI Explorer中直接運行該介面,免去您計算簽名的困擾。運行成功後,OpenAPI Explorer可以自動產生SDK程式碼範例。

調試

授權資訊

下表是API對應的授權資訊,可以在RAM權限原則語句的Action元素中使用,用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下:

  • 操作:是指具體的許可權點。

  • 存取層級:是指每個操作的存取層級,取值為寫入(Write)、讀取(Read)或列出(List)。

  • 資源類型:是指操作中支援授權的資源類型。具體說明如下:

    • 對於必選的資源類型,用前面加 * 表示。

    • 對於不支援資源級授權的操作,用全部資源表示。

  • 條件關鍵字:是指雲產品自身定義的條件關鍵字。

  • 關聯操作:是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權,操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

cams:EnableWhatsappROIMetric

get

*All Resource

*

請求參數

名稱

類型

必填

描述

樣本值

IsvCode

string

ISV 驗證碼,用於驗證子帳號是否由 ISV 授權。

skdi3kksloslikd****

CustSpaceId

string

ISV 子客戶的 SpaceId/執行個體 ID。即通道 ID,在通道管理介面檢視。

cams-************

返回參數

名稱

類型

描述

樣本值

object

返回資料。

AccessDeniedDetail

string

存取被拒絕詳細資訊。

None

RequestId

string

請求 ID。

608F9CCA-B5EB-3D72-8047-B25D6D75BDEC

Message

string

錯誤提示資訊。

None

Code

string

請求狀態碼。取值:

  • OK:代表請求成功。

  • 其他錯誤碼,請參見 API 錯誤碼

OK

樣本

正常返回樣本

JSON格式

{
  "AccessDeniedDetail": "None",
  "RequestId": "608F9CCA-B5EB-3D72-8047-B25D6D75BDEC\n",
  "Message": "None",
  "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.

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

變更歷史

更多資訊,參考變更詳情