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

Ce rappel se produit lorsqu’un message a été envoyé à votre Page. Les messages sont toujours envoyés dans l’ordre. Il est possible que vous receviez des textos ou des messages contenant des pièces jointes.

Voici les principaux types de pièces jointes pris en charge : image, audio, video, file, reel et ig_reel. Vous pouvez également recevoir des pièces jointes de type fallback. L’exemple le plus courant en serait la pièce jointe créée suite à un partage de lien, lorsqu’une personne partage une URL avec une Page. Si des partages non pris en charge sont effectués vers votre Page, une pièce jointe de type fallback sans charge utile peut être envoyée.

Pour vous abonner à ce rappel, sélectionnez le champ message lors de la configuration de votre webhook.

Exemples

Message texte

{
  "sender":{
    "id":"<PSID>"
  },
  "recipient":{
    "id":"<PAGE_ID>"
  },
  "timestamp":1458692752478,
  "message":{
    "mid":"mid.1457764197618:41d102a3e1ae206a38",
    "text":"hello, world!",
    "quick_reply": {
      "payload": "<DEVELOPER_DEFINED_PAYLOAD>"
    }
  }
}    

Message de réponse

{
  "sender":{
    "id":"<PSID>"
  },
  "recipient":{
    "id":"<PAGE_ID>"
  },
  "timestamp":1458692752478,
  "message":{
    "mid":"m_1457764197618:41d102a3e1ae206a38",
    "text":"hello, world!",
    "reply_to": {
      "mid":"m_1fTq8oLumEyIp3Q2MR-aY7IfLZDamVrALniheU"
    }
  }
}    

Message contenant une pièce jointe

{
  "id": "682498302938465",
  "time": 1518479195594,
  "messaging": [
    {
      "sender": {
        "id": "

Message contenant un modèle de produit

Le webhook de message contenant un modèle de produit est disponible uniquement à partir de la version 8.0 de l’API Graph.

Ce webhook s’applique dans le contexte d’un scénario de partage de produits à partir d’autres conversations ou d’un autre flux de partage vers la Page. Il est réservé aux produits appartenant à la Page. Seules les applications disposant de l’autorisation catalog_management peuvent recevoir des webhooks contenant les informations détaillées du produit.

{
  "id": "682498302938465",
  "time": 1518479195594,
  "messaging": [
    {
      "sender": {
        "id": "

Message contenant une pièce jointe de type fallback

Exemple applicable à messages à partir de la version 6.0.

{
    "object": "page",
    "entry": [
        {
            "id": "<PAGE_ID>",
            "time": 1583173667623,
            "messaging": [
                {
                    "sender": {
                        "id": "<PSID>"
                    },
                    "recipient": {
                        "id": "<PAGE_ID>"
                    },
                    "timestamp": 1583173666767,
                    "message": {
                        "mid": "m_toDnmD...",
                        "text": "This is where I want to go: https:\/\/youtu.be\/bbo_fZAjIhg",
                        "attachments": [
                            {
                                "type": "fallback",
                                "payload": {
                                    "url": "<ATTACHMENT_URL >",
                                    "title": "TAHITI - Heaven on Earth"
                                }
                            }
                        ]
                    }
                }
            ]
        }
    ]
}

Message de la Page de détails de produit Boutiques

Le webhook de message envoyé depuis la page des détails d’un produit dans une Boutique n’est disponible qu’à partir de la version 8.0 de l’API Graph.

{
  "sender":{
    "id":"<PSID>"
  },
  "recipient":{
    "id":"<PAGE_ID>"
  },
  "timestamp":1458692752478,
  "message":{
    "mid":"mid.1457764197618:41d102a3e1ae206a38",
    "text":"hello, world!",
    "referral": {
      "product": {
        "id":"<PRODUCT_ID>"
      }
    }
  }
}    

Message avec des informations sur les références publicitaires

Ce webhook s’applique quand un utilisateur ou une utilisatrice clique sur une publicité clic vers Messenger et envoie un message à une page Facebook. L’application recevra non seulement les détails du message, mais aussi des informations sur les références publicitaires.

Pour recevoir les messages contenant des informations sur les références publicitaires, l’application doit disposer d’abonnements de pages aux champs messages et messaging_referrals.

{
  "sender":{
    "id":"<PSID>"
  },
  "recipient":{
    "id":"<PAGE_ID>"
  },
  "timestamp":1458692752478,
  "message":{
    "mid":"mid.1457764197618:41d102a3e1ae206a38",
    "text":"hello, world!",
    "referral": {
      "ref": "<REF_DATA_IF_SPECIFIED_IN_THE_AD>",
      "ad_id": "<ID_OF_THE_AD>",
      "source": "ADS",
      "type": "OPEN_THREAD",
      "ads_context_data": {
        "ad_title": "<TITLE_OF_THE_AD>",
        "photo_url": "<URL_OF_THE_IMAGE_FROM_AD_THE_USER_IS_INTERESTED_IN>",
        "video_url": "<THUMBNAIL_URL_OF_THE_VIDEO_FROM_THE_AD>",
        "post_id": "<ID_OF_THE_POST>",
        "product_id": "<PRODUCT_ID>"
      }
    }
  }
}

Message contenant des commandes

{
  "object": "page",
  "entry": [
    {
      "id": "<PAGE_ID>",
      "time": 1697643211842,
      "messaging": [
        {
          "sender": {
            "id": "<PSID>"
          },
          "recipient": {
            "id": "<PAGE_ID>"
          },
          "timestamp": 1697643027400,
          "message": {
            "mid": "m_3vs...",
            "text": "find flights from SFO to LAX next Thursday",
            "commands": [
              {
                "name": "flights"
              }
            ]
          }
        }
      ]
    }
  ]
}

Propriétés

sender

PropriétéTypeDescription

id

Chaîne

PSID de la personne qui a déclenché l’évènement webhook.

user_ref

Chaîne

Référence user_ref de la personne qui a déclenché l’évènement webhook. Uniquement disponible pour l’évènement webhook du plugin de discussion.

recipient

PropriétéTypeDescription

id

Chaîne

ID de votre page.

message

Annonce du 4 mars 2020

À partir de la version 6.0, sticker_id a été déplacé de message vers message.attachments.payload.

Propriété Type Description

mid

Chaîne

ID du message

text

Chaîne

Texte du message

quick_reply

Objet

Données personnalisées facultatives fournies par l’application expéditrice

reply_to

Objet

Référence à l’ID de message (mid) auquel répond ce message

attachments

Tableau <attachment>

Tableau contenant les données de pièce jointe

referral

Objet

Renvoi du message de la Page de détails de produit Boutiques.

message.quick_reply

La charge utile quick_reply ne contient un texto que si l’utilisateur·ice appuie sur un bouton Réponses rapides.

Propriété Type Description

payload

Chaîne

Données personnalisées fournies par l’application

message.reply_to

Propriété Type Description

mid

Chaîne

Référence à l’ID de message auquel répond ce message

message.attachments

Propriété Type Description

type

Chaîne

audio, file, image, video, fallback, reel ou ig_reel

payload

Chaîne

message.attachments.payload

message.attachments.payload

Propriété Type Description

url

Chaîne

URL du type de pièce jointe. Applicable aux types de pièces jointes suivants : audio, file, image, video, fallback, reel et ig_reel

title

Chaîne

Titre de la pièce jointe. Applicable aux types de pièces jointes suivants : fallback, reel et ig_reel

sticker_id

Numéro

ID persistant du sticker. Par exemple, 369239263222822 fait référence au sticker J’aime. Applicable au type de pièces jointes suivant : image (seulement si un sticker est envoyé).

reel_video_id

Numéro

ID de la vidéo associée au reel joint. Applicable aux types de pièces jointes suivants : reel et ig_reel

message.attachments.payload.product.elements

Propriété Type Description

id

Chaîne

ID produit du catalogue produits Facebook

retailer_id

Chaîne

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

image_url

Chaîne

URL du produit

title

Chaîne

Titre du produit

subtitle

Chaîne

Sous-titre du produit

message.referral

La charge utile referral n’est fournie que si l’utilisateur·ice envoie un message depuis la Page de détails de produit Boutiques.

Propriété Type Description

product

Objet

Informations sur le produit

source

Chaîne

Source de cette référence. Valeur acceptée : ADS (seules les références publicitaires sont prises en charge).

type

Chaîne

Type de référence. Valeur acceptée : OPEN_THREAD.

ref

Chaîne

Attribut ref facultatif défini dans le référent. Valeurs acceptées : caractères alphanumériques, -, _ et =.

ad_id

Chaîne

ID publicitaire issu du Gestionnaire de publicités.

ads_context_data

Objet

Données contextuelles de la publicité provenant du Gestionnaire de publicités.

message.referral.product

Propriété Type Description

id

Chaîne

ID du produit

message.referral.ads_context_data

Propriété Type Description

ad_title

Chaîne

Titre de la publicité dans le Gestionnaire de publicités.

photo_url

Chaîne

[Facultatif] URL de l’image provenant de la publicité.

video_url

Chaîne

[Facultatif] URL de la miniature vidéo de la publicité.

post_id

Chaîne

ID de la publication publicitaire dans le Gestionnaire de publicités.

product_id

Chaîne

[Facultatif] ID produit de la publicité.

message.commands

Propriété Type Description

name

Chaîne

Le nom de la commande