Il tuo sistema chiama Whatsplaid per consultare le funzionalità, gestire i contatti, monitorare le conversazioni, inviare messaggi, controllare l'agente IA e richiedere assistenza umana.
API pubblica e documentazione
Collega i tuoi sistemi a Whatsplaid tramite API, connettori e webhook.
Usa l'API pubblica per integrare contatti, conversazioni, messaggi, supporto umano e l'agente IA. Usa il connettore esterno per interrogare i dati del tuo sistema e i webhook per ricevere eventi in tempo reale.
Tre contratti
Scegli la direzione corretta dell'integrazione.
La documentazione Swagger separa i flussi per evitare confusione tra le chiamate a Whatsplaid, le query effettuate dall'assistente e gli eventi inviati al tuo sistema.
Whatsplaid chiama il tuo sistema per interrogare prodotti, ordini, clienti o la disponibilità in tempo reale durante una conversazione.
Scopri il connettore esterno tramite APIWhatsplaid invia eventi di lead, messaggi, stati di consegna, ticket e modifiche all'agente IA a un URL configurato.
Lo Swagger su `api.whatsplaid.com/docs/` contiene gli schemi, gli esempi, le risposte previste e i contratti tecnici completi.
Riferimento rapido dei principali endpoint.
Questa vista riassume le funzionalità presenti nella documentazione ufficiale. L’implementazione finale deve seguire lo Swagger.
GET
/store
Restituisce i dati dell'account, l'e-commerce collegato e i moduli attivi.
Account
GET
/capabilities
Indica quali operazioni sono effettivamente disponibili in base all'account, al piano, ai moduli e alle integrazioni.
Account
GET
/ecommerce/products/search
Cerca prodotti nelle integrazioni native connesse, come Nuvemshop, Wix o Shopify.
Ecommerce
GET
/ecommerce/orders/search
Cerca gli ordini per numero, e-mail o telefono nelle integrazioni native connesse.
Ecommerce
POST
/contacts
Crea o aggiorna un contatto usando il numero di telefono come chiave principale.
Contacts
GET
/conversations
Elenco delle conversazioni avviate dai contatti, con paginazione, finestra di risposta e stato dell'agente IA.
Conversations
GET
/conversations/{conversationId}/messages
Restituisce la cronologia dei messaggi paginata di una conversazione.
Conversations
PATCH
/contacts/{contactId}/custom-fields
Aggiorna i campi personalizzati per il targeting e il contesto operativo.
Fields
POST
/messages/send
Invia un messaggio di testo entro la finestra di assistenza di 24 ore di WhatsApp.
Messaging
POST
/handoffs
Richiedi supporto umano utilizzando la configurazione aziendale attuale.
Handoff
GET
/tickets
Elenco di ticket di supporto umano con filtri e paginazione.
Tickets
POST
/tickets/{ticketId}/close
Chiude il ticket, genera l'evento corrispondente e riattiva l'agente IA della conversazione.
Tickets
PATCH
/conversations/{conversationId}/ai-agent
Attiva o mette in pausa l'agente IA solo per la conversazione indicata.
Conversations
GET
/ai-agent/prompt
Consulta il prompt modificabile usato come istruzione base dell'agente IA.
AI Agent
PATCH
/ai-agent/prompt
Aggiorna il prompt modificabile con controllo delle revisioni per evitare sovrascritture concorrenti.
AI Agent
Contratti tecnici
La documentazione copre l’API, il connettore esterno e i webhook.
I contratti separano le chiamate effettuate a Whatsplaid, le query eseguite dall'agente in sistemi esterni e gli eventi inviati da Whatsplaid.
Verifica account e capacità, gestisce contatti, tag e campi personalizzati, monitora conversazioni e invia messaggi entro la finestra consentita.
Consultare e aggiornare il prompt modificabile e attivare o mettere in pausa l’agente separatamente in ogni conversazione.
Accede alla cronologia, alla paginazione, alla finestra di risposta di WhatsApp e allo stato attuale dell'agente IA.
Il tuo sistema può esporre query su prodotti, ordini, clienti e disponibilità per l'uso dell'agente durante la conversazione.
Eventi disponibili: `lead.created`, `message.received`, `message.sent`, `message.status.updated`, `ticket.created`, `ticket.closed` e `conversation.ai_agent.updated`.
I webhook usano `delivery_id` per la deduplicazione e i nuovi tentativi in caso di errori temporanei. La consegna è considerata completata solo dopo una risposta HTTP 2xx.
Devi implementare o convalidare un’integrazione?
Apri la documentazione interattiva per passare tra `Whatsplaid Public API`, `Custom Data Connector Contract` e `Outgoing Webhooks`.