Facebook消息类型详解 - WOZTELL集成指南

Facebook 消息类型

有多种类型的原始(非结构化)内容可以发送给您的用户。

文本

文本
文本
{
type: "TEXT",
text: "Hello World!"
}
复制
属性描述必填
typeTEXT
text字符串;限制为2000个字符


图片

图片
图片
{
type: "IMAGE",
url: "http://image.png",
attachment_id: "SomeStringID"
}
复制
属性描述必填
typeIMAGE
url图片文件的URL
attachment_id字符串;您上传图片的ID
信息
注意
  • 图片必须是有效的图片文件格式,包括 .jpg、 .jpeg、 .png、 .gif、 .tiff和 .bmp
  • 最大文件大小为2MB
  • 您可以与图片一起发送快速回复按钮


音频

音频
音频
{
type: "AUDIO",
url: "http://audio.mp3",
attachment_id: "SomeStringID",
}
复制
属性描述必填
typeAUDIO
url音频文件的URL
attachment_id字符串;您上传音频的ID
信息
注意
  • 音频必须是有效的音频文件格式,包括 .aac、 .flac、 .m4a、 .m4p、 .mp3、 .wav和 .wma
  • 您可以与音频消息一起发送快速回复按钮


视频

视频
视频
{
type: "VIDEO",
url: "http://video.mp4",
attachment_id: "SomeStringID"
}
复制
属性描述必填
typeVIDEO
url视频文件的URL
attachment_id字符串;您上传视频的ID
信息
注意
  • 视频必须是有效的视频文件格式,包括 .mkv、 .gif、 .avi、 .wmv、 .rmvb、 .mp4、 .m4v、 .mpg、 .mpeg和 .3gp
  • 最大文件大小为25MB
  • 您可以与视频一起发送快速回复按钮


文件

文件
文件
{
type: "FILE",
url: "http://file.pdf",
attachment_id: "SomeStringID",
}
复制
属性描述必填
typeFILE
url文件附件的URL
attachment_id字符串;您上传文件的ID
信息
注意
  • 文件必须是有效的文件格式,包括 .pdf
  • 最大文件大小为25MB
  • 您可以与文件一起发送快速回复按钮


轮播

轮播是一行可以水平滚动的项目,每个项目由图片附件、简短描述和按钮组成,用于向用户请求输入。

轮播
轮播
{
type: "CAROUSEL",
carousel: [{
title: "Classic T-Shirt",
subtitle: "Medium Grey\n$29.99",
image_url: "http://img.url",
default_action: {
type: "web_url",
url: "https://zuckstees.com"
},
buttons: [{
type: "web_url",
url: "https://sanuker.com",
title: "查看详情"
}, {
type: "postback",
title: "立即购买",
payload: "A_LONG_PAYLOAD_HERE"
}, {
type: "phone_number",
title: "some title 3",
payload: "PHONE_NUMBER"
}]
}],
image_aspect_ratio: "square"
}
复制
响应对象
属性描述必填
typeCAROUSEL
carousel轮播项目数组;最多10个元素
image_aspect_ratio设置“horizontal”(1.91:1)或“square”(1:1);默认是“horizontal”
carousel 对象
属性描述必填
title字符串;限制为80个字符
subtitle字符串;限制为80个字符
image_url显示的图片URL
default_action用户点击图片时的默认网站URL
buttons按钮数组;最多3个按钮,作为行动号召显示
信息
注意
  • 您可以与轮播一起发送快速回复按钮
  • 如果不打算有行动号召,轮播不一定要包含按钮


按钮

按钮
按钮

{
type: "BUTTON",
text: "我能帮您做些什么?",
buttons: [{
type: "web_url",
url: "https://sanuker.com",
title: "获取订单状态"
}, {
type: "phone_number",
title: "给我打电话",
payload: "PHONE_NUMBER"
}, {
type: "postback",
title: "some title 2",
payload: "A_LONG_PAYLOAD_HERE"
}]
}
复制
属性描述必填
typeBUTTON
text字符串;限制为640个字符
buttons按钮数组;最多3个按钮,作为行动号召显示

URL按钮

URL按钮
URL按钮
打开网页视图
打开网页视图

URL按钮可用于在应用内浏览器中打开网页。该按钮可与按钮模板、轮播和列表一起使用。网页视图可以以三种不同的方式呈现:紧凑、高大或全屏。


{
type: "web_url",
title: "某个标题",
url: "https://sanuker.com",
webview_height_ratio: "tall",
messenger_extensions: true,
fallback_url: "https://sanuker.com",
webview_share_button: "hide",
urlTracking: false,
}
复制
属性描述必填
typeweb_url
title字符串;限制为20个字符
url目标URL;如果messenger_extensions为“true”,必须是HTTPS
webview_height_ratio网页视图窗口高度;设置为“compact”,“tall”或“full”;默认为“full”
fallback_url在不支持Messenger扩展的客户端上使用的URL;仅当messenger_extensions为“true”时设置;如果未指定,默认为url
webview_share_button设置为“hide”或未设置
urlTracking默认为“true”

可以在创建响应的URL按钮时启用URL分析功能。

用户点击URL按钮后,点击行为将被追踪并记录到分析仪表盘。



回传按钮

回传按钮
回传按钮

回传按钮用于触发聊天机器人中的动作。你可以为按钮设置payload(负载)。


{
type: "postback",
title: "某个标题",
payload: "some payload",
}
复制
属性描述必填
typepostback
title字符串;限制为20个字符
payload自定义payload 触发器;限制为1000个字符


呼叫按钮

呼叫按钮
呼叫按钮

呼叫按钮可直接用于发起电话呼叫。


{
type: "phone_number",
title: "给我们打电话",
payload: "+85281930208"
}
复制
属性描述必填
typephone_number
title字符串;限制为20个字符
payload格式必须以“+”开头,后跟国家代码、区号和本地号码,且无空格


登录按钮

登录按钮
登录按钮

登录按钮可以用于将第三方用户账户链接到Facebook Messenger。


{
"type": "account_link",
"url": "https://stella.sanuker.com"
}
复制
属性描述必填
typeaccount_link
url目标URL;必须是HTTPS


快速回复

快速回复为消息中的按钮提供了不同的呈现方式。它包含文本和可选的图片。

快速回复与按钮的唯一区别是,快速回复只显示一次,点击后会被关闭,而按钮即使被点击也会保留在消息中。这防止了用户点击之前消息中附带的旧快速回复按钮的情况。

Facebook快速回复
Facebook快速回复

{
type: "QUICK_REPLIES",
text: "some text",
quickReplies: [{
content_type: "text",
title: "红色",
payload: "PAYLOAD_STRING",
image_url: "http://red.img.url"
}, {
content_type: "text",
title: "绿色",
payload: "PAYLOAD_STRING",
image_url: "http://green.img.url"
}, {
content_type: "text"
}]
}
复制
响应对象
属性描述必填
typeQUICK_REPLIES
text字符串;限制为2000个字符
quickReplies快速回复按钮数组;最多13个按钮
quickReplies 对象
属性描述必填
content_type设置为 "text""user_phone_number""user_email"
title按钮的文字说明;限制为20个字符仅当 content_type 为 "text" 时必填
image_url文本快速回复按钮的图片URL
payload自定义 payload 触发器;限制为1000个字符仅当 content_type 为 "text" 时必填
提示
提示
  • image_url 的图片应至少为24x24像素,会被裁剪和调整大小。
  • 如果用户资料中没有电话号码或电子邮箱,则不会显示 "user_phone_number""user_email" 快速回复按钮。


媒体

媒体类似于没有标题和副标题的轮播,但它也可以显示视频。

Facebook媒体
Facebook媒体

{
type: "MEDIA",
media_type: "image",
attachment_id: "attachmentId",
buttons: [{
type: "postback",
title: "展示更多!",
payload: "A_LONG_PAYLOAD_HERE"
}]
}
复制
属性描述必填
typeMEDIA
media_type设置为“image”或“video”
attachment_id字符串;你上传的媒体文件ID
buttons按钮数组;最多3个作为行动呼吁的按钮
提示
注意
  • 你可以在媒体模板中发送快速回复按钮


公开回复

公开回复是指对Facebook帖子用户评论的回复。

Facebook公开回复
Facebook公开回复

{
type: "PUBLIC_REPLY",
text: "some text",
attachment_id: "attachmentId",
attachment_url: "https://img.url"
}
复制
属性描述必填
typePUBLIC_REPLY
text字符串;限制为5000个字符必须设置 text、attachment_id 或 attachment_url 中的一个
attachment_id字符串;你上传的媒体文件ID必须设置 text、attachment_id 或 attachment_url 中的一个
attachment_url你想发布的媒体文件URL必须设置 text、attachment_id 或 attachment_url 中的一个


消息类型

Meta 支持三种消息类型,以确保发送的消息符合消息政策和收件人的偏好。

请参阅此处了解更多关于消息类型的详细信息。

响应


{
"type": "TEXT",
"messagingMeta": {
"messaging_type": "RESPONSE"
},
"text": "测试文本"
}
复制

更新


{
"type": "TEXT",
"messagingMeta": {
"messaging_type": "UPDATE"
},
"text": "测试文本"
}
复制

消息标签


{
"type": "TEXT",
"messagingMeta": {
"tag": "ACCOUNT_UPDATE",
"messaging_type": "MESSAGE_TAG"
},
"text": "测试文本"
}
复制
属性描述
tag以下之一:ACCOUNT_UPDATECONFIRMED_EVENT_UPDATECUSTOMER_FEEDBACKHUMAN_AGENT