Referência de `persistent_menu`

O menu persistente pode ser definido no bot para ajudar as pessoas a descobrir e acessar com mais facilidade as suas funcionalidades durante a conversa.

O menu persistente está sempre disponível para o usuário. Ele deve conter ações de nível superior que os usuários podem realizar a qualquer momento. Com o menu persistente, as capacidades básicas do seu bot ficam mais claras para usuários novos e existentes. O menu aparecerá automaticamente na conversa se a pessoa ficar ausente por determinado período e, depois, retornar. Essas configurações fazem parte das referências da API de Perfil do Messenger.

O menu persistente também pode ser definido e alterado no nível do usuário. Para ver mais informações, consulte Menu do nível do usuário.

Requisitos

Para usar o menu persistente, você precisa do seguinte:

Definir um botão começar.
Ter a função de "Administrador" da página associada ao bot.

Formato de `persistent_menu`

Exemplo de menu 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"
                }
            ]
        }
    ]
}

Propriedades

Propriedade	Tipo	Descrição
`locale`	String	Uma matriz de objetos que definem o menu persistente para diferentes locais. O menu com uma propriedade `locale` que corresponda ao local da pessoa será exibido. Pelo menos um objeto na matriz `persistent_menu` deve especificar `"locale": "default"`. Esse será o menu usado se nenhum objeto tiver uma propriedade `locale` que corresponda ao local do usuário. Veja a lista de idiomas compatíveis.
`composer_input_disabled`	Booliano	Se definido como `true`, desabilita o campo de compositor do Messenger. Dessa forma, será possível interagir com o bot somente por meio de postbacks, menu persistente, botões e webViews. O padrão é `false`.
`disabled_surfaces`	Matriz	A matriz de nomes de interface em que o menu persistente pode ser desabilitado. No momento, apenas `customer_chat_plugin` é compatível.
`call_to_actions`	Array<`menu_item`>	Uma matriz de itens de nível superior para o menu persistente. O máximo de itens permitido é de 3. Obrigatório em caso de `"composer_input_disabled": true`.

Objeto de `menu_item`

Propriedade	Tipo	Descrição
`type`	String	O tipo de item do menu. Valores compatíveis: `web_url`: define o item como um botão de URL. `postback`: define o item como um botão de postback.
`title`	String	O título a ser exibido no item de menu. Limite de 30 caracteres.
`url`	String	A URL a ser aberta quando o botão é tocado. Obrigatório se o tipo for `web_url`.
`payload`	String	Dados que serão enviados de volta para seu webhook como um evento `messaging_postbacks`. Obrigatório se o tipo for `postback`. Limite de 1.000 caracteres.
`webview_height_ratio`	String	*Opcional.* A altura do webView. Os valores válidos incluem `compact`, `tall` e `full`.
`messenger_extensions`	Booliano	*Opcional.* Deve ser `true` caso o tipo de item seja `web_url` e o SDK de extensões do Messenger seja usado no webView.
`fallback_url`	String	*Opcional.* A URL a ser aberta no webView para clientes que não têm o SDK de extensões do Messenger. Se não for definido, `url` será usado como o valor padrão. Só pode ser especificado em caso de `"messenger_extensions": true`.
`webview_share_button`	String	*Opcional.* Defina como `hide` para desabilitar o compartilhamento no webView (para informações sensíveis).

Como desativar o menu persistente

Em alguns casos, talvez seja melhor desabilitar o menu persistente do bot no plugin de bate-papo. Para fazer isso, adicione "disabled_surfaces": ["CUSTOMER_CHAT_PLUGIN"] ao definir o menu persistente:

Exemplo de carga da API do Perfil do 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"
        }
      ]
    }
  ]
}

Limite de volume

Chamadas para a API de perfil do Messenger são limitadas a 10 chamadas de API a cada intervalo de 10 minutos. Esse limite de taxas é aplicado por página.

O menu no nível do usuário tem limite de 10 chamadas de API por usuário no intervalo de 10 minutos. Esse limite de volume é aplicado por Página.

Referência de persistent_menu