Plataforma do Messenger

Referência dos plugins da web

A plataforma do Messenger dispõe de um conjunto prático de plugins que facilitam sua vida na hora de iniciar uma conversa com quem visita sua página na web. Todos os plugins são implementados com o SDK do Facebook para JavaScript.

Conteúdo

Plugin de bate-papo com o cliente (beta)

O plugin de bate-papo com o cliente da plataforma do Messenger permite integrar o bot do Messenger diretamente no seu site. Assim, os clientes podem interagir com sua empresa a qualquer momento aproveitando a mesma experiência personalizada e avançada do Messenger.

Para mais detalhes de uso, consulte Plugin de bate-papo.

Incluir formato

<div class="fb-customerchat"
 page_id="<PAGE_ID>">
</div>

Atributos

Atributo Tipo Descrição

class

String

O valor deve ser fb-customerchat.

page_id

String

A identificação da página.

ref

String

Opcional. String personalizada transferida ao seu webhook em eventos messaging_postbacks e messaging_referrals.

theme_color

String

Opcional. A cor para usar como um tema para o plugin, incluindo a cor do plano de fundo do ícone do plugin de bate-papo com o cliente e a cor do plano de fundo de qualquer mensagem enviada pelos usuários. É compatível com qualquer código de cor hexadecimal precedido por um símbolo de número (por exemplo, #0084FF), exceto branco. Recomendamos que você escolha uma cor que tenha um alto contraste com o branco.

logged_in_greeting

String

Opcional. O texto de saudação que será exibido se o usuário estiver conectado com o Facebook. Máximo de 80 caracteres.

logged_out_greeting

String

Opcional. O texto de saudação que será exibido se o usuário não estiver conectado com o Facebook. Máximo de 80 caracteres.

greeting_dialog_display

String

Opcional. Define como o diálogo de saudação será exibido. Estes são os valores compatíveis:


  • show: o diálogo de saudação sempre será exibido quando o plugin carregar.
  • fade: o diálogo de saudação do plugin será exibido, esmaecerá e ficará oculto depois.
  • hide: o diálogo de saudação sempre ficará oculto até que o usuário clique no plugin.

O padrão será show no desktop e hide em dispositivos móveis.

greeting_dialog_delay

String

Opcional. Define o tempo de atraso em segundos antes da exibição do diálogo de saudação depois do carregamento do plugin. Isso pode ser usado para personalização quando você quiser que o diálogo de saudação seja exibido.

minimized

Booleano

Aviso de obsolescência

Este atributo está obsoleto. Use o greeting_dialog_display para personalizar o plugin. O atributo greeting_dialog_delay terá prevalência sobre minimized.

Opcional.

  • true: quando definido como verdadeiro, ele terá o mesmo efeito da configuração greeting_dialog_delay = "desaparecer".
  • false: quando definido como falso, ele terá o mesmo efeito da configuração greeting_dialog_delay = "exibir".

Plugin Envie-nos uma mensagem

Leve uma pessoa direto para uma conversa no Messenger.

Para mais detalhes de uso, consulte Plugin Envie-nos uma mensagem.

Incluir formato

<div class="fb-messengermessageus" 
  messenger_app_id="<APP_ID>" 
  page_id="<PAGE_ID>"
  color="<blue | white>"
  size="<standard | large | xlarge>">
</div>

Atributos

Atributo Atributo HTML5 Tipo Descrição

class

String

O valor deve ser fb-messengermessageus.

page_id

String

A identificação da página.

messenger_app_id

Número

O ID do app do Facebook.

color

data-color

String

A cor do botão: blue ou white.


O padrão é blue.

size

data-size

String

O tamanho do botão: standard, large ou xlarge.


O padrão é large.

ref

String

Opcional. String personalizada transferida ao seu webhook em eventos messaging_postbacks e messaging_referrals.

Plugin Enviar para o Messenger

Envie uma mensagem a uma pessoa usando seu bot do Messenger em segundo plano para confirmar a inscrição.

Para mais detalhes de uso, consulte Plugin Enviar para o Messenger.

Incluir formato

<div class="fb-send-to-messenger" 
  messenger_app_id="<APP_ID>" 
  page_id="PAGE_ID" 
  data-ref="<PASS_THROUGH_PARAM>" 
  color="<blue | white>" 
  size="<standard | large | xlarge>">
</div>

Atributos

Atributo Tipo Descrição

class

String

O valor deve ser fb-send-to-messenger.

page_id

String

A identificação da página.

messenger_app_id

Número

O ID do app do Facebook.

color

String

Opcional. A cor do botão: blue ou white.


O padrão é blue.

size

String

Opcional. O tamanho do botão: standard, large ou xlarge.


O padrão é large.

ref

String

Opcional. O parâmetro de estado personalizado. Máximo de 250 caracteres.


Os caracteres válidos são a-z A-Z 0-9 +/=-._.


Deve ser codificado e criptografado por motivos de segurança.

enforce_login

Booleano

Opcional. Se true, os usuários conectados deverão entrar novamente ao clicar no botão. O padrão é false.

Use o parâmetro data-ref para transmitir o estado com a autenticação. Se você exibir o plugin em diversos lugares, recomendamos modificar o estado com base no local onde ele aparecerá.

Plugin da caixa de seleção

O plugin da caixa de seleção inscreve uma pessoa no seu bot do Messenger como parte de um formulário, como uma finalização da compra ou um cadastro.

Para mais detalhes de uso, consulte Plugin da caixa de seleção.

Incluir formato

<div class="fb-messenger-checkbox"  
  origin=<PAGE_DOMAIN>
  page_id=<PAGE_ID>
  messenger_app_id=<APP_ID>
  user_ref="<UNIQUE_REF_PARAM>"
  allow_login="<true>"
  size="<small | medium | large | standard | xlarge>"
  skin="<light|dark>"
  center_align="<true|false>">
</div>

Atributos

Atributo Tipo Descrição

class

String

O valor deve ser fb-messenger-checkbox.

page_id

Número

A identificação da Página do Facebook associada ao seu bot.

messenger_app_id

Número

O ID do app do Facebook.

user_ref

String

O parâmetro único para fazer referência ao usuário. Máximo de 250 caracteres.


Os caracteres válidos são a-z A-Z 0-9 +/=-._.

allow_login

Booleano

Opcional. Permite que as pessoas se conectem quando não há uma sessão em andamento. O padrão é true.

size

String

Opcional. O tamanho do plugin: small, medium, large, standard, xlarge.


O padrão é large.

skin

String

Opcional. Define a cor do tem do conteúdo do plugin. As opções a seguir são suportadas:

  • light: o plugin será renderizado com texto escuro.
  • dark: o plugin será renderizado com texto branco, ícone transparente do Messenger e raio branco.

O padrão é light.

center_align

Booleano

Opcional. Define se o conteúdo do plugin deve ser alinhado ao centro.


O padrão é false.