Referencia de `persistent_menu`

Puedes configurar el menú persistente en tu bot para ayudar a las personas a descubrir tu funcionalidad y acceder más fácilmente a ella durante toda la conversación.

El menú persistente siempre está disponible para el usuario. Este menú debería contener acciones de nivel superior que los usuarios puedan implementar en cualquier momento. Tener un menú persistente permite comunicar fácilmente las capacidades básicas de tu bot a quienes lo utilizan por primera vez y a los usuarios que regresan. El menú aparecerá automáticamente en un hilo si la persona estuvo ausente durante un tiempo determinado y regresa. Esta configuración es parte de la referencia de la API de perfil de Messenger

El menú persistente también se puede configurar y modificar en el nivel de usuario. Para obtener más información al respecto, consulta menú de nivel de usuario.

Requisitos

Para usar el menú persistente, debes cumplir con estos requisitos:

Configurar un botón "Empezar".
Tener el rol de "administrador" en la página asociada al bot.

Formato de `persistent_menu`

Ejemplo de menú persistente

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

Propiedades

Propiedad	Tipo	Descripción
`locale`	Cadena	Una matriz de objetos que definen el menú persistente para diferentes configuraciones regionales. Se mostrará el menú con una propiedad `locale` que coincida con la configuración regional de la persona. Al menos un objeto de la matriz `persistent_menu` debe especificar `"locale": "default"`. Este es el menú al que recurriremos si ningún objeto tiene una propiedad `locale` que coincida con la configuración regional del usuario. Consulta la lista de configuraciones regionales admitidas.
`composer_input_disabled`	Booleano	Desactiva el campo del editor de Messenger si está configurado en `true`. Esto significa que solo se puede interactuar con tu bot a través del menú persistente, postbacks, botones y vistas web. Adopta `false` como valor predeterminado.
`disabled_surfaces`	Matriz	Matriz de nombres de interfaz para desactivar el menú persistente. Actualmente solo se admite `customer_chat_plugin`.
`call_to_actions`	Matriz <`menu_item`>	Una matriz de elementos de menú de nivel superior para el menú persistente. Se permite un máximo de 3 elementos. Obligatoria si `"composer_input_disabled": true`.

Objeto `menu_item`

Propiedad	Tipo	Descripción
`type`	Cadena	El tipo de elemento del menú. Los valores admitidos son: `web_url`: especifica que el elemento es un botón de URL. `postback`: especifica que el elemento es un botón de postback.
`title`	Cadena	Título para mostrar en el elemento del menú. Tiene un límite de 30 caracteres.
`url`	Cadena	URL para abrir cuando se pulsa el botón. Obligatoria si el tipo es `web_url`.
`payload`	Cadena	Datos que se enviarán de nuevo a tu webhook como un evento `messaging_postbacks`. Obligatoria si el tipo es `postback`. Tiene un límite de 1.000 caracteres.
`webview_height_ratio`	Cadena	*Opcional.* Altura de la vista web. Valores válidos: `compact`, `tall` y `full`.
`messenger_extensions`	Booleano	*Opcional.* Debe ser `true` si el tipo de elemento es `web_url` y el SDK de extensiones de Messenger se usará en la vista web.
`fallback_url`	Cadena	*Opcional.* URL para abrir en la vista web de los clientes que no admiten el SDK de extensiones de Messenger. Si no se define, `url` se usará como alternativa. Solo se puede especificar si `"messenger_extensions": true`.
`webview_share_button`	Cadena	*Opcional.* Se configura en `hide` para desactivar la función de compartir en la vista web (en el caso de la información confidencial).

Desactivación del menú persistente

En algunos casos, puede ser preferible desactivar el menú persistente del bot en el plugin de chat. Para hacerlo, agrega "disabled_surfaces": ["CUSTOMER_CHAT_PLUGIN"] cuando configures el menú persistente:

Ejemplo de la carga de la API de perfiles de Messenger

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

Límite de frecuencia

Las llamadas a la API de perfiles de Messenger se limitan a 10 llamadas de API por intervalo de 10 minutos. Este límite de frecuencia se aplica por página.

Ten en cuenta que las llamadas al menú de nivel de usuario se limitan a 10 llamadas a la API por usuario por intervalo de 10 minutos. Este límite de frecuencia se aplica por página.

Referencia de persistent_menu