Messenger Profile API

Im Messenger-Profil für deine Seite legst du Eigenschaften fest, die verschiedene Aspekte der folgenden Messenger-Features definieren. Mehr dazu erfährst du in der Tabelle mit den Messenger-Profileigenschaften weiter unten.

• Button „Los geht‘s“
• Willkommensseite
• Eisbrecher
• Beständiges Menü
• Domain-Whitelist
• Kontoverknüpfung
• Befehle
• Tab „Entdecken“ (Veraltet)

Mit der Messenger Profile API kannst du Eigenschaften aus dem Messenger-Profil deiner Seite festlegen, aktualisieren, abrufen und löschen.

Berechtigungen

Um mit diesem Endpunkt zu interagieren, benötigst du einen Seiten-Zugriffsschlüssel mit der Berechtigung pages_messaging.

Für Apps im Entwicklungsmodus sind die Einstellungen für das Messenger-Profil nur für Personen sichtbar, die über eine Rolle in der App verfügen.

Inhalt

• Anfrage-URI
• Messenger-Profileigenschaften
• Eigenschaften abrufen
• Eigenschaften festlegen/aktualisieren
• Eigenschaften löschen
• Ratenbegrenzung

Anfrage-URI

https://graph.facebook.com/v19.0/me/messenger_profile?access_token=<PAGE_ACCESS_TOKEN>

Messenger-Profileigenschaften

Die folgenden Eigenschaften können im Messenger-Profil für deine Seite enthalten sein. Die Beschreibung zum Typ und Zweck der einzelnen Eigenschaften findest du in der Tabelle weiter unten.

Eigenschaften abrufen

Ruft den aktuellen Wert von einer oder mehreren Messenger-Profileigenschaften anhand des Namens ab.

Anfrageparameter

Die folgenden Parameter sind im Abfrage-String der Anfrage enthalten:

Beispielanfrage

curl -X GET "https://graph.facebook.com/v19.0/me/messenger_profile?fields=whitelisted_domains,greeting&access_token=<PAGE_ACCESS_TOKEN>"

Beispielantwort

Der aktuelle Wert der angefragten Eigenschaften wird im data-Array zurückgegeben:

{
   "data": [
        {
          "whitelisted_domains": [
            "https://facebook.com/"
          ],
          "greeting": [
            {
               "locale": "default",
               "text": "Hello!"
            },
            {
               "locale": "en_US",
               "text": "Timeless apparel for the masses."
            }
         ]
      }
   ]
}

Eigenschaften festlegen/aktualisieren

Legt die Werte von einer oder mehreren Messenger-Profileigenschaften fest. Nur Eigenschaften, die im Anfrage-Hauptteil festgelegt sind, werden überschrieben.

Beispielanfrage

curl -X POST -H "Content-Type: application/json" -d '{
  "<PROPERTY_NAME>": "<NEW_PROPERTY_VALUE>",
  "<PROPERTY_NAME>": "<NEW_PROPERTY_VALUE>",
  ...
}' "https://graph.facebook.com/v18.0/me/messenger_profile?access_token=<PAGE_ACCESS_TOKEN>"

Beispielantwort

{
    "result": "success"
}

Eigenschaften löschen

Löscht eine oder mehrere Messenger-Profileigenschaften. Nur Eigenschaften, die im fields-Array angegeben sind, werden gelöscht.

Beispielanfrage

curl -X DELETE -H "Content-Type: application/json" -d '{
  "fields": [
    "<PROPERTY_NAME>",
    "<PROPERTY_NAME>",
    "<PROPERTY_NAME>",
    ...
  ]
}' "https://graph.facebook.com/v19.0/me/messenger_profile?access_token=<PAGE_ACCESS_TOKEN>"

Beispielantwort

{
    "result": "success"
}