以下是可以通过 WhatsApp On-Premise 发送的消息类型列表:
属性 | 说明 | 是否必需 |
---|---|---|
type | TEXT | 是 |
text | 字符串;最多 2000 个字符 | 是 |
属性 | 说明 | 是否必需 |
---|---|---|
type | IMAGE | 是 |
text | 字符串;图像的说明文字 | 否 |
attachment_id | 图像的媒体 ID | 是(或 url) |
url | 图像的 URL | 是(或 attachment_id) |
.jpeg
或 .png
属性 | 说明 | 是否必需 |
---|---|---|
type | AUDIO | 是 |
attachment_id | 音频的媒体 ID | 是(或 url) |
url | 音频的 URL | 是(或 attachment_id) |
.aac
、.mp4
、.mpeg
、.amr
和 .ogg
(仅支持 opus
编解码器,基本的 ogg
不支持)属性 | 说明 | 是否必需 |
---|---|---|
type | VIDEO | 是 |
text | 字符串;视频的说明文字 | 否 |
attachment_id | 视频的媒体 ID | 是(或 url) |
url | 视频的 URL | 是(或 attachment_id) |
.mp4
和 .3gp
H.264
视频编解码器和 AAC
音频编解码器属性 | 说明 | 是否必需 |
---|---|---|
type | VIDEO | 是 |
url | 贴纸的 URL | 是(或 attachment_id) |
attachment_id | 贴纸的媒体 ID | 是(或 url) |
.webp
,尺寸为 512x512 像素属性 | 说明 | 是否必需 |
---|---|---|
type | FILE | 是 |
filename | 字符串;文件的预览名称 | 否 |
url | 文件的 URL | 是(或 attachment_id) |
attachment_id | 文件的媒体 ID | 是(或 url) |
plain
、pdf
、vnd.ms-powerpoint
、msword
、vnd.ms-excel
、vnd.openxmlformats-officedocument.wordprocessingml.document
、vnd.openxmlformats-officedocument.presentationml.presentation
、vnd.openxmlformats-officedocument.spreadsheetml.sheet
属性 | 说明 | 是否必需 |
---|---|---|
type | LOCATION | 是 |
name | 字符串;位置名称 | 否 |
address | 字符串;位置地址 | 否 |
lat | 纬度 | 是 |
long | 经度 | 是 |
属性 | 说明 | 是否必需 |
---|---|---|
name | 字符串;联系人姓名 | 是 |
address | 字符串;联系人地址 | 否 |
birthday | 字符串;日期 | 否 |
emails | 字符串;电子邮件地址 | 否 |
org | 字符串;公司名称 | 否 |
phones | 字符串;电话号码 | 否 |
urls | 字符串;网址 | 否 |
name
字段。address
、birthday
、emails
、org
、phones
和 urls
。属性 | 说明 | 是否必需? |
---|---|---|
type | REACTION | 是 |
message_id | 用于标识要回应的消息的 ID | 是 |
emoji | 用作回应的表情符号;可以是表情符号本身或转义的 Unicode(例如 \uD83D\uDE0A) | 是 |
可以从日志中的消息事件或使用 ApiScope.chat
在 Open API 中获取上一条消息的消息 ID。
例如:
互动消息允许用户通过点击按钮快速回应。用户在列表或按钮消息中一次只能选择一个选项,但他们可以返回并重新打开先前的消息。
属性 | 说明 | 是否必需? |
---|---|---|
Header | 列表消息的标题,仅允许使用 text |
否 |
Body | 消息主体内容(最多 1024 个字符) | 是 |
Footer | 页脚内容(最多 60 个字符) | 否 |
Action | 在 action 内必须嵌套: - 一个包含按钮内容的 button 字段 - 至少一个 section 对象(最多 10 个) 在每个 section 中,必须添加至少一个 rows 对象 |
是 |
action
对象
属性 | 说明 | 是否必需? |
---|---|---|
button | 按钮内容。不能是空字符串,且在消息中必须唯一(最多 20 个字符) | 是 |
sections | section 对象数组。最少 1 个,最多 10 个 | 是 |
section
对象
属性 | 说明 | 是否必需? |
---|---|---|
title | 部分标题 | 是(当消息包含多个 section 时) |
rows | 包含一个选项列表。每个行项必须有标题和 ID。你可以添加描述(可选) | 是 |
属性 | 说明 | 是否必需 |
---|---|---|
Header | 列表消息的标题;可以为文本或媒体类型:“图片”、“视频”、“文档” | 否 |
Body | 消息主体内容(最多 1024 个字符) | 是 |
Footer | 页脚内容(最多 60 个字符) | 否 |
Action | 必须添加至少一个按钮,并包含类型和标题。最多不超过 3 个按钮 | 是 |
action
对象
属性 | 说明 | 是否必需? |
---|---|---|
buttons | 一个按钮可以包含以下参数: type:仅支持类型为 reply(用于回复按钮消息) title:按钮标题,不能为空字符串且在消息中必须唯一(最多 20 个字符) |
是 |
属性 | 说明 | 是否必需 |
---|---|---|
body | 消息主体内容(最多 1024 个字符) | 否 |
footer | 页脚内容(最多 60 个字符) | 否 |
action | 必须包含: - 必须设置为 single ,用于单一商品消息;- catalogId :用于此消息的目录 ID。可在 Commerce Manager 中获取;- productId :商品的唯一标识符(内容 ID) |
是 |
多商品消息最多只能包含 30 个商品。
属性 | 说明 | 是否必需 |
---|---|---|
header | type 必须为 text 。包含你想要显示的文本内容对象 |
是 |
body | 消息主体内容(最多 1024 个字符) | 是 |
footer | 页脚内容(最多 60 个字符) | 否 |
action | 必须包含: - type :必须为 multi ,用于多商品消息;- catalogId :你希望使用的商品目录 ID,可通过 Commerce Manager 获取;- sections :一个包含多个 section 对象的数组。必须至少包含一个 section |
是 |
sections
字段:
属性 | 说明 | 是否必需 |
---|---|---|
title | 每个 section 的标题 | 是 |
product_items | product_retailer_id :每个商品的唯一标识符(内容 ID) |
是 |
属性 | 说明 | 是否必需? |
---|---|---|
Name | 只能包含小写字母数字字符和下划线(_);不允许其他字符或空格 | 是 |
Category | 选择模板的正确分类;查看 支持的分类列表 | 是 |
Language | 选择模板的正确语言;所有翻译将使用相同模板名称;你将在发送模板时指定语言字段; 查看 支持的语言列表 | 是 |
Content | 模板消息的内容;支持使用 {{1}} 格式的参数占位符 |
是 |
Header | 消息模板的标题;可以是文本或媒体类型:“Image”、“Video”、“Document” | 否 |
Body | 消息模板的主体(字符限制:1024) | 是 |
Footer | 消息模板的文本页脚 | 否 |
Buttons | 模板消息的按钮;可以是行动呼吁或快速回复;最多支持 3 个按钮 | 否 |
属性 | 字符限制 |
---|---|
Body(无标题/页脚) | 最多 1024 个字符 |
Body(含标题/页脚) | 最多 160 个字符 |
Header | 60 个字符 |
Footer | 60 个字符 |
请注意,在 WhatsApp 消息模板中,字符限制不适用于 变量。
选择已有的“消息模板”。请确保你已完成 消息模板提交 流程,以查看你现有的模板。
将 语言策略 设置为 Deterministic(确定性)。
选择你消息模板的 语言。
你可以将消息作为对对话中先前消息的回复进行发送。先前的消息将在上下文气泡中被引用,并与回复消息一同显示。
在向 WhatsApp 用户发送任何消息时,你需要添加属性 reply_to
,并通过 Message ID
指定上下文消息。
属性 | 说明 | 是否必需 |
---|---|---|
reply_to | 要回复的消息的 Message ID | 是 |
ApiScope.chat
获取前一条消息的 message ID。例如: