Présentation

L’API Business Management vous permet de créer et de gérer les éléments professionnels liés à WhatsApp, tels que les comptes WhatsApp Business et les modèles de message. L’API s’appuie sur l’API Marketing et tire parti de certains de ses points de terminaison. Cette documentation peut donc contenir des liens vers la documentation de l’API Marketing.

Conditions requises

Tokens d’accès

La plateforme prend en charge les types de tokens d’accès suivants. Le type que vous utilisez varie selon la personne qui se servira de votre application et selon que vous êtes ou non un fournisseur de solutions.

Tokens d’accès utilisateur·ice système

Les tokens d’accès utilisateur·ice système vous représentent vous, votre entreprise ou votre organisation, ou les membres de ces dernières. Leur principal avantage est qu’ils n'expirent pas, et qu’ils peuvent représenter des services automatisés au sein de votre entreprise qui ne nécessitent aucune saisie de l’utilisateur·ice.

Les tokens d’accès utilisateur·ice système sont le seul type de token qui peut être utilisé par les fournisseurs de solutions partenaires pour partager des lignes de crédit avec la nouvelle clientèle.

Pour pouvoir générer un token d’accès utilisateur·ice système, vous devez créer un·e utilisateur·ice système. La plupart des points de terminaison vérifient si l'utilisateur·ice identifié·e par le token a accès à la ressource demandée. Si ce n’est pas le cas, la demande sera rejetée avec le code d’erreur 200.

Les utilisateur·ices système peuvent être des employé·es ou des admins.

Utilisateur·ices système employé·es

Les utilisateur·ices système employé·es doivent avoir accès aux comptes WhatsApp Business individuels appartenant à l'entreprise Meta ou partagés avec celle-ci. Si votre application ne doit accéder qu'à quelques comptes WhatsApp Business vous appartenant, un·e utilisateur·ice système employé·e devrait suffire.

Après sa création, vous devez accorder un accès total ou partiel à chaque compte WhatsApp Business auquel l’utilisateur·ice système doit accéder.

Utilisateur·ices système admins

Par défaut, les utilisateur·ices système admins ont un accès total à tous les comptes WhatsApp Business et éléments vous appartenant ou appartenant à votre entreprise, ou partagés avec vous ou celle-ci.

Les utilisateur·ices système admins sont utiles si votre application doit accéder aux comptes WhatsApp Business qui viennent d’être partagés avec votre entreprise. Si vous utilisez un·e utilisateur·ice système employé·e, vous devez accorder manuellement l'accès à chaque compte WhatsApp Business qui a été partagé avec vous.

Notez que vous pouvez outrepasser l'accès par défaut d'un·e utilisateur·ice système admin en accordant un accès partiel sur la base d’un compte WhatsApp Business.

Création d’un·e utilisateur·ice système

Pour créer un·e utilisateur·ice système :

  1. Connectez-vous à Meta Business Suite.
  2. Localisez votre compte business dans le menu déroulant en haut à gauche et cliquez sur son icône Paramètres.
  3. Cliquez sur Paramètres de l’entreprise.
  4. Naviguez jusqu’à Utilisateurs > Utilisateurs système.
  5. Cliquez sur le bouton Ajouter, puis créez un·e utilisateur·ice système admin ou employé·e.

Génération de tokens d’accès utilisateur·ice système

Pour générer un token d’accès utilisateur·ice système après avoir créé un·e utilisateur·ice système :

  1. Connectez-vous à Meta Business Suite.
  2. Localisez votre compte business dans le menu déroulant en haut à gauche et cliquez sur son icône Paramètres.
  3. Cliquez sur Paramètres de l’entreprise.
  4. Naviguez jusqu’à Utilisateurs > Utilisateurs système.
  5. Sélectionnez l’utilisateur·ice système approprié·e dans la liste.
  6. Cliquez sur le bouton Créer un nouveau token d’accès.
  7. Sélectionnez l’application qui utilisera le token.
  8. Sélectionnez toutes les autorisations dont l’application a besoin pour fonctionner correctement et générer le token.

Tokens d’accès utilisateur·ice du système d’intégration professionnelle

Les tokens d’accès utilisateur·ice du système d’intégration professionnelle concernent la nouvelle clientèle et doivent être utilisés par les fournisseurs de technologies et les fournisseurs de solutions partenaires lorsqu’ils accèdent aux données de cette clientèle.

Ils sont utiles pour les applications qui exécutent des actions de programmation automatisées sur les comptes WhatsApp Business des client·es, qui ne nécessitent pas de saisie manuelle ou de ré-authentification future.

Pour générer ce type de token d’accès, vous devez procéder à une inscription intégrée configurée avec Facebook Login for Business, et utiliser le code qui vous est renvoyé lorsqu’un·e client·e termine le processus.

Consultez les documents Inscription intégrée et Tokens d’accès utilisateur·ice du système d’intégration professionnelle pour en savoir plus sur ces tokens et la manière de les générer.

Tokens d’accès utilisateur·ice

Bien que les tokens d’accès utilisateur·ice soient pris en charge et puissent être utilisés par tous les développeurs et toutes les développeuses d’application, il est probable que vous n’y recouriez que lors de votre première utilisation de l’Espace App pour envoyer votre premier message de test. Pendant le développement de votre application, vous opterez plus probablement pour un token d’accès utilisateur·ice système (et finirez peut-être avec un token d’accès utilisateur·ice de système d’intégration professionnelle si vous êtes un fournisseur de technologies ou de solutions). La raison en est que les tokens d’accès utilisateur·ice expirent rapidement, ce qui vous oblige à en générer un nouveau toutes les quelques heures.

Il existe plusieurs façons de générer un token d'accès utilisateur·ice :

  • Dans l’Espace App, cliquez sur WhatsApp > Configuration de l’API. Ce panneau génère toujours un nouveau token d’accès utilisateur·ice à chaque fois que vous y accédez. Le token est automatiquement associé à votre nom d’utilisateur·ice, car vous vous êtes connecté·e avec votre compte de développement pour accéder au panneau.
  • Implémentez Facebook Login.

Utilisation de tokens dans les requêtes

Lors de vos requêtes d’API, incluez votre token dans un en-tête de demande d’autorisation, précédé de Bearer. Par exemple :

curl 'https://graph.facebook.com/v18.0/102290129340398/message_templates' \
-H 'Authorization: Bearer EAAJB...' \

Accès au compte WhatsApp Business

De nombreux points de terminaison exigent que l'utilisateur·ice dont le token est inclus dans les requêtes d'API dispose également d’un accès partiel ou total au compte WhatsApp Business interrogé (ou à ses éléments). Si l’utilisateur·ice n’a pas accès au compte, l’API renverra le code d’erreur 200.

Il est possible de définir un accès granulaire pour tout type d’utilisateur·ice, y compris les utilisateur·ices système. L'accès granulaire pour les utilisateur·ices système peut être utile si vous souhaitez restreindre l'accès à certains éléments pour des groupes de personnes. Par exemple, si vous avez une grande entreprise et si vous souhaitez qu'un service donné n'ait qu'un accès en lecture au modèle de compte WhatsApp Business et aux données de numéros de téléphone professionnels, vous pouvez créer un·e utilisateur·ice système pour ce service et définir un accès granulaire pour consultation uniquement.

Pour un accès utilisateur·ice désigné·e sur un compte WhatsApp Business ou ses éléments :

  1. Connectez-vous à Meta Business Suite.
  2. Localisez votre compte business dans le menu déroulant en haut à gauche et cliquez sur son icône Paramètres.
  3. Cliquez sur Paramètres de l’entreprise.
  4. Naviguez jusqu’à Comptes > Comptes WhatsApp.
  5. Sélectionnez le compte WhatsApp Business approprié.
  6. Sélectionnez l'onglet Accès au compte WhatsApp.
  7. Cliquez sur le bouton +Ajouter des personnes.
  8. Sélectionnez l'utilisateur·ice système approprié·e et affectez les niveaux d'accès appropriés sur le compte WhatsApp Business.

Test des points de terminaison

Si vous souhaitez tester des points de terminaison, nous vous recommandons d’utiliser notre collection Postman ou cURL. Bien que vous puissiez utiliser l’outil Explorateur de l’API Graph, celui-ci interprète les tokens comme des paramètres de chaîne de requête, ce que nous déconseillons. Nous vous recommandons plutôt de passer les tokens dans les en-têtes de requête.

Obtenir des informations sur une entreprise

Pour obtenir des informations sur une entreprise, envoyez une requête GET au point de terminaison WhatsAppBusinessAccount, où <WHATSAPP_BUSINESS_ACCOUNT_ID> est votre ID de compte WhatsApp Business.

Exemple de requête

curl -i -X GET 'https://graph.facebook.com/v19.0/<WHATSAPP_BUSINESS_ACCOUNT_ID>' \
  -H 'Authorization: Bearer <ACCESS_TOKEN>'

Exemple de réponse

{
  "id": "<WHATSAPP_BUSINESS_ACCOUNT_ID>",
  "name": "Your WhatsApp Business Account Name",
  "timezone_id": "1",
  "message_template_namespace": "05155c78_261e_4b2f_82b3_d7958d4cf75f"
}

Pour obtenir des informations spécifiques sur une entreprise (par exemple, son nom, ses modèles de message et ses numéros de téléphone), envoyez une requête GET au point de terminaison WhatsAppBusinessAccount, où <WHATSAPP_BUSINESS_ACCOUNT_ID> est votre ID de compte WhatsApp Business, puis définissez le paramètre fields sur une liste d’éléments dont vous demandez l’envoi.

Exemple de requête

curl -i -X GET 'https://graph.facebook.com/v19.0/<WHATSAPP_BUSINESS_ACCOUNT_ID>?fields=id,name,message_templates,phone_numbers' \
  -H 'Authorization: Bearer <ACCESS_TOKEN>'

Exemple de réponse

{
  "id": "<WHATSAPP_BUSINESS_ACCOUNT_ID>",
  "name": "Your WhatsApp Business Account Name",
  "message_templates": {
    "data": [
      {
        "name": "hello_world",
        "components": [
          {
            "type": "HEADER",
            "format": "TEXT",
            "text": "Hello World"
          },
          {
            "type": "BODY",
            "text": "Welcome and congratulations!! This message demonstrates your ability to send a message notification from WhatsApp Business Platform. Thank you for taking the time to test with us."
          },
          {
            "type": "FOOTER",
            "text": "WhatsApp Business Team"
          }
        ],
        "language": "en_US",
        "status": "APPROVED",
        "category": "ACCOUNT_UPDATE",
        "id": "307191531401674"
      },
      {
        "name": "sample_flight_confirmation",
        "components": [
          {
            "type": "HEADER",
            "format": "DOCUMENT"
          },
          {
            "type": "BODY",
            "text": "Confirmamos tu vuelo a {{1}}-{{2}} para el {{3}}."
          },
          {
            "type": "FOOTER",
            "text": "Este mensaje proviene de un negocio no verificado."
          }
        ],
        "language": "es",
        "status": "APPROVED",
        "category": "TICKET_UPDATE",
      },
      ...
    

Plafonds

Les requêtes envoyées par votre application à l’API WhatsApp Business Management sont comptabilisées dans son volume d’appels. Le volume d’appels d’une application correspond au nombre d’appels qu’elle peut effectuer durant une période d’une heure. Pour l’API WhatsApp Business Management suivante, votre application peut effectuer 200 appels par heure, par application, par compte WhatsApp Business par défaut. Pour les comptes WhatsApp Business actifs auxquels au moins un numéro de téléphone a été associé, votre application peut effectuer 5 000 appels par heure, par application, par compte WhatsApp Business actif.
Type d’appel Point de terminaison

GET

/{whatsapp-business-account-id}

GET, POST et DELETE

/{whatsapp-business-account-id}/assigned_users

GET

/{whatsapp-business-account-id}/phone_numbers

GET, POST et DELETE

/{whatsapp-business-account-id}/message_templates

GET, POST et DELETE

/{whatsapp-business-account-id}/subscribed_apps

GET

/{whatsapp-business-account-to-number-current-status-id}

Pour les API de ligne de crédit suivantes, votre application peut effectuer 5 000 appels par heure et par application.
Type d’appel Point de terminaison

GET

/{business-id}/extendedcredits

POST

/{extended-credit-id}/whatsapp_credit_sharing_and_attach

GET et DELETE

/{allocation-config-id}

GET

/{extended-credit-id}/owning_credit_allocation_configs

Pour éviter d’atteindre les plafonds, nous vous recommandons d’utiliser des webhooks pour connaître le statut des modèles de message, des numéros de téléphone et des comptes WhatsApp Business.

Pour en savoir plus sur la consultation de votre plafond actuel, lisez la section En-têtes.

En savoir plus

Étapes suivantes