消息模板字段说明

字段

是否必填

描述

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。