Facebook Messenger

Comece gerando o Segredo do Aplicativo e o token de Acesso à Página no Facebook Messenger.

1. Faça log-in na sua conta do desenvolvedor do Facebook.
2. Crie o aplicativo do Facebook que você usará para o canal:
   1. No seu navegador, vá para https://developers.facebook.com/apps/.
   2. Selecione a guia Meus Aplicativos e clique em Criar Aplicativo.
   3. Na página Detalhes do aplicativo do assistente de Criação de Aplicativo, informe o nome que você deseja usar para o aplicativo e o endereço de e-mail que você deseja usar como contato do aplicativo. Em seguida, clique em Próximo.
   4. Na página Casos de uso, em Filtrar por, selecione Mensagens de negócios. Em seguida, selecione Envolver-se com clientes no Messenger no Meta e clique em Próximo.
   5. Clique no restante das páginas do assistente e, na página Visão Geral, clique em Criar Aplicativo.
3. Depois que o aplicativo for criado, selecione-o (no lado esquerdo da página Meus Aplicativos) e, na seção Definições do Aplicativo, selecione Básico.
4. Copie o valor do campo Segredo do aplicativo e cole-o em algum lugar conveniente no seu sistema.

   Você precisará do segredo do aplicativo posteriormente para preencher a configuração de seu canal no Facebook.

5. Na seção Página do aplicativo, clique em Criar nova Página.
6. Na página Criar uma Página, preencha os campos obrigatórios e clique em Criar Página.
   Observação
   
   O nome da página deve conter o nome do aplicativo.
7. Gere um Token de Acesso:
   1. Selecione Ferramentas > Explorador de API de Gráfico.
   2. Na seção Token de Acesso da página, para Meta App, selecione o nome do seu aplicativo.
   3. Para o campo Usuário ou Página, selecione Obter Token.
   4. Na seção Permissões, clique em Adicionar uma Permissão e selecione as seguintes permissões:
      • business_management
      • pages_manage_metadata
      • pages_messaging
      • pages_show_list
   5. Clique em Gerar Token de Acesso.
8. Copie o token de acesso e cole-o em algum lugar conveniente.

   Você usará esse token, que dá ao seu Aplicativo do Facebook acesso à API de Mensagens do Facebook, para concluir sua definição de canal no Digital Assistant.

No Facebook Messenger, defina o URL de Callback usando o URL do Webhook gerado pelo Digital Assistant na etapa anterior.

1. No console do Facebook Messenger, vá para o projeto que você criou inicialmente para o webhook.
2. Selecione Definições da API do Messenger para abrir a página Configuração da API do Messenger.
3. No campo URL de CallBack, cole o URL do Webhook obtido na página Canais do Digital Assistant.
4. No campo Verificar Token na console do Messenger, cole o Token de Verificação na página Canais do Digital Assistant.
5. Na seção Campos do Webhook, selecione os eventos de callback messages e messaging_postbacks.
6. Clique em Verificar e Salvar.
7. Inscreva-se na página:
   1. Na seção Gerar tokens de acesso da página Configuração da API do Messenger, selecione a página do Facebook do seu canal.
   2. Clique em Adicionar Assinatura.
   3. Na caixa de diálogo Editar Assinaturas da Página, verifique se messages e messaging_postbacks estão selecionados e clique em Confirm.

Com a configuração concluída, você está pronto para ativar o canal do Facebook.

• No Digital Assistant, selecione o canal e ative o controle Canal Ativado.
• Clique em e selecione o assistente digital ou a habilidade que deseja associar ao canal.

Agora você pode testar o bot pelo canal.

Com a configuração do Canal do Facebook e das mensagens concluída, você pode testar seu bot usando sua página no Facebook, o Facebook Messenger (https://www.messenger.com/) e o aplicativo do Facebook Messenger no seu dispositivo.

1. Vá para https://www.messenger.com/.
2. Na interface do Messenger, informe o nome da sua página para procurar a página.
3. Comece a conversar com seu assistente digital (ou habilidade standalone).

O Facebook Messenger permite que você crie um menu persistente ao lado do campo Mensagem. Consulte https://developers.facebook.com/docs/messenger-platform/send-messages/persistent-menu/ para obter detalhes sobre o recurso.

Este é um exemplo que mostra itens do menu persistente para "Order Pizza" e "Order Pasta":

Descrição da ilustração Persistent-menu1.jpg

Os canais do Facebook Messenger no Digital Assistant suportam as seguintes capacidades:

• texto (envio e recebimento)
• imagens (envio e recebimento)
• arquivos (envio e recebimento)
• emojis (envio e recebimento)
• localização, mas obsoleto (envio e recebimento)
• links
• postbacks
• solicitações de localização
• propriedades personalizadas
• componentes de carrossel
• componentes de lista

Se você estiver direcionando sua habilidade para vários canais com diferentes recursos de formatação e sintaxe, poderá usar a marcação HTML básica em suas mensagens. Se você fizer isso, essa marcação será automaticamente convertida para o formato de markdown do Facebook Messenger quando a mensagem for transmitida para o canal. Isso é particularmente útil se você estiver direcionando suas habilidades para outros canais, além do Facebook Messenger. Consulte Formatação de Rich Text em Canais.

Os canais do Facebook Messenger no Digital Assistant têm as seguintes restrições de mensagens:

• Mensagens de Texto
  • Tamanho máximo da mensagem de texto: 640 caracteres. Se o tamanho exceder 640, o texto será dividido em várias mensagens.
  • Tamanho máximo do label de ação do texto: 20 caracteres
  • Tipos de ações de texto permitidos: Postback, Chamada, URL
  • Número máximo de ações de texto: 3. Se houver mais ações de texto, a mensagem será convertida em vários cartões horizontais, com o mesmo texto usado como título de cada cartão, cada um contendo até 3 ações.
• Cartões Horizontais
  • Tamanho máximo do título: 80 caracteres
  • Tamanho máximo da descrição: 80 caracteres
  • Tamanho máximo do label de ação do cartão: 20 caracteres
  • Número máximo de cartões: 10
  • Número máximo de ações do cartão: 3. Se o número de ações do cartão passar de 3, o cartão será duplicado para renderizar o restante das ações.
  • Número mínimo de ações do cartão: 0.
  • Número máximo de ações da lista de cartões: 0
  • Pelo menos uma descrição, imagem ou ação é necessária?: Sim
  • Tipos de ações de cartão permitidas: Postback, Chamada, URL, Compartilhamento
  • Tipos de ações de lista de cartões permitidos: N/A
• Cartões Verticais
  • Não suportado
• Mensagens de Anexo
  • Suportado?: Sim
  • Ações de anexo permitidas?: Não
• Botões de Ação
  • Tamanho máximo do label de ação global: 20 caracteres
  • Número máximo de ações globais: 11
  • Tipos de ações globais permitidas: Postback

Para canais do Facebook Messenger, você pode estender a funcionalidade dos componentes de Resposta Comum com recursos específicos do Facebook.

Acesse as extensões usando o elemento channelCustomProperties nos metadados do componente Resposta Comum e definindo as propriedades apropriadas. O código tem o seguinte formato:

...
            channelCustomProperties:
            - channel: "facebook"
              properties:
                PROPERTY_NAME: "PROPERTY_VALUE"
...

Estas são as propriedades personalizadas disponíveis para canais do Facebook Messenger:

Veja um exemplo de propriedades personalizadas definidas no nível do item de resposta (top_element_style) e no nível de cartões (webview_height_ratio e fallback_url):

responseItems:
  - type: "cards"
    cardLayout: "vertical"
    cards:
      - title: "${pizzas.name}"
        description: "${pizzas.description}"
        imageUrl: "${pizzas.image}"
        url: "${pizzas.moreInfo}"
        iteratorVariable: "pizzas"
        channelCustomProperties:
          - channel: "facebook"
            properties:
              webview_height_ratio: "compact"
              fallback_url: "http://www.oracle.com"
    channelCustomProperties:
      - channel: "facebook"
        properties:
          top_element_style: "large"
...

Para obter informações gerais adicionais sobre channelCustomProperties, consulte Extensões Específicas do Canal.