Composants des Webhooks
Les webhooks comprennent un champ de premier niveau contenant un tableau indiquant ce qui est communiqué. Les membres du tableau sont des objets JSON dotés de champs détaillés relatifs au Webhook :
Les Webhooks de l’API WhatsApp Business Management peuvent contenir les objets suivants :
| Paramètre | Description |
|---|---|
| Objet auquel vous êtes abonné·e. Dans le cas d’une inscription intégrée, il s’agit toujours d’un |
Cet objet contient les détails de la modification qui a déclenché l’appel Webhooks. |
Objet entry
| Paramètre | Description |
|---|---|
| ID des comptes WhatsApp Business auxquels ce webhook appartient. |
| Heure de l’entrée. |
| Modifications qui ont déclenché l’appel Webhooks. Voir l’objet |
changes
| Paramètre | Description (Cliquez sur la flèche de la colonne de gauche pour connaître les valeurs prises en charge.) |
|---|---|
| Contient le type de notification que vous recevez sur ce webhook. |
| Contient les détails des modifications associées au |
value
| Paramètre | Description (Cliquez sur la flèche de la colonne de gauche pour connaître les valeurs prises en charge.) |
|---|---|
| Ajouté aux webhooks quand un compte a été bloqué. Cet objet inclut deux propriétés :
|
| Contient la limite où se trouve actuellement le compte. |
| Utilisé si une décision relative aux comptes ou aux numéros de téléphone a été prise. |
| Inclut le numéro de téléphone du compte business qui a déclenché la notification. |
| Utilisé quand un évènement se produit dans un compte WhatsApp Business (WABA) spécifique. Cliquez sur la flèche dans la colonne de gauche pour afficher toutes les options disponibles. |
| Toujours présent quand Indique le nombre de modèles de messages que vous pouvez envoyer avec chacun des numéros de téléphone professionnels de votre compte WhatsApp Business associés à un nom à l’écran approuvé. Voir Limites de messages. |
| Inclut le nombre maximal de numéros de téléphone pouvant appartenir à une entreprise. Lorsque field=business_capability_update, un Webhook contiendra max_phone_numbers_per_business ou max_phone_numbers_per_waba. |
| Inclut le nombre maximal de numéros de téléphone pouvant appartenir à un WABA. Lorsque field=business_capability_update, un webhook contiendra max_phone_numbers_per_business ou max_phone_numbers_per_waba. |
| Raison du refus du modèle. Valeurs possibles :
|
| Si une demande a été rejetée, ce champ en affiche la raison. |
| Ce champ affiche le nom envoyé pour vérification. |
énumération | Utilisé pour signaler les restrictions imposées à un WABA spécifique lorsque celui-ci enfreint la Politique de la plateforme WhatsApp Business. Ce champ inclut une liste des types de restrictions, ainsi que leurs dates d’expiration respectives. Les types de restrictions possibles sont les suivants :
Les dates d’expiration sont indiquées au format DateHeure. |
| ID de l’utilisateur ou de l’utilisatrice qui a demandé à désactiver ou qui a déjà désactivé ou mis à jour le code de vérification en deux étapes. |
Exemples
Mise à jour du statut du modèle de message
Modèle approuvé
{
"object": "whatsapp_business_account",
"entry": [
{
"id": "whatsapp-business-account-id",
"time": 1604703141,
"changes": [
{
"field": "message_template_status_update",
"value": {
"event": "APPROVED",
"message_template_id": 1234567,
"message_template_name": "My message template",
"message_template_language": "en-US",
"reason": null
}
}
]
}
]
}
Modèle refusé
{
"object": "whatsapp_business_account"
"entry": [
{
"id": "<WHATSAPP_BUSINESS_ACCOUNT_ID>",
"time": <TIMESTAMP>,
"changes": [
{
"value": {
"event": "REJECTED",
"message_template_id": <TEMPLATE_ID>,
"message_template_name": "<TEMPLATE_NAME>",
"message_template_language": "<LANGUAGE_AND_LOCALE_CODE>",
"reason": "<REJECTION_REASON>"
},
"field": "message_template_status_update"
}
]
}
]
}Modèle planifié pour la désactivation
{
"object": "whatsapp_business_account",
"entry": [
{
"id": "WHATSAPP-BUSINESS-ACCOUNT-ID",
"time": TIMESTAMP,
"changes": [
{
"field": "message_template_status_update",
"value": {
"event": "FLAGGED",
"message_template_id": TEMPLATE-ID,
"message_template_name": "My message template",
"message_template_language": "en-US",
"reason": null,
"disable_info": {
"disable_date": "DATE",
}
}
}
]
}
]
}
Modèle mis en pause
{
"object": "whatsapp_business account",
"entry": [
{
"id": "10908...",
"time": 1661885238,
"changes": [
{
"value": {
"event": "PAUSED",
"message_template_id": 6048...,
"message_template_name": "welcome",
"message_template_language": "en_US",
"reason": "NONE",
"other_info": {
"title": "SECOND_PAUSE",
"description": "Your WhatsApp message template has been paused for 6 hours until Aug 31 at 12:47 AM UTC because it continued to have issues."
}
},
"field": "message_template_status_update"
}
]
}
],
}
Modèle de message en attente de suppression
{
"object": "whatsapp_business account",
"entry": [
{
"id": "10310...",
"time": TIMESTAMP,
"changes": [
{
"value": {
"event": "PENDING_DELETION",
"message_template_id": 1137...,
"message_template_name": "<MY_TEMPLATE_NAME>",
"message_template_language": "en_US",
"reason": "NONE"
}
},
"field": "message_template_status_update"
}
]
}
],
}
Mise à jour de la catégorie de modèle
Catégorie du modèle modifiée
{
"object": "whatsapp_business_account",
"entry": [
{
"id": "<ID>",
"time": <TIME>,
"changes": [
{
"field": "template_category_update",
"value": {
"message_template_id": <MESSAGE_TEMPLATE_ID>,
"message_template_name": "<MESSAGE_TEMPLATE_NAME>",
"message_template_language": "<MESSAGE_TEMPLATE_LANGUAGE",
"previous_category": "<PREVIOUS_CATEGORY>",
"new_category": "<NEW_CATEGORY>"
}
}
]
}
]
}
Mise à jour de la qualité du modèle de message
Évaluation de qualité du modèle modifiée
{
"object": "whatsapp_business_account",
"entry": [
{
"id": "<WHATSAPP_BUSINESS_ACCOUNT_ID>",
"time": <TIMESTAMP>,
"changes": [
{
"field": "message_template_quality_update",
"value": {
"previous_quality_score": "<PREVIOUS_QUALITY_SCORE>",
"new_quality_score": "<NEW_QUALITY_SCORE>",
"message_template_id": <TEMPLATE_ID>,
"message_template_name": "<TEMPLATE_NAME>",
"message_template_language": "<LANGUAGE_AND_LOCALE_CODE>"
}
}
]
}
]
}Modifications du numéro de téléphone
Mise à jour du nom reçue
{
"object": "whatsapp_business_account",
"entry": [
{
"id": "waba-id",
"time": 1608243053,
"changes": [
{
"field": "phone_number_name_update",
"value": {
"display_phone_number": "16505551111",
"decision": "APPROVED",
"requested_verified_name": "WhatsApp",
"rejection_reason": null
}
}
]
}
]
}
Mise à jour de la qualité reçue
{
"object": "whatsapp_business_account",
"entry": [
{
"id": "waba-id",
"time": 1608243062,
"changes": [
{
"field": "phone_number_quality_update",
"value": {
"display_phone_number": "16505551111",
"event": "FLAGGED",
"current_limit": "TIER_10K"
}
}
]
}
]
}
Mises à jour du WABA
Mise à niveau du numéro sandbox en compte vérifié
{
"object": "whatsapp_business_account",
"entry": [
{
"id": "whatsapp-business-account-id",
"time": 1604703058,
"changes": [
{
"field": "account_update",
"value": {
"phone_number": "16505551111",
"event": "VERIFIED_ACCOUNT"
}
}
]
}
]
}
Compte WhatsApp Business bloqué
{
"object": "whatsapp_business_account",
"entry": [
{
"id": "whatsapp-business-account-id",
"time": 1604703058,
"changes": [
{
"field": "account_update",
"value": {
"event": "DISABLED_UPDATE"
"ban_info": {
"waba_ban_state": ["SCHEDULE_FOR_DISABLE", "DISABLE", "REINSTATE"],
"waba_ban_date": "January 31, 2021"
}
}
}
]
}
]
}
Compte WhatsApp Business en infraction avec la politique
{
"object": "whatsapp_business_account",
"entry": [
{
"id": "WHATSAPP-BUSINESS-ACCOUNT-ID",
"time": TIMESTAMP,
"changes": [
{
"value": {
"event": "ACCOUNT_VIOLATION",
"violation_info": {
"violation_type": "VIOLATION_TYPE"
}
},
"field": "account_update"
}
]
}
]
}Compte WhatsApp Business restreint après infraction à la politique
{
"object": "whatsapp_business_account",
"entry": [
{
"id": "WHATSAPP-BUSINESS-ACCOUNT-ID",
"time": TIMESTAMP,
"changes": [
{
"value": {
"event": "ACCOUNT_RESTRICTION",
"restriction_info": [
{"restriction_type":
"RESTRICTED_BIZ_INITIATED_MESSAGING" |
"RESTRICTION_ON_ADD_PHONE_NUMBER_ACTION" |
"RESTRICTED_CUSTOMER_INITIATED_MESSAGING",
"expiration": TIMESTAMP}
]
}
},
"field": "account_update"
}
]
}
]
}Compte WhatsApp Business désactivé
{
"object": "whatsapp_business_account",
"entry": [
{
"id": "WHATSAPP-BUSINESS-ACCOUNT-ID",
"time": TIMESTAMP,
"changes": [
{
"value": {
"event": "DISABLED_UPDATE",
"ban_info": {
"waba_ban_state":
"SCHEDULE_FOR_DISABLE" |
"DISABLE" |
"REINSTATE",
"waba_ban_date": TIMESTAMP
}
},
"field": "account_update"
}
]
}
]
}Examen du compte WhatsApp Business terminé
{
"object": "whatsapp_business_account",
"entry": [
{
"id": "whatsapp-business-account-id",
"time": 1604703141,
"changes": [
{
"field": "account_review_update",
"value": {
"decision": "APPROVED"
}
}
]
}
]
}
Compte WhatsApp Business restreint pour infractions à la politique
{
"field": "account_update",
"value": {
"phone_number": "PHONE_NUMBER",
"event": "ACCOUNT_RESTRICTION",
"restriction_info": [
{
"restriction_type": "RESTRICTION_ADD_PHONE_NUMBER_ACTION",
"expiration": TIMESTAMP
},
{
"restriction_type": "RESTRICTED_BIZ_INITIATED_MESSAGING",
"expiration": TIMESTAMP
},
{
"restriction_type": "RESTRICTED_CUSTOMER_INITIATED_MESSAGING",
"expiration": TIMESTAMP
}
]
}
}Compte WhatsApp Business supprimé
{
"object": "whatsapp_business_account",
"entry": [
{
"id": "WHATSAPP-BUSINESS-ACCOUNT-ID",
"time": TIMESTAMP,
"changes": [
{
"value": {
"phone_number": "15551...",
"event": "ACCOUNT_DELETED",
},
"field": "account_update"
}
]
}
]
}Compte WhatsApp Business supprimé du partenaire
{
"object": "whatsapp_business_account",
"entry": [
{
"id": "WHATSAPP-BUSINESS-ACCOUNT-ID",
"time": TIMESTAMP,
"changes": [
{
"value": {
"phone_number": "15551...",
"event": "PARTNER_REMOVED",
},
"field": "account_update"
}
]
}
]
}Mises à jour de la fonctionnalité de l’entreprise
{
"object": "whatsapp_business_account",
"entry": [
{
"id": "WHATSAPP-BUSINESS-ACCOUNT-ID",
"time": TIMESTAMP,
"changes": [
{
"field": "business_capability_update",
"value": {
"max_daily_conversation_per_phone": NUMBER,
"max_phone_numbers_per_business": NUMBER
}
}
]
}
]
}Alertes de compte
Augmentation de la limite de messages refusée
{
"entry": [
{
"id": "<WHATSAPP_BUSINESS_ACCOUNT_ID>",
"time": <UNIX_TIMESTAMP>,
"changes": [
{
"value": {
"entity_type": "BUSINESS",
"entity_id": "<BUSINESS_ID>",
"alert_severity": "CRITICAL",
"alert_status": "ACTIVE",
"alert_type": "INCREASED_CAPABILITIES_ELIGIBILITY_FAILED",
"alert_description": "Based on your activity, limits cannot be increased for your business <BUSINES_NAME>. Contact support for more information."
},
"field": "account_alerts"
}
]
}
],
"object": "whatsapp_business_account"
}Augmentation de la limite de messages refusée, plus d’utilisation requise
{
"entry": [
{
"id": "<WHATSAPP_BUSINESS_ACCOUNT_ID>",
"time": <UNIX_TIMESTAMP>,
"changes": [
{
"value": {
"entity_type": "BUSINESS",
"entity_id": "<BUSINESS_ID>",
"alert_severity": "WARNING",
"alert_status": "ACTIVE",
"alert_type": "INCREASED_CAPABILITIES_ELIGIBILITY_DEFERRED",
"alert_description": "Limits cannot be increased for your business <BUSINES_NAME>. Use WhatsApp Business platform actively for several days and follow our messaging policies."
},
"field": "account_alerts"
}
]
}
],
"object": "whatsapp_business_account"
}Augmentation de la limite de messages refusée, besoin de plus d’infos
{
"entry": [
{
"id": "<WHATSAPP_BUSINESS_ACCOUNT_ID>",
"time": <UNIX_TIMESTAMP>,
"changes": [
{
"value": {
"entity_type": "BUSINESS",
"entity_id": "<BUSINESS_ID>",
"alert_severity": "WARNING",
"alert_status": "ACTIVE",
"alert_type": "INCREASED_CAPABILITIES_ELIGIBILITY_NEED_MORE_INFO",
"alert_description": "Additional verification is required for your business <BUSINESS_NAME>. Go to Security Center in Meta for Business to complete identity verification. To continue without completing additional verification, your business can use WhatsApp Business platform actively for several days and follow our messaging policies."
},
"field": "account_alerts"
}
]
}
],
"object": "whatsapp_business_account"
}