Webhook per l'API On-Premises
Attiva l'iscrizione ai webhook per ricevere notifiche relative ai messaggi ricevuti dall'azienda e agli aggiornamenti del profilo dei clienti. Consulta Panoramica, Webhook per maggiori informazioni sui webhook della piattaforma WhatsApp Business.
La configurazione dei webhook non influirà sul numero di telefono sull'app WhatsApp Business, ma dopo aver eseguito la migrazione del numero alla piattaforma WhatsApp Business non potrai più utilizzarlo sull'app WhatsApp Business.
Prima di iniziare
Ecco cosa dovrai fare:
- Un codice che supporti HTTPS con un certificato SSL valido
- Un endpoint dell'URL di callback configurato per accettare richieste in arrivo da Coreapp
- Un endpoint dell'URL di callback che restituisca una risposta
HTTPS 200 OKalla ricezione di una notifica
Nuovo tentativo
Se una notifica non viene recapitata per qualsiasi motivo o se la richiesta del webhook restituisce un codice di stato HTTP diverso da 200, viene effettuato un secondo tentativo di consegna. Continuiamo a riprovare, a intervalli crescenti tra un tentativo e l'altro, fino a un determinato timeout (in genere 24 ore, sebbene tale valore possa variare) o fino a quando la consegna non ha esito positivo.
Configurazione dell'endpoint dell'URL di callback
Invia una richiesta PATCH all'endpoint /v1/settings/application con il parametro webhooks impostato sul tuo endpoint dell'URL di callback. Altri parametri comunemente configurati sono sent_status e callback_persist.
Esempio di richiesta
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
},
}
}
In caso di azione eseguita correttamente, la risposta conterrà 200 OK con un oggetto null o JSON.
Consulta il riferimento Impostazioni dell'app per maggiori informazioni sulla configurazione della tua app e sui parametri aggiuntivi dei webhook.
Payload di notifica webhook
Ogni volta che si verifica un evento di attivazione, la piattaforma WhatsApp Business vede l'evento e invia una notifica a un URL del webhook specificato in precedenza. Puoi ricevere due tipi di notifiche:
- Messaggi ricevuti: questo avviso ti informa che hai ricevuto un messaggio. Nella documentazione, questo tipo di avviso può anche essere indicato con il termine "notifiche in entrata".
- Notifiche su stato del messaggio e prezzi: questo avviso ti informa del cambio di stato di un messaggio (ad esempio, il messaggio è stato letto o consegnato). Nella documentazione, questo tipo di avviso può anche essere indicato con il termine "notifiche in uscita".
Per informazioni su ogni campo, consulta Componenti.
Notifica di errore
{
"errors": [ {
"code": <error-code>,
"title": "<error-title>",
"details": "<error-description>",
"href": "location for error detail"
},
{
...
}
]
}
