Generische Vorlage – Referenz

Mit der generischen Vorlage kannst du eine strukturierte Nachricht senden, die ein Bild, Text und Buttons enthält. Eine generische Vorlage mit mehreren im elements-Array beschriebenen Vorlagen sendet ein horizontal scrollbares Carousel mit Elementen, von denen jedes ein Bild, Text und Buttons enthält. Die vollständigen Details zur Implementierung findest du unter Generische Vorlage.

Anfrage-URI

https://graph.facebook.com/v21.0/me/messages?access_token=<PAGE_ACCESS_TOKEN>

Beispielanfrage

curl -X POST -H "Content-Type: application/json" -d '{
  "recipient":{
    "id":"<PSID>"
  },
  "message":{
    "attachment":{
      "type":"template",
      "payload":{
        "template_type":"generic",
        "elements":[
           {
            "title":"Welcome!",
            "image_url":"https://petersfancybrownhats.com/company_image.png",
            "subtitle":"We have the right hat for everyone.",
            "default_action": {
              "type": "web_url",
              "url": "https://petersfancybrownhats.com/view?item=103",
              "messenger_extensions": false,
              "webview_height_ratio": "tall",
              "fallback_url": "https://petersfancybrownhats.com/"
            },
            "buttons":[
              {
                "type":"web_url",
                "url":"https://petersfancybrownhats.com",
                "title":"View Website"
              },{
                "type":"postback",
                "title":"Start Chatting",
                "payload":"DEVELOPER_DEFINED_PAYLOAD"
              }              
            ]      
          }
        ]
      }
    }
  }
}' "https://graph.facebook.com/v2.6/me/messages?access_token=<PAGE_ACCESS_TOKEN>"

Beispielantwort

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

Eigenschaften

`recipient`

Beschreibung des Nachrichtenempfängers Alle Anfragen müssen entweder id , phone_number oder user_ref enthalten.

Eigenschaft	Typ	Beschreibung
`recipient.id`	String	`PSID`, `phone_number` oder `user_ref` des Nachrichtenempfängers.
`recipient.phone_number`	String	*Optional.* Telefonnummer des Empfängers im Format +1(212)555-2368. Dein Bot muss für den Kundenabgleich genehmigt sein, um auf diese Art Nachrichten senden zu können.
`recipient.user_ref`	String	*Optional.*`user_ref` aus dem Kontrollkästchen-Plugin.
`recipient.name`	Objekt	*Optional.* Wird nur verwendet, wenn `phone_number` festgelegt ist. Gibt den Namen der Person in folgendem Format an: `{"first_name":"John", "last_name":"Doe"}` Durch Angabe eines Namens wird die Wahrscheinlichkeit eines erfolgreichen Abgleichs erhöht.

`message`

Description of the message to be sent.

Property	Type	Description
`message.attachment`	Object	An object describing attachments to the message.

`message.attachment`

Property	Type	Description
`type`	String	Value must be `template`
`payload`	Object	`payload` der Vorlage.

`message.attachment.payload`

Eigenschaftsname	Typ	Beschreibung
`template_type`	String	Der Wert muss `generic` lauten.
`elements`	Array-<`element`>	Ein Array mit 1 element-Objekt, das die Medien in der Nachricht beschreibt. Es wird maximal 1 Element unterstützt.
`sharable`	Boolescher Wert	*Optional.* Setze diese Eigenschaft auf `true`, um den nativen „Teilen“-Button im Messenger für die Vorlagennachricht zu aktivieren. Der Wert lautet standardmäßig `false`.

`message.attachment.payload.elements`

Die generische Vorlage unterstützt maximal 10 Elemente pro Nachricht. Mindestens eine Eigenschaft muss zusätzlich zu title festgelegt sein.

Eigenschaftsname	Typ	Beschreibung
`title`	String	Der Titel, der in der Vorlage erscheinen soll. Max. 80 Zeichen.
`subtitle`	String	*Optional.* Der Untertitel, der in der Vorlage erscheinen soll. Max. 80 Zeichen.
`image_url`	String	*Optional.* Die URL des Bildes, das in der Vorlage erscheinen soll.
`default_action`	Objekt	*Optional.* Die Standardhandlung, die ausgeführt wird, wenn jemand auf die Vorlage tippt. Akzeptiert dieselben Eigenschaften wie URL-Button mit Ausnahme von `title`.
`buttons`	Array-<`button`>	*Optional.* Ein Array von Buttons, die an die Vorlage angehängt werden sollen. Es werden maximal drei Buttons pro Element unterstützt.