Componenti dei webhook
I webhook hanno un campo array di primo livello indicante ciò che viene comunicato. I membri dell'array sono oggetti JSON con campi dettagliati relativi al webhook.
I webhook dell'API Business Management di WhatsApp possono contenere gli oggetti seguenti:
| Parametro | Descrizione |
|---|---|
| L'oggetto a cui è stata attivata l'iscrizione. Per l'iscrizione integrata, è sempre |
Questo oggetto contiene i dettagli della modifica che ha attivato la chiamata al webhook. |
Oggetto entry
| Parametro | Descrizione |
|---|---|
| ID degli account WhatsApp Business a cui appartiene il webhook. |
| Ora dell'immissione. |
| Modifiche che hanno attivato la chiamata al webhook; consulta l'oggetto |
changes
| Parametro | Descrizione (clicca sulla freccia nella colonna di sinistra per i valori supportati). |
|---|---|
| Contiene il tipo di notifica che ricevi su quel webhook. |
| Contiene i dettagli sulle modifiche correlate al |
value
| Parametro | Descrizione (clicca sulla freccia nella colonna di sinistra per i valori supportati). |
|---|---|
| Aggiunto ai webhook in caso di sospensione di un account. Questo oggetto include due proprietà:
|
| Contiene il limite del livello corrente associato all'account. |
| Usato se è stata presa una decisione in merito ad account o numeri di telefono. |
| Include il numero di telefono dell'account business che ha attivato la notifica. |
| Usato quando si verifica un evento in uno specifico account WhatsApp Business. Clicca sulla freccia sulla colonna a sinistra per vedere tutte le opzioni disponibili. |
| Sempre presente quando Indica il numero di modelli di messaggi che puoi inviare con ciascuno dei numeri di telefono aziendali del tuo account WhatsApp Business che dispongono di un nome visualizzato approvato. Consulta Limiti dei messaggi. |
| Include il numero massimo di numeri di telefono che possono appartenere a un'azienda. Quando campo=business_capability_update, nel webhook sarà presente max_phone_numbers_per_business o max_phone_numbers_per_waba. |
| Include il numero massimo di numeri di telefono che possono appartenere a un account WhatsApp Business. Quando field=business_capability_update, nel webhook sarà presente max_phone_numbers_per_business o max_phone_numbers_per_waba. |
| Motivo del rifiuto del modello. Valori possibili:
|
| In caso di rifiuto di una richiesta, questo campo ne riporta il motivo. |
| Questo campo visualizza il nome inviato per il controllo. |
enum | Usato per segnalare le restrizioni applicate a un account WhatsApp Business specifico in caso di violazione delle normative della piattaforma WhatsApp Business. Questo campo include un elenco di tipi di restrizioni e le rispettive date di scadenza. I tipi di restrizioni possibili sono:
Le date di scadenza sono riportate nel formato DateTime. |
| ID dell'utente che ha richiesto di disabilitare, o ha già disabilitato o aggiornato, il codice di verifica in due passaggi. |
Esempi
Aggiornamenti allo stato del modello di messaggio
Modello approvato
{
"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
}
}
]
}
]
}
Modello rifiutato
{
"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"
}
]
}
]
}Modello pianificato per la disabilitazione
{
"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",
}
}
}
]
}
]
}
Modello in pausa
{
"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"
}
]
}
],
}
Eliminazione del modello di messaggio in sospeso
{
"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"
}
]
}
],
}
Aggiornamento alla categoria del modello
Categoria del modello modificata
{
"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>"
}
}
]
}
]
}
Aggiornamento alla qualità del modello di messaggio
Valutazione della qualità del modello modificata
{
"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>"
}
}
]
}
]
}Aggiornamenti ai numeri di telefono
Aggiornamento del nome ricevuto
{
"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
}
}
]
}
]
}
Aggiornamento della qualità ricevuto
{
"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"
}
}
]
}
]
}
Aggiornamenti agli account WhatsApp Business
Numero sandbox aggiornato ad account verificato
{
"object": "whatsapp_business_account",
"entry": [
{
"id": "whatsapp-business-account-id",
"time": 1604703058,
"changes": [
{
"field": "account_update",
"value": {
"phone_number": "16505551111",
"event": "VERIFIED_ACCOUNT"
}
}
]
}
]
}
Account WhatsApp Business sospeso
{
"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"
}
}
}
]
}
]
}
L'account WhatsApp Business viola le normative
{
"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"
}
]
}
]
}Account WhatsApp Business con restrizioni a causa di violazioni delle normative
{
"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"
}
]
}
]
}Account WhatsApp Business disabilitato
{
"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"
}
]
}
]
}Controllo dell'account WhatsApp Business completato
{
"object": "whatsapp_business_account",
"entry": [
{
"id": "whatsapp-business-account-id",
"time": 1604703141,
"changes": [
{
"field": "account_review_update",
"value": {
"decision": "APPROVED"
}
}
]
}
]
}
Account WhatsApp Business con restrizioni a causa di violazioni delle normative
{
"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
}
]
}
}Account WhatsApp Business eliminato
{
"object": "whatsapp_business_account",
"entry": [
{
"id": "WHATSAPP-BUSINESS-ACCOUNT-ID",
"time": TIMESTAMP,
"changes": [
{
"value": {
"phone_number": "15551...",
"event": "ACCOUNT_DELETED",
},
"field": "account_update"
}
]
}
]
}Account WhatsApp Business rimosso dal partner
{
"object": "whatsapp_business_account",
"entry": [
{
"id": "WHATSAPP-BUSINESS-ACCOUNT-ID",
"time": TIMESTAMP,
"changes": [
{
"value": {
"phone_number": "15551...",
"event": "PARTNER_REMOVED",
},
"field": "account_update"
}
]
}
]
}Aggiornamenti alla funzionalità dell'azienda
{
"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
}
}
]
}
]
}Avvisi account
Aumento limite di messaggi negato
{
"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"
}Aumento limite di messaggi negato, richiesto maggiore utilizzo
{
"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"
}Aumento limite di messaggi negato, richieste maggiori informazioni
{
"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"
}