字段

是否必填

描述

longitude

是

坐標的經度。

latitude

是

坐標的緯度。

name

否

坐標的名稱。

address

否

坐標的地址信息。僅在已設置name時展示。

字段

是否必填

描述

addresses

否

聯系人的地址信息。

一個完整的聯系人地址信息包含以下字段：

• street（類型為string）：可選，街道編號和名稱。

• city（類型為string）：可選，城市名稱。

• state（類型為string）：可選，縣（市、州、區、旗）名縮寫。

• zip（類型為string）：可選，郵政編碼。

• country（類型為string）：可選，國家名稱。

• country_code（類型為string）：可選，兩個字母的國家縮寫。

• type（類型為string）：可選，枚舉值為HOME和WORK。

birthday

否

聯系人的生日，格式為YYYY-MM-DD。

emails

否

聯系人電子郵件地址。

一個完整的聯系人電子郵件地址包含以下字段：

• email（類型為string）：可選，郵件地址。

• type（類型為string）：可選，舉值為HOME和WORK。

name

是

聯系人的名稱。

一個完整的聯系人名稱包含以下字段：

• formatted_name（類型為string）：必填，通常使用全名。

• first_name（類型為string）：可選，名。

• last_name（類型為string）：可選，姓。

• middle_name（類型為string）：可選，中間名。

• suffix（類型為string）：可選，名稱后綴。

• prefix（類型為string）：可選，名稱前綴。

org

否

聯系人的組織信息。

一個完整的聯系人組織信息包含以下字段：

• company（類型為string）：可選，聯系人的公司名稱。

• department（類型為string）：可選，聯系人所在部門的名稱。

• title（類型為string）：可選，聯系人的職稱。

phones

否

聯系人的號碼信息。

一個完整的聯系人號碼信息包含以下字段：

• phone（類型為string）：可選，自動填充wa_id的值作為格式化的電話號碼。

• type（類型為string）：可選，枚舉值為CELL、MAIN、IPHONE、HOME、WORK。

• wa_id（類型為string）：可選，WhatsApp ID。

urls

否

聯系人的URL。

一個完整的URL信息包含以下字段：

• url（類型為string）：可選，URL。

• type（類型為string）：可選，枚舉值為HOME和WORK。

字段

是否必填

描述

link

是

需要發送的媒體的協議和URL，僅與HTTP或HTTPS URL使用。

• 當消息類型MessageType設置為text時，此參數不填。

• 當消息類型MessageType設置為audio、document、image或video且不使用鏈接時，此參數為必填。

caption

否

長度不超過1024個字符。

filename

否

描述特定文檔的文件名，僅與document媒體一起使用。

字段

是否必選

描述

text

是

消息的文本內容，其中可以包含格式化的URL。

previewUrl

否

預覽地址，string類型，默認值為false。取值：

• true：有預覽。

• false：無預覽。

字段

是否必選

描述

type

是

您想要發送的交互消息類型。支持的值：

• list：用于列表消息。

• button：用于回復按鈕。

• product：用于單個產品消息。

• product_list：用于多產品消息。

• catalog_message：用于產品目錄消息。

• cta_url：用于帶行動號召 (CTA) 網址按鈕的消息。

• flow：用于WhatsApp flow消息。

• address_message：用于地址消息。

• location_request_message：用于位置請求消息。

header

-

顯示在消息頂部的標題內容。如果interactive對象是product，則不能設置header。

header對象包含以下字段：

• document（類型為object）：MessageType為document時必填，傳入文檔的media對象。

• image（類型為object）：MessageType為image時必填，傳入圖片的media對象。

• video（類型為object）：MessageType為video時必填，傳入視頻的media對象。

• text（類型為tring）：MessageType為text時必填，頭部的文本允許使用emojis表情，不支持markdown，長度不超過60個字符。

• type（類型為string）：必填。type支持以下類型：

  • text：用于列表消息、回復按鈕和多產品消息。

  • video：用于回復按鈕。

  • image：用于回復按鈕。

  • document：用于回復按鈕。

body

-

具有消息主體的對象。

body對象包含以下字段：text（類型為string）需要展示時必填。消息主體內容支持Emojis表情和markdown，長度不超過1024個字符。

footer

否

消息頁腳的對象。

footer對象包含以下字段：text（類型為string）需要展示時必填。底部內容支持Emojis表情和markdown，長度不超過60個字符。

action

是

一個action對象，包含您希望用戶在讀取消息后執行的操作。

適用消息類型

字段

描述

列表消息

button

列表消息必填，按鈕內容。

Button content不能為空字符串，在消息中必須是唯一的。支持Emojis表情，不支持markdown，長度不超過20個字符。

回復按鈕消息

buttons

回復按鈕消息必填，一個button對象。

示例

{
 "type":"reply",
 "reply":{
       "id":"********231211",
       "title":"請點擊"
  }
}

列表消息或多產品消息

sections

列表消息或多產品消息必填。

section對象的數組。最小值為1，最大值為10。

單產品消息或多產品消息

catalog_id

單產品消息或多產品消息必填。

鏈接到您WhatsApp商業賬戶的Facebook目錄的唯一標識符。此ID可以通過Commerce Manager檢索。

product_retailer_id

單產品消息或多產品消息必填。

目錄中產品的唯一標識符，單產品消息或多產品消息不超過100個字符。

帶行動號召 (CTA) 網址按鈕的消息

name

字符串，必填。

值必須是cta_url。

parameters

object

display_text

字符串，必填。

按鈕文本。

url

字符串，必填。

WhatsApp用戶輕觸該按鈕時要在設備的默認網頁瀏覽器中加載的網址。

Flow消息

name

字符串，必填。

值必須是flow。

parameters

object

mode

字符串，可選。

Flow的當前模式。

取值：draft或published。

默認值：published

flow_message_version

字符串，必填。

必須是3。

flow_token

字符串，必填。

由企業生成的用作標識符的令牌。

flow_id

字符串，必填。

WhatsApp提供的Flow的唯一標識符。

flow_cta

字符串，必填。

CTA按鈕上的文本，例如“報名”。

最大長度：20個字符（無表情符號）。

flow_action

字符串，可選。

取值：navigate或data_exchange。

默認值：navigate

flow_action_payload

字符串，可選。僅當flow_action為navigate時必須。

該對象可以包含以下參數：

• screen：字符串，必需。Flow的第一個屏幕的id。

• data：object，可選。Flow的第一個屏幕的輸入數據。如果提供，則必須是非空對象。

地址消息

name

字符串，必填。

值必須是address_message。

parameters

object

country

字符串，必填。

國家/地區二字碼。例如：SG、IN

values

數組，必填。

包含以下參數：

• name：用戶姓名。

• phone_number：用戶電話號碼。

validation_errors

字符串，可選。

在地址字段中拋出錯誤，然后 WhatsApp 將阻止用戶提交地址。

saved_addresses

與用戶關聯的已保存地址。

包含以下參數：

• id：字符串，必填。已保存的地址id。

• value：數組，必填。

  • name：名稱，文本，支持印度和新加坡使用。

  • phone_number：電話號碼，支持印度和新加坡使用，僅限有效電話號碼。

  • in_pin_code：PIN碼，文本，最多6個字符，僅限印度使用。

  • sg_post_code：郵編，數字，最多 6個字符，僅限新加坡使用。

  • house_number：公寓或房屋門牌號，文本，僅限印度使用。

  • floor_number：樓層號，文本，僅限印度使用。

  • tower_number：樓號，文本，僅限印度使用。

  • building_name：建筑或公寓名稱，文本，僅限印度使用。

  • address：地址，文本，支持印度和新加坡使用。

  • landmark_area：地標或地區，文本，僅限印度使用。

  • unit_number：單元號，文本，僅限新加坡使用。

  • city：城市，文本，支持印度和新加坡使用。

  • state：州/省/自治區/直轄市，文本，僅限印度使用。

位置請求信息

name

字符串，必填。

值必須是send_location

字段

描述

title

如果消息有多個section時必填。section的標題，長度不超過24個字符。

rows

列表消息必填。包含row對象的列表，所有部分限制為10行。

每個row對象包含以下字段：

• title（類型為string）：必填。長度不超過24個字符。

• ID（類型為string）：必填。長度不超過200個字符。

• description（類型為string）：選填。長度不超過72個字符。

product_items

多產品消息必填。包含product對象的列表，每個部分至少有一個產品，所有部分最多有30個產品。

每個product對象包含以下字段：product_retailer_id多產品消息必填，目錄中產品的唯一標識符。

字段

是否必選

描述

messageId

是

消息ID，String類型。示例：2022129384888829****。

emoji

是

Emoji表情，String類型。

字段

是否必選

描述

text

是

文本內容。

字段

是否必選

描述

link

是

圖片地址。

字段

是否必選

描述

link

是

視頻地址。

thumbnail

是

縮略圖地址。

fileSize

是

文件大小，單位：MB。

duration

是

文件時長，單位：秒。

字段

是否必選

描述

link

是

文件地址。

fileName

是

文件名稱，不超過25個字符。

fileType

是

文件類型。

字段

是否必選

描述

text

是

文本內容。

caption

是

按鈕文本。

action

是

按鈕打開URL的地址。

字段

是否必選

描述

text

是

文本內容。

link

是

圖片地址。

caption

是

按鈕文本。

action

是

按鈕打開URL的地址。

字段

是否必選

描述

text

是

文本內容。

link

是

視頻地址。

thumbnail

是

縮略圖地址。

fileSize

是

文件大小，單位：MB。

duration

是

視頻時長，單位：秒。

字段

是否必選

描述

text

是

文本內容。

link

是

視頻地址。

thumbnail

是

縮略圖地址。

fileSize

是

文件大小，單位：MB。

duration

是

視頻時長，單位：秒。

caption

是

按鈕文本。

媒體

支持類型

大小限制

音頻（audio）

ACC、MP4、MPEG、AMR

16MB

文檔（document）

TXT、PDF、PPT、DOC、XLS、DOCX、PPTX、XLSX

100MB

圖片（image）

JPEG、PNG

5MB

視頻（video）

MP4、3GP

說明

• 僅支持 H.264 視頻編解碼器和 AAC 音頻編解碼器。

• 支持帶有單個音頻流或沒有音頻流的視頻。

16MB

貼紙（sticker）

WebP

靜態貼紙：100KB

動態貼紙：500KB

媒體

支持類型

大小限制

文本（text）

UTF-8

1000 個字符，包括空格和特殊字符。

文件（document）

DOC、DOCX、RTF、DOT、DOTX、ODT、ODF、FODT、TXT、INFO、PDF、XPS、PDAX、EPS、XLS、XLSX、ODS、FODS、CSV、XLSM、XLTX

200MB

視頻（video）

MP4、M4V、MOV、3GP

圖片（image）

JPG、JPEG、PNG、GIF、WebP

GIF：20MB，其他格式建議50MB以內。

建議分辨率800*800，封面建議分辨率400*400。