Riferimento per eventi webhook messages

Questa callback si verifica all'invio di un messaggio alla tua Pagina. I messaggi sono sempre inviati in ordine. Potresti ricevere messaggi di testo o messaggi con allegati.

I tipi di allegato image, audio, video, file, reel e ig_reel sono i principali tipi supportati. Potresti inoltre ricevere allegati fallback. Un esempio comune di "fallback" è quando un utente condivide un URL con una Pagina e viene creato un allegato basato sulla condivisione del link. Per le condivisioni non supportate eseguite dagli utenti sulla tua Pagina, potrebbe essere inviato un fallback senza payload.

Puoi effettuare l'iscrizione a questa callback selezionando message durante la configurazione del webhook.

Esempi

Messaggio di testo

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

Messaggio di risposta

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

Messaggio con allegato

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

Messaggio con modello di prodotto

Il webhook message con modello di prodotto è disponibile solo sulle versioni 8.0 e successive dell'API Graph.

Questo webhook si applica allo scenario in cui l'utente condivide prodotti da altre conversazioni o dal flusso di condivisione sulla Pagina. Questo webhook è limitato ai soli prodotti di proprietà della Pagina. L'app dovrà disporre dell'autorizzazione catalog_management per ricevere i dettagli del prodotto nei webhook.

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

Messaggio con allegato fallback

Esempio applicabile a messages nelle versioni successive alla 6.0

{
    "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"
                                }
                            }
                        ]
                    }
                }
            ]
        }
    ]
}

Messaggio dalla pagina dei dettagli del prodotto di Shops

Il webhook message dalla pagina dei dettagli del prodotto di Shops è disponibile solo sulle versioni 8.0 e successive dell'API Graph.

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

Messaggio con informazioni di reindirizzamento all'inserzione

Questo webhook si applica allo scenario in cui un utente clicca su un'inserzione che rimanda a Messenger e invia un messaggio a una Pagina Facebook. Oltre ai dettagli del messaggio inclusi, l'app riceve anche informazioni di reindirizzamento all'inserzione.

Un messaggio con informazioni di reindirizzamento all'inserzione richiede che l'app abbia effettuato l'iscrizione nella Pagina ai campi messages e messaging_referrals.

{
  "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>"
      }
    }
  }
}

Messaggio con comandi

{
  "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"
              }
            ]
          }
        }
      ]
    }
  ]
}

Proprietà

sender

ProprietàTipoDescrizione

id

Stringa

Il PSID dell'utente che ha attivato l'evento Webhook.

user_ref

Stringa

L'user_ref dell'utente che ha attivato l'evento Webhook. Disponibile solo per l'evento webhook dal plug-in per la chat.

recipient

ProprietàTipoDescrizione

id

Stringa

L'ID della tua Pagina.

message

Annuncio del 4 marzo 2020

Nelle versioni successive alla 6.0 sticker_id è stato spostato da message a message.attachments.payload

Proprietà Tipo Descrizione

mid

Stringa

ID del messaggio.

text

Stringa

Testo del messaggio.

quick_reply

Oggetto

Dati personalizzati opzionali forniti dall'app di invio.

reply_to

Oggetto

Riferimento all'ID del messaggio (mid) a cui questo messaggio sta rispondendo.

attachments

Array<attachment>

Array contenente dati sugli allegati.

referral

Oggetto

Reindirizzamento del messaggio dalla pagina dei dettagli del prodotto di Shops.

message.quick_reply

Un payload quick_reply viene fornito con un messaggio di testo solo quando l'utente tocca un pulsante Risposte rapide.

Proprietà Tipo Descrizione

payload

Stringa

Dati personalizzati forniti dall'app.

message.reply_to

Proprietà Tipo Descrizione

mid

Stringa

Riferimento all'ID del messaggio a cui questo messaggio sta rispondendo.

message.attachments

Proprietà Tipo Descrizione

type

Stringa

audio, file, image, video, fallback, reel o ig_reel

payload

Stringa

message.attachments.payload

message.attachments.payload

Proprietà Tipo Descrizione

url

Stringa

URL del tipo di allegato. Applicabile al tipo di allegato: audio, file, image, video, fallback, reel, ig_reel

title

Stringa

Titolo dell'allegato. Applicabile al tipo di allegato: fallback, reel e ig_reel

sticker_id

Numero

ID permanente di questo adesivo, ad esempio 369239263222822 fa riferimento all'adesivo "Mi piace". Applicabile al tipo di allegato: image solo se è inviato un adesivo.

reel_video_id

Numero

ID del video associato al reel allegato. Applicabile al tipo di allegato: reel e ig_reel

message.attachments.payload.product.elements

Proprietà Tipo Descrizione

id

Stringa

ID prodotto dal Catalogo prodotti Facebook

retailer_id

Stringa

ID esterno associato al prodotto (ad es.: SKU/ID contenuto)

image_url

Stringa

URL del prodotto.

title

Stringa

Titolo del prodotto.

subtitle

Stringa

Sottotitolo del prodotto.

message.referral

Il payload referral è fornito solo quando l'utente invia un messaggio dalla pagina dei dettagli del prodotto di Shops.

Proprietà Tipo Descrizione

product

Oggetto

Informazioni sul prodotto.

source

Stringa

Origine del reindirizzamento. Valori supportati: ADS (supportato solo il reindirizzamento alle inserzioni).

type

Stringa

Tipo di reindirizzamento. Attualmente supporta OPEN_THREAD.

ref

Stringa

L'attributo facoltativo ref specificato nel reindirizzamento. Sono supportati solo caratteri alfanumerici e -, _ e =.

ad_id

Stringa

ID dell'inserzione da Gestione inserzioni.

ads_context_data

Oggetto

Dati relativi al contesto dell'inserzione da Gestione inserzioni.

message.referral.product

Proprietà Tipo Descrizione

id

Stringa

ID del prodotto.

message.referral.ads_context_data

Proprietà Tipo Descrizione

ad_title

Stringa

Titolo dell'inserzione in Gestione inserzioni.

photo_url

Stringa

[Facoltativo] URL dell'immagine dell'inserzione.

video_url

Stringa

[Facoltativo] URL della miniatura del video dell'inserzione.

post_id

Stringa

ID del post dell'inserzione in Gestione inserzioni.

product_id

Stringa

[Facoltativo] ID del prodotto dell'inserzione.

message.commands

Proprietà Tipo Descrizione

name

Stringa

Nome del comando.