API Messenger Profile

Le profil Messenger de votre Page est l’espace dans lequel vous définissez les propriétés des différents aspects des fonctionnalités suivantes de la plateforme Messenger. Pour en savoir plus, reportez-vous au tableau Propriétés du profil Messenger ci-dessous.

L’API Messenger Profile vous permet de définir, mettre à jour, récupérer et supprimer des propriétés du profil Messenger de votre Page.

Autorisations

Un token d’accès de Page associé à l’autorisation pages_messaging est obligatoire pour interagir avec ce point de terminaison.

Pour les applications en mode développement, seules les personnes disposant d’un rôle dans ces applications pourront voir les paramètres du profil Messenger.

URI de requête

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

Propriétés du profil Messenger

Le profil Messenger de votre Page peut inclure les propriétés suivantes. Pour en savoir plus sur le type et la fonction de chaque propriété, reportez-vous aux descriptions fournies dans le tableau ci-dessous.

Propriété Type Description

get_started

Objet

Charge utile qui sera envoyée en tant qu’évènement messaging_postbacks lorsque le bouton Démarrer de l’écran d’accueil Messenger de votre Page sera utilisé.


Pour en savoir plus, reportez-vous à la référence sur le bouton Démarrer.

greeting

Tableau<Object>

Tableau de messages de bienvenue propres aux paramètres régionaux à afficher sur l’écran d’accueil Messenger de votre Page.


Pour en savoir plus, reportez-vous à la référence sur le texte de bienvenue.

ice_breakers

Tableau<Object>

Tableau avec un objet de prise de contact.


Pour en savoir plus, reportez-vous à la référence sur les prises de contact.

persistent_menu

Tableau<Object>

Tableau de boutons call-to-action à inclure dans le menu fixe.


Pour en savoir plus, reportez-vous à la référence sur le menu fixe.

whitelisted_domains

Tableau<String>

Liste de domaines mis sur liste blanche. Obligatoire pour les Pages qui utilisent le SDK Messenger Extensions et le plugin Checkbox.


Pour en savoir plus, reportez-vous à la référence sur la mise de domaines sur liste blanche.

account_linking_url

Chaîne

URL du rappel d’authentification. Doit utiliser le protocole https.


Pour en savoir plus, reportez-vous à la référence sur l’URL d’association de comptes.

home_url

Objet

URL qui s’affiche dans le webview Messenger lorsque quelqu’un ouvre votre plugin de discussion Messenger.


Obsolète pour toutes les opérations (GET, POST, DELETE) dans la version 7.0 et les versions ultérieures.

commands

Tableau<Object>

Argument facultatif. S’il est fourni, il ne peut pas être nul.


Pour en savoir plus, reportez-vous à la référence sur les commandes.

target_audience (obsolète)

Objet

Ensemble de critères qui détermine l’audience pour laquelle votre Messenger apparaîtra dans l’onglet Découvrir.


Pour en savoir plus, reportez-vous à la référence sur les paramètres d’audience cible.

subject_to_new_eu_privacy_rules

Opérateur booléen

Indicateur booléen qui détermine si la page est concernée par les mises à jour de l’API Messenger pour l’Europe. Cette propriété est uniquement disponible pour la requête GET.

Récupérer des propriétés

Récupère la valeur actuelle d’une ou de plusieurs propriétés du profil Messenger par nom.

Paramètres de la requête

Les paramètres inclus dans la chaîne de requête de la requête sont les suivants :

ParamètreDescription

fields

Liste séparée par des virgules des propriétés du profil Messenger à récupérer.

Exemple de requête

curl -X GET "https://graph.facebook.com/v21.0/me/messenger_profile?fields=whitelisted_domains,greeting&access_token=<PAGE_ACCESS_TOKEN>"

Exemple de réponse

La valeur actuelle des propriétés demandées sera renvoyée dans le tableau data :

{
   "data": [
        {
          "whitelisted_domains": [
            "https://facebook.com/"
          ],
          "greeting": [
            {
               "locale": "default",
               "text": "Hello!"
            },
            {
               "locale": "en_US",
               "text": "Timeless apparel for the masses."
            }
         ]
      }
   ]
}

Définir/Mettre à jour des propriétés

Définit les valeurs d’une ou de plusieurs propriétés du profil Messenger. Seules les propriétés définies dans le corps de la requête seront remplacées.

Exemple de requête

curl -X POST -H "Content-Type: application/json" -d '{
  "<PROPERTY_NAME>": "<NEW_PROPERTY_VALUE>",
  "<PROPERTY_NAME>": "<NEW_PROPERTY_VALUE>",
  ...
}' "https://graph.facebook.com/v21.0/me/messenger_profile?access_token=<PAGE_ACCESS_TOKEN>"

Exemple de réponse

{
    "result": "success"
}

Supprimer des propriétés

Supprime une ou plusieurs propriétés du profil Messenger. Seules les propriétés spécifiées dans le tableau fields seront supprimées.

Exemple de requête

curl -X DELETE -H "Content-Type: application/json" -d '{
  "fields": [
    "<PROPERTY_NAME>",
    "<PROPERTY_NAME>",
    "<PROPERTY_NAME>",
    ...
  ]
}' "https://graph.facebook.com/v21.0/me/messenger_profile?access_token=<PAGE_ACCESS_TOKEN>"

Exemple de réponse

{
    "result": "success"
}

Limite de débit

Les appels vers l’API Messenger Profile sont limités à 10 appels d’API par intervalle de 10 minutes. Cette limite de débit est appliquée par Page.