Messenger 开放平台

网页插件参考文档

Messenger 开放平台提供一组便利的网页插件，可帮助您轻松地与通过网页访问的用户开始对话。所有插件都通过 Javascript 版 Facebook SDK 来实现。

目录

顾客聊天插件（封闭式 Beta 测试）

借助 Messenger 开放平台的顾客聊天插件，您可以直接在自己的网站中集成 Messenger 智能助手。如此一来，顾客就可以随时与您的商家互动，同时获得与使用 Messenger 相同的个性化富媒体体验。

如需了解详细用法，请参阅顾客聊天插件。

包含格式

<div class="fb-customerchat"
 page_id="<PAGE_ID>">
</div>

属性

属性 类型 描述

class

字符串

值必须为 fb-customerchat。

page_id

字符串

您的公共主页编号

ref

字符串

可选。此自定义字符串将通过 messaging_postbacks 和 messaging_referrals 事件传递到您的 Webhooks。

theme_color

字符串

可选。插件使用的主题颜色，包括顾客聊天插件图标的背景颜色和用户发送的任何消息的背景颜色。支持任何带前导数字符号的十六进制颜色代码（如 #0084FF），白色除外。强烈建议您选择与白色形成鲜明对比的颜色。

logged_in_greeting

字符串

可选。要对当前已登录 Facebook 的用户显示的问候语。不超过 80 个字符。

logged_out_greeting

字符串

可选。要对当前未登录 Facebook 的用户显示的问候语。不超过 80 个字符。

greeting_dialog_display

字符串

可选。设置问候对话框的显示方式。支持下列值：


  • show：在加载插件时始终显示问候对话框。
  • fade：插件的问候对话框将在显示后淡出，之后一直隐藏。
  • hide：插件的问候对话框将一直隐藏，直到用户点击插件才会显示。

在桌面端默认为 show，在移动端默认为 hide。

greeting_dialog_delay

字符串

可选。设置插件加载后延迟多少秒才显示问候对话框。您可使用此属性自定义问候对话框的显示时机。

minimized

布尔值

停用通知

此属性现已停用。请改用 greeting_dialog_display 来自定义插件。greeting_dialog_delay 属性将优先于 minimized 属性。

可选。

  • true 设置为 true 时，与 greeting_dialog_delay = "fade" 设置具有相同效果。
  • false 设置为 false 时，与 greeting_dialog_delay = "show" 设置具有相同效果。

“给我们发消息”插件

将用户直接引导到 Messenger 对话。

如需了解详细用法，请参阅“给我们发消息”插件。

包含格式

<div class="fb-messengermessageus" 
  messenger_app_id="<APP_ID>" 
  page_id="<PAGE_ID>"
  color="<blue | white>"
  size="<standard | large | xlarge>">
</div>

属性

属性 HTML5 属性 类型 描述

class

字符串

值必须为 fb-messengermessageus。

page_id

字符串

您的公共主页编号

messenger_app_id

数字

您的 Facebook 应用编号。

color

data-color

字符串

按钮颜色：blue 或 white。


默认为 blue。

size

data-size

字符串

按钮大小：standard、large 或 xlarge。


默认值为 large。

ref

字符串

可选。此自定义字符串将通过 messaging_postbacks 和 messaging_referrals 事件传递到您的 Webhooks。

“发送到 Messenger”插件

在后台通过 Messenger 智能助手向用户发送消息，让他们订阅。

如需了解详细用法，请参阅“发送到 Messenger”插件。

包含格式

<div class="fb-send-to-messenger" 
  messenger_app_id="<APP_ID>" 
  page_id="PAGE_ID" 
  data-ref="<PASS_THROUGH_PARAM>" 
  color="<blue | white>" 
  size="<standard | large | xlarge>">
</div>

属性

属性 类型 描述

class

字符串

值必须为 fb-send-to-messenger。

page_id

字符串

您的公共主页编号

messenger_app_id

数字

您的 Facebook 应用编号。

color

字符串

可选。按钮颜色：blue 或 white。


默认为 blue。

size

字符串

可选。按钮大小：standard、large 或 xlarge。


默认值为 large。

ref

字符串

可选。自定义状态参数。不超过 250 个字符。


有效字符为 a-z A-Z 0-9 +/=-._


出于安全考虑，应对此属性编码和加密。

enforce_login

布尔值

可选。如果为 true，则点击该按钮时，已登录用户必须重新登录。默认值为 false。

使用 ref 参数传递身份验证状态。如要在多个位置显示插件，您可能需要根据插件显示位置修改状态。

复选框插件

借助复选框插件，您可让用户在填写表单的过程中（例如结账或注册）订阅 Messenger 智能助手。

如需了解详细用法，请参阅复选框插件。

包含格式

<div class="fb-messenger-checkbox"  
  origin=<PAGE_DOMAIN>
  page_id=<PAGE_ID>
  messenger_app_id=<APP_ID>
  user_ref="<UNIQUE_REF_PARAM>"
  allow_login="<true>"
  size="<small | medium | large | standard | xlarge>"
  skin="<light|dark>"
  center_align="<true|false>">
</div>

属性

属性 类型 描述

class

字符串

值必须为 fb-messenger-checkbox

page_id

数字

与您的智能助手关联的 Facebook 公共主页编号。

messenger_app_id

数字

您的 Facebook 应用编号。

user_ref

字符串

用于指代用户的唯一参数。不超过 250 个字符。


有效字符为 a-z A-Z 0-9 +/=-._

allow_login

布尔值

可选。让用户能够在没有已有会话的情况下登录。默认为 true。

size

字符串

可选。插件大小：small、medium、large、standard、xlarge。


默认值为 large。

skin

字符串

可选。设置插件内容的色彩主题。支持下列选项：

  • light：插件显示深色文本。
  • dark：插件显示白色文本、透明 messenger 图标和白色闪电图标。

默认为 light。

center_align

布尔值

可选。设置插件内容是否居中对齐。


默认值为 false。