Ditt system anropar Whatsplaid för att fråga om kapabiliteter, hantera kontakter, följa konversationer, skicka meddelanden, styra AI‑agenten och begära mänsklig support.
Publik API och dokumentation
Anslut dina system till Whatsplaid med API:er, anslutningar och webhooks.
Använd det publika API:et för att integrera kontakter, konversationer, meddelanden, mänsklig support och AI‑agenten. Använd den externa connectorn för att fråga ditt systems data och webhooks för att ta emot händelser i realtid.
Tre avtal
Välj rätt riktning för integrationen.
Swaggerdokumentationen separerar flödena för att undvika förvirring mellan anrop till Whatsplaid, förfrågningar som görs av assistenten och händelser som skickas till ditt system.
Whatsplaid anropar ditt system för att hämta information om produkter, beställningar, kunder eller realtidsstatus under en konversation.
Upptäck den externa kontakten via APIWhatsplaid skickar lead‑händelser, meddelanden, leveransstatus, ärenden och ändringar i AI‑agenten till en konfigurerad URL.
Swagger på `api.whatsplaid.com/docs/` innehåller scheman, exempel, förväntade svar och kompletta tekniska kontrakt.
Snabbreferens för huvudendpunkterna.
Denna vy sammanfattar de funktioner som förekommer i den officiella dokumentationen. Den slutliga implementeringen måste följa Swagger.
GET
/store
Returnerar kontodata, ansluten e-handel och aktiva moduler.
Account
GET
/capabilities
Visar vilka åtgärder som faktiskt är tillgängliga beroende på konto, plan, moduler och integrationer.
Account
GET
/ecommerce/products/search
Sök efter produkter i anslutna inbyggda integrationer, såsom Nuvemshop, Wix eller Shopify.
Ecommerce
GET
/ecommerce/orders/search
Sök efter beställningar via nummer, e‑post eller telefon i de anslutna inbyggda integrationerna.
Ecommerce
POST
/contacts
Skapar eller uppdaterar en kontakt med telefonnumret som primär nyckel.
Contacts
GET
/conversations
Lista över konversationer som startats av kontakter, med paginering, svarsfönster och AI‑agents status.
Conversations
GET
/conversations/{conversationId}/messages
Returnerar en paginerad meddelandehistorik för en konversation.
Conversations
PATCH
/contacts/{contactId}/custom-fields
Uppdaterar anpassade fält för inriktning och operativ kontext.
Fields
POST
/messages/send
Skickar ett textmeddelande inom WhatsApps 24-timmars-meddelandefönster.
Messaging
POST
/handoffs
Begär mänsklig support med företagets nuvarande konfiguration.
Handoff
GET
/tickets
Lista över mänskliga supportärenden med filter och paginering.
Tickets
POST
/tickets/{ticketId}/close
Stänger ärendet, utlöser motsvarande händelse och återaktiverar konversationens AI‑agent.
Tickets
PATCH
/conversations/{conversationId}/ai-agent
Aktivera eller pausa AI-agenten endast för den angivna konversationen.
Conversations
GET
/ai-agent/prompt
Kontrollerar den redigerbara prompten som används som AI-agentens grundinstruktion.
AI Agent
PATCH
/ai-agent/prompt
Uppdatera den redigerbara prompten med versionskontroll för att förhindra samtidiga överskrivningar.
AI Agent
Tekniska kontrakt
Dokumentationen täcker API, extern connector och webhooks.
Kontrakt separerar anrop som görs till Whatsplaid, förfrågningar som agenten gör i externa system och händelser som skickas av Whatsplaid.
Kontrollerar konto och kapaciteter, hanterar kontakter, taggar och anpassade fält, följer konversationer och skickar meddelanden inom tillåtet fönster.
Visa och uppdatera den redigerbara prompten, samt aktivera eller pausa agenten separat i varje konversation.
Får åtkomst till historik, paginering, WhatsApp-svarsfönster och aktuell status för AI-agenten.
Ditt system kan exponera förfrågningar om produkter, beställningar, kunder och tillgänglighet för agentens användning under konversationen.
Tillgängliga händelser: `lead.created`, `message.received`, `message.sent`, `message.status.updated`, `ticket.created`, `ticket.closed` och `conversation.ai_agent.updated`.
Webhooks använder `delivery_id` för deduplicering och omförsök vid tillfälliga fel. Leverans anses vara klar först efter ett HTTP 2xx-svar.
Behöver du implementera eller validera en integration?
Öppna den interaktiva dokumentationen för att växla mellan `Whatsplaid Public API`, `Custom Data Connector Contract` och `Outgoing Webhooks`.