Référence concernant l’API Send

L’API Send est la principale API utilisée pour envoyer des messages aux utilisateurs et utilisatrices, y compris du texte, des pièces jointes, des modèles, des actions de l’expéditeur et de l’expéditrice, et bien plus.

Création

Créez et envoyez des messages à vos clients et clientes, ou à toute personne intéressée par votre Page Facebook.

Avant de commencer

Vous aurez besoin des éléments suivants :

  • Une personne autorisée à effectuer la tâche MESSAGE sur la Page doit avoir obtenu un token d’accès de Page
  • Vous devez disposer de l’autorisation pages_messaging
  • Le destinataire ou la destinatrice de votre message doit avoir contacté votre Page au cours des dernières 24 heures, ou avoir autorisé votre Page à lui envoyer des messages en dehors de la fenêtre de réponse standard de 24 heures

Limites

  • Vous ne pouvez pas envoyer de contenu promotionnel avec des tags de message.

Notez que l’API Send n’inclut pas de recipient_id en réponse aux messages envoyés utilisant recipient.user_ref ou recipient.phone_number pour identifier le destinataire du message.

Exemple de requête

Pour envoyer un message à une personne, envoyez une requête POST au point de terminaison /PAGE-ID/messsages avec les paramètres messaging_type et recipient définis, ainsi que le contenu du message.

Formaté pour plus de lisibilité.

Dans l’exemple ci-dessous, la Page répond au message d’une personne par un message contenant uniquement du texte.

curl -X POST "https://graph.facebook.com/v21.0/{PAGE_ID}/messages" \
      -d "recipient={'id':'{PSID}'}" \
      -d "messaging_type=RESPONSE" \
      -d "message={'text':'hello, world'}" \
      -d "access_token={PAGE_ACCESS_TOKEN}"

En cas de réussite, l’application reçoit la réponse JSON suivante :

{
  "recipient_id": "PAGE-SCOPED-ID",
  "message_id": "AG5Hz2U..."
} 

Paramètres

ParamètreDescription

message

objet

Type de message envoyé par votre Page. Quand vous utilisez ce paramètre, vous devez définir text ou attachement.

  • objet attachment : affiche un aperçu de l’URL. Utilisé pour envoyer des messages avec du contenu multimédia ou des messages structurés. Les objets text ou attachment doivent être définis.

    • type : type de pièce jointe. Valeurs possibles : audio, file, image, template ou video. Taille de fichier maximale : 25 Mo
    • payload : objet dont le contenu est un modèle ou un fichier
  • metadata : chaîne de données supplémentaires que vous voulez diffuser dans le webhook message_echo. Nombre maximal de caractères : 1 000

  • quick_replies : tableau de réponses rapides qu’il est possible d’envoyer dans un message
  • text : message contenant uniquement du texte. Il doit être au format UTF-8 et peut comporter jusqu’à 2 000 caractères.

messaging_type

énumération

Obligatoire

Type du message envoyé

  • RESPONSE : le message est envoyé en réponse à un message reçu. Cela comprend les messages promotionnels et non promotionnels envoyés pendant la fenêtre d’envoi de messages standard de 24 heures. Ce tag peut être utile pour répondre à une personne qui demande une confirmation de réservation ou une mise à jour de statut.
  • UPDATE : le message est envoyé de manière proactive et non en réponse à un message reçu. Cela comprend les messages promotionnels et non promotionnels envoyés pendant la fenêtre de réponse standard de 24 heures.
  • MESSAGE_TAG : le message n’est pas promotionnel et est envoyé en dehors de la fenêtre de réponse standard de 24 heures, accompagné d’un tag de message. Le message doit correspondre au cas d’utilisation autorisé pour le tag.

notification_type

énumération

Type de notification push reçue par une personne

  • NO_PUSH : aucune notification
  • REGULAR (par défaut) : notification signalée par un son ou une vibration
  • SILENT_PUSH : notification affichée à l’écran seulement

recipient

objet

Obligatoire

Destinataire du message envoyé par votre Page

  • id : ID spécifique à une page d’une personne qui a contacté votre Page au cours des dernières 24 heures ou qui a accepté de recevoir des messages de votre Page au-delà de la fenêtre de réponse standard de 24 heures, utilisé pour envoyer le message
  • user_ref : référence utilisée pour envoyer un message à la personne ayant répondu au plugin de discussion client ou activé une case à cocher
  • comment_id : identifiant du commentaire d’une personne ayant commenté une publication de votre Page, utilisé pour lui répondre dans un message privé
  • post_id : identifiant de la publication publiée par une personne sur votre Page, utilisé pour lui répondre dans un message privé

sender_action

énumération

Icône représentant l’action réalisée par la Page en réponse à un message reçu sur cette dernière. Cette icône apparaît dans la fenêtre de rédaction du message.

  • typing_on : affiche la bulle de saisie lorsque la Page est en train de répondre
  • typing_off : n’affiche pas la bulle de saisie
  • mark_seen : affiche l’icône de confirmation de lecture quand le message a été vu par la Page

Le paramètre recipient doit être envoyé conjointement. Ne peut contenir le paramètre message, qui doit être envoyé dans une requête distincte.

tag

énumération

Tag permettant à votre Page d’envoyer un message à une personne au-delà de la fenêtre de réponse standard de 24 heures.

  • ACCOUNT_UPDATE : identifie votre message comme une actualisation ponctuelle de l’application ou du compte de votre client·e. Voir les utilisations autorisées.

    Non disponible pour l’API Instagram Messaging.

  • CONFIRMED_EVENT_UPDATE : identifie votre message comme le rappel d’un évènement à venir ou l’actualisation d’un évènement en cours auquel votre client·e est inscrit·e. Voir les utilisations autorisées.

    Non disponible pour l’API Instagram Messaging.

  • CUSTOMER_FEEDBACK : identifie votre message comme un sondage de commentaires clients. Ces sondages doivent être envoyés dans les sept jours suivant le dernier message d’une personne. Voir les utilisations autorisées.

    Non disponible pour l’API Instagram Messaging.

  • HUMAN_AGENT :obligatoire pour l’API Instagram Messaging. Ce tag permet à un·e agent·e humain·e de répondre au message d’une personne. Ces messages peuvent être envoyés dans les sept jours suivant le dernier message d’une personne. L’intervention d’un·e agent·e humain·e est réservée aux problèmes qui ne peuvent être réglés au cours de la fenêtre de réponse standard. Voir les utilisations autorisées.
    • Les applications doivent demander l’autorisation Human Agent via l’Espace App des équipes de développement. Accédez à Espace App -> Contrôle app -> Autorisations et fonctionnalités -> Agent humain. Les applications qui ont obtenu un accès à la bêta de l’autorisation Human Agent (Agent humain) n’ont pas besoin de redemander cette autorisation.

    L’autorisation Human Agent n’est pas disponible en accès standard ou en mode développement. Avant de pouvoir utiliser le tag Human Agent, vous devez passer l’examen Contrôle app. Afin que le Contrôle app se déroule correctement, veuillez fournir des instructions claires et une démonstration du tag Human Agent dans vos expériences.

  • POST_PURCHASE_UPDATE : identifie votre message comme une information concernant un achat récent du client ou de la cliente. Voir les utilisations autorisées.

    Non disponible pour l’API Instagram Messaging.

Utilisations des tags de message

Le tableau suivant dresse la liste des types de messages pour chaque tag de message.

Tag de messageUtilisation

ACCOUNT_UPDATE

Usages autorisés

  • Une notification du changement de statut d’une application, par exemple pour une carte de crédit ou une candidature à un emploi
  • Une notification d’activité suspecte, par exemple une alerte à la fraude

Usages non autorisés (liste non exhaustive)

  • Contenu promotionnel, y compris, mais sans s’y limiter, les bons plans, les promotions, les coupons et remises Contenu récurrent (p. ex., le relevé est prêt, la facture doit être payée, nouvelles offres d’emploi...)
  • Invites de réponse à des enquêtes, sondages ou avis non liés à une interaction précédente dans Messenger

Non disponible pour l’API Instagram Messaging.

CONFIRMED_EVENT_UPDATE

Usages autorisés

  • Un rappel pour un cours, un rendez-vous ou un évènement à venir qu’un·e utilisateur·ice a programmé
  • Une confirmation de la réservation ou de la présence à un évènement ou un rendez-vous accepté
  • Une notification de transport ou d’un voyage planifié par l’utilisateur·ice, signalant par exemple une arrivée, une annulation, un retard des bagages ou d’autres modifications de statut

Usages non autorisés (liste non exhaustive)

  • Contenu promotionnel, tel que les bons plans, les offres, les bons, les remises, etc.
  • Contenu lié à un évènement auquel l’utilisateur ne s’est pas inscrit (par exemple, rappels d’achat de billets pour un évènement, vente croisée d’autres évènements, planification de tournées, etc.)
  • Messages relatifs à des évènements passés
  • Invites de réponse à des enquêtes, sondages ou avis non liés à une interaction précédente dans Messenger

Non disponible pour l’API Instagram Messaging.

CUSTOMER_FEEDBACK

Usages autorisés

  • Un sondage pour obtenir des commentaires sur l’aide aux achats
  • Un sondage pour obtenir des commentaires sur l’évènement
  • Des avis sur les produits

Usages non autorisés (liste non exhaustive)

  • Ce tag ne peut être utilisé qu’avec le modèle d’avis client·e. Il ne fonctionnera pas dans les autres formulaires.

Non disponible pour l’API Instagram Messaging.

HUMAN_AGENT

Usages autorisés

  • Une intervention humaine pour les problèmes impossibles à résoudre dans la fenêtre d’envoi de messages standard de 24 heures, par exemple, en dehors des heures normales de bureau ou pour des problèmes nécessitant une prise en charge supérieure à 24 heures

Usages non autorisés (liste non exhaustive)

  • Messages automatiques
  • Contenu non lié à une demande d’utilisateur·ice

Obligatoire pour l’API Instagram Messaging.

POST_PURCHASE_UPDATE

Usages autorisés

  • Une confirmation de transaction, telle qu’une facture ou un reçu
  • Une mise à jour du statut d’expédition, par exemple un produit en cours d’acheminement, expédié, distribué ou retardé
  • Une modification du statut exigeant une intervention sur une commande passée, par exemple une carte de crédit refusée, une livraison d’articles différée ou d’autres mises à jour de la commande qui nécessitent une action de l’utilisateur·ice

Usages non autorisés (liste non exhaustive)

  • Contenu promotionnel, tel que les bons plans, les promotions, les bons, les remises, etc.
  • Messages de vente croisée ou de vente incitative de produits ou de services
  • Invites de réponse à des enquêtes, sondages ou avis non liés à une interaction précédente dans Messenger

Non disponible pour l’API Instagram Messaging.

Lecture

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

Pour en savoir plus, consultez la documentation de référence sur les conversations de Pages.

Mise à jour

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

Suppression

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

Voir aussi

Assistance pour les équipes chargées du développement