API User Profile

L’API User Profile vous permet d’utiliser un ID spécifique de Page (PSID) pour récupérer les informations d’un profil utilisateur afin de personnaliser l’expérience des personnes qui échangent avec votre plateforme Messenger.

Disponibilité

Pour extraire les informations du profil d’un·e utilisateur·ice, vous devez avoir un accès avancé à la fonctionnalité Accès au profil de l’utilisateur·ice des éléments professionnels. Certains champs nécessitent des autorisations supplémentaires pour l’accès.

Même avec un PSID valide, dans certains cas, vous ne pourrez pas l’utiliser pour récupérer les informations de profil d’une personne. Par exemple, les PSID associés à des Pages Jeux instantanés ne sont pas accessibles via l’API User Profile.

Consentement de l’utilisateur·ice

Les évènements suivants autoriseront votre bot à accéder aux informations de profil d’une personne :

La personne lance la conversation via un écran d’accueil et appuie sur le bouton « Démarrer ».
La personne lance la conversation en cliquant sur un bouton « Envoyer vers Messenger ».
La personne lance la conversation en envoyant un message.
La personne lance la conversation en acceptant une demande de message de Page.
Votre bot Messenger utilise la fonction askPermission() du SDK Messenger Extensions dans la webview pour demander l’autorisation user_profile.
Pour les applications Business, la fonctionnalité Accès au profil de l’utilisateur·ice des éléments professionnels est aussi requise et peut être demandée via Contrôle app.

Certains points d’entrée autorisent les applications à lancer une conversation sans leur permettre d’accéder au profil public de la personne. Dans ces cas, l’application sera autorisée à accéder au profil de la personne une fois que cette dernière aura répondu au message initial. Une personne peut initier une conversation avec l’application mais sans autoriser l’accès au profil dans les situations particulières suivantes :

Conversations initiées via le plugin Checkbox lorsque la personne n’a pas répondu sur Messenger.
Interactions avec des Publicités clic vers Messenger avant la réponse de la personne sur Messenger

Profil indisponible

Actuellement, l’API User Profile ne permet pas la récupération des informations de profil pour les comptes Messenger créés à l’aide d’un numéro de téléphone.

Dans ce cas, l’API renverra le code d’erreur 2018218 avec le message « Profil indisponible pour cet utilisateur ».

Champs de profil disponibles

Les applications qui ont reçu l’approbation Contrôle app pour la fonctionnalité et l’autorisation requises peuvent récupérer les champs suivants pour les utilisateur·ices qui ont rendu ces informations publiques et ont donné leur consentement sur votre Page.

Nom du champ	Description	Autorisation
`id`	PSID de l’utilisateur	S.O.
`name`	Prénom et nom de l’utilisateur	S.O.
`first_name`	Prénom	S.O.
`last_name`	Nom	S.O.
`profile_pic`	Photo de profil	S.O.
`locale`	Paramètre régional de l’utilisateur sur Facebook	`pages_user_locale`
`timezone`	Fuseau horaire (par rapport au fuseau GMT)	`pages_user_timezone`
`gender`	Sexe	`pages_user_gender`

Demander l’accès de la fonctionnalité aux champs utilisateur pour la Page

Accédez à Paramètres de la Page > Messagerie avancée.
Sous « Informations sur les personnes », sélectionnez le champ et cliquez sur le bouton « Demander ».

Récupérer le profil d’une personne

Pour utiliser l’API User Profile, envoyez une demande GET avec les champs de profil souhaités pour la personne :

curl -X GET "https://graph.facebook.com/<PSID>?fields=first_name,last_name,profile_pic&access_token=<PAGE_ACCESS_TOKEN>"

Si l’application est autorisée à accéder au profil d’une personne, l’API User Profile renvoie une chaîne JSON avec les champs demandés.

{
  "first_name": "Peter",
  "last_name": "Chang",
  "profile_pic": "https://fbcdn-profile-a.akamaihd.net/hprofile-ak-xpf1/v/t1.0-1/p200x200/13055603_10105219398495383_8237637584159975445_n.jpg?oh=1d241d4b6d4dac50eaf9bb73288ea192&oe=57AF5C03&__gda__=1470213755_ab17c8c8e3a0a447fed3f272fa2179ce",
  "locale": "en_US",
  "timezone": -7,
  "gender": "male",
  "last_ad_referral": {
    "source": "ADS",
    "type": "OPEN_THREAD",
    "ad_id": "6045246247433"
  }
}

Si l’application n’est pas autorisée à accéder au profil d’une personne, un objet vide est renvoyé.

Voir aussi

Plateforme Messenger, Codes d’erreur