脸书消息类型
Messenger支持不同操作类型的按楼多媒体内容及文字。
文字
{
type: "TEXT",
text: "Hello World!"
}
属性 | 说明 | 必须? |
---|---|---|
type | TEXT | 是 |
text | 字串;2,000字以內 | 是 |
图片
{
type: "IMAGE",
url: "http://image.png",
attachment_id: "SomeStringID"
}
属性 | 说明 | 必须? |
---|---|---|
type | IMAGE | 是 |
url | 图片的连结 | 是 |
attachment_id | 字串;上传图片的ID | 否 |
小提示:
- 图片支援以下档案格式
.jpg
、.jpeg
、.png
、.gif
、.tiff
及.bmp
- 图片档案大小建议不多於25MB
- 您可在发送图片後加入快速回复的按钮
语音
{
type: "AUDIO",
url: "http://audio.mp3",
attachment_id: "SomeStringID"
}
属性 | 说明 | 必须? |
---|---|---|
type | AUDIO | 是 |
url | 语音的连结 | 是 |
attachment_id | 字串;上传语音的ID | 否 |
小提示:
- 语音只支援以下的格式
.aac
、.flac
、.m4a
、.m4p
、.mp3
、.wav
及.wma
- 您可以发送有语音的快速回覆
影片
{
type: "VIDEO",
url: "http://video.mp4",
attachment_id: "SomeStringID",
}
属性 | 说明 | 必须? |
---|---|---|
type | VIDEO | 是 |
url | 影片的连结 | 是 |
attachment_id | 字串;上传影片的ID | 否 |
小提示:
- 影片支援以下档案格式
.mkv
、.gif
、.avi
、.wmv
、.rmvb
、.mp4
、.m4v
、.mpg
、.mpeg
及.3gp
- 影片档案大小建议不多於25MB
- 您可在发送影片後加入快速回复的按钮
文件
{
type: "FILE",
url: "http://file.pdf",
attachment_id: "SomeStringID"
}
属性 | 说明 | 必须? |
---|---|---|
type | FILE | 是 |
url | 文件的连结 | 是 |
attachment_id | 字串;上传文件的ID | 否 |
小提示:
- 文件支援以下档案格式
.pdf
- 文件档案大小建议不多於25MB
- 您可在发送文件後加入快速回复的按钮
常规模板轮播
借助常规模板,您可以发送包含图片、文本和按钮的结构化消息。包含 elements 数组所述的多个模板的常规模板会发送可水平滚动的项目轮播,每个项目都包含图片、文本和按钮。
{
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: "View Details"
}, {
type: "postback",
title: "Shop Now",
payload: "A_LONG_PAYLOAD_HERE"
}, {
type: "phone_number",
title: "some title 3",
payload: "PHONE_NUMBER"
}]
}],
image_aspect_ratio: "square",
}
响应物件
属性 | 说明 | 必须? |
---|---|---|
type | CAROUSEL | 是 |
carousel | 由多组常规模板物件组成的阵列;最多10组 | 是 |
image_aspect_ratio | 可设置为「horizontal」或者「square」;默认格式为「horizontal」 | 否 |
常规模板物件
属性 | 说明 | 必须? |
---|---|---|
title | 字串;80字以內 | 是 |
subtitle | 字串;80字以內 | 否 |
image_url | 图片档案的连结 | 否 |
default_action | 当用户点击图片时,默认的回传网页连结 | 否 |
buttons | 由多组按钮组成的阵列;最多3个按钮 | 否 |
小提示:
- 您可在发送常规模板後加入快速回复的按钮
- 您不一定要加入按钮,如无需进行任何回传通作,您可不使用任何按钮
按钮
{
type: "BUTTON",
text: "What can I do to help?",
buttons: [{
type: "web_url",
url: "https://sanuker.com",
title: "Get Order Status"
}, {
type: "phone_number",
title: "Call Me",
payload: "PHONE_NUMBER"
}, {
type: "postback",
title: "some title 2",
payload: "A_LONG_PAYLOAD_HERE"
}]
}
属性 | 说明 | 必须? |
---|---|---|
type | BUTTON | 是 |
text | 字串;640字以內 | 是 |
buttons | 由多组按钮组成的阵列;最多3个按钮 | 是 |
如果您需要查看不同类型的按钮,请参阅 Button Types
小提示:
- 您可在发送按钮後加入快速回复的按钮
快速回覆
借助快速回复,您可以通过在消息中发送按钮来收集消息接收人输入的信息。轻触快速回复后,按钮的值将在对话中发送,同时 Messenger 平台会向您的 Webhook 发送 messages 事件。快速回复是一类利用发送 API 发送的消息。
您最多可在对话中显示 13 个按钮,这些按钮可以包含一个标题和可选图片,并显示于编辑器上方的显眼位置。此外,您还可以使用快速回复请求用户提供位置信息、电子邮箱和手机号。
{
type: "QUICK_REPLIES",
text: "some text",
quickReplies: [{
content_type: "text",
title: "Red",
payload: "PAYLOAD_STRING",
image_url: "http://red.img.url"
}, {
content_type: "text",
title: "Green",
payload: "PAYLOAD_STRING",
image_url: "http://green.img.url"
}, {
content_type: "text"
}]
}
响应物件
属性 | 说明 | 必须? |
---|---|---|
type | QUICK_REPLIES | 是 |
text | 字串;2,000字以內 | 是 |
quickReplies | 由多组快速回复组成的阵列;最多13个按钮 | 是 |
快速回复物件
属性 | 说明 | 必须? |
---|---|---|
content_type | 只能设定为「text」 | 是 |
title | 字串;按钮标题;20字以內 | 是 |
image_url | 用于快速回复的图片的连结 | 否 |
payload | 自定义的负载触发点;1,000字以內 | 是 |
小提示:
- 图片档案的大小必须最小为24x24,而且实际大小会由系统自动裁切及调整
媒体模版
媒体模板让您可以通过结构化消息的形式发送图片、GIF 和视频,并可选择在其中添加按钮。利用这种方式发送的视频和 GIF 动图可在对话中播放。
{
type: "MEDIA",
media_type: "image",
attachment_id: "attachmentId",
buttons: [{
type: "postback",
title: "Show Me More!",
payload: "A_LONG_PAYLOAD_HERE"
}]
}
属性 | 说明 | 必须? |
---|---|---|
type | MEDIA | 是 |
media_type | 可设置为「image」或者「video」 | 是 |
attachment_id | 字串;上傳媒体的ID | 是 |
buttons | 由多组按钮组成的阵列;最多3个按钮 | 否 |
小提示:
- 您可在发送媒体後加入快速回复的按钮
公开回覆
每当用户在帖子评论时,聊天机器人能发送一个自动的回覆。
{
type: "PUBLIC_REPLY",
text: "some text",
attachment_id: "attachmentId",
attachment_url: "https://img.url"
}
属性 | 说明 | 必须? |
---|---|---|
type | PUBLIC_REPLY | 是 |
text | 字串;5,000字以內 | 一定要设置以下其中一样 text、attachment_id 或者 attachment_url |
attachment_id | 字串;上傳媒体的ID | 一定要设置以下其中一样 text、attachment_id 或者 attachment_url |
attachment_url | 发布媒体的连结 | 一定要设置以下其中一样 text、attachment_id 或者 attachment_url |
私人回覆
聊天机器人在您的收件夹作私人回覆。
{
type: "PRIVATE_REPLY",
text: "some text"
}
属性 | 说明 | 必须? |
---|---|---|
type | PRIVATE_REPLY | 是 |
text | 字串;2,000字以內 | 是 |