Referência do evento de webhook messages

Esse retorno de chamada acontecerá quando uma mensagem for enviada para sua Página. As mensagens sempre são enviadas em ordem. Você pode receber mensagens de texto ou com anexos.

Os principais tipos de anexos compatíveis são image, audio, video, file e reel. Você também pode receber anexos de fallback. Um exemplo comum de "fallback" é quando o usuário compartilha uma URL com a Página e um anexo é criado com base no compartilhamento de link. Para compartilhamentos não compatíveis feitos por usuários na sua Página, um fallback sem carga pode ser enviado.

Para se inscrever nesse retorno de chamada, selecione o campo message ao configurar o webhook.

Exemplos

Mensagem de texto

{
  "sender":{
    "id":"<PSID>"
  },
  "recipient":{
    "id":"<PAGE_ID>"
  },
  "timestamp":1458692752478,
  "message":{
    "mid":"mid.1457764197618:41d102a3e1ae206a38",
    "text":"hello, world!",
    "quick_reply": {
      "payload": "<DEVELOPER_DEFINED_PAYLOAD>"
    }
  }
}    

Mensagem de resposta

{
  "sender":{
    "id":"<PSID>"
  },
  "recipient":{
    "id":"<PAGE_ID>"
  },
  "timestamp":1458692752478,
  "message":{
    "mid":"m_1457764197618:41d102a3e1ae206a38",
    "text":"hello, world!",
    "reply_to": {
      "mid":"m_1fTq8oLumEyIp3Q2MR-aY7IfLZDamVrALniheU"
    }
  }
}    

Mensagem com anexo

{
  "id": "682498302938465",
  "time": 1518479195594,
  "messaging": [
    {
      "sender": {
        "id": "

Mensagem com modelo de produto

O webhook de mensagem com modelo de produto está disponível somente na Graph API 8.0 e em versões posteriores.

Esse webhook se aplica ao cenário em que a pessoa compartilha produtos de outras conversas ou fluxos de compartilhamento na página. Além disso, ele se limita a produtos que pertencem à página. O app precisa da permissão catalog_management para receber detalhes do produto nos webhooks.

{
  "id": "682498302938465",
  "time": 1518479195594,
  "messaging": [
    {
      "sender": {
        "id": "

Mensagem com anexo de fallback

Este exemplo se aplica a messages na versão 6.0 e posteriores.

{
    "object": "page",
    "entry": [
        {
            "id": "<PAGE_ID>",
            "time": 1583173667623,
            "messaging": [
                {
                    "sender": {
                        "id": "<PSID>"
                    },
                    "recipient": {
                        "id": "<PAGE_ID>"
                    },
                    "timestamp": 1583173666767,
                    "message": {
                        "mid": "m_toDnmD...",
                        "text": "This is where I want to go: https:\/\/youtu.be\/bbo_fZAjIhg",
                        "attachments": [
                            {
                                "type": "fallback",
                                "payload": {
                                    "url": "<ATTACHMENT_URL >",
                                    "title": "TAHITI - Heaven on Earth"
                                }
                            }
                        ]
                    }
                }
            ]
        }
    ]
}

Mensagem da página de detalhes sobre o produto em Lojas

O webhook de mensagem da página de detalhes sobre o produto em Lojas está disponível somente na Graph API 8.0 e em versões posteriores.

{
  "sender":{
    "id":"<PSID>"
  },
  "recipient":{
    "id":"<PAGE_ID>"
  },
  "timestamp":1458692752478,
  "message":{
    "mid":"mid.1457764197618:41d102a3e1ae206a38",
    "text":"hello, world!",
    "referral": {
      "product": {
        "id":"<PRODUCT_ID>"
      }
    }
  }
}    

Mensagem com comandos

{
  "object": "page",
  "entry": [
    {
      "id": "<PAGE_ID>",
      "time": 1697643211842,
      "messaging": [
        {
          "sender": {
            "id": "<PSID>"
          },
          "recipient": {
            "id": "<PAGE_ID>"
          },
          "timestamp": 1697643027400,
          "message": {
            "mid": "m_3vs...",
            "text": "find flights from SFO to LAX next Thursday",
            "commands": [
              {
                "name": "flights"
              }
            ]
          }
        }
      ]
    }
  ]
}

Propriedades

sender

PropriedadeTipoDescrição

id

Cadeia de caracteres

O PSID (Número de identificação no escopo da Página) do usuário que acionou o evento de webhook.

user_ref

Cadeia de caracteres

O parâmetro user_ref do usuário que acionou o evento de webhook. Disponível somente para o evento de webhook do plugin de bate-papo.

recipient

PropriedadeTipoDescrição

id

Cadeia de caracteres

Seu ID da Página.

message

Anúncio de 4 de março de 2020

Na versão 6.0, sticker_id mudou de message para message.attachments.payload.

Propriedade Tipo Descrição

mid

String

ID da mensagem.

text

String

Texto da mensagem.

quick_reply

Objeto

Dados personalizados opcionais fornecidos pelo app remetente.

reply_to

Objeto

Referência ao ID da mensagem (mid) sendo respondida.

attachments

Matriz<attachment>

Matriz com os dados de anexo.

referral

Objeto

Referência da mensagem da página de detalhes sobre o produto em Lojas.

message.quick_reply

A carga quick_reply é fornecida com uma mensagem de texto quando o usuário toca em um botão de Respostas rápidas.

Propriedade Tipo Descrição

payload

String

Dados personalizados fornecidos pelo app.

message.reply_to

Propriedade Tipo Descrição

mid

String

Referência ao ID da mensagem sendo respondida.

message.attachments

Propriedade Tipo Descrição

type

String

audio, file, image, video, fallback ou reel

payload

String

message.attachments.payload

message.attachments.payload

Propriedade Tipo Descrição

url

String

URL do tipo de anexo. Aplicável aos tipos de anexo audio, file, image, video, fallback e reel.

title

String

Título do anexo. Aplicável aos tipos de anexo fallback e reel.

sticker_id

Número

A identificação persistente da figurinha (por exemplo, 369239263222822 para a figurinha Curtir). Aplicável ao tipo de anexo image se uma figurinha for enviada.

reel_video_id

Número

ID do vídeo associado ao reel anexado. Aplicável ao tipo de anexo reel.

message.attachments.payload.product.elements

Propriedade Tipo Descrição

id

String

ID do produto no catálogo de produtos do Facebook.

retailer_id

String

ID externo associado ao produto (por exemplo: SKU ou ID do conteúdo).

image_url

String

URL do produto.

title

String

Título do produto.

subtitle

String

Subtítulo do produto.

message.referral

A carga referral é fornecida apenas quando o usuário envia uma mensagem da página de detalhes sobre o produto em Lojas.

Propriedade Tipo Descrição

product

Objeto

Informações do produto.

message.referral.product

Propriedade Tipo Descrição

id

String

ID do produto

message.commands

Propriedade Tipo Descrição

name

String

Nome do comando.