service_type ws_profile
Проверьте, есть ли у номера аватар в WhatsApp, получите URL изображения и атрибуты портрета на этом аватаре.
POST /api/v1/checkАнализ аватаров WhatsAppВход не требуется.
Контракт API
Отправьте один номер и выберите этот продукт с помощью service_type. Для аутентификации используется ваш ключ API.
Скопируйте команду curl ниже и замените только пример ключа API на свой.
POST /api/v1/checkcurl -X POST "https://avatarlookup.com/api/v1/check" \
-H "X-API-Key: sk_your_api_key" \
-H "Content-Type: application/json" \
-d '{ "service_type": "ws_profile", "identifier": "+17253100591" }'200 OK{
"code": 0,
"msg": "ok",
"data": {
"service_type": "ws_profile",
"identifier": "+17253100591",
"registered": true,
"avatar": true,
"avatar_url": "https://pps.whatsapp.net/v/example.jpg",
"category": "individual portrait",
"age": 39,
"gender": "male",
"skin_color": "white",
"hair_color": "brown"
}
}Как использовать
Номер в формате E.164 (знак плюс, код страны, затем номер) для WhatsApp или полный email для продукта email.
registered показывает, существует ли аккаунт (для адреса email — доступен ли он), avatar — установлен ли аватар, avatar_url содержит изображение. Все три поля возвращаются при каждой успешной проверке.
avatar_url указывает на собственный CDN платформы и может перестать работать по её графику. Воспринимайте его как ссылку: скачайте или кэшируйте изображение, если его нужно сохранить.
Что проверяется
registered · boolean — Зарегистрирован ли номер в WhatsApp.avatar · boolean — Установлен ли аватар.avatar_url · string — URL аватара; пустая строка, если фото не установлено.category · string — Что изображено: individual portrait, group photo, game avatar, cartoon avatar, landscape, pet avatar или object. unknown, если получить портрет не удалось.age · integer — Оценка возраста целым числом с точностью примерно до 3 лет, в диапазоне 0–80. Отсутствует, если оценить не удалось (например, когда не определён пол).gender · string — male, female или unknown.skin_color · string — Описательный тон кожи, например white, east_asian или hispanic. Считайте набор значений открытым; unknown, если не определено.hair_color · string — Описательный цвет волос, например black, brown, blond или gray white. Считайте набор значений открытым; unknown, если не определено.Лучше всего подходит для
Добавляйте состояние аватара и URL изображения в списки клиентов, диалоги поддержки или адресные книги. Проверяйте наличие аватара, прежде чем загружать его или показывать изображение по умолчанию.
Записывайте полученный URL аватара в существующие записи контактов, чтобы отделы продаж, поддержки и операций видели одинаковый, более полный профиль клиента.
Передавайте состояние регистрации, состояние аватара и атрибуты изображения в очереди ручной проверки как дополнительный сигнал полноты записи.
Формируйте группы по регистрации, наличию аватара и результатам профиля, чтобы упорядочить списки и спланировать дальнейшую работу с данными.
Краткий ответ
Анализ аватаров WhatsApp возвращает сведения о том, есть ли у номера аватар в WhatsApp, и URL изображения, если он есть. Укажите service_type ws_profile (параметр, выбирающий продукт) и один номер в формате E.164, например +17253100591, и прочитайте атрибуты портрета на верхнем уровне того же ответа API.
Чёткие границы
FAQ по продукту
Он проверяет один идентификатор и возвращает сведения о том, есть ли у номера аватар в WhatsApp, и URL изображения, если он есть в том же синхронном ответе.
Баланс списывается только за завершённые проверки. За неудачные или неопределённые проверки средства не удерживаются.
Отправляйте идентификатор, который принимает продукт: номер в формате E.164 для WhatsApp или полный email для продукта email. Идентификатор в неверном формате отклоняется до списания средств.
Нет. Он лишь сообщает, установлен ли аватар в данный момент. Он ничего не говорит о том, используется ли аккаунт и в сети ли он, и не даёт разрешения с кем-либо связываться. Согласие и соблюдение применимых правил остаются вашей ответственностью.
Похожие продукты
Создайте аккаунт, чтобы пользоваться всеми продуктами из панели SaaS или через API: проверки в реальном времени и асинхронные массовые проверки расходуют один и тот же баланс.
