Button-Vorlage – Referenz

Mit der Button-Vorlage kannst du eine strukturierte Nachricht senden, die Text und Buttons enthält. Ausführliche Informationen zur Implementierung findest du unter Button-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":"button",
        "text":"What do you want to do next?",
        "buttons":[
          {
            "type":"web_url",
            "url":"https://www.messenger.com",
            "title":"Visit Messenger"
          },
          {
            ...
          },
          {...}
        ]
      }
    }
  }
}' "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`

Eigenschaft	Typ	Beschreibung
`template_type`	String	Der Wert muss `button` lauten.
`text`	String	UTF-8 codierter Text mit bis zu 640 Zeichen. Text wird über den Buttons angezeigt.
`buttons`	Array<button>	Gruppe von 1–3 Buttons, die als Calls to Action angezeigt werden.