WhatsApp消息类型
您可向您的用户发送以下类型的消息:
文字
{
type: "TEXT",
text: "Hello World!",
}
属性 | 简介 | 必须? |
---|---|---|
type | TEXT | 是 |
text | 字串;最多2000个字元 | 是 |
图片
{
type: "IMAGE",
text: "I am Sanuker!",
url: "http://image.png",
}
属性 | 简介 | 必须? |
---|---|---|
type | IMAGE | 是 |
text | 字串;WhatsApp图片的说明文字 | 否 |
url | 图片档案的连结 | 是 |
小提示:
- 图片支援以下档案格式,包括
.jpeg
及.png
- 图片档案大小建议不多於25MB
语音
{
type: "AUDIO",
url: "http://audio.aac",
}
属性 | 简介 | 必须? |
---|---|---|
type | AUDIO | 是 |
url | 语音档案的连结 | 是 |
小提示:
- 语音支援以下档案格式,包括
.aac
影片
{
type: "VIDEO",
url: "http://video.mp4",
}
属性 | 简介 | 必须? |
---|---|---|
type | VIDEO | 是 |
url | 影片档案的连结 | 是 |
小提示:
- 影片支援以下档案格式,包括
.mp4
- 影片档案大小建议不多於25MB
文件
{
type: "FILE",
url: "http://file.pdf",
}
属性 | 简介 | 必须? |
---|---|---|
type | FILE | 是 |
url | 文件档案的连结 | 是 |
小提示:
- 文件支援以下档案格式,包括
.pdf
- 文件档案大小建议不多於25MB
位置
{
"type": "LOCATION",
"text": "ABC Company",
"address": "Room C, 1/F, DFG Building, 101 Rainbow Road",
"lat": 22.31586918460027,
"long": 114.20883121469535
}
属性 | 简介 | 必须? |
---|---|---|
type | LOCATION | 是 |
text | String; Name of location | 否 |
address | String; Addresso of Location | 否 |
lat | Latitude | 是 |
long | Longitude | 是 |
联络
{
"type": "CONTACTS",
"contacts": [
{
"id": "YXpJfusT",
"name": {
"formatted_name": "John Lee",
"first_name": "John",
"last_name": "Lee",
"prefix": "Mr"
},
"addresses": [
{
"type": "work",
"city": "Hong Kong",
"street": "Rainbow Road 131, ABC Building"
}
],
"emails": [
{
"type": "work",
"email": "workmail123@gmail.com"
}
],
"phones": [
{
"type": "cell",
"phone": "+852 1234 5678"
}
],
"urls": [
{
"type": "work",
"url": "www.sanuker.com"
}
],
"org": {
"company": " Sanuker"
}
}
]
}
属性 | 简介 | 必须? |
---|---|---|
name | String; name of contact | 是 |
address | String; contact address | 否 |
birthday | String; date | 否 |
emails | String; email address | 否 |
org | String; company name | 否 |
phones | String; phone number | 否 |
urls | String; url | 否 |
Contact
中的每个 Object 都包含一个或多个可选参数,你可以参考此处了解详情。
互动式信息
互动式信息通过提供可点击的按钮,使用户能够快速做出反应。用户不能同时从列表或按钮信息中选择一个以上的选项,但他们可以返回并重新打开以前的信息。
单一产品信息
"type": "WHATSAPP_PRODUCT",
"body": {
"text": "Check out our Bag of the Day"
},
"action": {
"catalogId": "4928452840550143",
"productId": "03-Pack"
}
属性 | 简介 | 必须? |
---|---|---|
body | The body content of the message (Maximum of 1024 characters) | 否 |
footer | The footer content (Maximum of 60 characters) | 否 |
action | Must contain - catalogId : an ID for the catalog you want to use for this message. Retrieve this ID via Commerce Manager. - productId : a product’s unique identifier (Content ID). | 是 |
多个产品信息
多个产品信息只能包含最多 30 个库存产品的选择。
{
"type": "WHATSAPP_PRODUCT_LIST",
"header": {
"type": "text",
"text": "Fall Collection"
},
"body": {
"text": "Click view items to see our Fall Collection"
},
"action": {
"catalogId": "4928452840550143",
"sections": [
{
"title": "Urban Essentials",
"productIds": [
"01-Pack",
"02-Bag"
]
},
{
"title": "Hiking Essentials",
"productIds": [
"03-Pack"
]
}
]
}
}
属性 | 简介 | 必须? |
---|---|---|
header | type must be text . Contain a text object with the desired content | 是 |
body | The footer content (Maximum of 1024 characters) | 是 |
footer | The footer content (Maximum of 60 characters) | 否 |
action | Must contain - catalogId : an ID for the catalog you want to use for this message. Retrieve this ID via Commerce Manager - sections : Array of section objects. You must include at least one section | 是 |
sections
field
P属性 | 简介 | 必须? |
---|---|---|
title | a title for each section | 是 |
productIds | product’s unique identifier (Content ID) | 是 |
列表信息
{
"type": "WHATSAPP_LIST",
"header": {
"type": "text",
"text": "Hello 👋🏻"
},
"body": {
"text": "Sanuker provides chatbot solutions."
},
"footer": {
"text": "Facebook and WhatsApp Official Business Partner"
},
"action": {
"button": "Menu",
"sections": [
{
"title": "section title",
"rows": [
{
"payload": "GREETINGS",
"title": "Main Menu",
"description": "Hello!"
},
{
"payload": "ABOUT_SANUKER",
"title": "About Sanuker",
"description": "Who are you?"
}
]
}
]
}
}
属性 | 描述 | 需要? |
---|---|---|
Header | 列表信息的标题;它可以是一个文本或媒体。"图片"、"视频"、"文档" | 否 |
Body | 信息的主体内容(最多1024个字符)。 | 是 |
Footer | 页脚内容(最多60个字符) | 否 |
Action | 在动作里面,你必须嵌套: - 一个带有你的按钮内容的按钮字段,以及 - 至少一个部分对象(最多10个) 在部分里面,你必须添加至少一个行对象 | 是 |
action
Object
属性 | 描述 | 需要? |
---|---|---|
button | B按钮内容。它不能是一个空字符串,并且在信息中必须是唯一的(最多20个字符)。 | 是 |
sections | 节段对象的数组。最小为1,最大为10 | 是 |
section
Object
属性 | 描述 | 需要? |
---|---|---|
title | 节的标题 | Y(如果信息有多个节)。 | |
rows | 包含一个行的列表。每行必须有一个标题和一个ID。你可以添加一个描述,但它是可选的 | Y |
回复按钮
{
"type": "WHATSAPP_REPLY_BUTTONS",
"header": {
"type": "image",
"image": {
"id": "2e5a7aad-e8c7-43ba-ad5e-b298bb32f8af"
}
},
"body": {
"text": "Sanuker provides chatbot solutions."
},
"footer": {
"text": "Facebook and WhatsApp Official Business Partner"
},
"action": {
"buttons": [
{
"type": "reply",
"reply": {
"payload": "GREETINGS",
"title": "Main Menu"
}
},
{
"type": "reply",
"reply": {
"payload": "ABOUT_SANUKER",
"title": "About Sanuker"
}
}
]
}
}
属性 | 描述 | 需要? |
---|---|---|
Header | 列表信息的标题;它可以是文本或媒体。"图片", "视频", "文件" | 否 |
Body | 信息的主体内容(最多1024个字符)。 | 是 |
Footer | 页脚内容(最多60个字符) | 否 |
Action | 你必须至少添加一个按钮,并包括类型和标题。你不能添加超过3个按钮。 | 是 |
action
Object
属性 | 描述 | 需要? |
---|---|---|
buttons | 一个按钮可以包含以下参数。 类型:唯一支持的类型是回复(对于回复按钮信息) 标题。按钮的标题。它不能是一个空字符串,并且必须在信息中是唯一的(最多20个字符)。 | 是 |
消息模板
{
"type": "TEMPLATE",
"components": [
{
"parameters": [
{
"image": {
"id": "57ec1287-6915-4a44-8dc9-9caa620385e1"
},
"type": "image"
}
],
"type": "header"
},
{
"type": "button",
"sub_type": "quick_reply",
"index": "0",
"parameters": [
{
"type": "payload",
"payload": "Contact Sanuker"
}
]
},
{
"type": "button",
"sub_type": "quick_reply",
"index": "1",
"parameters": [
{
"type": "payload",
"payload": "GREETINGS"
}
]
},
{
"type": "button",
"sub_type": "quick_reply",
"index": "2",
"parameters": [
{
"type": "payload",
"payload": "ABOUT_SANUKER"
}
]
}
],
"languagePolicy": "deterministic",
"languageCode": "en",
"namespace": "bc3ac5dd_6dfd_2345_d5f7_123456789bf",
"elementName": "multiple_button_test_1",
"accountId": "1234567890"
}
请注意,
components
是必须的,否则,在使用Bot API的sendResponses
时,响应会无法被发送。
消息范本资料
属性 | 简介 | 必须? |
---|---|---|
Name | 只能包括小写英文字母丶数字及底线( _ ); 其馀字元或空白均不能接受 | 是 |
Category | 选择正确的消息范本类型;详情请参阅支援范本类型 | 是 |
Language | 选择正确的消息范本语言;同一消息范本内的所有翻译都推有同一个消息范本名称;在发送消息范本的时候,您须注明该消息范本的发送语言;详情请参阅支援语言 | 是 |
Content | 消息范本的内容;针对所有动态参数,您可以{{1}} 此格式填写取代` | 是 |
Header | 消息模板的标题;可以是文字或媒体。"图片", "视频", "文档" | 否 |
Body | 消息模板的正文 | 是 |
Footer | 信息模板的脚注 | 否 |
Buttons | 消息模板的按钮;Call-to-action或快速回复;最多3个按钮。 | 否 |
最大字符数限制
属性 | 字符数限制 |
---|---|
Body (没有Header/Footer时) | 最多1024个字符 |
Body (含有Header/Footer时) | 最多1024个字符 |
Header | 60个字符 |
Footer | 60个字符 |
在消息范本中,最大字符数限制并不适用于varaiable。
设置程序
- 开启「Response Builder」,于消息类型的下拉选单中选择「WhatsApp Message Template」。
创建消息模板响应
于「Message Template」选择现有的消息模板。假如您仍未有现成的消息模板,请先向WhatsApp递交消息范本。
将「Language Policy」语言设定为「Deterministic」。
为消息模板选择语言。
以下为自选设定:
- 如果您的消息模板附有快速回复的按钮,请输入负载触发点。
输入负载触发点
- 如果您的消息模板有附上图片或影片等多媒体标题,请输入Media ID或url。
添加多媒体