全部產品
Search
文件中心

Chat App Message Service:RequestWhatsappConversionApi

更新時間:Jun 16, 2026

請求Whatsapp Conversion API

介面說明

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

調試

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

調試

授權資訊

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

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

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

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

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

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

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

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

操作

存取層級

資源類型

條件關鍵字

關聯操作

cams:RequestWhatsappConversionApi

none

*全部資源

*

請求參數

名稱

類型

必填

描述

樣本值

PageId

string

Meta 的 PageId

1939848838

CustSpaceId

string

客戶的 SpaceId/實例 ID。

929399382

RequestData

array<object>

請求資料

array<object>

請求資料

DataProcessingOptionsState

integer

在某些情況下為必要項。(查看下方備註以瞭解詳情。) 您希望與此資料處理選項相關聯的州/省。當前可接受值為 1000(代表加利福尼亞州),或者 0(請求我們為此事件進行地理定位)。

26

UserData

object

包含客戶資訊資料的映射。

any

data

{"currency":"USD", "value": 1}

EventName

string

  • 標準事件或自訂事件的名稱。此欄位用於刪除由網站(透過 Meta Pixel 像素代碼)或應用(透過 SDK 或應用事件 API)以及轉化 API 傳送的重複事件。event_id 參數也用於刪除重複事件。

  • 對於相同的客戶操作,瀏覽器事件或應用事件的 event 應與伺服器事件的 event_name 相符。如果我們在 48 小時內傳送的事件之間找到匹配項,則只考慮第一個事件。如果幾乎同一時間收到伺服器和瀏覽器/應用事件(即彼此相差 5 分鐘以內),則將優先考慮瀏覽器/應用事件。詳細瞭解刪除重複的 Pixel 像素代碼事件和伺服器事件。

Purchase

OptOut

boolean

表示不應將此事件用於廣告投放最佳化的標記。設定為 true 時,該事件僅可用作歸因條件。

true

AppData

object

應用事件必要參數

這些參數用於將應用資料和裝置資訊分享給轉化 API。

any

data

{}

EventTime

integer

Unix 時間戳記(以秒為單位),表示事件的實際發生時間。指定時間可能早於您將事件傳送至 Facebook 的時間。其目的在於實現批次處理和伺服器效能最佳化。您必須以格林威治標準時間 (GMT) 時區格式傳送該日期。

1709201870

ExtInfo

object

應用事件必要參數

擴充裝置資訊,例如螢幕的寬度和高度。此參數是一個陣列,各個值之間使用逗號分隔。使用 extinfo 時,所有值均為必要項,並且必須按照以下索引順序排列。如果缺少某個值,則需使用空字串作為佔位符填充。

any

data

{}

CustomData

object

包含事件其他企業資料的映射。

any

data

{}

EventId

string

此編號可以是廣告主選定的任何唯一字串。參數 event_name 和 event_id 用於刪除由網站(透過 Meta Pixel 像素代碼)或應用(透過 SDK 或應用事件 API)以及轉化 API 傳送的重複事件。請注意,雖然我們將 event_id 標記為可選項,但是建議您在刪除重複事件時採用此參數。

20029399299

DataProcessingOptions

array

您希望為特定事件啟用的處理選項。對於受限資料使用,當前可接受值為 LDU。您可以傳送一個空陣列來明確指定,不得使用「受限資料使用」限制來處理此事件。

string

data

[]

MessagingChannel

string

來源,固定為: whatsapp

whatsapp

ActionSource

string

您可透過此欄位指定轉化發生的位置。瞭解事件發生的位置有助於確保將廣告投放至正確的受眾。使用轉化 API,即表示您同意:就您所知 action_source 參數準確無誤。

您可在 action_source 欄位中傳送的值如下:

  • email — 轉化透過郵件發生。

  • website — 轉化在網站上完成。

  • app — 轉化在行動應用上完成。

  • phone_call — 轉化透過電話完成。

  • chat — 轉化透過訊息應用、簡訊或線上訊息功能完成。

  • physical_store — 轉化在實體店面對面完成。

  • system_generated — 轉化自動發生,例如將訂閱續費設定為每月自動支付。

  • other — 轉化透過本文未列出的其他方式完成。

注意:所有操作來源值都支援廣告成效衡量和自訂受眾建立功能。所有操作來源(除 physical_store 外)都支援廣告最佳化功能。

business_messaging

DataProcessingOptionsCountry

integer

如果您在 data_processing_options 下傳送 LDU,則為必要項。 您希望與此資料處理選項相關聯的國家/地區。當前可接受值為 1(代表美國),或者 0(請求我們為此事件進行地理定位)。

100

EventSourceUrl

string

事件發生的瀏覽器網址。此網址必須以 http:// 或 https:// 開頭,並且應與已認證的網域相匹配。

http://alibaba.com

返回參數

名稱

類型

描述

樣本值

object

AccessDeniedDetail

string

存取被拒絕詳細資訊。

Message

string

錯誤提示資訊。

範例值

RequestId

string

請求 ID。

範例值範例值範例值

Code

string

請求狀態碼。

  • 返回 OK 代表請求成功。

  • 其他錯誤碼,請參見錯誤碼列表

OK

Success

boolean

是否呼叫成功:

  • true:呼叫成功。

  • false:呼叫失敗。

true

樣本

正常返回樣本

JSON格式

{
  "AccessDeniedDetail": "無",
  "Message": "範例值",
  "RequestId": "範例值範例值範例值",
  "Code": "OK",
  "Success": true
}

錯誤碼

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

變更歷史

更多資訊,參考變更詳情