Referenz zum Webhook-Event `messaging_referrals`

Dieser Rückruf findet statt, wenn der*die Nutzer*in bereits einen Thread mit dem Bot führt und durch folgende Handlungen zum Thread gelangt:

Beim Folgen eines m.me-Links mit einem Weiterleitungsparameter
Durch Klicken auf eine Messenger Conversation Ad
Durch Beginnen oder Fortsetzen einer Unterhaltung über das Customer Chat-Plugin

Infos zum Verfolgen von Weiterleitungen in neuen Threads findest du unter Postback-Event.

Um diese Events zu empfangen, musst du messaging_referrals in den Webhook-Einstellungen für deine App abonnieren.

Beispiele

m.me-Link

{
  "sender": {
    "id": "<PSID>"
  },
  "recipient": {
    "id": "<PAGE_ID>"
  },
  "timestamp": 1458692752478,
  "referral": {
    "ref": <REF_DATA_PASSED_IN_M.ME_PARAM>,
    "source": "SHORTLINK",
    "type": "OPEN_THREAD",
  }
}

Anzeigenweiterleitung

{
  "sender": {
    "id": "<PSID>"
  },
  "recipient": {
    "id": "<PAGE_ID>"
  },
  "timestamp": 1458692752478,
  "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>
    }
  }
}

Customer Chat-Plugin

Aktuelle Änderung (5. Mai 2020)

Graph API v7.0 und höher: Das messaging_postback-Webhook-Event des Chat-Plugins gibt nicht das sender.id-Feld zurück. Es gibt das neue Feld sender.user_ref zurück. Diese Änderung wird ab dem 2. November 2020 für alle älteren Graph API-Versionen angewendet.

Neues Referral-Webhook-Event (Graph API v7.0 und höher und alle Graph API-Versionen ab 2. November 2020)

{
  "sender":{
    "user_ref":"<USER_REF>"
  },
  "recipient":{
    "id":"<PAGE_ID>"
  },
  "timestamp": 1458692752478,
  "referral": {
     "ref": "<REF_DATA_PASSED_IN_CODE>",
     "source": "CUSTOMER_CHAT_PLUGIN",
     "type": "OPEN_THREAD",
     "referer_uri": "<WEBSITE_URL>"
  }
}

Altes Referral-Webhook-Event (Graph API <= v6.0 – verfügbar bis 2. November 2020)

{
  "sender":{
    "id":"<PSID>"
  },
  "recipient":{
    "id":"<PAGE_ID>"
  },
  "timestamp": 1458692752478,
  "referral": {
     "ref": "<REF_DATA_PASSED_IN_CODE>",
     "source": "CUSTOMER_CHAT_PLUGIN",
     "type": "OPEN_THREAD",
     "referer_uri": "<WEBSITE_URL>"
  }
}

Eigenschaften

`sender`

Eigenschaft	Typ	Beschreibung
`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`

Eigenschaft	Typ	Beschreibung
`id`	String	Deine Seiten-ID.

`referral`

Eigenschaft	Typ	Beschreibung
`source`	String	Die Quelle der Weiterleitung. Unterstützte Werte: `ADS` `SHORTLINK` `CUSTOMER_CHAT_PLUGIN`
`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.
`referer_uri`	String	Die URI der Website, von der die Nachricht im Customer Chat-Plugin gesendet wurde.
`is_guest_user`	String	Eine Kennzeichnung, die angibt, ob derdie Nutzerin eine Gastnutzerin vom Facebook-Chat-Plugin ist.
`ads_context_data`	Objekt	Die Daten, die Informationen über die CTM-Anzeige enthalten, von der derdie Nutzerin den Thread initialisiert hat.

`ads_context_data`

Property	Type	Description
`ad_title`	String	Title of the Ad.
`photo_url`	String	[Optional] Url of the image from the Ad the user is interested.
`video_url`	String	[Optional] Thumbnail url of the the video from the ad.
`post_id`	String	ID of the post.
`product_id`	String	[Optional] Product ID from the Ad the user is interested.

Referenz zum Webhook-Event messaging_referrals