Référence liée au modèle générique

Le modèle générique vous permet d’envoyer un message structuré incluant une image, du texte et des boutons. Un modèle générique contenant plusieurs modèles décrits dans le tableau elements envoie un carrousel horizontal d’éléments à faire défiler, chacun composé d’une image, de texte et de boutons. Pour en savoir plus sur l’implémentation, consultez la section Modèle générique.

URI de requête

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

Exemple de requête

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>"

Exemple de réponse

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

Propriétés

`recipient`

Description du destinataire du message. Toutes les demandes doivent contenir l’un de ces éléments : id, phone_number ou user_ref.

Propriété	Type	Description
`recipient.id`	Chaîne	Soit le `PSID`, le `phone_number` ou la `user_ref` du destinataire du message.
`recipient.phone_number`	Chaîne	*Facultatif.* Numéro de téléphone du destinataire au format +1(212)555-2368. Pour envoyer des messages de cette manière, votre bot doit être approuvé pour la correspondance client.
`recipient.user_ref`	Chaîne	*Facultatif.*`user_ref` à partir du plugin Checkbox.
`recipient.name`	Objet	*Facultatif.* Utilisé uniquement si `phone_number` est défini. Spécifie le nom de la personne au format : `{"first_name":"John", "last_name":"Doe"}` Fournir un nom augmente les chances de trouver une correspondance.

`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` du modèle.

`message.attachment.payload`

Nom de propriété	Type	Description
`template_type`	Chaîne	La valeur doit être `generic`.
`elements`	Tableau <`element`>	Ensemble qui contient 1 objet element décrivant le contenu du message. Un élément maximum est pris en charge.
`sharable`	Booléen	*Facultatif.* Choisissez `true` pour activer le bouton de partage natif dans Messenger pour le modèle de message. Valeur par défaut : `false`.

`message.attachment.payload.elements`

Le modèle générique prend en charge un maximum de dix éléments par message. Au moins une propriété doit être définie en plus de title.

Nom de propriété	Type	Description
`title`	Chaîne	Titre à afficher dans le modèle. Limite de 80 caractères.
`subtitle`	Chaîne	*Facultatif.* Sous-titre à afficher dans le modèle. Limite de 80 caractères.
`image_url`	Chaîne	*Facultatif.* URL de l’image à afficher dans le modèle.
`default_action`	Objet	*Facultatif.* Action par défaut à exécuter en cas d’appui sur le modèle. Accepte les mêmes propriétés que le bouton URL, à l’exception de `title`.
`buttons`	Ensemble d’objets <`button`>	*Facultatif.* Ensemble de boutons à joindre au modèle. Trois boutons maximum sont pris en charge.