Twój system wywołuje Whatsplaid, aby sprawdzić możliwości, zarządzać kontaktami, śledzić rozmowy, wysyłać wiadomości, kontrolować agenta AI i prosić o wsparcie człowieka.
Publiczne API i dokumentacja
Połącz swoje systemy z Whatsplaid za pomocą API, konektorów i webhooków.
Użyj publicznego API, aby integrować kontakty, rozmowy, wiadomości, obsługę human‑to‑human oraz agenta AI. Użyj zewnętrznego konektora do zapytań danych z Twojego systemu i webhooków, aby otrzymywać zdarzenia w czasie rzeczywistym.
Trzy umowy
Wybierz poprawny kierunek integracji.
Dokumentacja Swagger rozdziela przepływy, aby uniknąć zamieszania między wywołaniami do Whatsplaid, zapytaniami wykonywanymi przez asystenta a zdarzeniami wysyłanymi do Twojego systemu.
Whatsplaid wywołuje Twój system, aby podczas rozmowy pobierać informacje o produktach, zamówieniach, klientach lub dostępności w czasie rzeczywistym.
Poznaj zewnętrzny konektor przez APIWhatsplaid wysyła zdarzenia leadów, wiadomości, statusy dostawy, zgłoszenia i zmiany agenta AI na skonfigurowany URL.
Swagger pod adresem `api.whatsplaid.com/docs/` zawiera schematy, przykłady, oczekiwane odpowiedzi oraz pełne kontrakty techniczne.
Szybkie odniesienie do głównych endpointów.
Widok ten podsumowuje funkcje, które pojawiają się w oficjalnej dokumentacji. Końcowa implementacja musi być zgodna ze Swagger.
GET
/store
Zwraca dane konta, podłączony e-commerce i aktywne moduły.
Account
GET
/capabilities
Informuje, które operacje są faktycznie dostępne w zależności od konta, planu, modułów i integracji.
Account
GET
/ecommerce/products/search
Wyszukaj produkty w podłączonych natywnych integracjach, takich jak Nuvemshop, Wix lub Shopify.
Ecommerce
GET
/ecommerce/orders/search
Wyszukaj zamówienia według numeru, e-maila lub telefonu w podłączonych natywnych integracjach.
Ecommerce
POST
/contacts
Tworzy lub aktualizuje kontakt, używając numeru telefonu jako klucza głównego.
Contacts
GET
/conversations
Lista konwersacji rozpoczętych przez kontakty, z paginacją, oknem odpowiedzi i statusem agenta AI.
Conversations
GET
/conversations/{conversationId}/messages
Zwraca stronicowaną historię wiadomości rozmowy.
Conversations
PATCH
/contacts/{contactId}/custom-fields
Aktualizuje pola niestandardowe dla targetowania i kontekstu operacyjnego.
Fields
POST
/messages/send
Wysyła wiadomość tekstową w ramach 24‑godzinnego okna wiadomości WhatsApp.
Messaging
POST
/handoffs
Zgłoś prośbę o obsługę przez człowieka, korzystając z bieżącej konfiguracji firmy.
Handoff
GET
/tickets
Lista zgłoszeń do wsparcia obsługiwanego przez ludzi z filtrami i paginacją.
Tickets
POST
/tickets/{ticketId}/close
Zamyka zgłoszenie, emituje odpowiednie zdarzenie i ponownie aktywuje agenta AI rozmowy.
Tickets
PATCH
/conversations/{conversationId}/ai-agent
Włącz lub wstrzymaj agenta AI tylko dla wskazanej rozmowy.
Conversations
GET
/ai-agent/prompt
Sprawdza edytowalny prompt używany jako instrukcja bazowa agenta AI.
AI Agent
PATCH
/ai-agent/prompt
Zaktualizuj edytowalny prompt z kontrolą wersji, aby zapobiec równoczesnym nadpisaniom.
AI Agent
Kontrakty techniczne
Dokumentacja obejmuje API, zewnętrzny konektor i webhooki.
Kontrakty rozdzielają wywołania kierowane do Whatsplaid, zapytania wykonywane przez agenta w systemach zewnętrznych oraz zdarzenia wysyłane przez Whatsplaid.
Sprawdza konto i uprawnienia, zarządza kontaktami, tagami i polami niestandardowymi, śledzi rozmowy i wysyła wiadomości w dozwolonym oknie.
Przejrzyj i zaktualizuj edytowalny prompt oraz włączaj lub wstrzymuj agenta oddzielnie w każdej rozmowie.
Dostęp do historii, paginacji, okna odpowiedzi WhatsApp i bieżącego stanu agenta AI.
Twój system może udostępniać zapytania o produkty, zamówienia, klientów i dostępność do wykorzystania przez agenta podczas rozmowy.
Dostępne zdarzenia: `lead.created`, `message.received`, `message.sent`, `message.status.updated`, `ticket.created`, `ticket.closed` oraz `conversation.ai_agent.updated`.
Webhooki używają `delivery_id` do deduplikacji oraz ponownych prób przy błędach tymczasowych. Dostawa uznawana jest za zakończoną dopiero po odpowiedzi HTTP 2xx.
Czy potrzebujesz wdrożyć lub zweryfikować integrację?
Otwórz interaktywną dokumentację, aby przełączać się między `Whatsplaid Public API`, `Custom Data Connector Contract` i `Outgoing Webhooks`.