Руководство по продукту
Интеграция WA Lookup: автоматическая очистка данных CRM и классификация аккаунтов
Интегрируйте синхронный API WA Lookup для очистки данных CRM. Проверяйте наличие аккаунта WhatsApp, аватары и бизнес-статус по номерам в формате E.164.

Узнайте, как интегрировать синхронный API WA Lookup, чтобы проверять наличие аккаунта WhatsApp, получать сведения об аватаре и классифицировать бизнес-аккаунты для очистки данных CRM.
API WA Lookup позволяет CRM-системам синхронно проверять наличие аккаунта WhatsApp. Отправив POST-запрос на эндпоинт /api/v1/check с номером телефона в формате E.164, разработчики могут получить статус регистрации, наличие аватара или классификацию бизнес-аккаунта в том же HTTP-ответе. Эти данные помогают поддерживать чистоту CRM, выявляя действительные записи, связанные с WhatsApp, без асинхронной обработки, опроса или вебхуков.
Архитектура API WA Lookup
Встраивание сигналов наличия аккаунта в CRM требует архитектуры, поддерживающей немедленную маршрутизацию данных и принятие решений. API WA Lookup построен вокруг единого синхронного эндпоинта: POST /api/v1/check.
Когда CRM-система или платформа обработки данных отправляет запрос, API выполняет проверку и возвращает результаты в том же HTTP-ответе. Такая синхронная архитектура устраняет инженерные издержки асинхронной обработки — настройку вебхуков, управление URL обратного вызова или реализацию логики опроса. Разработчики могут встраивать API непосредственно в синхронные процессы, например в формы приёма лидов или конвейеры очистки данных в реальном времени.
Для завершённой проверки WhatsApp возвращаемый data содержит service_type, identifier и registered; ws_avatar дополнительно включает avatar и avatar_url, а ws_business — business. Внутренние поля записи, транзакции, статуса и биллинга не возвращаются.
Классификация типов аккаунтов WhatsApp
Чтобы поддерживать разные требования к очистке данных CRM, API проверки в реальном времени предлагает три типа сервиса. Все три используют один и тот же синхронный эндпоинт, а параметр service_type определяет, какие именно поля возвращаются в ответе и какая стоимость списывается с баланса за операцию.
Сравнение типов сервиса
| Тип сервиса | Основная возможность | Возвращаемые поля |
|---|---|---|
ws |
Сигнал регистрации на платформе | registered |
ws_avatar |
Обогащение профиля и наличие аватара | registered, avatar (булево), avatar_url (строка, пустая, если URL недоступен) |
ws_business |
Сигнал бизнес-профиля | registered, business (булево) |
WhatsApp Checker (ws) — базовый тип сервиса. Он используется только для подтверждения того, зарегистрирован ли переданный номер телефона в WhatsApp, и возвращает лишь поле registered. Обычно он применяется для базовой очистки списков и определения того, у каких контактов CRM есть аккаунт в WhatsApp.
WhatsApp Avatar Checker (ws_avatar) расширяет базовую проверку возможностями обогащения профиля. Помимо статуса регистрации, он возвращает булево поле avatar, указывающее, установлено ли фото профиля, и строку avatar_url. Поле URL пустое, если URL недоступен. Этот сигнал помогает командам оценить полноту профиля контакта.
WhatsApp Business Checker (ws_business) предназначен для сегментации в B2B CRM. Он проверяет регистрацию в WhatsApp и возвращает булево поле business, указывающее, использует ли аккаунт WhatsApp Business. Это позволяет менеджерам по данным отделять личные аккаунты от бизнес-аккаунтов в своих базах.
Техническая реализация и чистота данных
Интеграция API в CRM или конвейер данных требует соблюдения документированного контракта запроса. API ожидает JSON-тело и определённые заголовки для успешной аутентификации и обработки запроса.
Документированный контракт требует POST-запроса к /api/v1/check. Запрос должен содержать два заголовка: X-API-Key с вашим ключом аутентификации и Content-Type: application/json.
JSON-тело должно содержать ровно два поля:
service_type: строковое значениеws,ws_avatarилиws_business.identifier: номер телефона для проверки.
Важно, чтобы все передаваемые номера телефонов были отформатированы по международному плану нумерации E.164. Например, номер из США должен передаваться как +17253100591. Несоблюдение формата E.164 может привести к ошибкам разбора или неопределённым проверкам.
Стандартное JSON-тело выглядит так: {"service_type": "ws_business", "identifier": "+17253100591"}
Приводя вводимые в CRM данные к E.164 и пропуская их через эту синхронную проверку, разработчики могут автоматически помечать недействительные номера, сегментировать бизнес-пользователей и поддерживать высокий уровень чистоты данных. Поскольку ответ приходит сразу, такие проверки можно встраивать непосредственно в формы ввода данных, чтобы в базу попадали только подтверждённые сигналы наличия аккаунта.
Отчётность в панели и управление аккаунтом
Управление использованием API и мониторинг операций по очистке данных выполняются через панель платформы. Панель предоставляет администраторам CRM и разработчикам полный набор инструментов для отслеживания работы интеграции и управления аутентификацией.
Панель поддерживает полноценное управление ключами API и позволяет командам безопасно их ротировать. Для операционного контроля она показывает текущий баланс аккаунта, подробную историю проверок и отчётность по продуктам. Администраторы могут просматривать недавние проверки, отслеживать расход баланса и анализировать активность аккаунта, чтобы понимать, как API используется в разных процессах CRM.
Для завершённой проверки WhatsApp возвращаемый data содержит service_type, identifier и registered; ws_avatar дополнительно включает avatar и avatar_url, а ws_business — business. Внутренние поля записи, транзакции, статуса и биллинга не возвращаются.
Часто задаваемые вопросы
API WA Lookup синхронный или асинхронный?
API WA Lookup строго синхронный. Когда запрос отправляется на эндпоинт POST /api/v1/check, результаты возвращаются в том же HTTP-ответе, что и запрос.
Может ли этот API проверить, находится ли пользователь сейчас в сети?
Нет. Результат «зарегистрирован» сообщает поля статуса WhatsApp, доступные на момент проверки. Он служит лишь сигналом наличия аккаунта и не сообщает о присутствии в сети, истории сообщений, согласии контакта или о том, можно ли связаться с номером в данный момент.
Чем отличаются типы сервиса ws, ws_avatar и ws_business?
Все три типа сервиса используют один и тот же синхронный эндпоинт, но возвращают разные поля. Тип ws подтверждает базовую регистрацию в WhatsApp. Тип ws_avatar возвращает статус регистрации вместе с булевым полем avatar и полем URL аватара, которое пустое, если URL недоступен. Тип ws_business возвращает статус регистрации и булево значение, указывающее, использует ли аккаунт WhatsApp Business.