`persistent_menu`-Referenz

Du kannst das beständige Menü für deinen Bot einstellen, damit Nutzer*innen deine Funktionen während der Unterhaltung entdecken und einfacher aufrufen können.

Das beständige Menü ist immer für Nutzer*innen verfügbar. Dieses Menü sollte allgemeine Handlungen enthalten, die Nutzer*innen jederzeit ausführen können. Über ein beständiges Menü kannst du neuen und wiederkehrenden Nutzer*innen auf einfache Weise die Grundfunktionen deines Bots vermitteln. Das Menü wird automatisch in einem Thread angezeigt, wenn die Person nach einer längeren Abwesenheit wieder zurückkehrt. Diese Einstellungen gehören zur Messenger Profile API-Referenz.

Das beständige Menü kann auch auf Nutzer*innen-Ebene eingerichtet und geändert werden. Weitere Informationen dazu findest du unter Menü auf Nutzer*innen-Ebene.

Voraussetzungen

Führe Folgendes aus, um das beständige Menü zu verwenden:

Lege einen „Los geht‘s“-Button fest.
Nimm die „Administrator“-Rolle für die Seite an, die mit dem Bot verknüpft ist.

`persistent_menu`-Format

Beispiel für ein beständiges Menü

{
    "persistent_menu": [
        {
            "locale": "default",
            "composer_input_disabled": false,
            "call_to_actions": [
                {
                    "type": "postback",
                    "title": "Talk to an agent",
                    "payload": "CARE_HELP"
                },
                {
                    "type": "postback",
                    "title": "Outfit suggestions",
                    "payload": "CURATION"
                },
                {
                    "type": "web_url",
                    "title": "Shop now",
                    "url": "https://www.originalcoastclothing.com/",
                    "webview_height_ratio": "full"
                }
            ]
        }
    ]
}

Eigenschaften

Eigenschaft	Typ	Beschreibung
`locale`	String	Ein Array mit Objekten, die das beständige Menü für verschiedene Ländereinstellungen definieren. Das Menü mit einer `locale`-Eigenschaft, die mit der Ländereinstellung der Person übereinstimmt, wird angezeigt. Mindestens ein Objekt im `persistent_menu`-Array muss `"locale": "default"` angeben. Dieses Menü wird als Fallback verwendet, wenn kein Objekt eine `locale`-Eigenschaft aufweist, die mit der Ländereinstellung desder Nutzerin übereinstimmt. Weitere Informationen dazu findest du in der Liste der unterstützten Spracheinstellungen.
`composer_input_disabled`	Boolescher Wert	Deaktiviert das Eingabefeld im Messenger, wenn der Wert `true` lautet. Das bedeutet, dass Nutzer*innen nur über das beständige Menü, Postbacks, Buttons und Webansichten mit deinem Bot interagieren können. Dieser Wert lautet standardmäßig `false`.
`disabled_surfaces`	Array	Array an Schnittstellennamen zur Deaktivierung des beständigen Menüs. Derzeit wird nur `customer_chat_plugin` unterstützt.
`call_to_actions`	Array<`menu_item`>	Ein Array mit Menüelementen der obersten Ebene für das beständige Menü. Maximal drei Elemente sind zulässig. Erforderlich, wenn `"composer_input_disabled": true`.

`menu_item`-Objekt

Eigenschaft	Typ	Beschreibung
`type`	String	Der Typ des Menüelements. Die folgenden Werte werden unterstützt: `web_url`: Gibt an, ob das Element ein URL-Button ist. `postback`: Gibt an, ob das Element ein Postback-Button ist.
`title`	String	Titel für das Menüelement. Max. 30 Zeichen.
`url`	String	URL, die geöffnet wird, wenn jemand auf den Button tippt. Erforderlich, wenn der Typ „`web_url`“ ist.
`payload`	String	Daten, die als `messaging_postbacks`-Event an deinen Webhook zurückgesendet werden. Erforderlich, wenn der Typ „`postback`“ ist. Max. 1.000 Zeichen.
`webview_height_ratio`	String	*Optional.* Höhe der Webansicht. Gültige Werte umfassen `compact`, `tall`, `full`.
`messenger_extensions`	Boolescher Wert	*Optional.* Muss `true` lauten, wenn der Elementtyp „`web_url`“ ist und das SDK für Messenger-Erweiterungen in der Webansicht verwendet wird.
`fallback_url`	String	*Optional.* URL zum Öffnen in der Webansicht für Clients, die das SDK für Messenger-Erweiterungen nicht unterstützen. Wenn dies nicht festgelegt wird, wird die `url` als Fallback verwendet. Dies kann nur festgelegt werden, wenn `"messenger_extensions": true`.
`webview_share_button`	String	*Optional.* Setze dies auf `hide`, um das Teilen der Webansicht zu deaktivieren (bei sensiblen Inhalten).

Deaktivieren des beständigen Menüs

In manchen Fällen ist es von Vorteil, das beständige Menü für deinen Bot im Chat-Plugin zu deaktivieren. Füge dazu beim Einrichten deines beständigen Menüs "disabled_surfaces": ["CUSTOMER_CHAT_PLUGIN"] hinzu:

Beispiel für Messenger Profile API-Payload

{
  "persistent_menu":[
    {
      "locale":"default",
      "disabled_surfaces": ["CUSTOMER_CHAT_PLUGIN"],
      "composer_input_disabled": false,      
      "call_to_actions":[
        {
          "title":"My Account",
          "type":"postback",
          "payload":"PAYBILL_PAYLOAD"
        }
      ]
    }
  ]
}

Ratenbegrenzung

Aufrufe der Messenger Profile API sind auf 10 API-Aufrufe pro 10-Minuten-Intervall begrenzt. Diese Ratenbegrenzung wird pro Seite durchgesetzt.

Hinweis: Aufrufe des Menüs auf Nutzer*innen-Ebene sind auf 10 API-Aufrufe pro 10-Minuten-Intervall begrenzt. Diese Ratenbegrenzung wird pro Seite durchgesetzt.

persistent_menu-Referenz