Vai al contenuto
WbizTool

Primi passi

Primi passi con l'API di WbizTool

L'API REST di WbizTool permette al tuo software di inviare messaggi WhatsApp dal tuo numero WhatsApp collegato. Usala per inviare aggiornamenti sugli ordini, promemoria e avvisi dalla tua app, dal CRM, dal sito web o dallo strumento di automazione.

Questa pagina spiega cosa serve a ogni richiesta. Per inviare il tuo primo messaggio, vai direttamente a Invia messaggio.

URL di base#

Tutti gli endpoint si trovano sotto:

https://wbiztool.com/api/v1/

La maggior parte degli endpoint accetta richieste POST. Puoi inviare il corpo come JSON (application/json) o come campi di un modulo (application/x-www-form-urlencoded). Per caricare un file, usa multipart/form-data. Alcuni endpoint di lettura usano GET; la pagina di ogni endpoint indica il metodo.

Prima di iniziare#

  1. Crea un account su wbiztool.com/signup. I nuovi account includono 50 messaggi gratuiti.
  2. Collega un numero WhatsApp. Apri Numeri WhatsApp, fai clic su Aggiungi numero e scansiona il codice QR con WhatsApp dal tuo telefono.
  3. Crea una chiave API. Vai su Impostazioni → Chiavi API. Solo il proprietario di uno spazio di lavoro può creare chiavi. Ogni spazio di lavoro può avere fino a 10 chiavi.

Autenticazione#

Invia la tua chiave API in un header Authorization: Bearer in ogni richiesta (consigliato). La chiave indica il suo spazio di lavoro, quindi in quel caso client_id non serve. Le credenziali nel corpo (client_id e api_key come JSON o campi di un modulo) continuano a funzionare su ogni endpoint. Se invii la chiave in entrambi i punti, viene usata una chiave valida nell'header. Vedi Inviare la chiave in un header.

Authorization: Bearer YOUR_API_KEY
api_keystringobbligatorio

Una delle tue chiavi API da Impostazioni → Chiavi API, nell'header Authorization: Bearer o nel corpo. Tienila segreta: chiunque abbia la chiave può inviare messaggi dai tuoi numeri.

client_idintegerSolo con la chiave nel corpo

Il tuo ID Client API, mostrato nella stessa pagina.

whatsapp_clientintegerLa maggior parte degli endpoint di messaggistica

L'ID del numero WhatsApp da cui inviare, mostrato come ID … ⧉ sulla scheda del numero in Numeri WhatsApp (fai clic per copiarlo). La pagina di ogni endpoint indica se è necessario.

La chiave API determina su quale spazio di lavoro agisce una richiesta. Se fai parte di più spazi di lavoro, usa una chiave creata nello spazio di lavoro da cui vuoi inviare.

Se una chiave viene divulgata, eliminala nella pagina delle chiavi API. Le chiavi eliminate smettono di funzionare immediatamente.

La tua prima richiesta#

Questa richiesta invia un messaggio di testo dal tuo numero collegato. Sostituisci gli ID, la chiave e il numero di telefono con i tuoi.

curl -X POST https://wbiztool.com/api/v1/send_msg/ \
  -H "Content-Type: application/json" \
  -d '{
    "client_id": 12345,
    "api_key": "YOUR_API_KEY",
    "whatsapp_client": 678,
    "msg_type": 0,
    "country_code": "91",
    "phone": "9876543210",
    "msg": "Hi Aman, your order #4821 has shipped and will arrive on Thursday."
  }'

Una risposta "status": 1 con un msg_id significa che il messaggio è in coda. Invia messaggio spiega ogni parametro e contiene le versioni per Python, Node.js e PHP.

Risposte ed errori#

Ogni risposta è un oggetto JSON con un campo status (tranne l'health check /api/v1/status/, che restituisce "status": 200):

  • "status": 1 significa che la richiesta è andata a buon fine.
  • "status": 0 significa che non è riuscita. Il campo message ne spiega il motivo.
{ "status": 0, "message": "Auth Error: invalid api key" }

Errori di autenticazione comuni:

MessaggioSignificato
Auth Errorclient_id o api_key mancano, il corpo non è JSON né dati di un modulo validi, oppure la richiesta non era una POST.
Auth Error - Please send correct API key and Client idapi_key manca o è vuoto.
Invalid client id. o Invalid Client Idclient_id non è un numero intero (oppure, su alcuni endpoint, manca). Invialo come numero, ad esempio 12345.
Auth Error: invalid api keyLa chiave non esiste, è stata eliminata o non appartiene a questo client_id.
Demo Account can not access apisGli account demo non possono usare l'API.
Not enough creditsLo spazio di lavoro è sul piano gratuito e non ha più messaggi: i piani a pagamento inviano messaggi illimitati. Vedi Quando finiscono i messaggi.
Daily limit reached: … (HTTP 429, "code": "daily_limit_reached")Il numero WhatsApp ha accettato 1.000 messaggi nelle ultime 24 ore (uso corretto). Invia il resto più tardi o da un altro numero.

Ciclo di vita di un messaggio#

I messaggi che invii tramite l'API vengono prima messi in coda e poi inviati dal tuo numero WhatsApp. Ogni messaggio ha uno di questi stati:

StatoNomeSignificato
0CreatedIn coda, in attesa di essere inviato.
1SentInviato dal tuo numero WhatsApp.
2FailedNon è stato possibile inviarlo, ad esempio perché il numero non usa WhatsApp.
3CancelledAnnullato prima dell'invio.
4ExpiredNon inviato prima della scadenza expire_after_seconds.

Il tuo numero WhatsApp deve restare collegato perché i messaggi in coda vengano inviati. Se il numero da cui invii è scollegato, i suoi messaggi restano in coda finché non si ricollega o finché non scadono. I messaggi non inviati su un numero scollegato vengono rimossi dopo 90 giorni.

Per seguire un messaggio, salva il msg_id della risposta e passa un URL webhook quando lo invii, oppure chiama Stato del messaggio.

Librerie client ufficiali#

I wrapper per Python e Node.js gestiscono per te l'autenticazione e il caricamento dei file. Non coprono ancora correttamente tutti gli endpoint, quindi controlla la pagina di ciascun endpoint prima di affidarti a un metodo del client.

pip install wbiztool-client

Preferisci una configurazione senza codice? Consulta App e integrazioni per Zapier, n8n, Make, Pabbly Connect, Google Sheets, Shopify e WordPress.

Esplora la documentazione#