Referencia de `persistent_menu`

El menú persistente se puede establecer para un bot con el objetivo de ayudar a los usuarios a descubrir tu funcionalidad y acceder con más facilidad a ella durante toda la conversación.

El menú persistente siempre está disponible para el usuario. Este menú debe contener acciones de nivel superior que los usuarios puedan llevar a cabo cuando deseen. Al tener un menú persistente, se comunican fácilmente las capacidades básicas del bot para los usuarios que acceden por primera vez y que regresan. El menú aparecerá automáticamente en una conversación si el usuario ha estado ausente durante un determinado periodo de tiempo y regresa. Esta configuración forma parte de la referencia de la API de perfiles de Messenger.

El menú persistente también se puede establecer y cambiar 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, debe hacer lo siguiente:

Establecer un botón “Empezar”.
Tener el rol “Administrador” para 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	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 del usuario. Al menos un objeto de la matriz `persistent_menu` debe especificar `"locale": "default"`. Se trata del menú al que recurriremos si ningún objeto tiene una propiedad `locale` que coincida con la configuración regional de los usuarios. Consulta la lista de configuraciones regionales admitidas.
`composer_input_disabled`	Booleano	Desactiva el campo del editor de Messenger si se establece en `true`. Esto significa que solo se puede interactuar con el bot mediante el menú persistente, postbacks, botones y vistas web. Adopta `false` como valor predeterminado.
`disabled_surfaces`	Matriz	Matriz de nombres de interfaces en las que desactivar el menú persistente. Actualmente solo se admite `customer_chat_plugin`.
`call_to_actions`	Matriz<`menu_item`>	Matriz de elementos de menú de nivel superior para el menú persistente. Se permite un máximo de tres elementos. Obligatorio si `"composer_input_disabled": true`.

Objeto `menu_item`

Propiedad	Tipo	Descripción
`type`	Cadena	Tipo de elemento del menú. Los valores que se admiten son los siguientes: `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 que mostrar en el elemento del menú. Límite de 30 caracteres.
`url`	Cadena	URL que abrir cuando se toca el botón. Obligatorio si el tipo es `web_url`.
`payload`	Cadena	Datos que se devolverán al webhook como un evento `messaging_postbacks`. Obligatorio si el tipo es `postback`. Límite de 1000 caracteres.
`webview_height_ratio`	Cadena	*Opcional.* Altura de la vista web. Los valores válidos incluyen `compact`, `tall` y `full`.
`messenger_extensions`	Booleano	*Opcional.* Debe ser `true` si el tipo del elemento es `web_url` y el SDK de extensiones de Messenger se usará en la vista web.
`fallback_url`	Cadena	*Opcional.* URL que abrir en la vista web para los clientes que no admiten el SDK de extensiones de Messenger. Si no se define esta propiedad, se utiliza el valor de `url` como valor alternativo. Solo se puede especificar si `"messenger_extensions": true`.
`webview_share_button`	Cadena	*Opcional.* Se establece como `hide` para desactivar el uso compartido en la vista web (en caso de información confidencial).

Deshabilitar el menú persistente

Puede que haya casos en que sea preferible desactivar el menú persistente para el bot en el plugin de chat. Para hacerlo, añade "disabled_surfaces": ["CUSTOMER_CHAT_PLUGIN"] al configurar el menú persistente:

Carga útil de la API de perfiles de Messenger de ejemplo

{
  "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 están limitadas a 10 llamadas a la API por cada intervalo de 10 minutos. El límite de frecuencia se aplica por página.

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

Referencia de persistent_menu