API On-Premises de la plateforme WhatsApp Business

Webhooks pour l’API On-Premises

Abonnez-vous aux webhooks pour obtenir des notifications concernant les messages reçus par votre entreprise et les mises à jour du profil client. Pour plus d’informations sur les webhooks de la plateforme WhatsApp Business, voir Présentation, Webhooks.

La configuration des webhooks n’affectera pas le numéro de téléphone sur votre application WhatsApp Business. Un numéro transféré vers la plateforme WhatsApp Business ne peut plus être utilisé dans votre application WhatsApp Business.

Avant de commencer

Vous aurez besoin des éléments suivants :

  • Code compatible HTTPS avec certificat SSL valide
  • Point de terminaison d’URL de rappel configuré pour accepter les requêtes entrantes à partir du Coreapp
  • Point de terminaison d’URL de rappel qui renvoie une réponse HTTPS 200 OK dès réception d’une notification

Nouvelle tentative

Si une notification n’est pas distribuée pour quelque raison que ce soit ou si la requête webhook renvoie un code d’état HTTP autre que 200, nous retentons la distribution. Nous continuons à retenter la distribution avec des délais de plus en plus importants jusqu’à un certain délai d’expiration (généralement 24 heures, bien que cela puisse varier) ou jusqu’à ce que la distribution soit réussie.

Définir le point de terminaison de votre URL de rappel

Envoyez une requête PATCH au point de terminaison /v1/settings/application avec le paramètre webhooks défini sur le point de terminaison de votre URL de rappel. Les autres paramètres généralement configurés sont sent_status et callback_persist.

Exemple de requête

PATCH /v1/settings/application
{
    "callback_persist": true,
    "sent_status": true,  // Either use this or webhooks.message.sent, but webhooks.message.sent property is preferred as sent_status will be deprecated soon
    "webhooks": { 
    	"url": "webhook.your-domain", 
        "message": {     // Available on v2.41.2 and above
        	"sent": false,
        	"delivered": true,
        	"read": false
       },
    }
}

En cas de succès, la réponse contient 200 OK avec null ou un objet JSON.

Pour plus d’informations sur la configuration de votre application et autres paramètres webhooks, voir Paramètres d’application.

Charge utile de notification de webhook

Chaque fois qu’un évènement déclencheur se produit, la plateforme WhatsApp Business prend connaissance de l’évènement et envoie une notification à une URL du webhook que vous avez précédemment spécifiée. Vous pouvez recevoir deux types de notifications :

  • Messages reçus : cette alerte vous indique que vous avez reçu un message. Ces alertes sont également appelées « Notifications entrantes » dans l’ensemble de la documentation.
  • Notifications de statut de message et de tarification : ces alertes vous informent lorsque le statut d’un message a changé, par exemple lorsque le message a été lu ou distribué. Ces alertes sont également appelées « Notifications sortantes » dans l’ensemble de la documentation.

Pour obtenir des informations sur chaque champ, voir Composants.

Notification d’erreur

{
    "errors": [ {
       "code": <error-code>,
       "title": "<error-title>",
       "details": "<error-description>",
       "href": "location for error detail"
    },
    {
       ...
    }
    ]
 }

Exemples de points de terminaison

Pour tester vos webhooks, vous pouvez créer un exemple d’application avec un point de terminaison pour la réception des notifications.