API Cloud

Composants de conversation

Les composants de conversation sont des fonctionnalités de discussion que vous pouvez activer pour les numéros de téléphone professionnels. Ils permettent aux utilisateur·ices de WhatsApp d’interagir plus facilement avec votre entreprise. Vous pouvez configurer des commandes faciles à utiliser, proposer des modèles de prises de contact sur lesquels les utilisateur·ices pourront appuyer et configurer un message de bienvenue qui sera envoyé lors de la première interaction.

Limites

Si un utilisateur ou une utilisatrice de WhatsApp appuie sur un lien universel (c’est-à-dire un lien wa.me) configuré avec du texte prédéfini, les interfaces d’utilisation des prises de contact sont automatiquement ignorées.

Configuration via le Gestionnaire WhatsApp (WAM)

Vous pouvez configurer toutes ces fonctionnalités pour les numéros de votre choix dans le Gestionnaire WhatsApp :

  1. Accédez au tableau de bord Mes applications sur le site Meta for Developers.
  2. Sélectionnez votre application, puis dans le panneau de gauche, sélectionnez Configuration sous WhatsApp.
  3. Sous Numéros de téléphone, sélectionnez Gérer les numéros de téléphone.
  4. Tout à droite du numéro de téléphone que vous souhaitez configurer, sélectionnez l’icône en forme d’engrenage sous Paramètres.
  5. Sélectionnez Automatisations.
  6. Accédez aux composants de conversation pour les configurer.

Les fournisseurs de solutions peuvent également configurer ces fonctionnalités pour leur client ou cliente, à condition d’avoir accès au compte WhatsApp Business de cette personne dans le Gestionnaire WhatsApp.

Messages de bienvenue

Pour le moment, les messages de bienvenue ne fonctionnent pas comme prévu.

Malheureusement, nous n’avons fixé aucun calendrier pour la mise en œuvre de cette fonctionnalité.

Tous les types de messages à forme libre, interactifs et basés sur un modèle peuvent être envoyés comme message de bienvenue. Le tarif associé à la catégorie du message s’applique.

Vous pouvez recevoir une notification par webhook lorsque l’utilisateur ou l’utilisatrice de WhatsApp lance une première conversation avec vous. Cela peut être utile si vous souhaitez renvoyer à cette personne un message de bienvenue personnalisé de votre conception.

Les messages de bienvenue sont un bon moyen d’entamer des conversations d’assistance, notamment avec les services clientèle ou en charge des comptes. Par exemple, vous pouvez intégrer un bouton WhatsApp dans votre application ou votre site Web. Lorsque les utilisateurs et utilisatrices cliquent sur ce bouton, ces personnes sont redirigées vers WhatsApp où elles reçoivent un message de bienvenue leur expliquant comment interagir avec vous.

Si vous activez cette fonctionnalité et qu’un utilisateur ou une utilisatrice vous envoie un message, le client WhatsApp vérifie s’il existe déjà un fil de discussion entre cette personne et votre numéro de téléphone professionnel. S’il n’y en a aucun, le client déclenche un webhook messages avec le paramètre type défini sur request_welcome. Vous pouvez ensuite répondre à la personne avec votre message de bienvenue personnalisé.

Le webhook request_welcome déclenche une fenêtre de service clientèle, pendant laquelle votre entreprise peut envoyer des messages à forme libre au client ou à la cliente.

Ash: My home office supervisor

Message basé sur un modèle carrousel en tant que message de bienvenue

Charge utile des webhooks

{
  "object": "whatsapp_business_account",
  "entry": [
    {
      "id": "<WHATSAPP_BUSINESS_ACCOUNT_ID>",
      "changes": [
        {
          "value": {
            "messaging_product": "whatsapp",
            "metadata": {
              "display_phone_number": "<BUSINESS_DISPLAY_PHONE_NUMBER>",
              "phone_number_id": "<BUSINESS_PHONE_NUMBER_ID>"
            },
            "contacts": [
              {
                "profile": {
                  "name": "<WHATSAPP_USER_NAME>"
                },
                "wa_id": "<WHATSAPP_USER_ID>"
              }
            ],
            "messages": [
              {
                "from": "<WHATSAPP_USER_PHONE_NUMBER_ID>",
                "id": "<WHATSAPP_MESSAGE_ID>",
                "timestamp": "<TIMESTAMP>",
                "type": "request_welcome"  // Indicates first time message from WhatsApp user
              }
            ]
          },
          "field": "messages"
        }
      ]
    }
  ]
}

Prises de contact

Les prises de contact sont des chaînes de texte personnalisables qui apparaissent dans les fils de discussion la première fois que vous discutez avec un utilisateur ou une utilisatrice. Par exemple, « Planifier un voyage » ou « Créer un programme d’entraînement ».

Les prises de contact sont parfaitement adaptées pour entamer des conversations d’assistance, notamment avec les services clientèle ou en charge des comptes. Par exemple, vous pouvez intégrer un bouton WhatsApp dans votre application ou votre site Web. Lorsque les utilisateurs et utilisatrices cliquent sur ce bouton, ces personnes sont redirigées vers WhatsApp où elles peuvent choisir l’une des invites personnalisées en fonction de leurs besoins.

Vous pouvez configurer jusqu’à quatre prises de contact par numéro de téléphone professionnel. Chaque prise de contact peut contenir un maximum de 80 caractères. Les emojis ne sont pas pris en charge.

Lorsqu’un utilisateur ou une utilisatrice appuie sur une prise de contact, un webhook standard se déclenche pour indiquer que le message a été reçu. La propriété body est attribuée à la chaîne de la prise de contact dans la charge utile. Si, au lieu d’appuyer sur une prise de contact, l’utilisateur·ice essaie de vous envoyer un message, le clavier superposé apparaît, mais il peut être masqué pour voir à nouveau le menu de prise de contact.

Si un utilisateur ou une utilisatrice de WhatsApp appuie sur un lien universel (lien wa.me ou api.whatsapp.com) configuré avec un texte prédéfini, les interfaces d’utilisation des prises de contact sont automatiquement ignorées.

Charge utile des webhooks

{
  "object": "whatsapp_business_account",
  "entry": [
    {
      "id": "<WHATSAPP_BUSINESS_ACCOUNT_ID>",
      "changes": [
        {
          "value": {
            "messaging_product": "whatsapp",
            "metadata": {
              "display_phone_number": "<BUSINESS_DISPLAY_PHONE_NUMBER>",
              "phone_number_id": "<BUSINESS_PHONE_NUMBER_ID>"
            },
            "contacts": [
              {
                "profile": {
                  "name": "<WHATSAPP_USER_NAME>"
                },
                "wa_id": "<WHATSAPP_USER_ID>"
              }
            ],
            "messages": [
              {
                "from": "<WHATSAPP_USER_PHONE_NUMBER_ID>",
                "id": "<WHATSAPP_MESSAGE_ID>",
                "timestamp": "<TIMESTAMP>",
                "text": {
                  "body": "Plan a trip"
                },
                "type": "text"
              }
            ]
          },
          "field": "messages"
        }
      ]
    }
  ]
}

Commandes

Les commandes sont des chaînes de texte que les utilisateur·ices de WhatsApp peuvent voir en tapant la barre oblique dans un fil de discussion avec votre entreprise.

Les commandes intègrent la commande elle-même et un indice, qui explique aux utilisateur·ices quel effet aura la commande. Voici un exemple de commande :

/imagine - Create images using a text prompt

Si un utilisateur ou une utilisatrice de WhatsApp tape /imagine des voitures de course sur Mars, un webhook de message reçu est déclenché, avec cette chaîne de texte dans la propriété body. Vous pourriez alors générer et renvoyer une image représentant des voitures de course sur la planète Mars.

Vous pouvez définir jusqu’à 30 commandes. Chaque commande peut contenir jusqu’à 32 caractères, et chaque indice peut en contenir jusqu’à 256. Les emojis ne sont pas pris en charge.

Charge utile des webhooks

{
  "object": "whatsapp_business_account",
  "entry": [
    {
      "id": "<WHATSAPP_BUSINESS_ACCOUNT_ID>",
      "changes": [
        {
          "value": {
            "messaging_product": "whatsapp",
            "metadata": {
              "display_phone_number": "<BUSINESS_DISPLAY_PHONE_NUMBER>",
              "phone_number_id": "<BUSINESS_PHONE_NUMBER_ID>"
            },
            "contacts": [
              {
                "profile": {
                  "name": "<WHATSAPP_USER_NAME>"
                },
                "wa_id": "<WHATSAPP_USER_ID>"
              }
            ],
            "messages": [
              {
                "from": "<WHATSAPP_USER_PHONE_NUMBER_ID>",
                "id": "<WHATSAPP_MESSAGE_ID>",
                "timestamp": "<TIMESTAMP>",
                "text": {
                  "body": "/imagine cars racing on Mars"
                },
                "type": "text"
              }
            ]
          },
          "field": "messages"
        }
      ]
    }
  ]
}

Configuration avec l’API

Avec l’API, vous pouvez également configurer des composants de conversation et visualiser les valeurs configurées.

L’API Conversational Components comprend deux points de terminaison :

POST </PHONE_NUMBER_ID>/conversational_automation qui permet de configurer des composants de conversation pour un numéro de téléphone donné.

GET /<PHONE_NUMBER_ID>/conversational_automation qui renvoie les valeurs actuelles des champs enable_welcome_message, commands et prompts pour un numéro de téléphone donné.

Configurer des composants de conversation via l’API

Vous pouvez configurer des composants de conversation pour un numéro de téléphone donné en appelant le point de terminaison POST.

Syntaxe de la requête

// Enable or disable the Welcome Message for the given phone number ID
POST /<PHONE_NUMBER_ID>/conversational_automation?enable_welcome_message=<ENABLE_DISABLE>

// Configure Commands with names and descriptions
POST /<PHONE_NUMBER_ID>/conversational_automation?commands=<COMMAND_LIST>

// Configure Prompts
POST /<PHONE_NUMBER_ID>/conversational_automation?prompts=<PROMPT>

Propriétés du corps


Espace réservéDescriptionExemple de valeur

<PHONE_NUMBER_ID>

Nombre entier

Obligatoire.


ID de numéro de téléphone sur un compte WhatsApp Business.

+12784358810

<ENABLE_DISABLE>

Booléen

Facultatif.


Booléen permettant d’activer ou de désactiver un message de bienvenue sur le numéro de téléphone.


true

<COMMAND_LIST>

JSON

Facultatif.


Liste de commandes à configurer.


"commands": {
     "command_name": "generate"
     "command_description": "Create a new image",
     “command_name”: “rethink”
     “command_description”: “Generate new images from existing images”,
}

<PROMPTS>

Liste de chaînes

Facultatif.


Une ou plusieurs invites à configurer.


"prompts": ["Book a flight","plan a vacation"]

Exemple de requête

   curl -X POST \
 'https://graph.facebook.com/v19.0/PHONE_NUMBER_ID/conversational_automation' \
 -H 'Authorization: Bearer ACCESS_TOKEN' \
 -H 'Content-Type: application/json' \
 -d '{
   "enable_welcome_message": true/false,
   "commands": [
     {
       "command_name": "tickets",
       "command_description": "Book flight tickets",
     },
     {
       "command_name": "hotel",
       "command_description": "Book hotel",
     }
   ],
 "prompts": ["Book a flight","plan a vacation"]
}'

Exemple de réponse

{
  "success": true
}

Afficher la configuration actuelle via l’API

Vous pouvez afficher la configuration actuelle des composants de conversation pour un numéro de téléphone donné en appelant le point de terminaison GET.

Syntaxe de la requête

GET  /<PHONE_NUMBER_ID>?fields=conversational_automation

Exemple de réponse

{
  "conversational_automation": {
    "enable_welcome_message": true
    "prompts": [
      "Find the best hotels in the area",
      "Find deals on rental cars"
    ],
    "commands": [
      {
        "command_name": "tickets",
        "command_description": "Book flight tickets",
      },
      {
        "command_name": "hotel",
        "command_description": "Book hotel",
      }
    ],
  }
  "id": "123456"
}

Tests

Pour tester les composants de conversation configurés, ouvrez le client WhatsApp et démarrez une discussion avec votre numéro de téléphone professionnel.

Pour les messages de bienvenue et les prises de contact, si vous avez déjà un fil de discussion avec le numéro de téléphone professionnel, vous devez d’abord effacer ce fil de discussion :

  1. Ouvrez le fil dans le client WhatsApp.
  2. Appuyez sur le profil du numéro de téléphone professionnel.
  3. Appuyez sur Effacer la discussion > Effacer tous les messages.
  4. Supprimer la discussion.
  5. Démarrez un nouveau fil de discussion avec cette entreprise.

Vous pouvez à présent envoyer un message au numéro de téléphone professionnel, ce qui devrait déclencher le webhook request_welcome.