Messenger-Plattform

Referenz zu messaging_postbacks-Webhooks

In diesem Dokument wird die JSON-Payload erläutert, die dein Webhook-Server empfängt, wenn ein Messaging-Postback-Webhook-Event ausgelöst wird. Ein Postback-Webhook-Event wird ausgelöst, wenn jemand auf einen Postback-Button, einen „Los geht‘s“-Button oder eine Option im beständigen Menü klickt.

Beispielbenachrichtigung

Hier siehst du ein Beispiel für die JSON-Payload, die an deinen Webhook-Server gesendet wird.

{
  "field": "messaging_postbacks",
  "value": {
    "sender": {
      "user_ref": "USER-REF-ID"
    },
    "recipient": {
      "id": "PAGE-ID"
    },
    "timestamp": "1527459824",
    "postback": {
      "mid": "m_MESSAGE-ID",
      "title": "TITLE-FOR-THE-CTA",
      "payload": "USER-DEFINED-PAYLOAD",
      "referral": {
        "ref": "USER-DEFINED-REFERRAL-PARAM",
        "source": "SHORT-URL",
        "type": "OPEN_THREAD"
      }
    }
  }
}

JSON-Eigenschaften

Alle JSON-Eigenschaften in einer Webhook-Benachrichtigung sind Strings.

EigenschaftBeschreibung

postback.mid

Die ID für die Nachricht.

postback.payload

Im CTA-payload-Parameter definierte Informationen. Diese werden nur in die Webhook-Benachrichtigung an die App aufgenommen, von der die Nachricht an die Person gesendet wurde.

postback.referral

Informationen zur Handlung, die die Person zum Beginnen einer Unterhaltung durchgeführt hat.

Die Informationen der referral-Eigenschaft sind nur dann in der Webhook-Benachrichtigung enthalten, wenn eine Person eine Unterhaltung über eine der folgenden Methoden beginnt und dann auf einen CTA wie einen „Los geht‘s“-Button klickt:

  • Chat-Plugin
  • m.me-Link
  • Click-to-Messenger Ad
  • Messenger-QR-Code
  • Willkommensbildschirm

postback.referral.ref

Die beliebigen Daten, die ursprünglich im an den m.me-Link angehängten ref-Parameter übergeben wurden. Nur alphanumerische Zeichen sowie „-“, „_“ und „=“ werden unterstützt.

postback.referral.source

Die URL für diese Weiterleitung. Bei m.me-Links ist der Wert von „source“ “SHORTLINK”. Bei Weiterleitungen von Messenger Conversation Ads ist der Wert von „source“ "ADS".

postback.referral.type

Die ID für die Weiterleitung. Bei Weiterleitungen von m.me-Links lautet dieser Wert immer "OPEN_THREAD".

postback.title

Der Titel für den Call-to-Action (CTA), auf den geklickt wurde.

recipient.id

Die ID für deine Facebook-Seite.

sender.user_ref

Die ID für die Referenz für eine Person, die eine Handlung ausgeführt hat, mit der eine Nachricht gesendet wurde, wie das Klicken auf einen „Los geht‘s“-Button, ein Chat-Plugin oder eine Option im beständigen Menü.

timestamp

Der UNIX-Zeitstempel für das Datum, an dem die Webhook-Benachrichtigung an deinen Server gesendet wurde.

Siehe auch

Zusätzliche Entwicklerdokumentation zum Vertiefen deiner Kenntnisse der in diesem Leitfaden für Messaging-Postback-Webhooks erwähnten Konzepte.