Sistemul dvs. apelează Whatsplaid pentru a interoga capabilități, a gestiona contacte, a urmări conversații, a trimite mesaje, a controla agentul AI și a solicita asistență umană.
API publică și documentație
Conectați sistemele dvs. la Whatsplaid prin API-uri, conectori și webhook-uri.
Folosește API‑ul public pentru a integra contacte, conversații, mesaje, suport uman și agentul AI. Folosește conectorul extern pentru a interoga date din sistemul tău și webhooks pentru a primi evenimente în timp real.
Trei contracte
Alege direcția corectă a integrării.
Documentația Swagger separă fluxurile pentru a evita confuzia între apelurile către Whatsplaid, interogările realizate de asistent și evenimentele trimise către sistemul dumneavoastră.
Whatsplaid apelează sistemul dvs. pentru a consulta produse, comenzi, clienți sau disponibilitatea în timp real în timpul unei conversații.
Cunoașteți conectorul extern prin APIWhatsplaid trimite evenimente de lead, mesaje, stări de livrare, tichete și modificări ale agentului AI către o URL configurată.
Swagger la `api.whatsplaid.com/docs/` conține schemele, exemplele, răspunsurile așteptate și contractele tehnice complete.
Referință rapidă pentru principalele endpoint-uri.
Această vizualizare rezumă funcționalitățile care apar în documentația oficială. Implementarea finală trebuie să urmeze Swagger.
GET
/store
Returnează datele contului, comerțul electronic conectat și modulele active.
Account
GET
/capabilities
Arată ce operațiuni sunt efectiv disponibile în funcție de cont, plan, module și integrări.
Account
GET
/ecommerce/products/search
Caută produse în integrările native conectate, precum Nuvemshop, Wix sau Shopify.
Ecommerce
GET
/ecommerce/orders/search
Caută comenzi după număr, e‑mail sau telefon în integrațiile native conectate.
Ecommerce
POST
/contacts
Creează sau actualizează un contact folosind numărul de telefon ca cheie principală.
Contacts
GET
/conversations
Listă cu conversațiile inițiate de contacte, cu paginare, fereastră de răspuns și stare a agentului AI.
Conversations
GET
/conversations/{conversationId}/messages
Returnează istoricul de mesaje paginat al unei conversații.
Conversations
PATCH
/contacts/{contactId}/custom-fields
Actualizează câmpurile personalizate pentru targetare și contextul operațional.
Fields
POST
/messages/send
Trimite un mesaj text în cadrul ferestrei de mesagerie de 24 de ore a WhatsApp.
Messaging
POST
/handoffs
Solicită asistență umană folosind configurația curentă a companiei.
Handoff
GET
/tickets
Listă de tichetelor de suport uman cu filtre și paginare.
Tickets
POST
/tickets/{ticketId}/close
Închide tichetul, emite evenimentul corespunzător și reactivează agentul AI al conversației.
Tickets
PATCH
/conversations/{conversationId}/ai-agent
Activează sau pune pe pauză agentul AI doar pentru conversația specificată.
Conversations
GET
/ai-agent/prompt
Verifică promptul editabil folosit ca instrucțiune de bază a agentului AI.
AI Agent
PATCH
/ai-agent/prompt
Actualizează promptul editabil cu control al reviziilor pentru a preveni suprascrierile simultane.
AI Agent
Contracte tehnice
Documentația acoperă API-ul, conectorul extern și webhooks.
Contractele separă apelurile făcute către Whatsplaid, interogările efectuate de agent în sisteme externe și evenimentele trimise de Whatsplaid.
Verifică contul și capabilitățile, gestionează contacte, etichete și câmpuri personalizate, urmărește conversațiile și trimite mesaje în fereastra permisă.
Vizualizați și actualizați promptul editabil, precum și activați sau puneți în pauză agentul separat în fiecare conversație.
Accesează istoricul, paginarea, fereastra de răspuns WhatsApp și starea curentă a agentului AI.
Sistemul dvs. poate expune interogări despre produse, comenzi, clienți și disponibilitate pentru utilizarea de către agent în timpul conversației.
Evenimente disponibile: `lead.created`, `message.received`, `message.sent`, `message.status.updated`, `ticket.created`, `ticket.closed` și `conversation.ai_agent.updated`.
Webhooks folosesc `delivery_id` pentru deduplicare și reîncercări la erori temporare. Livrarea este considerată finalizată doar după un răspuns HTTP 2xx.
Aveți nevoie să implementați sau să validați o integrare?
Deschide documentația interactivă pentru a comuta între `Whatsplaid Public API`, `Custom Data Connector Contract` și `Outgoing Webhooks`.