Piattaforma Messenger

Riferimento per eventi webhook message_echoes

Questo callback si verificherà quando un messaggio è stato inviato dalla tua Pagina. Potresti ricevere messaggi text o messaggi con allegati (image, video, audio, template o fallback). Il payload includerà anche un metadata personalizzato opzionale inviato dal mittente e il corrispondente app_id.
Puoi attivare l'iscrizione a questo callback selezionando il campo message_echoes quando configuri il tuo webhook.

Sono supportati più tipi di messaggi:

Formato comune

Esempio 1

{
  "sender":{
    "id":"<PSID>"
  },
  "recipient":{
    "id":"<USER_ID>"
  },
  "timestamp":1457764197627,
  "message":{
    "is_echo":true,
    "app_id":1517776481860111,
    "metadata": "<DEVELOPER_DEFINED_METADATA_STRING>",
    "mid":"mid.1457764197618:41d102a3e1ae206a38",
    ...
  }
}

Esempio 2

{
    "object": "page",
    "entry": [
        {
            "id": "<PAGEID>",
            "time": 1570053170926,
            "standby": [
                {
                    "sender": {
                        "id": "<PAGEID>"
                    },
                    "recipient": {
                        "id": "<PSID>"
                    },
                    "timestamp": 1570053170673,
                    "message": {
                        "mid": "qT7ywaKpO9kkQR7Gv-nM8LIfLZDamVrALniheUYEDdHJXjDXEAyaS1xxONzb2Iv-DFzmTihfWJV012P5pK0AhQ",
                        "is_echo": true,
                        "app_id": <APPID>,
                        "attachments": [
                            {
                                "title": "",
                                "url": "https:\/\/www.facebook.com\/commerce\/update\/",
                                "type": "template",
                                "payload": {
                                    "template_type": "media",
                                    "elements": [
                                        {
                                            "media_type": "image",
                                            "attachment_id": 2457235337685388
                                        }
                                    ]
                                }
                            }
                        ]
                    }
                }
            ]
        }
    ]
}

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

Nome del campo Tipo Descrizione

is_echo

Booleano

Indica il messaggio inviato dalla Pagina

app_id

Stringa

ID dell'app da cui è stato inviato il messaggio A partire dall'API Graphapp_id+, il campo v12.0 restituirà l'ID dell'app della posta della Pagina Facebook (26390203743090) ogni volta che il messaggio viene inviato tramite la posta della Pagina Facebook.

metadata

Stringa

Stringa personalizzata passata all'API Send come campo metadata. Presente solo se la proprietà metadata è stata impostata nel messaggio originale.

mid

Stringa

ID del messaggio

Messaggio di testo

Esempio

{
  "sender":{
    "id":"<PSID>"
  },
  "recipient":{
    "id":"<USER_ID>"
  },
  "timestamp":1457764197627,
  "message":{
    "is_echo":true,
    "app_id":1517776481860111,
    "metadata": "<DEVELOPER_DEFINED_METADATA_STRING>",
    "mid":"mid.1457764197618:41d102a3e1ae206a38",
    "text":"hello, world!"
  }
}

Proprietà

message

Proprietà Tipo Descrizione

text

Stringa

Testo del messaggio

Messaggio con immagine, audio, video o file allegato

Esempio

{
  "sender":{
    "id":"<PSID>"
  },
  "recipient":{
    "id":"<USER_ID>"
  },
  "timestamp":1458696618268,
  "message":{
    "is_echo":true,
    "app_id":1517776481860111,
    "metadata": "<DEVELOPER_DEFINED_METADATA_STRING>",
    "mid":"mid.1458696618141:b4ef9d19ec21086067",
    "attachments":[
      {
        "type":"image",
        "payload":{
          "url":"<IMAGE_URL>"
        }
      }
    ]
  }
}

Proprietà

message.attachments

Proprietà Tipo Descrizione

type

Stringa

Tipo di allegato: image, audio, video o file

payload.url

Stringa

URL dell'allegato

Messaggio con allegato template

Esempio

{
  "sender":{
    "id":"<PSID>"
  },
  "recipient":{
    "id":"<USER_ID>"
  },
  "timestamp":1458696618268,
  "message":{
    "is_echo":true,
    "app_id":1517776481860111,
    "metadata": "<DEVELOPER_DEFINED_METADATA_STRING>",
    "mid":"mid.1458696618141:b4ef9d19ec21086067",
    "attachments":[
      {
        "type":"template",
        "payload":{
          "template_type":"button",
          "buttons":[
            {
              "type":"web_url",
              "url":"https:\/\/www.messenger.com\/",
              "title":"Visit Messenger"
            }
          ]
        }
      }
    ]
  }
}

Proprietà

message.attachments

Proprietà Tipo Descrizione

type

Stringa

template

payload

Stringa

Payload del template come descritto nel riferimento per l'API Send

Nel caso di un payload con allegati, l'ID allegato inviato è un numero, non una stringa. Vedi l'esempio 2

Questo non corrisponde al formato dell'API Send che necessita che l'ID allegato venga inviato come stringa.

Messaggio con allegato fallback

Un allegato fallback è qualsiasi allegato non attualmente riconosciuto o supportato dalla funzione Message Echo.

Esempio

{
  "sender":{
    "id":"<PSID>"
  },
  "recipient":{
    "id":"<USER_ID>"
  },
  "timestamp":1458696618268,
  "message":{
    "is_echo":true,
    "app_id":1517776481860111,
    "metadata": "<DEVELOPER_DEFINED_METADATA_STRING>",
    "mid":"mid.1458696618141:b4ef9d19ec21086067",
    "attachments":[
      {
        "title":"Legacy Attachment",
        "url":"https:\/\/www.messenger.com\/",
        "type":"fallback",
        "payload":null
      }
    ]
  }
}

Proprietà

message.attachments

Proprietà Tipo Descrizione

type

Stringa

fallback

title

Stringa

Titolo dell'allegato (opzionale)

url

Stringa

URL dell'allegato (opzionale)

payload

Stringa

Payload dell'allegato (opzionale)

Messaggio con prodotti

Il webhook message con products echo è disponibile solo sulle versioni 8.0 e successive dell'API Graph

L'app dovrà disporre dell'autorizzazione catalog_management per ricevere i dettagli del prodotto nei webhook.

Esempio

{
  "sender":{
    "id":"<PSID>"
  },
  "recipient":{
    "id":"<USER_ID>"
  },
  "timestamp":1458696618268,
  "message":{
    "is_echo":true,
    "app_id":1517776481860111,
    "metadata": "<DEVELOPER_DEFINED_METADATA_STRING>",
    "mid":"mid.1458696618141:b4ef9d19ec21086067",
    "attachments":[
      {
        "type":"template",
        "payload":{
          "product":{
             "elements":[ // multiple elements for Hscroll
               {
                 "id":"<PRODUCT_ID>",
                 "retailer_id":"<EXTERNAL_ID>",
                 "image_url":"https://fb.cdn.com/sdsd",
                 "title":"Some product title",
                 "subtitle": "40",
               },
               {...},
             ]
            }

          ]
        }
      }
    ]
  }
}

Proprietà

product.elements

Proprietà Tipo Descrizione

id

Stringa

ID prodotto dal catalogo prodotti

retailer_id

Stringa

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

image_url

Stringa

URL dell'immagine del prodotto

title

Stringa

Titolo del prodotto.

subtitle

Stringa

Sottotitolo del prodotto