Messenger-Plattform

Referenz zum Webhook-Event messaging_optins

Das Webhook-Event für Nachrichten-Opt-ins wird ausgelöst, wenn eine Person dem Erhalt von Marketing-Nachrichten zustimmt oder auf das Plugin „An Messenger senden“ tippt.

Wenn das Plugin „An Messenger senden“ verwendet wird, wird der Parameter optin.ref durch das Feld data-ref im Plugin „An Messenger senden“ festgelegt. Dieses Feld kann von dem*der Entwickler*in verwendet werden, um ein Klick-Event im Plugin einem Rückruf zuzuordnen.

Webhook-Benachrichtigung für Nachrichten-Opt-ins

Deine App erhält eine Opt-in-Webhook-Benachrichtigung, wenn Folgendes geschieht:

  • Eine Person stimmt zu.
  • Eine Person stimmt erneut zu, indem Sie auf den Nachrichten weiterhin senden-Button klickt, der vor Ablauf des Nachrichten-Tokens angezeigt wird.
  • Eine Person ändert ihren Opt-in-Status, indem sie den Empfang von Nachrichten beendet oder wieder aktiviert.
{
  "sender": {
    "id": "PSID",
  },
  "recipient": {
    "id": "PAGE-ID",
  },
  "timestamp": "TIMESTAMP",
  "optin": {
    "type": "notification_messages", 
    "payload": "ADDITIONAL-INFORMATION",
    "notification_messages_token": "NOTIFICATION-MESSAGES-TOKEN", 
    "notification_messages_frequency": "FREQUENCY",  
    "notification_messages_timezone": "TIMEZONE-ID",
    "token_expiry_timestamp": "TIMESTAMP",
    "user_token_status": "TOKEN-STATUS",  
    "notification_messages_status": "NOTIFICATION-STATUS",
    "title": "TITLE" 
    }
}

optin

EigenschaftBeschreibung

payload

String

Zusätzliche Informationen, die du in der Webhooks-Benachrichtigung aufnehmen möchtest.

title

String

Der Titel, der in der Vorlage erscheinen soll.

notification_messages_token

String

Das Token, das die zustimmende Person darstellt, einschließlich des bestimmten Themas und der Nachrichtenfrequenz der gesendeten Marketing-Nachrichten.

notification_messages_frequency

enum { DAILY, WEEKLY, MONTHLY }

Der Wert kann einer der Folgenden sein:

  • DAILY: Eine Benachrichtigung wird alle 24 Stunden für 6 Monate ab Opt-In-Datum gesendet.
  • WEEKLY: Eine Benachrichtigung wird einmal pro Woche für 9 Monate ab Opt-In-Datum gesendet.
  • MONTHLY: Eine Benachrichtigung wird einmal pro Monat für 12 Monate ab Opt-In-Datum gesendet.

(Entfernt in API v16)

notification_messages_timezone

String

Zeitzone für die Person, die die Nachricht erhält

notification_messages_status

enum { STOP NOTIFICATIONS, RESUME NOTIFICATIONS } 		Dieses Feld ist nur vorhanden, wenn der*die Nutzer*in Marketing-Nachrichten stoppt oder wieder aktiviert.

Der Wert kann einer der Folgenden sein:

  • STOP NOTIFICATIONS (Benachrichtigungen ausschalten): Der*die Nutzer*in hat auf „Diese Nachrichten nicht mehr erhalten“ geklickt.
  • RESUME NOTIFICATIONS (Benachrichtigungen wieder aktivieren): Der*die Nutzer*in hat auf „Diese Nachrichten wieder aktivieren“ geklickt.

token_expiry_timestamp

Unix-Zeitstempel

Datum, an dem das Benachrichtigungstoken abläuft.

type

String

Der Wert muss notification_messages lauten.

user_token_status

enum { REFRESHED, NOT_REFRESHED }

Der Wert kann einer der Folgenden sein:

  • REFRESHED: Dieser Wert wird festgelegt, wenn der*die Nutzer*in dem Erhalt von Marketing-Nachrichten erneut zugestimmt hat, nachdem das Token abgelaufen ist.
  • NOT_REFRESHED: Dies ist der Standardwert und er wird festgelegt, wenn der*die* Nutzer*in dem Erhalt von Marketing-Nachrichten nicht erneut zugestimmt hat, nachdem das Token abgelaufen ist.