Ihr System ruft Whatsplaid auf, um Funktionen abzufragen, Kontakte zu verwalten, Konversationen nachzuverfolgen, Nachrichten zu senden, den KI-Agenten zu steuern und menschlichen Support anzufordern.
Öffentliche API und Dokumentation
Verbinden Sie Ihre Systeme mit Whatsplaid über APIs, Connectors und Webhooks.
Verwenden Sie die öffentliche API, um Kontakte, Unterhaltungen, Nachrichten, menschlichen Support und den KI-Agenten zu integrieren. Verwenden Sie den externen Connector, um Daten aus Ihrem System abzufragen, und Webhooks, um Echtzeitereignisse zu empfangen.
Drei Verträge
Wählen Sie die richtige Richtung der Integration.
Die Swagger-Dokumentation trennt die Abläufe, um Verwechslungen zwischen Aufrufen an Whatsplaid, Anfragen des Assistenten und an Ihr System gesendeten Ereignissen zu vermeiden.
Whatsplaid ruft Ihr System auf, um während eines Gesprächs Produkte, Bestellungen, Kunden oder die Echtzeitverfügbarkeit abzufragen.
Lernen Sie den externen Connector über die API kennenWhatsplaid sendet Lead-Ereignisse, Nachrichten, Zustellstatus, Tickets und Änderungen am KI-Agenten an eine konfigurierte URL.
Der Swagger unter `api.whatsplaid.com/docs/` enthält die Schemata, Beispiele, erwarteten Antworten und vollständigen technischen Verträge.
Kurzübersicht der wichtigsten Endpunkte.
Diese Ansicht fasst die Funktionen zusammen, die in der offiziellen Dokumentation erscheinen. Die endgültige Implementierung muss dem Swagger folgen.
GET
/store
Gibt Kontodaten, verbundenen E‑Commerce und aktive Module zurück.
Account
GET
/capabilities
Zeigt an, welche Vorgänge je nach Konto, Tarif, Modulen und Integrationen tatsächlich verfügbar sind.
Account
GET
/ecommerce/products/search
Suche nach Produkten in verbundenen nativen Integrationen, wie Nuvemshop, Wix oder Shopify.
Ecommerce
GET
/ecommerce/orders/search
Bestellungen nach Nummer, E‑Mail oder Telefonnummer in den verbundenen nativen Integrationen suchen.
Ecommerce
POST
/contacts
Erstellt oder aktualisiert einen Kontakt und verwendet die Telefonnummer als Primärschlüssel.
Contacts
GET
/conversations
Liste der von Kontakten gestarteten Unterhaltungen mit Paginierung, Antwortfenster und Status des KI-Agenten.
Conversations
GET
/conversations/{conversationId}/messages
Gibt die paginierte Nachrichtenhistorie eines Gesprächs zurück.
Conversations
PATCH
/contacts/{contactId}/custom-fields
Aktualisiert benutzerdefinierte Felder für Targeting und operativen Kontext.
Fields
POST
/messages/send
Sendet eine Textnachricht innerhalb des 24‑Stunden‑Antwortfensters von WhatsApp.
Messaging
POST
/handoffs
Menschlichen Support anfordern unter Verwendung der aktuellen Unternehmenseinstellung.
Handoff
GET
/tickets
Liste von menschlichen Support-Tickets mit Filtern und Paginierung.
Tickets
POST
/tickets/{ticketId}/close
Schließt das Ticket, löst das entsprechende Ereignis aus und reaktiviert den KI-Agenten der Konversation.
Tickets
PATCH
/conversations/{conversationId}/ai-agent
Aktiviert oder pausiert den KI-Agenten nur für die angegebene Konversation.
Conversations
GET
/ai-agent/prompt
Prüft das editierbare Prompt, das als Basisanweisung des KI-Agenten verwendet wird.
AI Agent
PATCH
/ai-agent/prompt
Aktualisiere die editierbare Eingabeaufforderung mit Versionskontrolle, um gleichzeitige Überschreibungen zu verhindern.
AI Agent
Technische Verträge
Die Dokumentation behandelt die API, den externen Connector und Webhooks.
Verträge trennen Aufrufe an Whatsplaid, Abfragen, die der Agent in externen Systemen stellt, und von Whatsplaid gesendete Ereignisse.
Prüft Konto und Berechtigungen, verwaltet Kontakte, Tags und benutzerdefinierte Felder, verfolgt Gespräche und sendet Nachrichten innerhalb des zulässigen Zeitfensters.
Den editierbaren Prompt ansehen und aktualisieren sowie den Agenten in jedem Gespräch einzeln aktivieren oder pausieren.
Greift auf Verlauf, Paginierung, WhatsApp-Antwortfenster und den aktuellen Zustand des KI-Agenten zu.
Ihr System kann Produkt-, Bestell-, Kunden- und Verfügbarkeitsabfragen für die Nutzung durch den Agenten während der Konversation bereitstellen.
Verfügbare Events: `lead.created`, `message.received`, `message.sent`, `message.status.updated`, `ticket.created`, `ticket.closed` und `conversation.ai_agent.updated`.
Webhooks verwenden `delivery_id` zur Duplikatserkennung und für erneute Versuche bei vorübergehenden Fehlern. Die Zustellung gilt erst nach einer HTTP-2xx-Antwort als abgeschlossen.
Müssen Sie eine Integration implementieren oder validieren?
Öffnen Sie die interaktive Dokumentation, um zwischen `Whatsplaid Public API`, `Custom Data Connector Contract` und `Outgoing Webhooks` zu wechseln.