Plateforme Messenger

Référence sur les évènements webhook message_echoes

Ce rappel se produit lorsqu’un message a été envoyé par votre Page. Il est possible que vous receviez des messages text ou des messages contenant des pièces jointes (image, video, audio, template ou fallback). La charge utile inclut également une chaîne metadata personnalisée facultative envoyée par l’expéditeur·ice et la chaîne app_id correspondante.
Pour vous abonner à ce rappel, sélectionnez le champ message_echoes lors de la configuration de votre webhook.

Plusieurs types de messages sont pris en charge :

Format courant

Exemple 1

{
  "sender":{
    "id":"<PAGE_ID>"
  },
  "recipient":{
    "id":"<PSID>"
  },
  "timestamp":1457764197627,
  "message":{
    "is_echo":true,
    "app_id":1517776481860111,
    "metadata": "<DEVELOPER_DEFINED_METADATA_STRING>",
    "mid":"mid.1457764197618:41d102a3e1ae206a38",
    ...
  }
}

Exemple 2

{
    "object": "page",
    "entry": [
        {
            "id": "<PAGE_ID>",
            "time": 1570053170926,
            "standby": [
                {
                    "sender": {
                        "id": "<PAGE_ID>"
                    },
                    "recipient": {
                        "id": "<PSID>"
                    },
                    "timestamp": 1570053170673,
                    "message": {
                        "mid": "qT7ywaKpO9kkQR7Gv-nM8LIfLZDamVrALniheUYEDdHJXjDXEAyaS1xxONzb2Iv-DFzmTihfWJV012P5pK0AhQ",
                        "is_echo": true,
                        "app_id": <APPID>,
                        "attachments": [
                            {
                                "title": "",
                                "url": "https:\/\/www.facebook.com\/commerce\/update\/",
                                "type": "template",
                                "payload": {
                                    "template_type": "media",
                                    "elements": [
                                        {
                                            "media_type": "image",
                                            "attachment_id": 2457235337685388
                                        }
                                    ]
                                }
                            }
                        ]
                    }
                }
            ]
        }
    ]
}

Propriétés

sender

Champ senderDescription

id

chaîne

ID de votre Page Facebook

recipient

Champ recipientDescription

id

chaîne

ID spécifique à la Page représentant la personne destinataire d’un message envoyé par votre entreprise

message

Nom du champ Type Description

is_echo

Booléen

Indique le message envoyé de la page elle-même

app_id

Chaîne

ID de l’application à partir de laquelle le message a été envoyé Si vous lancez l’API Graph v12.0 et ultérieure, le champ app_id renvoie l’identifiant de l’application de messagerie de la Page Facebook (26390203743090) chaque fois que le message est envoyé via cette messagerie.

metadata

Chaîne

Chaîne personnalisée transmise à l’API Send en tant que champ metadata. Uniquement présente si la propriété metadata a été définie dans le message d’origine.

mid

Chaîne

ID du message

Message texte

Exemple

{
  "sender":{
    "id":"<PAGE_ID>"
  },
  "recipient":{
    "id":"<PSID>"
  },
  "timestamp":1457764197627,
  "message":{
    "is_echo":true,
    "app_id":1517776481860111,
    "metadata": "<DEVELOPER_DEFINED_METADATA_STRING>",
    "mid":"mid.1457764197618:41d102a3e1ae206a38",
    "text":"hello, world!"
  }
}

Propriétés

message

Propriété Type Description

text

Chaîne

Texte du message

Message contenant une pièce jointe de type image, audio, video ou file

Exemple

{
  "sender":{
    "id":"<PAGE_ID>"
  },
  "recipient":{
    "id":"<PSID>"
  },
  "timestamp":1458696618268,
  "message":{
    "is_echo":true,
    "app_id":1517776481860111,
    "metadata": "<DEVELOPER_DEFINED_METADATA_STRING>",
    "mid":"mid.1458696618141:b4ef9d19ec21086067",
    "attachments":[
      {
        "type":"image",
        "payload":{
          "url":"<IMAGE_URL>"
        }
      }
    ]
  }
}

Propriétés

message.attachments

Propriétés Type Description

type

Chaîne

Type de pièce jointe : image, audio, video ou file

payload.url

Chaîne

URL de la pièce jointe

Message contenant une pièce jointe de type template

Exemple

{
  "sender":{
    "id":"<PAGE_ID>"
  },
  "recipient":{
    "id":"<PSID>"
  },
  "timestamp":1458696618268,
  "message":{
    "is_echo":true,
    "app_id":1517776481860111,
    "metadata": "<DEVELOPER_DEFINED_METADATA_STRING>",
    "mid":"mid.1458696618141:b4ef9d19ec21086067",
    "attachments":[
      {
        "type":"template",
        "payload":{
          "template_type":"button",
          "buttons":[
            {
              "type":"web_url",
              "url":"https:\/\/www.messenger.com\/",
              "title":"Visit Messenger"
            }
          ]
        }
      }
    ]
  }
}

Propriétés

message.attachments

Propriété Type Description

type

Chaîne

template

payload

Chaîne

Charge utile de modèle comme décrit dans la Référence sur l’API Send

Notez que dans le cas d’une charge utile payload comportant des pièces jointes, l’ID de pièce jointe envoyé est un nombre, pas une chaîne. Voir l’exemple 2.

Ceci ne correspond pas au format de l’API Send, qui nécessite que l’ID de pièce jointe soit envoyé sous la forme d’une chaîne.

Message contenant une pièce jointe de type fallback

Les pièces jointes de type fallback désignent toutes celles non reconnues ou prises en charge actuellement par la fonctionnalité d’écho de message.

Exemple

{
  "sender":{
    "id":"<PAGE_ID>"
  },
  "recipient":{
    "id":"<PSID>"
  },
  "timestamp":1458696618268,
  "message":{
    "is_echo":true,
    "app_id":1517776481860111,
    "metadata": "<DEVELOPER_DEFINED_METADATA_STRING>",
    "mid":"mid.1458696618141:b4ef9d19ec21086067",
    "attachments":[
      {
        "title":"Legacy Attachment",
        "url":"https:\/\/www.messenger.com\/",
        "type":"fallback",
        "payload":null
      }
    ]
  }
}

Propriétés

message.attachments

Propriété Type Description

type

Chaîne

fallback

title

Chaîne

Titre de la pièce jointe (facultatif)

url

Chaîne

URL de la pièce jointe (facultatif)

payload

Chaîne

Charge utile de la pièce jointe (facultatif)

Message contenant des produits

Le message contenant des produits est disponible uniquement à partir de la version 8.0 de l’API Graph.

Seules les applications disposant de l’autorisation catalog_management peuvent recevoir des webhooks contenant les informations détaillées du produit.

Exemple

{
  "sender":{
    "id":"<PAGE_ID>"
  },
  "recipient":{
    "id":"<PSID>"
  },
  "timestamp":1458696618268,
  "message":{
    "is_echo":true,
    "app_id":1517776481860111,
    "metadata": "<DEVELOPER_DEFINED_METADATA_STRING>",
    "mid":"mid.1458696618141:b4ef9d19ec21086067",
    "attachments":[
      {
        "type":"template",
        "payload":{
          "product":{
             "elements":[ // multiple elements for Hscroll
               {
                 "id":"<PRODUCT_ID>",
                 "retailer_id":"<EXTERNAL_ID>",
                 "image_url":"https://fb.cdn.com/sdsd",
                 "title":"Some product title",
                 "subtitle": "40",
               },
               {...},
             ]
            }

          ]
        }
      }
    ]
  }
}

Propriétés

product.elements

Propriété Type Description

id

Chaîne

ID produit du catalogue produits

retailer_id

Chaîne

ID externe associé au produit (p. ex. : SKU/ID de contenu)

image_url

Chaîne

URL de l’image du produit

title

Chaîne

Titre du produit

subtitle

Chaîne

Sous-titre du produit