Ваша система обращается к Whatsplaid, чтобы узнать возможности, управлять контактами, отслеживать разговоры, отправлять сообщения, контролировать AI‑агента и запрашивать помощь человека.
Публичный API и документация
Подключите ваши системы к Whatsplaid через API, коннекторы и вебхуки.
Используйте публичное API для интеграции контактов, разговоров, сообщений, человеческой поддержки и AI‑агента. Используйте внешний коннектор для запроса данных из вашей системы и вебхуки для получения событий в реальном времени.
Три контракта
Выберите правильное направление интеграции.
Документация Swagger разделяет потоки, чтобы избежать путаницы между вызовами в Whatsplaid, запросами, выполняемыми ассистентом, и событиями, отправляемыми в вашу систему.
Whatsplaid обращается к вашей системе, чтобы запрашивать информацию о товарах, заказах, клиентах или доступности в реальном времени во время разговора.
Познакомьтесь с внешним коннектором через APIWhatsplaid отправляет события лидов, сообщения, статусы доставки, тикеты и изменения в агенте ИИ на настроенный URL.
Swagger на `api.whatsplaid.com/docs/` содержит схемы, примеры, ожидаемые ответы и полные технические контракты.
Краткая справка по основным конечным точкам.
Этот вид суммирует функции, которые представлены в официальной документации. Финальная реализация должна соответствовать Swagger.
GET
/store
Возвращает данные аккаунта, подключённый e‑commerce и активные модули.
Account
GET
/capabilities
Показывает, какие операции действительно доступны в зависимости от аккаунта, тарифа, модулей и интеграций.
Account
GET
/ecommerce/products/search
Ищите товары в подключённых нативных интеграциях, таких как Nuvemshop, Wix или Shopify.
Ecommerce
GET
/ecommerce/orders/search
Ищите заказы по номеру, электронной почте или телефону в подключённых нативных интеграциях.
Ecommerce
POST
/contacts
Создаёт или обновляет контакт, используя номер телефона в качестве основного ключа.
Contacts
GET
/conversations
Список разговоров, инициированных контактами, с постраничной навигацией, окном ответа и статусом AI‑агента.
Conversations
GET
/conversations/{conversationId}/messages
Возвращает постраничную историю сообщений беседы.
Conversations
PATCH
/contacts/{contactId}/custom-fields
Обновляет пользовательские поля для таргетинга и операционного контекста.
Fields
POST
/messages/send
Отправляет текстовое сообщение в пределах 24‑часового окна обслуживания WhatsApp.
Messaging
POST
/handoffs
Запросите помощь человека с использованием текущих настроек компании.
Handoff
GET
/tickets
Список обращений в живую поддержку с фильтрами и постраничной навигацией.
Tickets
POST
/tickets/{ticketId}/close
Закрывает тикет, генерирует соответствующее событие и повторно активирует AI‑агента беседы.
Tickets
PATCH
/conversations/{conversationId}/ai-agent
Включает или приостанавливает работу AI-агента только для указанного разговора.
Conversations
GET
/ai-agent/prompt
Проверяет редактируемый prompt, используемый как базовая инструкция агента ИИ.
AI Agent
PATCH
/ai-agent/prompt
Обновите редактируемый prompt с контролем версий, чтобы избежать одновременных перезаписей.
AI Agent
Технические контракты
Документация охватывает API, внешний коннектор и вебхуки.
Контракты разделяют вызовы, отправляемые в Whatsplaid, запросы, которые агент выполняет во внешних системах, и события, отправляемые Whatsplaid.
Проверяет аккаунт и возможности, управляет контактами, метками и пользовательскими полями, отслеживает разговоры и отправляет сообщения в пределах допустимого окна.
Просматривайте и обновляйте редактируемый prompt, а также отдельно включайте или приостанавливайте агента в каждом разговоре.
Доступ к истории, постраничной навигации, окну ответа WhatsApp и текущему состоянию AI-агента.
Ваша система может предоставлять агенту для использования в ходе разговора запросы о товарах, заказах, клиентах и наличии.
Доступные события: `lead.created`, `message.received`, `message.sent`, `message.status.updated`, `ticket.created`, `ticket.closed` и `conversation.ai_agent.updated`.
Webhook'и используют `delivery_id` для дедупликации и повторных попыток при временных ошибках. Доставка считается завершённой только после ответа HTTP 2xx.
Вам нужно внедрить или проверить интеграцию?
Откройте интерактивную документацию, чтобы переключаться между `Whatsplaid Public API`, `Custom Data Connector Contract` и `Outgoing Webhooks`.