Web-Plugins – Referenz

Die Messenger-Plattform stellt praktischerweise verschiedene Web-Plugins bereit, die es dir leicht machen, eine Unterhaltung mit Personen zu beginnen, die dich im Web besuchen. Alle Plugins werden mit dem Facebook-SDK für Javascript implementiert.

Inhalt

Kund*innen-Chat-Plugin (Beta)

Mit dem Kund*innen-Chat-Plugin der Messenger-Plattform kannst du deinen Messenger-Bot direkt in deine Webseite integrieren. So können Kund*innen jederzeit über dieselben individuellen und ansprechenden Erlebnisse mit deinem Unternehmen kommunizieren, die sie vom Messenger gewohnt sind.

Weitere Details zur Verwendung findest du unter Kund*innen-Chat-Plugin.

Format zum Einbinden

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

Attribute

Attribut Typ Beschreibung

class

String

Wert muss fb-customerchat lauten.

page_id

String

Deine Seiten-ID

ref

String

Optional. Selbstdefinierte Zeichenfolge, die in messaging_postbacks- und messaging_referrals-Events an deinen Webhook weitergegeben wird.

theme_color

String

Optional. Die Farbe, die als Thema für das Plugin verwendet wird. Damit werden die Hintergrundfarbe des Customer Chat-Plugin-Symbols und die Hintergrundfarbe der Nachrichten, die Nutzer*innen senden, festgelegt. Unterstützt alle Hexadezimal-Farbcodes mit voranstehendem Nummernzeichen (z. B. #0084FF) außer Weiß. Wir empfehlen, eine Farbe auszuwählen, die einen starken Kontrast zu Weiß bildet.

logged_in_greeting

String

Optional. Der Begrüßungstext, der angezeigt wird, wenn der*die Nutzer*in derzeit bei Facebook angemeldet ist. Maximal 80 Zeichen.

logged_out_greeting

String

Optional. Der Begrüßungstext, der angezeigt wird, wenn der*die Nutzer*in derzeit nicht bei Facebook angemeldet ist. Maximal 80 Zeichen.

greeting_dialog_display

String

Optional. Legt fest, wie der Begrüßungsdialog angezeigt wird. Die folgenden Werte werden unterstützt:


  • show: Der Begrüßungsdialog wird beim Laden des Plugins immer angezeigt.
  • fade: Der Begrüßungsdialog des Plugins wird angezeigt. Danach verschwindet er langsam und bleibt dann ausgeblendet.
  • hide: Der Begrüßungsdialog des Plugins wird immer ausgeblendet, bis ein*e Nutzer*in auf das Plugin klickt.

Die Standardeinstellung für Desktops lautet show und für mobile Browser hide.

greeting_dialog_delay

String

Optional. Legt die Dauer (in Sekunden) fest, bis der Begrüßungsdialog nach dem Laden des Plugins angezeigt wird. Damit kannst du selbstdefiniert festlegen, wann der Begrüßungsdialog angezeigt werden soll.

minimized

Boolescher Wert

Hinweis über Veraltung

Dieses Attribut ist nun veraltet. Bitte verwende greeting_dialog_display, um dein Plugin stattdessen zu personalisieren. Das greeting_dialog_delay-Attribut hat Vorrang vor dem minimized-Attribut.

Optional.

  • true Wenn diese Option aktiviert ist, hat sie dieselbe Auswirkung wie die Einstellung greeting_dialog_delay = "fade".
  • false Wenn diese Option deaktiviert ist, hat sie dieselbe Auswirkung wie die Einstellung greeting_dialog_delay = "show".

Plugin „Sende uns eine Nachricht“

Führe im Messenger eine Person direkt in eine Unterhaltung.

Weitere Details zur Verwendung findest du unter Plugin „Sende uns eine Nachricht“.

Format zum Einbinden

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

Attribute

Attribut HTML5-Attribut Typ Beschreibung

class

String

Wert muss fb-messengermessageus lauten.

page_id

String

Deine Seiten-ID

messenger_app_id

Zahl

Deine Facebook-App-ID.

color

data-color

String

Die Button-Farbe: blue oder white.


Dieser Wert lautet standardmäßig blue.

size

data-size

String

Die Button-Größe: standard, large oder xlarge.


Dieser Wert lautet standardmäßig large.

ref

String

Optional. Selbstdefinierte Zeichenfolge, die in messaging_postbacks- und messaging_referrals-Events an deinen Webhook weitergegeben wird.

Plugin „An Messenger senden“

Sende dem*der Nutzer*in eine Nachricht von deinem Messenger-Bot im Hintergrund und melde ihn so an.

Weitere Details zur Verwendung findest du unter Plugin „An Messenger senden“.

Format zum Einbinden

<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>

Attribute

Attribut Typ Beschreibung

class

String

Wert muss fb-send-to-messenger lauten.

page_id

String

Deine Seiten-ID

messenger_app_id

Zahl

Deine Facebook-App-ID.

color

String

Optional. Farbe des Buttons: blue oder white.


Dieser Wert lautet standardmäßig blue.

size

String

Optional. Größe des Buttons: standard, large oder xlarge.


Dieser Wert lautet standardmäßig large.

ref

String

Optional. Selbstdefinierter Statusparameter. Max. 250 Zeichen.


Gültige Zeichen sind a-z A-Z 0-9 +/=-._


Sollte aus Sicherheitsgründen codiert und verschlüsselt sein.

enforce_login

Boolescher Wert

Optional. Wenn true, müssen sich angemeldete Nutzer*innen beim Klick auf den Button erneut anmelden. Dieser Wert lautet standardmäßig false.

Verwende den Parameter ref, um den Status mit der Authentifizierung zu übergeben. Wenn du das Plugin an mehreren Stellen anzeigst, solltest du den Status eventuell je nach Anzeigeort des Plugins ändern.

Kontrollkästchen-Plugin

Mit dem Kontrollkästchen-Plugin kann ein*e Nutzer*in automatisch über ein Formular wie den Bezahlvorgang oder die Registrierung ein Abonnement deines Messenger-Bots abschließen.

Weitere Details zur Verwendung findest du unter Kontrollkästchen-Plugin.

Format zum Einbinden

<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>

Attribute

Attribut Typ Beschreibung

class

String

Der Wert muss fb-messenger-checkbox lauten.

page_id

Nummer

Die mit deinem Bot verknüpfte Facebook-Seiten-ID.

messenger_app_id

Nummer

Deine Facebook-App-ID.

user_ref

String

Einmaliger Parameter für die Weiterleitung eines*einer Nutzer*in. Max. 250 Zeichen.


Gültige Zeichen sind a-z A-Z 0-9 +/=-._

allow_login

Boolescher Wert

Optional. Ermöglicht Personen den Login, wenn keine aktive Sitzung vorhanden ist. Dieser Wert lautet standardmäßig true.

size

String

Optional. Plugin-Größe: small, medium, large, standard, xlarge.


Dieser Wert lautet standardmäßig large.

skin

String

Optional. Legt das Farbschema für den Plugin-Content fest. Die folgenden Optionen werden unterstützt:

  • light: Plugin wird mit dunklem Text angezeigt.
  • dark: Plugin wird mit weißem Text, transparentem Messenger-Symbol und weißem Blitz angezeigt.

Dieser Wert lautet standardmäßig light.

center_align

Boolescher Wert

Optional. Legt fest, ob der Plugin-Content zentriert ist.


Dieser Wert lautet standardmäßig false.