Перейти к содержимому
Wbiztool

API проверки номеров

Статус проверки номеров WhatsApp (API)

Следите за ходом задачи проверки номеров и получайте результат по каждому номеру в ней. Опрашивайте этот endpoint после создания задачи проверки, пока задача не завершится.

GEThttps://wbiztool.com/api/v1/verification/status/?campaign_id=4521

Быстрый пример#

curl "https://wbiztool.com/api/v1/verification/status/?campaign_id=4521" \
  -H "Authorization: Bearer YOUR_API_KEY"

Параметры запроса#

Authorizationheaderобязательно

Bearer YOUR_API_KEY с ключом из раздела Настройки → API ключи. Вместо этого ключ можно передать в параметре запроса api_key, но заголовок не попадает в журналы серверов и прокси.

campaign_idintegerобязательно

campaign_id, возвращённый API создания проверки, в строке запроса. Это должна быть задача проверки в том же рабочем пространстве, что и API-ключ.

Ответ#

Успешный запрос возвращает HTTP 200:

{
  "status": "success",
  "campaign_id": 4521,
  "campaign_name": "Website leads - September",
  "overall_status": "processing",
  "progress": {
    "total": 3,
    "pending": 1,
    "verified": 1,
    "invalid": 1,
    "completed_percentage": 66.67
  },
  "results": [
    {
      "number": "14155550123",
      "status": "pending",
      "checked_at": null,
      "created_at": "2026-09-16T10:15:00.483101+00:00"
    },
    {
      "number": "919876543210",
      "status": "verified",
      "checked_at": "2026-09-16T10:16:12.204551+00:00",
      "created_at": "2026-09-16T10:15:00.482913+00:00"
    },
    {
      "number": "919876543211",
      "status": "invalid",
      "checked_at": "2026-09-16T10:16:19.915372+00:00",
      "created_at": "2026-09-16T10:15:00.483020+00:00"
    }
  ],
  "created_at": "2026-09-16T10:15:00.471820+00:00",
  "last_updated": "2026-09-16T10:15:00.471820+00:00"
}
ПолеТипОписание
statusstring"success". При ошибках возвращается "error".
campaign_idintegerID задачи проверки.
campaign_namestringНазвание задачи.
overall_statusstringpending, processing или completed. См. раздел Значения общего статуса.
progress.totalintegerНомера в задаче.
progress.pendingintegerЕщё не проверенные номера.
progress.verifiedintegerНомера, зарегистрированные в WhatsApp.
progress.invalidintegerНомера со статусом invalid (нет в WhatsApp, недействительный номер или проверка завершилась сбоем).
progress.completed_percentagenumberДоля проверенных номеров (verified + invalid) от total в процентах, с округлением до 2 знаков после запятой.
resultsarrayВсе номера задачи, отсортированные по номеру. Список возвращается целиком, без пагинации.
results[].numberstringОчищенный номер телефона.
results[].statusstringpending, verified, invalid или unknown. См. раздел Значения статуса номера.
results[].checked_atstring or nullКогда номер был проверен, или null, пока проверка не выполнена.
results[].created_atstringКогда номер был добавлен.
created_atstringКогда задача была создана.
last_updatedstringКогда запись задачи изменялась в последний раз. Это значение не меняется по мере проверки номеров, поэтому для отслеживания недавней активности используйте checked_at.

Все метки времени указываются в формате ISO 8601 в UTC с микросекундами и смещением +00:00, например 2026-09-16T10:16:12.204551+00:00.

Значения статуса номера#

ЗначениеСмысл
pendingОжидает проверки.
verifiedНомер зарегистрирован в WhatsApp.
invalidНомер не зарегистрирован в WhatsApp, не является действительным номером телефона или не был проверен из-за ошибки обработки. Если номер, который должен быть действительным, показывает invalid, проверьте его ещё раз в новой задаче.
unknownПроверка была отменена службой поддержки Wbiztool. При обычной обработке этот статус не устанавливается.

Значения общего статуса#

ЗначениеСмысл
pendingНи один номер ещё не проверен.
processingЧасть номеров проверена, часть ещё ожидает проверки.
completedНомеров, ожидающих проверки, не осталось.

У задачи со статусом completed значение completed_percentage может быть меньше 100, если часть проверок была отменена: отменённые номера учитываются в total, но не в проценте.

Ошибки#

Ошибки возвращают JSON-тело со status, равным "error", и кодом ошибки HTTP:

{ "status": "error", "message": "Campaign not found" }
HTTPСообщениеКак исправить
405Only GET method allowedОтправьте запрос GET.
401API key requiredДобавьте заголовок Authorization: Bearer YOUR_API_KEY.
401Invalid API keyПроверьте, что ключ существует, не удалён и не отключён.
400campaign_id is requiredДобавьте campaign_id в строку запроса.
404Campaign not foundID не существует, не является задачей проверки или принадлежит другому рабочему пространству. Используйте ключ из рабочего пространства, в котором создана задача.
500Internal server error: …Чаще всего campaign_id не является числом. Передавайте только цифры.

Советы#

  • Не опрашивайте слишком часто. За один запуск в фоне проверяется до 10 номеров, поэтому опроса раз в 30–60 секунд вполне достаточно, а большая задача может выполняться долго.
  • Прекращайте опрос, когда overall_status равен completed.
  • Задача застряла в pending? Для проверки нужен номер WhatsApp, подключённый на странице настроек WhatsApp в том же рабочем пространстве. Без него номера никогда не будут проверены. Проверки также ждут, пока ваш подключённый номер занят отправкой сообщений.
  • Большие задачи: этот endpoint возвращает все номера в одном ответе. Чтобы читать результаты постранично или только номера со статусом verified, используйте API результатов проверки.