Jou stelsel roep Whatsplaid aan om vermoëns te navraag, kontakte te bestuur, gesprekke op te spoor, boodskappe te stuur, die AI‑agent te beheer en menslike ondersteuning aan te vra.
Openbare API en dokumentasie
Koppel u stelsels aan Whatsplaid met API's, connectors en webhooks.
Gebruik die openbare API om kontakte, gesprekke, boodskappe, menslike ondersteuning en die AI-agent te integreer. Gebruik die eksterne koppelaar om data uit jou stelsel te bevraagteken en webhooks om gebeurtenisse in real‑time te ontvang.
Drie kontrakte
Kies die korrekte rigting van die integrasie.
Die Swagger-dokumentasie skei die vloei om verwarring te voorkom tussen oproepe na Whatsplaid, navrae deur die assistent en gebeure wat na u stelsel gestuur word.
Whatsplaid roep jou stelsel aan om produkte, bestellings, kliënte of regstreekse beskikbaarheid tydens ’n gesprek te navraag.
Ontmoet die eksterne koppelaar via APIWhatsplaid stuur lei‑events, boodskappe, afleweringsstatusse, kaartjies en veranderings aan die AI‑agent na 'n gekonfigureerde URL.
Die Swagger by `api.whatsplaid.com/docs/` bevat die skemas, voorbeelde, verwagte antwoorde en volledige tegniese kontrakte.
Vinnige verwysing vir die hoof-endpunte.
Hierdie weergawe som die funksies op wat in die amptelike dokumentasie voorkom. Die finale implementering moet Swagger volg.
GET
/store
Gee rekeningdata, gekoppelde e-handel en aktiewe modules terug.
Account
GET
/capabilities
Wys in watter operasies werklik beskikbaar is volgens rekening, plan, modules en integrasies.
Account
GET
/ecommerce/products/search
Soek na produkte in gekoppelde ingeboude integrasies, soos Nuvemshop, Wix of Shopify.
Ecommerce
GET
/ecommerce/orders/search
Soek bestellings op nommer, e-pos of telefoon in die gekoppelde ingeboude integrasies.
Ecommerce
POST
/contacts
Skep of werk ’n kontak op deur die telefoonnommer as die primêre sleutel te gebruik.
Contacts
GET
/conversations
Lys van gesprekke wat deur kontakte begin is, met paginasie, antwoordvenster en AI‑agentstatus.
Conversations
GET
/conversations/{conversationId}/messages
Gee die gepagineerde boodskapgeskiedenis van 'n gesprek terug.
Conversations
PATCH
/contacts/{contactId}/custom-fields
Werk pasgemaakte velde by vir teikenstelling en operasionele konteks.
Fields
POST
/messages/send
Stuur ’n teksboodskap binne WhatsApp se 24‑uur boodskapperiode.
Messaging
POST
/handoffs
Vra menslike ondersteuning aan met die maatskappy se huidige konfigurasie.
Handoff
GET
/tickets
Lys van menslike ondersteuningskaartjies met filters en bladsyering.
Tickets
POST
/tickets/{ticketId}/close
Sluit die kaartjie, stuur die ooreenstemmende gebeurtenis uit en aktiveer die gesprek se AI‑agent weer.
Tickets
PATCH
/conversations/{conversationId}/ai-agent
Skakel die AI-agent slegs vir die gespesifiseerde gesprek aktief of pouseer dit.
Conversations
GET
/ai-agent/prompt
Kontroleer die wysigbare prompt wat as die AI-agent se basisuitleg gebruik word.
AI Agent
PATCH
/ai-agent/prompt
Werk die redigeerbare prompt by met hersieningsbeheer om gelyktydige oorskrywings te voorkom.
AI Agent
Tegniese kontrakte
Die dokumentasie dek API, eksterne koppelvlak en webhooks.
Kontrakte skei oproepe na Whatsplaid, navrae wat deur die agent in eksterne stelsels gemaak word, en gebeure wat deur Whatsplaid gestuur word.
Kontroleer konto en vermoëns, bestuur kontakte, etikette en persoonlike velde, hou gesprekke dop en stuur boodskappe binne die toegestane venster.
Bekyk en werk die redigeerbare prompt by, en skakel die agent in of pouseer dit afsonderlik in elke gesprek.
Toegang tot geselsgeskiedenis, paginasie, WhatsApp-antwoordvenster en huidige AI-agentstatus.
U kanstelsel kan produk-, bestelling-, kliënt- en beskikbaarheidsnavrae blootstel vir die agent se gebruik tydens die gesprek.
Beskikbare gebeure: `lead.created`, `message.received`, `message.sent`, `message.status.updated`, `ticket.created`, `ticket.closed` en `conversation.ai_agent.updated`.
Webhooks gebruik `delivery_id` vir deduplisering en nuwe pogings by tydelike foute. Aflewering word eers as voltooi beskou na 'n HTTP 2xx-reaksie.
Het u ’n integrasie wat u moet implementeer of verifieer?
Maak die interaktiewe dokumentasie oop om tussen `Whatsplaid Public API`, `Custom Data Connector Contract` en `Outgoing Webhooks` te skakel.