Documentation de référence de `persistent_menu`

Vous pouvez associer un menu fixe à votre bot pour que les internautes puissent découvrir vos fonctionnalités et accéder facilement à celles-ci tout au long de la conversation.

Le menu fixe est toujours accessible pour l’utilisateur·ice. Ce menu doit contenir des actions globales que les utilisateur·ices peuvent effectuer à tout moment. Le menu fixe vous permet de communiquer facilement les fonctions de base de votre bot aux nouveaux utilisateurs et nouvelles utilisatrices, et aux autres. Il apparaît automatiquement dans la conversation lorsque l’utilisateur·ice y revient après s’être absenté·e un certain temps. Ces paramètres font partie de la documentation de référence de l’API Messenger Profile

Le menu fixe peut également être défini et modifié au niveau utilisateur·ice. Pour plus d’informations à ce sujet consultez la section menu au niveau utilisateur·ice.

Conditions requises

Pour utiliser le menu fixe, procédez comme suit :

Définissez un bouton Démarrer.
Attribuez au bot le rôle Admin sur la Page.

Format de `persistent_menu`

Exemple de menu fixe

{
    "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"
                }
            ]
        }
    ]
}

Propriétés

Propriété	Type	Description
`locale`	Chaîne	Tableau d’objets définissant le menu fixe pour différents paramètres régionaux. Le menu dont la propriété `locale` correspond au paramètre régional de l’utilisateur·ice sera affiché. Au moins un objet du tableau `persistent_menu` doit spécifier `"locale": "default"`. Ce menu sera celui que nous utiliserons si aucun objet ne possède une propriété `locale` correspondant au paramètre régional de l’utilisateur·ice. Consultez la liste des paramètres régionaux pris en charge.
`composer_input_disabled`	Booléen	Désactive le champ de saisie Messenger s’il est défini sur `true`. Cela signifie que les interactions avec votre bot se limitent au menu fixe, aux postbacks, aux boutons et aux webviews. Valeur par défaut : `false`.
`disabled_surfaces`	Tableau	Tableau de noms des interfaces dans lesquelles le menu fixe doit être désactivé. La seule valeur actuellement prise en charge est `customer_chat_plugin`.
`call_to_actions`	Tableau<`menu_item`>	Tableau des éléments du niveau le plus élevé du menu fixe. Le nombre maximal d’éléments autorisés est de 3. Obligatoire si `"composer_input_disabled": true`.

Objet `menu_item`

Propriété	Type	Description
`type`	Chaîne	Type de l’élément du menu. Valeurs acceptées : `web_url` : indique que l’élément est un bouton d’URL. `postback` : indique que l’élément est un bouton de postback.
`title`	Chaîne	Titre à afficher sur l’élément du menu 30 caractères maximum.
`url`	Chaîne	URL à ouvrir en cas d’appui sur le bouton. Obligatoire si le type est `web_url`.
`payload`	Chaîne	Données qui seront renvoyées à votre webhook en tant qu’évènement `messaging_postbacks`. Obligatoire si le type est `postback`. 1 000 caractères maximum.
`webview_height_ratio`	Chaîne	*Facultatif.* Hauteur de la webview. Les valeurs acceptées sont `compact`, `tall` et `full`.
`messenger_extensions`	Booléen	*Facultatif.* Doit être `true` si le type d’élément est `web_url` et que le SDK Messenger Extensions doit être utilisé dans la webview.
`fallback_url`	Chaîne	*Facultatif.* URL à ouvrir dans la webview pour les clients qui ne prennent pas en charge le SDK Messenger Extensions. Si cette propriété n’est pas définie, `url` est utilisée comme solution de repli. Elle doit être spécifiée uniquement si `"messenger_extensions": true`.
`webview_share_button`	Chaîne	*Facultatif.* À définir sur `hide` pour désactiver le bouton de partage dans la webview (pour les informations de nature sensible).

Désactivation du menu fixe

Dans certains cas, il convient de désactiver le menu fixe de votre bot dans le plugin de discussion. Pour ce faire, ajoutez "disabled_surfaces": ["CUSTOMER_CHAT_PLUGIN"] lors de la configuration de votre menu fixe :

Exemple de charge utile de l’API Messenger Profile

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

Limite de débit

Les appels vers l’API Messenger Profile sont limités à 10 appels d’API par intervalle de 10 minutes. Cette limite de débit est appliquée par Page.

Notez que les appels au menu niveau utilisateur·ice sont limités à 10 appels d’API par utilisateur·ice et par intervalle de 10 minutes. Ce plafond est appliqué par Page.

Documentation de référence de persistent_menu