Тип сервиса ws_avatar: справочник по запросу, ответу и полям

WA Lookup предоставляет свои проверки WhatsApp через единый синхронный вызов, а значение service_type определяет, какая проверка выполняется. Это справочник по полям для варианта ws_avatar.

Чтобы выполнить проверку аватара WhatsApp с помощью WA Lookup, отправьте POST /api/v1/check с заголовком X-API-Key и JSON-телом {"service_type": "ws_avatar", "identifier": "<E.164 number>"}. Ответ возвращает стандартные поля проверки, а также булево поле avatar и строку avatar_url; avatar_url — пустая строка, если URL недоступен.

Контракт запроса

WA Lookup документирует один синхронный вызов — POST /api/v1/check, который отправляется с заголовком X-API-Key и Content-Type: application/json. Тело содержит ровно два значения: service_type, выбирающее проверку, и identifier, который должен быть номером телефона в формате E.164. Передача номера в местном формате — самая частая причина неудачи, которой можно избежать, поэтому нормализуйте номер перед отправкой.

Поля ответа, которые возвращаются всегда

Для завершённой проверки WhatsApp возвращаемый data содержит service_type, identifier и registered; ws_avatar дополнительно включает avatar и avatar_url, а ws_business — business. Внутренние поля записи, транзакции, статуса и биллинга не возвращаются.

Два поля, которые добавляет ws_avatar

Выбор service_type=ws_avatar добавляет булево поле avatar и строку avatar_url. Булево поле avatar сообщает, был ли обнаружен аватар. Поле avatar_url всегда присутствует в успешном ответе ws_avatar и содержит пустую строку, если URL недоступен. Храните его отдельно от булева поля avatar, поскольку эти два поля отвечают на разные вопросы.

Всё приходит в одном ответе

Поскольку вызов синхронный, поля регистрации и аватара возвращаются в том же HTTP-ответе, что и запрос. Не нужно хранить идентификатор задачи или опрашивать маршрут статуса, поэтому интеграция сводится к одному вызову и одному пути обработки ошибок. Код, написанный для API с опросом, обычно содержит структуру, которую здесь можно просто удалить.

Часто задаваемые вопросы

Как обрабатывать avatar_url?

Поле avatar_url всегда присутствует в успешном ответе ws_avatar. Сохраняйте пустую строку как «URL недоступен»; не используйте её как замену булева поля avatar.

Какой формат номера требуется для identifier?

E.164. Нормализация перед отправкой позволяет избежать самой распространённой категории неудачных проверок.

Нужен ли второй вызов, чтобы получить статус регистрации?

Нет. ws_avatar возвращает поле регистрации вместе с полями аватара в том же ответе.