Messenger-Plattform

Referenz zum Webhook-Event message_echoes

Dieser Rückruf tritt auf, wenn von deiner Seite eine Nachricht gesendet wurde. Du kannst text-Nachrichten oder Nachrichten mit Anhängen (image, video, audio, template oder fallback) empfangen. Die Payload umfasst außerdem einen optionalen selbstdefinierten metadata-Parameter, der von dem*der Absender*in gesendet wird, und die entsprechende app_id.
Durch Auswahl des Feldes message_echoes beim Einrichten deines Webhooks kannst du diesen Rückruf abonnieren.

Es werden mehrere Nachrichtentypen unterstützt:

Allgemeines Format

Beispiel 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",
    ...
  }
}

Beispiel 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
                                        }
                                    ]
                                }
                            }
                        ]
                    }
                }
            ]
        }
    ]
}

Eigenschaften

sender

EigenschaftTypBeschreibung

id

String

Die PSID des Nutzers, der das Webhook-Event ausgelöst hat.

user_ref

String

Die user_ref des Nutzers, der das Webhook-Event ausgelöst hat. Dies ist nur für Webhook-Events aus dem Chat-Plugin verfügbar.

recipient

EigenschaftTypBeschreibung

id

String

Deine Seiten-ID.

message

Name des Feldes Typ Beschreibung

is_echo

Boolescher Wert

Gibt die Nachricht an, die von der Seite selbst gesendet wurde

app_id

String

ID der App, von der die Nachricht gesendet wurde. Ab Graph API v12.0 gibt das Feld app_id die App-ID des Facebook-Seiten-Postfachs (26390203743090) zurück, wenn die Nachricht über das Postfach der Facebook-Seite gesendet wird.

metadata

String

Selbstdefinierter String, der an die Send API als metadata-Feld gesendet wird. Nur vorhanden, wenn die metadata-Eigenschaft in der ursprünglichen Nachricht festgelegt wurde.

mid

String

Nachrichten-ID.

Nachricht

Beispiel

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

Eigenschaften

message

Eigenschaft Typ Beschreibung

text

String

Text der Nachricht.

Nachricht mit Bild-, Audio-, Video- oder Dateianhang

Beispiel

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

Eigenschaften

message.attachments

Eigenschaften Typ Beschreibung

type

String

Typ des Anhangs: image, audio, video oder file

payload.url

String

URL des Anhangs

Nachricht mit Vorlagenanhang

Beispiel

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

Eigenschaften

message.attachments

Eigenschaft Typ Beschreibung

type

String

template

payload

String

Vorlagen-Payload wie in der Send API-Referenz beschrieben.

Beachte, dass bei einer payload mit Anhängen die gesendete Anhangs-ID eine Zahl und kein String ist. Siehe Beispiel 2

Dies entspricht nicht dem Format der Send API, wobei die Anhangs-ID als String gesendet werden muss.

Nachricht mit Fallback-Anhang

Ein Fallback-Anhang ist ein Anhang, der derzeit nicht von der Message Echo-Funktion erkannt oder unterstützt wird.

Beispiel

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

Eigenschaften

message.attachments

Eigenschaft Typ Beschreibung

type

String

fallback

title

String

Titel des Anhangs (optional)

url

String

URL des Anhangs (optional)

payload

String

Payload des Anhangs (optional)

Nachricht mit Produkten

Nachrichten mit Produkt-Echo-Webhooks sind erst ab Version 8.0 der Graph API verfügbar.

Die App benötigt eine Genehmigung für die Berechtigung catalog_management, um Produktdetails über Webhooks abzurufen.

Beispiel

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

          ]
        }
      }
    ]
  }
}

Eigenschaften

product.elements

Eigenschaft Typ Beschreibung

id

String

Produkt-ID aus dem Produktkatalog.

retailer_id

String

Externe ID, die mit dem Produkt verknüpft ist (z. B. SKU/Content-ID).

image_url

String

URL des Produktbilds

title

String

Titel des Produkts.

subtitle

String

Untertitel des Produkts