Esempi di payload di notifiche webhook
Messaggi ricevuti
Messaggi di testo
Di seguito è riportato un esempio di SMS ricevuto da un cliente:
{
"object": "whatsapp_business_account",
"entry": [
{
"id": "<WHATSAPP_BUSINESS_ACCOUNT_ID>",
"changes": [
{
"value": {
"messaging_product": "whatsapp",
"metadata": {
"display_phone_number": "<BUSINESS_DISPLAY_PHONE_NUMBER>",
"phone_number_id": "<BUSINESS_PHONE_NUMBER_ID>"
},
"contacts": [
{
"profile": {
"name": "<WHATSAPP_USER_NAME>"
},
"wa_id": "<WHATSAPP_USER_ID>"
}
],
"messages": [
{
"from": "<WHATSAPP_USER_PHONE_NUMBER>",
"id": "<WHATSAPP_MESSAGE_ID>",
"timestamp": "<WEBHOOK_SENT_TIMESTAMP>",
"text": {
"body": "<MESSAGE_BODY_TEXT>"
},
"type": "text"
}
]
},
"field": "messages"
}
]
}
]
}Messaggi con reazione
Di seguito è riportato un esempio di messaggio con reazione ricevuto da un cliente. Non riceverai questo webhook se il messaggio a cui il cliente sta reagendo risale a oltre 30 giorni fa.
{
"object": "whatsapp_business_account",
"entry": [{
"id": "WHATSAPP_BUSINESS_ACCOUNT_ID",
"changes": [{
"value": {
"messaging_product": "whatsapp",
"metadata": {
"display_phone_number": PHONE_NUMBER,
"phone_number_id": PHONE_NUMBER_ID
},
"contacts": [{
"profile": {
"name": "NAME"
},
"wa_id": PHONE_NUMBER
}],
"messages": [{
"from": PHONE_NUMBER,
"id": "wamid.ID",
"timestamp": TIMESTAMP,
"reaction": {
"message_id": "MESSAGE_ID",
"emoji": "EMOJI"
},
"type": "reaction"
}]
},
"field": "messages"
}]
}]
}
Tieni presente che per le reazioni, il valore timestamp indica quando il cliente ha inviato la reazione, non quando è stato generato il webhook.
Messaggi con contenuto multimediale
Quando viene ricevuto un messaggio con contenuto multimediale, la piattaforma WhatsApp Business scarica il contenuto multimediale. Al termine del download, viene inviata una notifica al tuo webhook.
Questa notifica contiene informazioni che identificano l'oggetto multimediale e consentono di trovarlo e recuperarlo. Per recuperare il contenuto multimediale, utilizza gli endpoint per i contenuti multimediali.
{
"object": "whatsapp_business_account",
"entry": [{
"id": "WHATSAPP_BUSINESS_ACCOUNT_ID",
"changes": [{
"value": {
"messaging_product": "whatsapp",
"metadata": {
"display_phone_number": PHONE_NUMBER,
"phone_number_id": PHONE_NUMBER_ID
},
"contacts": [{
"profile": {
"name": "NAME"
},
"wa_id": "WHATSAPP_ID"
}],
"messages": [{
"from": PHONE_NUMBER,
"id": "wamid.ID",
"timestamp": TIMESTAMP,
"type": "image",
"image": {
"caption": "CAPTION",
"mime_type": "image/jpeg",
"sha256": "IMAGE_HASH",
"id": "ID"
}
}]
},
"field": "messages"
}]
}]
}Quando ricevi un adesivo, vedi la notifica seguente:
{
"object": "whatsapp_business_account",
"entry": [
{
"id": "ID",
"changes": [
{
"value": {
"messaging_product": "whatsapp",
"metadata": {
"display_phone_number": "PHONE_NUMBER",
"phone_number_id": "PHONE_NUMBER_ID"
},
"contacts": [
{
"profile": {
"name": "NAME"
},
"wa_id": "ID"
}
],
"messages": [
{
"from": "SENDER_PHONE_NUMBER",
"id": "wamid.ID",
"timestamp": "TIMESTAMP",
"type": "sticker",
"sticker": {
"mime_type": "image/webp",
"sha256": "HASH",
"id": "ID"
}
}
]
},
"field": "messages"
}
]
}
]
}Messaggi sconosciuti
Si potrebbe ricevere una notifica di callback di messaggio sconosciuto. Ad esempio, un cliente potrebbe inviarti un messaggio non supportato, come un messaggio effimero (nel qual caso avviseremo il cliente che il tipo di messaggio non è supportato).
Di seguito è riportato un esempio di messaggio non supportato ricevuto da un cliente.
{
"object": "whatsapp_business_account",
"entry": [{
"id": "WHATSAPP_BUSINESS_ACCOUNT_ID",
"changes": [{
"value": {
"messaging_product": "whatsapp",
"metadata": {
"display_phone_number": "PHONE_NUMBER",
"phone_number_id": "PHONE_NUMBER_ID"
},
"contacts": [{
"profile": {
"name": "NAME"
},
"wa_id": "WHATSAPP_ID"
}],
"messages": [{
"from": "PHONE_NUMBER",
"id": "wamid.ID",
"timestamp": "TIMESTAMP",
"errors": [
{
"code": 131051,
"details": "Message type is not currently supported",
"title": "Unsupported message type"
}],
"type": "unknown"
}]
}
"field": "messages"
}],
}]
}Messaggi basati sulla posizione
Di seguito è riportato un esempio di messaggio basato sulla posizione ricevuto da un cliente:
{
"object": "whatsapp_business_account",
"entry": [{
"id": "WHATSAPP_BUSINESS_ACCOUNT_ID",
"changes": [{
"value": {
"messaging_product": "whatsapp",
"metadata": {
"display_phone_number": "PHONE_NUMBER",
"phone_number_id": "PHONE_NUMBER_ID"
},
"contacts": [{
"profile": {
"name": "NAME"
},
"wa_id": "WHATSAPP_ID"
}],
"messages": [{
"from": "PHONE_NUMBER",
"id": "wamid.ID",
"timestamp": "TIMESTAMP",
"location": {
"latitude": LOCATION_LATITUDE,
"longitude": LOCATION_LONGITUDE,
"name": LOCATION_NAME,
"address": LOCATION_ADDRESS,
}
}]
},
"field": "messages"
}]
}]
}Messaggi contenenti contatti
Di seguito è riportato un esempio di messaggio contenente un contatto ricevuto da un cliente:
{
"object":"whatsapp_business_account",
"entry":[{
"id":"WHATSAPP_BUSINESS_ACCOUNT_ID",
"changes":[{
"value":{
"messaging_product":"whatsapp",
"metadata": {
"display_phone_number":"PHONE_NUMBER",
"phone_number_id":"PHONE_NUMBER_ID"
},
"contacts": [{
"profile":{
"name":"NAME"
},
"wa_id":"WHATSAPP_ID"
}],
"messages":[{
"from":"PHONE_NUMBER",
"id":"wamid.ID",
"timestamp":"TIMESTAMP",
"contacts":[{
"addresses":[{
"city":"CONTACT_CITY",
"country":"CONTACT_COUNTRY",
"country_code":"CONTACT_COUNTRY_CODE",
"state":"CONTACT_STATE",
"street":"CONTACT_STREET",
"type":"HOME or WORK",
"zip":"CONTACT_ZIP"
}],
"birthday":"CONTACT_BIRTHDAY",
"emails":[{
"email":"CONTACT_EMAIL",
"type":"WORK or HOME"
}],
"name":{
"formatted_name":"CONTACT_FORMATTED_NAME",
"first_name":"CONTACT_FIRST_NAME",
"last_name":"CONTACT_LAST_NAME",
"middle_name":"CONTACT_MIDDLE_NAME",
"suffix":"CONTACT_SUFFIX",
"prefix":"CONTACT_PREFIX"
},
"org":{
"company":"CONTACT_ORG_COMPANY",
"department":"CONTACT_ORG_DEPARTMENT",
"title":"CONTACT_ORG_TITLE"
},
"phones":[{
"phone":"CONTACT_PHONE",
"wa_id":"CONTACT_WA_ID",
"type":"HOME or WORK>"
}],
"urls":[{
"url":"CONTACT_URL",
"type":"HOME or WORK"
}]
}]
}]
},
"field":"messages"
}]
}]
}Callback ricevuta da un pulsante di risposta rapida
Quando il cliente clicca su un pulsante di risposta rapida in un modello di messaggio interattivo, viene inviata una risposta. Di seguito è riportato un esempio del formato della callback.
{
"object": "whatsapp_business_account",
"entry": [{
"id": "WHATSAPP_BUSINESS_ACCOUNT_ID",
"changes": [{
"value": {
"messaging_product": "whatsapp",
"metadata": {
"display_phone_number": PHONE_NUMBER,
"phone_number_id": PHONE_NUMBER_ID
},
"contacts": [{
"profile": {
"name": "NAME"
},
"wa_id": "WHATSAPP_ID"
}],
"messages": [{
"context": {
"from": PHONE_NUMBER,
"id": "wamid.ID"
},
"from": "16315551234",
"id": "wamid.ID",
"timestamp": TIMESTAMP,
"type": "button",
"button": {
"text": "No",
"payload": "No-Button-Payload"
}
}]
},
"field": "messages"
}]
}]
}Risposta ricevuta da messaggio con lista
La notifica webhook seguente viene ricevuta quando un utente clicca su un elemento da un messaggio con lista che hai inviato:
{
"object": "whatsapp_business_account",
"entry": [
{
"id": "WHATSAPP_BUSINESS_ACCOUNT_ID",
"changes": [
{
"value": {
"messaging_product": "whatsapp",
"metadata": {
"display_phone_number": "PHONE_NUMBER",
"phone_number_id": "PHONE_NUMBER_ID",
},
"contacts": [
{
"profile": {
"name": "NAME"
},
"wa_id": "PHONE_NUMBER_ID"
}
],
"messages": [
{
"from": PHONE_NUMBER_ID,
"id": "wamid.ID",
"timestamp": TIMESTAMP,
"interactive": {
"list_reply": {
"id": "list_reply_id",
"title": "list_reply_title",
"description": "list_reply_description"
},
"type": "list_reply"
},
"type": "interactive"
}
]
},
"field": "messages"
}
]
}
]
}Risposta ricevuta al pulsante di risposta
La notifica webhook seguente viene ricevuta quando un utente clicca su un pulsante di risposta che hai inviato:
{
"object": "whatsapp_business_account",
"entry": [
{
"id": "WHATSAPP_BUSINESS_ACCOUNT_ID",
"changes": [
{
"value": {
"messaging_product": "whatsapp",
"metadata": {
"display_phone_number": "PHONE_NUMBER",
"phone_number_id": PHONE_NUMBER_ID,
},
"contacts": [
{
"profile": {
"name": "NAME"
},
"wa_id": "PHONE_NUMBER_ID"
}
],
"messages": [
{
"from": PHONE_NUMBER_ID,
"id": "wamid.ID",
"timestamp": TIMESTAMP,
"interactive": {
"button_reply": {
"id": "unique-button-identifier-here",
"title": "button-text",
},
"type": "button_reply"
},
"type": "interactive"
}
]
},
"field": "messages"
}
]
}
]
}Messaggio ricevuto attivato da inserzioni che rimandano a WhatsApp
Quando una conversazione viene avviata dopo che un utente clicca su un'inserzione con una call to action che rimanda a WhatsApp, ricevi il webhook seguente:
{
"object": "whatsapp_business_account",
"entry": [
{
"id": "ID",
"changes": [
{
"value": {
"messaging_product": "whatsapp",
"metadata": {
"display_phone_number": "PHONE_NUMBER",
"phone_number_id": "PHONE_NUMBER_ID"
},
"contacts": [
{
"profile": {
"name": "NAME"
},
"wa_id": "ID"
}
],
"messages": [
{
"referral": {
"source_url": "AD_OR_POST_FB_URL",
"source_id": "ADID",
"source_type": "ad or post",
"headline": "AD_TITLE",
"body": "AD_DESCRIPTION",
"media_type": "image or video",
"image_url": "RAW_IMAGE_URL",
"video_url": "RAW_VIDEO_URL",
"thumbnail_url": "RAW_THUMBNAIL_URL",
"ctwa_clid": "CTWA_CLID"
},
"from": "SENDER_PHONE_NUMBERID",
"id": "wamid.ID",
"timestamp": "TIMESTAMP",
"type": "text",
"text": {
"body": "BODY"
}
}
]
},
"field": "messages"
}
]
}
]
}Messaggi contenenti richieste sui prodotti
Ricevi un messaggio contenente una richiesta sui prodotti quando un cliente chiede maggiori informazioni su un prodotto. Questo succede quando:
- un cliente risponde a messaggi per un prodotto o per più prodotti;
- un cliente accede al catalogo di un'azienda tramite un altro punto di accesso, passa alla pagina Dettagli del prodotto e clicca su Message Business about this Product (Chiedi informazioni all'azienda su questo prodotto).
Una notifica webhook per un messaggio contenente una richiesta sui prodotti ha un aspetto simile a questo:
{
"object": "whatsapp_business_account",
"entry": [
{
"id": "ID",
"changes": [
{
"value": {
"messaging_product": "whatsapp",
"metadata": {
"display_phone_number": "PHONE_NUMBER",
"phone_number_id": "PHONE_NUMBER_ID",
},
"contacts": [
{
"profile": {
"name": "NAME"
},
"wa_id": "PHONE_NUMBER_ID"
}
],
"messages": [
{
"from": "PHONE_NUMBER",
"id": "wamid.ID",
"text": {
"body": "MESSAGE_TEXT"
},
"context": {
"from": "PHONE_NUMBER",
"id": "wamid.ID",
"referred_product": {
"catalog_id": "CATALOG_ID",
"product_retailer_id": "PRODUCT_ID"
}
},
"timestamp": "TIMESTAMP",
"type": "text"
}
]
},
"field": "messages"
}
]
}
]
}Messaggi dell'ordine
Una notifica webhook per l'ordine effettuato da un cliente ha un aspetto simile a questo:
{
"object": "whatsapp_business_account",
"entry": [
{
"id": "8856996819413533",
"changes": [
{
"value": {
"messaging_product": "whatsapp",
"metadata": {
"display_phone_number": "16505553333",
"phone_number_id": "phone-number-id",
},
"contacts": [
{
"profile": {
"name": "Kerry Fisher"
},
"wa_id": "16315551234"
}
],
"messages": [
{
"from": "16315551234",
"id": "wamid.ABGGFlCGg0cvAgo6cHbBhfK5760V",
"order": {
"catalog_id": "the-catalog_id",
"product_items": [
{
"product_retailer_id":"the-product-SKU-identifier",
"quantity":"number-of-item",
"item_price":"unitary-price-of-item",
"currency":"price-currency"
},
...
],
"text":"text-message-sent-along-with-the-order"
},
"context": {
"from": "16315551234",
"id": "wamid.gBGGFlaCGg0xcvAdgmZ9plHrf2Mh-o"
},
"timestamp": "1603069091",
"type": "order"
}
]
},
"field": "messages"
}
]
}
]
}Notifica di numero modificato dall'utente
Quando un utente modifica il proprio numero di telefono su WhatsApp, ricevi una notifica di messaggio di sistema:
{
"object": "whatsapp_business_account",
"entry": [{
"id": "WHATSAPP_BUSINESS_ACCOUNT_ID",
"changes": [{
"value": {
"messaging_product": "whatsapp",
"metadata": {
"display_phone_number": PHONE_NUMBER,
"phone_number_id": PHONE_NUMBER_ID
},
"messages": [{
"from": PHONE_NUMBER,
"id": "wamid.ID",
"system": {
"body": "NAME changed from PHONE_NUMBER to PHONE_NUMBER",
"new_wa_id": NEW_PHONE_NUMBER,
"type": "user_changed_number"
},
"timestamp": TIMESTAMP,
"type": "system"
}]
},
"field": "messages"
}]
}]
}Aggiornamenti allo stato del messaggio
I prezzi basati sulle conversazioni sono cambiati. Consulta Prezzi per capire come funziona il nostro nuovo modello di prezzi basati sulle conversazioni.
Inoltre, è cambiata la visibilità di metric_types a partire dal 1 luglio 2023. Per maggiori dettagli consulta la tabella Dati statistici sulle conversazioni.
La piattaforma WhatsApp Business invia notifiche per informarti dello stato dei messaggi tra te e gli utenti. Quando un messaggio viene inviato correttamente, ricevi una notifica quando questo viene inviato, consegnato e letto. L'ordine di queste notifiche nell'app potrebbe non riflettere gli orari effettivi dello stato del messaggio. Visualizza l'indicazione temporale per determinare l'orario, se necessario.
Stato: messaggio inviato
{
"object": "whatsapp_business_account",
"entry": [
{
"id": "<WHATSAPP_BUSINESS_ACCOUNT_ID>",
"changes": [
{
"value": {
"messaging_product": "whatsapp",
"metadata": {
"display_phone_number": "<BUSINESS_DISPLAY_PHONE_NUMBER>",
"phone_number_id": "<BUSINESS_PHONE_NUMBER_ID>"
},
"statuses": [
{
"id": "<WHATSAPP_MESSAGE_ID>",
"status": "sent",
"timestamp": "<WEBHOOK_SENT_TIMESTAMP>",
"recipient_id": "<WHATSAPP_USER_ID>",
"conversation": {
"id": "<CONVERSATION_ID>",
"expiration_timestamp": "<CONVERSATION_EXPIRATION_TIMESTAMP>",
"origin": {
"type": "<CONVERSATION_CATEGORY>"
}
},
"pricing": {
"billable": <IS_BILLABLE?>,
"pricing_model": "CBP",
"category": "<CONVERSATION_CATEGORY>"
}
}
]
},
"field": "messages"
}
]
}
]
}Per le conversazioni con punto di accesso gratis, origin.type e pricing.category sono entrambi impostati su referral_conversion, mentre pricing.billable è impostato su false.
Stato: messaggio consegnato
La seguente notifica viene ricevuta quando un messaggio inviato da un'azienda come parte di una conversazione avviata dall'utente viene consegnato (se la conversazione non è iniziata in un punto di accesso gratis):
{
"object": "whatsapp_business_account",
"entry": [
{
"id": "<WHATSAPP_BUSINESS_ACCOUNT_ID>",
"changes": [
{
"value": {
"messaging_product": "whatsapp",
"metadata": {
"display_phone_number": "<BUSINESS_DISPLAY_PHONE_NUMBER>",
"phone_number_id": "<BUSINESS_PHONE_NUMBER_ID>"
},
"statuses": [
{
"id": "<WHATSAPP_MESSAGE_ID>",
"status": "sent",
"timestamp": "<WEBHOOK_SENT_TIMESTAMP>",
"recipient_id": "<WHATSAPP_USER_ID>",
"conversation": {
"id": "<CONVERSATION_ID>",
"origin": {
"type": "<CONVERSATION_CATEGORY>"
}
},
"pricing": {
"billable": <IS_BILLABLE?>,
"pricing_model": "CBP",
"category": "<CONVERSATION_CATEGORY>"
}
}
]
},
"field": "messages"
}
]
}
]
}Per le conversazioni con punto di accesso gratis, origin.type e pricing.category sono entrambi impostati su referral_conversion, mentre pricing.billable è impostato su false.
Stato: messaggio letto
{
"object": "whatsapp_business_account",
"entry": [
{
"id": "<WHATSAPP_BUSINESS_ACCOUNT_ID>",
"changes": [
{
"value": {
"messaging_product": "whatsapp",
"metadata": {
"display_phone_number": "<BUSINESS_DISPLAY_PHONE_NUMBER>",
"phone_number_id": "<BUSINESS_PHONE_NUMBER_ID>"
},
"statuses": [
{
"id": "<WHATSAPP_MESSAGE_ID>",
"status": "read",
"timestamp": "<WEBHOOK_SENT_TIMESTAMP>",
"recipient_id": "<WHATSAPP_USER_ID>"
}
]
},
"field": "messages"
}
]
}
]
}Stato: messaggio eliminato
Attualmente, l'API Cloud non supporta aggiornamenti di stato del webhook per i messaggi eliminati. Se un utente elimina un messaggio, ricevi un webhook con un codice di errore per un tipo di messaggio non supportato:
{
"object": "whatsapp_business_account",
"entry": [{
"id": "WHATSAPP_BUSINESS_ACCOUNT_ID",
"changes": [{
"value": {
"messaging_product": "whatsapp",
"metadata": {
"display_phone_number": PHONE_NUMBER,
"phone_number_id": PHONE_NUMBER
},
"contacts": [{
"profile": {
"name": "NAME"
},
"wa_id": PHONE_NUMBER
}],
"messages": [{
"from": PHONE_NUMBER,
"id": "wamid.ID",
"timestamp": TIMESTAMP,
"errors": [{
"code": 131051,
"details": "Message type is not currently supported",
"title": "Unsupported message type"
}],
"type": "unsupported"
}]
},
"field": "messages"
}]
}]
}Ci sono altri comportamenti dell'utente che possono attivare questo stesso messaggio di errore.
Stato: messaggio non inviato
{
"object": "whatsapp_business_account",
"entry": [
{
"id": "<WHATSAPP_BUSINESS_ACCOUNT_ID>",
"changes": [
{
"value": {
"messaging_product": "whatsapp",
"metadata": {
"display_phone_number": "<BUSINESS_DISPLAY_PHONE_NUMBER>",
"phone_number_id": "<BUSINESS_PHONE_NUMBER_ID>"
},
"statuses": [
{
"id": "<WHATSAPP_MESSAGE_ID>",
"status": "failed",
"timestamp": "<WEBHOOK_SENT_TIMESTAMP>",
"recipient_id": "<WHATSAPP_USER_ID>",
"errors": [
{
"code": <ERROR_CODE>,
"title": "<ERROR_TITLE>",
"message": "<ERROR_MESSAGE>",
"error_data": {
"details": "<ERROR_DETAILS>"
},
"href": "https://developers.facebook.com/docs/whatsapp/cloud-api/support/error-codes/"
}
]
}
]
},
"field": "messages"
}
]
}
]
}