Version API du graphe

Message

Un message individuel dans une conversation Messenger ou par messages Instagram.

Utilisez le point de terminaison conversation ou Webhooks pour récupérer les ID de message individuels.

Lecture

Explorateur de l’API Graph
GET /v19.0/{message-id} HTTP/1.1
Host: graph.facebook.com
/* PHP SDK v5.0.0 */
/* make the API call */
try {
  // Returns a `Facebook\FacebookResponse` object
  $response = $fb->get(
    '/{message-id}',
    '{access-token}'
  );
} catch(Facebook\Exceptions\FacebookResponseException $e) {
  echo 'Graph returned an error: ' . $e->getMessage();
  exit;
} catch(Facebook\Exceptions\FacebookSDKException $e) {
  echo 'Facebook SDK returned an error: ' . $e->getMessage();
  exit;
}
$graphNode = $response->getGraphNode();
/* handle the result */
/* make the API call */
FB.api(
    "/{message-id}",
    function (response) {
      if (response && !response.error) {
        /* handle the result */
      }
    }
);
/* make the API call */
new GraphRequest(
    AccessToken.getCurrentAccessToken(),
    "/{message-id}",
    null,
    HttpMethod.GET,
    new GraphRequest.Callback() {
        public void onCompleted(GraphResponse response) {
            /* handle the result */
        }
    }
).executeAsync();
/* make the API call */
FBSDKGraphRequest *request = [[FBSDKGraphRequest alloc]
                               initWithGraphPath:@"/{message-id}"
                                      parameters:params
                                      HTTPMethod:@"GET"];
[request startWithCompletionHandler:^(FBSDKGraphRequestConnection *connection,
                                      id result,
                                      NSError *error) {
    // Handle the result
}];

Conditions requises

TypeDescription

Contrôle app

Obligatoire pour accéder aux données de personnes qui n’ont pas de rôle dans votre application (développeur·se, testeur·se ou admin)

Fonctionnalités

Sans objet

Tokens

Un token d’accès de Page d’une personne autorisée à effectuer la tâche MODERATE ou MESSAGING sur la Page interrogée ou associée au compte professionnel Instagram.

Autorisations

Les autorisations pages_messaging et pages_manage_metadata.

Les autorisations instagram_basic et instagram_manage_messaging sont également requises pour les messages Instagram.

Limites

Pour les messages Instagram

  • Seuls les comptes professionnels Instagram avec Page Facebook associée peuvent accéder à ce point de terminaison.
  • Lorsque vous interrogez ce point de terminaison, tous les messages de la conversation concernée sont renvoyés. Cependant, vous ne pourrez interroger que les données des 20 derniers messages de la conversation. Si un message ne figure pas parmi les 20 derniers, une erreur sera renvoyée indiquant qu’il a été supprimé.

Champs

Les champs qui ne contiennent pas de données ne sont pas renvoyés dans la réponse JSON.

NomDescription

attachments.data

tableau
file_url
generic_template
id
image_data
name
video_data

Contenu multimédia joint au message, par exemple image, vidéo ou URL CDN de fichier.


URL du fichier joint au message

URL de l’image jointe au message. Peut inclure les paires clé:valeur suivantes :

  • cta: objet avec title, type, url
  • url : chaîne, URL de l’image
  • subtitle : chaîne, en pixels
  • title : chaîne,

ID de la pièce jointe

URL de l’image jointe au message. Peut inclure les paires clé:valeur suivantes :

  • animated_gif_preview_url : chaîne, URL d’aperçu du GIF
  • animated_gif_url : chaîne, URL du GIF
  • height : entier, en pixels
  • max_height : entier, en pixels
  • max_width : entier, en pixels
  • preview_url : chaîne, aperçu de l’URL
  • render_as_sticker : booléen, true ou false
  • url : chaîne, URL de l’image
  • width : entier, en pixels

Nom de la pièce jointe

URL de la vidéo jointe au message

created_time

horodatage

Horodatage de la création du message

from

objet
id
email
name
username

Informations concernant l’expéditeur·ice du message. Il peut s’agir d’une personne, d’une Page ou d’un compte professionnel Instagram.

L’ID peut être un ID spécifique d’Instagram ou de Page pour une personne, ou l’ID du compte professionnel Instagram de votre entreprise.

Adresse e-mail d’une personne ou d’une Page Facebook. Messages Page uniquement

Nom d’une personne ou d’une Page Facebook. Messages Page uniquement

Nom d’utilisateur·ice d’une personne sur Instagram ou votre compte professionnel Instagram. Messages Instagram uniquement

"from": {
    "username": "INSTAGRAM-USERNAME",
    "id": "ID"
  }

id

chaîne

ID d’un message

is_unsupported

booléen

Renvoyé uniquement si la valeur est true pour indiquer que le contenu du message n’est pas pris en charge.

message

chaîne

Texte du message. Si le message ne contient pas de texte, ce champ sera vide.

reactions

tableau
data tableau
reaction emoji
users tableau d’objets
id

username

Types de réactions reçues par le message, accompagnés de la liste des personnes ayant utilisé chaque type de réaction.

Tableau d’objets réaction

Type d’emoji de réaction

Liste des personnes ayant réagi au message


L’ID peut être l’ID spécifique d’Instagram d’une personne ou l’ID du compte professionnel Instagram de votre entreprise.

Nom d’utilisateur d’une personne sur Instagram ou votre compte professionnel Instagram. Messages Instagram uniquement

"reactions":
  {
    "reaction": "❤️",
    "users" : [
      {
        "username": "INSTAGRAM-USERNAME",
        "id": "ID", 
      },
    ]
  }

shares

tableau

Partages de contenu multimédia, comme une publication ou un modèle de produit, inclus dans le message. Notez que, pour l’objet shares, vous devez aussi interroger les sous-champs pour récupérer les données.

"shares": {
  "data": [{
    "template": {
      "payload":{
        "product": {
           "elements":{     //Can contain multiple products if applicable
             "data": [
              {
                "id" : "PRODUCT-ID",    // 0 if business can't see this product
                "retailer_id": "ID-ASSIGNED-BY-THE-RETAILER", 
                "image_url" : "IMAGE-URL", 
                "name" : "PRODUCT-NAME",
                "price" : "$10"
              },
            ],
          }
        }
      }
    }
  }]
}   

story

tableau

Lien et ID d’une story. Seules les mentions et les réponses sont prises en charge.

StoryReply: 
{
    "link": "CDN-URL",
    "id": "STORY-ID"
}

StoryMention: 
{
    "link": "CDN-URL",
    "id": "STORY-ID"
}

tags

objet

Tableau data contenant les noms des tags indiquant le dossier et la source du message.

  • Pour les Pages Facebook, name peut être inbox, read ou source:chat.

to

objet
data tableau
id
email
name
username

Informations concernant le destinataire du message.



L’ID peut être un ID spécifique d’Instagram ou de Page pour une personne, ou l’ID de Page ou du compte professionnel Instagram pour votre entreprise.

Adresse e-mail d’une personne ou d’une Page Facebook. Messages Page uniquement

Nom d’une personne ou d’une Page Facebook. Messages Page uniquement

Nom d’utilisateur·ice d’une personne sur Instagram ou votre compte professionnel Instagram. Messages Instagram uniquement

"to": {
  "data": [
    { 
      "username": "INSTAGRAM-USERNAME", 
      "id": "ID" 
    }
  ]
}

Arêtes

Nom Description

/attachments

Fichiers joints à un message.

/shares

Éléments partagés, notamment des liens, photos, vidéos, stickers et produits.

Création

Vous ne pouvez pas effectuer cette opération sur ce point de terminaison.

Mise à jour

Vous ne pouvez pas effectuer cette opération sur ce point de terminaison.

Supprimer

Vous ne pouvez pas effectuer cette opération sur ce point de terminaison.