Medienvorlage

Mit der Medienvorlage kannst du Bilder, GIFs und Videos als strukturierte Nachricht mit einem optionalen Button senden. Videos und animierte GIFs, die mit der Medienvorlage gesendet werden, können in Unterhaltungen abgespielt werden.

Die Medienvorlage kann über die Send API sowie über die Messenger-Webansicht mit der beginShareFlow()-Funktion des SDK für Messenger-Erweiterungen gesendet werden.

Nur Bilder und Videos

Aktuell unterstützt die Medienvorlage nur das Senden von Bildern und Videos. Audio wird derzeit nicht unterstützt.

Inhalt

Senden von Medien nach Anhangs-ID

Um ein Bild zu senden, sende eine POST-Anfrage mit der folgenden payload-Eigenschaft im Anfragehauptteil an die Send API. Hierbei steht attachment_id für eine über die Attachment Upload API hochgeladene ID. Bei Anfragen, die die attachment_id-Eigenschaft verwenden, werden Bilder und Videos unterstützt.

Ausführliche Informationen zu Anfrageeigenschaften findest du in der Referenz zur Medienvorlage.

Erneute Verwendung von Medien aus Facebook-URLs

Anhangs-IDs werden für Medien aus Facebook-URLs nicht unterstützt. Diese Dateien wurden bereits zwischengespeichert und sollten per Facebook-URL an die Medienvorlage angehängt werden.

curl -X POST -H "Content-Type: application/json" -d '{
  "recipient":{
    "id":"<PSID>"
  },
  "message":{
    "attachment": {
      "type": "template",
      "payload": {
         "template_type": "media",
         "elements": [
            {
               "media_type": "<image|video>",
               "attachment_id": "<ATTACHMENT_ID>"
            }
         ]
      }
    }    
  }
}' "https://graph.facebook.com/v2.6/me/messages?access_token=<PAGE_ACCESS_TOKEN>"

Senden von Medien nach Facebook-URL

Mit der Medienvorlage kannst du auf Facebook hochgeladene Bilder und Videos senden, indem du eine POST-Anfrage an den /messages-Endpunkt sendest, die die Facebook-URL in der url-Eigenschaft enthält:

Ausführliche Informationen zu Anfrageeigenschaften findest du in der Referenz zur Medienvorlage.

Nur Facebook-URLs

Die Medienvorlage unterstützt keine externen, sondern nur Facebook-URLs. Um ein Bild aus einer externen URL zu senden, lade es zunächst mit der Attachment Upload API hoch und rufe eine attachment_id ab.

curl -X POST -H "Content-Type: application/json" -d '{
  "recipient":{
    "id":"<PSID>"
  },
  "message":{
    "attachment": {
      "type": "template",
      "payload": {
         "template_type": "media",
         "elements": [
            {
               "media_type": "<image|video>",
               "url": "<FACEBOOK_URL>"
            }
         ]
      }
    }    
  }
}' "https://graph.facebook.com/v2.6/me/messages?access_token=<PAGE_ACCESS_TOKEN>"

Abrufen der Facebook-URL

So rufst du die Facebook-URL für ein Bild oder Video ab:

  1. Klicke auf die Miniaturansicht des Bildes oder Videos, um die Großansicht zu öffnen.
  2. Kopiere die URL aus der Adresszeile deines Browsers.

Facebook-URLs weisen immer folgendes Grundformat auf:

MedientypMedienquelleURL-Format

Video

Facebook-Seite

https://business.facebook.com/<PAGE_NAME>/videos/<NUMERIC_ID>

Video

Facebook-Konto

https://www.facebook.com/<USERNAME>/videos/<NUMERIC_ID>/

Bild

Facebook-Seite

https://business.facebook.com/<PAGE_NAME>/photos/<NUMERIC_ID>

Bild

Facebook-Konto

https://www.facebook.com/photo.php?fbid=<NUMERIC_ID>

Hinzufügen eines Buttons

Optional können auch Buttons an die Medienvorlage angehängt werden. Anzahl und Art der unterstützten Buttons hängen davon ab, ob du die Medienvorlage mit der beginShareFlow()-Funktion des SDK für Messenger-Erweiterungen verwendest oder sie mit der Send API sendest:

  • Send API: Es können bis zu drei Buttons eines beliebigen Typs angehängt werden.
  • beginShareFlow(): Es kann nur ein Button des Typs „URL“ angehängt werden.

Um einen Button zu deiner Medienvorlage hinzuzufügen, füge ein buttons-Array zur Vorlagendefinition im Anfragehauptteil hinzu.

Weitere verfügbare Buttons findest du unter Buttons.

"elements": [
   {
      "media_type": "image",
      "url": "<MEDIA_URL>",
      "buttons": [
         {
            "type": "web_url",
            "url": "<WEB_URL>",
            "title": "View Website",
         }
      ]
   }
]

API-Antwort

Ist der Vorgang erfolgreich, antwortet die Messenger-Plattform mit recipient_id und message_id der gesendeten Nachricht:

{
  "recipient_id": "1254477777772919",
  "message_id": "AG5Hz2Uq7tuwNEhXfYYKj8mJEM_QPpz5jdCK48PnKAjSdjfipqxqMvK8ma6AC8fplwlqLP_5cgXIbu7I3rBN0P"
}