From b3f2de4e70fb61fbeaa3fa048b7b41b3d031d82c Mon Sep 17 00:00:00 2001 From: Simone Gallo Date: Thu, 18 Apr 2024 17:16:17 +0200 Subject: [PATCH] fix readme --- readme.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/readme.md b/readme.md index ee641e5..cf71173 100644 --- a/readme.md +++ b/readme.md @@ -12,17 +12,17 @@ Installazione --- **Required Node version > 12.x** -Per installare le dipendenze del progetto, esegui il seguente comando nel terminale: ```npm install``` +Per installare le dipendenze del progetto, eseguire il seguente comando nel terminale: ```npm install``` Uso --- -Per avviare il bot, **esegui il seguente comando nel terminale**: ```node main.js``` +Per avviare il bot, **eseguire il seguente comando nel terminale**: ```node main.js``` -Quando il bot è pronto, visualizzerà un QR code nel terminale. Scansiona questo QR code con l'applicazione WhatsApp sul tuo telefono per collegare il bot al tuo account WhatsApp. +Quando il bot è pronto, si visualizzerà un QR code nel terminale. Scansionare questo QR code con l'applicazione WhatsApp sul tuo telefono per collegare il bot al tuo account WhatsApp. Endpoint --- -Il bot ha un **endpoint POST /send-message** che accetta un numero di telefono e un messaggio nel corpo della richiesta. Quando riceve una richiesta a questo endpoint, invia il messaggio al numero di telefono specificato. +Il bot ha un **endpoint POST /send-message** che accetta un numero di telefono e un messaggio nel corpo della richiesta (JSON). Quando riceve una richiesta a questo endpoint, invia il messaggio al numero di telefono specificato. Il numero dev'essere preceduto dal country code (39) seguito dal numero di telefono e @c.us. **Esempio di richiesta:** ```curl -X POST -H "Content-Type: application/json" -d '{"number": "39XXXXXXX@c.us", "message": "Ciao!"}' http://localhost:3000/send-message``` @@ -34,7 +34,7 @@ Il bot ascolta i seguenti eventi: * qr: Questo evento viene emesso quando il bot ha bisogno di mostrare un QR code per l'autenticazione. -* message_create: Questo evento viene emesso quando il bot riceve un messaggio. Attualmente, il bot risponde a tutti i messaggi con un messaggio predefinito. +* message_create: Questo evento viene emesso quando il bot riceve un messaggio. Attualmente, il bot logga. Funzioni ---