Messaggi

/v1/messages

Usa il nodo messages per inviare messaggi di testo, con contenuto multimediale, contatti o luoghi, interattivi e modelli di messaggi ai tuoi clienti.

Consulta le seguenti guide per informazioni relative ai tipi di messaggi che puoi inviare: messaggi di testo, messaggi multimediali, messaggi con contatti e luoghi, messaggi interattivi, modelli di messaggi, modelli di messaggi con contenuto multimediale e modelli di messaggi interattivi.

Prima di iniziare

Devi:

• autenticarti e ricevere un token di autenticazione che ti consenta di accedere al servizio. Per ulteriori informazioni su come eseguire questa operazione, consulta la documentazione su accesso e autenticazione;
• verificare l'account WhatsApp a cui desideri inviare il messaggio e ottieni il relativo ID utente WhatsApp Consulta la documentazione sui contatti per maggiori informazioni su come eseguire questa operazione;
• soddisfare i requisiti del servizio del controllo di cut-off per i messaggi.

Limitazioni

• Sono supportati i seguenti tipi di messaggi: testo, modelli di messaggi, immagini, documenti e audio.
• Un messaggio di testo può avere una lunghezza massima di 4096 caratteri.

Creazione

Per inviare i messaggi devi effettuare una chiamata POST al nodo /messages indipendentemente dal tipo di messaggio. Il contenuto del corpo del messaggio JSON cambia per ogni tipo di messaggio (testo, immagine, ecc.).

Parametri

Questi sono i parametri principali utilizzati nelle richieste POST /messages:

Oggetto text

Oggetto media

Per l'API On-Premises, l'ID dell'oggetto media viene restituito quando il contenuto multimediale viene caricato correttamente nel client on-premises/reference di WhatsApp Business tramite l'endpoint media.

Oggetto contacts

In contacts, puoi nidificare i seguenti oggetti: addresses, emails, name, org, phone e urls. Gli oggetti pluralizzati devono essere nidificati in un array come mostrato nell'esempio seguente.

Esempio di un oggetto contacts con oggetti pluralizzati nidificati al suo interno:

"contacts": [
    {
        "addresses": [
            {
                "city": "city name",
                "country": "country name",
                "country_code": "code",
                "state": "Contact's State",
                "street": "Contact's Street",
                "type": "Contact's Address Type",
                "zip": "Contact's Zip Code"
            }
        ],
        "birthday": "birthday",
        "emails": [
            {
                "email": "email",
                "type": "HOME"
            },
            {
                "email": "email",
                "type": "WORK"
            }
        ],
        "name": {
            "first_name": "first name value",
            "formatted_name": "formatted name value",
            "last_name": "last name value",
            "suffix": "suffix value"
        },
        "org": {
            "company": "company name",
            "department": "dep name",
            "title": "title"
        },
        "phones": [
            {
                "phone": "Phone number",
                "wa-id": "WA-ID value",
                "type": "MAIN"
            },
            {
                "phone": "Phone number",
                "type": "HOME"
            },
            {
                "phone": "Phone number",
                "type": "WORK"
            }
        ],
        "urls": [{
            "url": "some url",
            "type": "WORK"
        }]
    }
]

Oggetto location

Oggetto template

In template, puoi nidificare gli oggetti components e language.

Oggetto components

In components, puoi nidificare l'oggetto parameters. Inoltre, puoi impostare type su button.

Oggetto parameter

Tipo di pulsante

Nell'oggetto components, puoi impostare type su button. Questi sono i parametri del tipo button:

Esempio di tipo button con sottotipo quick_reply:

 {
    "type": "button",
    "sub_type": "quick_reply",
    "index": 0,
    "parameters": 
     [{
    	"type": "payload",
    	"payload": "Yes-Button-Payload"
     }]
 } 

Esempio di tipo button con sottotipo copy_code:

    
 { 
    "type": "button", 
    "sub_type": "copy_code", 
    "index": 0, 
    "parameters": 
    [{ 
     "type": "coupon_code", 
     "coupon_code": "DISCOUNT20" 
    }] 
 }

Oggetto hsm

Oggetto interactive

Oggetto action

Esempi

Messaggi audio:

POST /v1/messages
{
  "recipient_type": "individual",
  "to": "whatsapp-id",
  "type": "audio",
  "audio": {
      "id": "your-media-id",
  }
}

Messaggi con documento che utilizzano filename:

POST /v1/messages
{
  "recipient_type": "individual",
  "to": "whatsapp-id",
  "type": "document",
  "document": {
      "id": "your-media-id",
      "filename": "your-document-filename"
  }
}

Messaggi con documento che utilizzano link:

POST /v1/messages
{
  "recipient_type": "individual",
  "to": "whatsapp-id",
  "type": "document",
  "document": {
      "link": "http(s)://the-url"
      "provider": {
          "name" : "provider-name"
      }     
    }
}

Videomessaggi che utilizzano link:

POST /v1/messages
{
  "recipient_type": "individual",
  "to": "whatsapp-id",
  "type": "video",  
  "video": {
      "link": "http(s)://the-url"
      "provider": {
          "name" : "provider-name"
      }
    }
  }
}

SMS:

POST /v1/messages
{
  "recipient_type": "individual",
  "to": "whatsapp-id",
  "type": "text",
  "text": {
      "body": "your-message-content"
  }
}

Messaggi interattivi (liste):

POST /v1/messages
{
  "recipient_type": "individual",
  "to": "whatsapp-id",
  "type": "interactive",
  "interactive":{
    "type": "list",
    "header": {
      "type": "text",
      "text": "your-header-content-here"
    },
    "body": {
      "text": "your-text-message-content-here"
    },
    "footer": {
      "text": "your-footer-content-here"
    },
    "action": {
      "button": "cta-button-content-here",
      "sections":[
        {
          "title":"your-section-title-content-here",
          "rows": [
            {
              "id":"unique-row-identifier-here",
              "title": "row-title-content-here",
              "description": "row-description-content-here",           
            }
          ]
        },
        {
          "title":"your-section-title-content-here",
          "rows": [
            {
              "id":"unique-row-identifier-here",
              "title": "row-title-content-here",
              "description": "row-description-content-here",           
            }
          ]
        },
        ...
      ]
    }
  }

}

Messaggi interattivi (pulsanti di risposta):

POST /v1/messages
{
  "recipient_type": "individual",
  "to": "whatsapp-id",
  "type": "interactive",
  "interactive": {
    "type": "button",
    "header": { # optional
      "type": "text" | "image" | "video" | "document",
      "text": "your text"
      # OR
      "document": {
        "id": "your-media-id",
        "filename": "some-file-name"
      }
      # OR
      "document": {
        "link": "the-provider-name/protocol://the-url",
        "provider": {
          "name": "provider-name",
        },
        "filename": "some-file-name"
      },
      # OR
      "video": {
        "id": "your-media-id"
      }
      # OR
      "video": {
        "link": "the-provider-name/protocol://the-url",
        "provider": {
          "name": "provider-name"
        }
      }
      # OR
      "image": {
        "id": "your-media-id"
      }
      # OR
      "image": {
        "link": "http(s)://the-url",
        "provider": {
          "name": "provider-name"
        }
      }
    }, # end header
    "body": {
      "text": "your-text-body-content"
    },
    "footer": { # optional
      "text": "your-text-footer-content"
    },
    "action": {
      "buttons": [
        {
          "type": "reply",
          "reply": {
            "id": "unique-postback-id",
            "title": "First Button’s Title" 
          }
        },
        {
          "type": "reply",
          "reply": {
            "id": "unique-postback-id",
            "title": "Second Button’s Title" 
          }
        }
      ] 
    } # end action   
  } # end interactive

}

Messaggi interattivi (messaggi con un singolo prodotto e più prodotti):

{ 
  "recipient_type": "individual",
  "to" : "{{Recipient-WA-ID}}",
  "type": "interactive",
  "interactive": {
    "type": "product",
    "body": {
      "text": "body text"
    },
    "footer": {
      "text": "footer text"
    },
    "action": {
      "
      
      _id": "catalog-ID",
      "product_retailer_id": "product-ID"
    }
  }
}

Messaggi interattivi (messaggi con più prodotti):

{ 
  "recipient_type": "individual",
  "to" : "whatsapp-id",
  "type": "interactive",
  "interactive": 
    {
    "type": "product_list",
    "Header":{
       "type": "text",
        "text": "text-header-content"
     },
     "body":{
        "text": "text-body-content"
      },
     "footer":{
        "text":"text-footer-content"
     },
     "action":{
        "catalog_id":"catalog-id",
        "sections": [
             {
             "title": "section-title",             
             "product_items": [
                  { "product_retailer_id": "product-SKU-in-catalog" },
                  { "product_retailer_id": "product-SKU-in-catalog" },
                            ...
              ]},
              {
              "title": "the-section-title",
              "product_items": [
                 { "product_retailer_id": "product-SKU-in-catalog" }
                           ...
              ]},
               ...
       ]
     },  
    }
}

Messaggi interattivi (messaggi con catalogo):

{ 
  "recipient_type": "individual",
  "to" : "whatsapp-id",
  "type": "interactive",
  "interactive": 
    {
    "type": "catalog_message",
     "body":{
        "text": "text-body-content"
      },
     "footer":{
        "text":"text-footer-content"
     },
     "action":{
        "name": "catalog_message",
      	"parameters":{ 
      	  "thumbnail_product_retailer_id": "product-SKU-in-catalog"
      	}
     },  
    }
}

Messaggi interattivi (flussi):

{
  "recipient_type": "individual",
  "to": "{{Recipient-WA-ID}}",
  "type": "interactive",
  "interactive": {
    "type": "flow",
    "header": {
      "type": "text",
      "text": "Flow message header"
    },
    "body": {
      "text": "Flow message body"
    },
    "footer": {
      "text": "Flow message footer"
    },
    "action": {
      "name": "flow",
      "parameters": {
        "flow_message_version": "3",
        "flow_token": "AQAAAAACS5FpgQ_cAAAAAD0QI3s",
        "flow_id": "<FLOW_ID>",
        "flow_cta": "Book!",
        "flow_action": "navigate",
        "flow_action_payload": {
          "screen": "<SCREEN_ID>",
          "data": { # optional
            "user_name": "name",
            "user_age": 25
          }
        }
      }
    }
  }
}

Di seguito è riportato un esempio di payload in una risposta; gli oggetti meta ed error sono omessi per brevità.

{
  "messages": [{ 
    "id": "message-id" 
  }]    
}

Se la richiesta viene eseguita correttamente, riceverai una risposta con un ID del messaggio. Se la richiesta restituisce una sezione errors, controlla il messaggio di origine e correggi gli errori prima di reinviare la richiesta. Per maggiori informazioni sugli errori, consulta Codici di errore del client on-premises/reference di WhatsApp Business e Codici di stato HTTP.

Se la richiesta è sospesa per la valutazione della qualità, la risposta conterrà una proprietà message_status con un messaggio indicante che il messaggio non è stato inviato immediatamente e che verrà inviato o annullato dopo la convalida della qualità. Questa proprietà esisterà solo in caso di sospensione del messaggio.

    {
      "messages": [{ 
        "id": "message-id",
        "message_status": "Message has been held because quality assessment is pending",
      }]    
    }
    

Formattazione nei messaggi di testo

WhatsApp consente alcune funzioni di formattazione nei messaggi. Per formattare tutto un messaggio o parte di esso, utilizza questi simboli di formattazione:

Prestazioni

In questo contesto, le prestazioni rappresentano il numero di messaggi che possono essere inviati ogni secondo mediante il client on-premises/reference di WhatsApp Business. Le massime prestazioni ottenibili dipendono da una serie di fattori; tra questi, il più importante è la configurazione del client scelta e se il messaggio viene inviato a un nuovo utente o un utente esistente; la configurazione delle sessioni di crittografia richiede infatti più tempo quando si invia un messaggio a un nuovo utente.

FAQ

Ulteriori informazioni

• Documentazione su accesso e autenticazione
• Documentazione sui contatti
• Codici di errore del client on-premises/reference di WhatsApp Business
• Codici di stato HTTP