Referenz zum Webhook-Event messages

Dieser Rückruf tritt auf, wenn eine Nachricht an deine Seite gesendet wurde. Nachrichten werden immer nacheinander gesendet. Du kannst SMS-Nachrichten oder Nachrichten mit Anhängen erhalten.

Es werden hauptsächlich die Anhangstypen image, audio, video, file, reel und ig_reel unterstützt. Du erhältst möglicherweise auch fallback-Anhänge. Ein gängiges Beispiel für einen „Fallback“ ist, wenn ein*e Nutzer*in eine URL mit einer Seite teilt und ein Anhang auf Grundlage des Teilen von Links erstellt wird. Wenn das Teilen durch eine*n Nutzer*in mit deiner Seite nicht unterstützt wird, wird möglicherweise ein fallback ohne Payload gesendet.

Du kannst diesen Rückruf abonnieren, indem du message beim Setup deines Webhooks auswählst.

Beispiele

SMS-Nachricht

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

Antwortnachricht

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

Nachricht mit Anhang

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

Nachricht mit Produktvorlage

Der Nachrichten-Webhook mit Produktvorlagen ist erst ab Version 8.0 der Graph API verfügbar.

Dieser Webhook wird bei einem Szenario angewendet, bei dem ein*e Nutzer*in Produkte aus anderen Threads oder einem Teilen-Vorgang mit der Seite teilt. Dieser Webhook ist auf Produkte beschränkt, die der Seite gehören. Die App benötigt eine Genehmigung für die Berechtigung catalog_management, um Produktdetails über Webhooks abzurufen.

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

Nachricht mit Fallback-Anhang

Beispiel gilt für messages ab Version 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"
                                }
                            }
                        ]
                    }
                }
            ]
        }
    ]
}

Nachricht von der Shops-Produktdetailseite

Der Nachrichten-Webhook von der Shops-Produktdetailseite ist erst ab Version 8.0 der Graph API verfügbar.

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

Nachricht mit Informationen zur Anzeigenweiterleitung

Dieser Webhook wird bei einem Szenario angewendet, in dem Nutzer*innen auf eine CTM-Werbung (Click-to-Message) klickt und eine Nachricht an eine Facebook-Seite sendet. Zusätzlich zu den enthaltenen Nachrichtendetails erhält die App außerdem Informationen zur Anzeigenweiterleitung.

Für Nachricht mit Informationen zur Anzeigenweiterleitung muss die App über Seitenabonnements für die Felder messages und messaging_referrals verfügen.

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

Nachricht mit Befehlen

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

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

Ankündigung vom 4. März 2020

Ab Version 6.0 wurde sticker_id von message zu message.attachments.payload verschoben.

Eigenschaft Typ Beschreibung

mid

String

Nachrichten-ID

text

String

Text der Nachricht

quick_reply

Objekt

Optionale selbstdefinierte Daten, die von der sendenden App bereitgestellt werden.

reply_to

Objekt

Verweis auf die Nachrichten-ID (Message ID, mid), auf die diese Nachricht antwortet.

attachments

Array<attachment>

Array mit Anhangsdaten.

referral

Objekt

Weiterleitung der Nachricht von der Shops-Produktdetailseite.

message.quick_reply

Eine quick_reply-Payload wird nur dann mit einer Textnachricht bereitgestellt, wenn der*die Nutzer*in auf einen Schnellantwort-Button tippt.

Eigenschaft Typ Beschreibung

payload

String

Von der App bereitgestellte personalisierte Daten.

message.reply_to

Eigenschaft Typ Beschreibung

mid

String

Verweis auf die Nachrichten-ID, auf die diese Nachricht antwortet.

message.attachments

Eigenschaft Typ Beschreibung

type

String

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

payload

String

message.attachments.payload

message.attachments.payload

Eigenschaft Typ Beschreibung

url

String

Die URL des Anhangstyps. Gilt für die folgenden Anhangstypen: audio, file, image, video, fallback, reel, ig_reel

title

String

Titel des Anhangs. Gilt für die folgenden Anhangstypen: fallback, reel und ig_reel

sticker_id

Nummer

Beständige ID dieses Stickers. 369239263222822 verweist beispielsweise auf den „Gefällt mir“-Sticker. Gilt für den folgenden Anhangstyp: image, nur wenn ein Sticker gesendet wird.

reel_video_id

Zahl

ID des Videos, das mit dem angehängten Reel verbunden ist. Gilt für die folgenden Anhangstypen: reel und ig_reel

message.attachments.payload.product.elements

Eigenschaft Typ Beschreibung

id

String

Produkt-ID aus dem Facebook-Produktkatalog.

retailer_id

String

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

image_url

String

URL des Produkts.

title

String

Titel des Produkts.

subtitle

String

Untertitel des Produkts

message.referral

referral-Payload wird nur bereitgestellt, wenn der*die Nutzer*in eine Nachricht von der Shops-Produktdetailseite sendet.

Eigenschaft Typ Beschreibung

product

Objekt

Produktinformationen.

source

String

Die Quelle der Weiterleitung. Unterstützte Werte: ADS (nur Anzeigenweiterleitung wird unterstützt).

type

String

Der Weiterleitungstyp. Unterstützt derzeit OPEN_THREAD.

ref

String

Das optional in der Weiterleitung festgelegte ref-Attribut. Nur alphanumerische Zeichen sowie -, _ und = werden unterstützt.

ad_id

String

Anzeigeng-ID aus dem Werbeanzeigenmanager.

ads_context_data

Objekt

Werbekontextdaten aus dem Werbeanzeigenmanager.

message.referral.product

Eigenschaft Typ Beschreibung

id

String

Produkt-ID.

message.referral.ads_context_data

Eigenschaft Typ Beschreibung

ad_title

String

Titel der Anzeige im Werbeanzeigenmanager.

photo_url

String

[Optional] URL der Bilddatei aus der Anzeige.

video_url

String

[Optional] Thumbnail-URL des Videos aus der Anzeige.

post_id

String

Anzeigen-ID im Werbeanzeigenmanager.

product_id

String

[Optional] Produkt-ID aus der Anzeige.

message.commands

Eigenschaft Typ Beschreibung

name

String

Der Name des Befehls.