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, reel e ig_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

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

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

Mensagem com informações de referência de anúncios

Esse webhook se aplica ao cenário em que o usuário clica em um anúncio de clique para o Messenger e envia uma mensagem a uma página do Facebook. Além dos detalhes incluídos sobre a mensagem, o app receberá informações de referência de anúncios.

{
  "sender":{
    "id":"<PSID>"
  },
  "recipient":{
    "id":"<PAGE_ID>"
  },
  "timestamp":1458692752478,
  "message":{
    "mid":"mid.1457764197618:41d102a3e1ae206a38",
    "text":"hello, world!",
    "referral": {
      "ref": "<REF_DATA_IF_SPECIFIED_IN_THE_AD>",
      "ad_id": "<ID_OF_THE_AD>",
      "source": "ADS",
      "type": "OPEN_THREAD",
      "ads_context_data": {
        "ad_title": "<TITLE_OF_THE_AD>",
        "photo_url": "<URL_OF_THE_IMAGE_FROM_AD_THE_USER_IS_INTERESTED_IN>",
        "video_url": "<THUMBNAIL_URL_OF_THE_VIDEO_FROM_THE_AD>",
        "post_id": "<ID_OF_THE_POST>",
        "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

recipient

message

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.

message.reply_to

message.attachments

message.attachments.payload

message.attachments.payload.product.elements

message.referral

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

message.referral.product

message.referral.ads_context_data

message.commands