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

API v2 (бета)

Проверки номеров

Проверка номеров выясняет, у каких номеров телефонов есть аккаунт WhatsApp, ничего им не отправляя. Очистите список перед кампанией или проверьте номер нового клиента, прежде чем ему писать. Проверки, созданные через API, — те же самые списки, что на странице Проверка номеров в панели.

ОперацияEndpointОбласть доступа
Запуск проверкиPOST /api/v2/number-checkscontacts
Список проверокGET /api/v2/number-checkscontacts
Получение проверкиGET /api/v2/number-checks/{id}contacts
Получение результатовGET /api/v2/number-checks/{id}/resultscontacts

Для запуска проверки нужен тариф, включающий проверку номеров; иначе ответ — 403 plan_required. Чтение проверок работает на любом тарифе.

Запуск проверки#

POSThttps://wbiztool.com/api/v2/number-checks

Тело запроса: JSON (application/json)

Номера ставятся в очередь, и ответ — 201 с проверкой в статусе pending. Подключённый номер WhatsApp вашего рабочего пространства проверяет их в течение следующих минут. Опрашивайте проверку, пока status не станет completed, а затем прочитайте результаты.

Тело запроса

numbersarray of stringsобязательно

Номера для проверки, от 1 до 10 000 элементов. Пишите их в международном формате с + (+919876543210). Номер без кода страны получает код страны рабочего пространства. Повторы проверяются один раз, а элементы, которые не являются номерами телефонов, пропускаются.

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

Название проверки, до 500 символов, как оно показывается на странице «Проверка номеров». По умолчанию: API check и дата и время в UTC, например API check 2026-10-18 10:40.

curl -X POST https://wbiztool.com/api/v2/number-checks \
  -H "Authorization: Bearer $WBIZTOOL_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: october-leads" \
  -d '{
    "name": "October leads",
    "numbers": ["+919876543210", "+447700900123", "+14155550123"]
  }'

Ответ (201):

{
  "id": 51207,
  "name": "October leads",
  "status": "pending",
  "counts": { "total": 3, "pending": 3, "on_whatsapp": 0, "not_on_whatsapp": 0, "cancelled": 0 },
  "created_at": "2026-10-18T10:40:02.511Z",
  "skipped": 0
}

skipped — сколько элементов не были номерами телефонов (текст, меньше 7 или больше 15 цифр): они не проверяются и не учитываются в вашем тарифе.

Лимиты тарифа#

Ваш тариф определяет, сколько номеров можно проверить (см. Лимиты тарифа):

  • На одну проверку: в проверке не может быть больше номеров, чем позволяет тариф. При превышении проверка отклоняется с too_many_numbers, с count и limit.
  • За расчётный период: все проверки вместе, из API и из панели, тоже не могут превысить лимит. Проверка, которая его превысила бы, отклоняется с number_check_quota_reached, с requested, used и limit.
  • У тарифа без лимита нет ни того, ни другого. API принимает не больше 10 000 номеров за запрос на любом тарифе.
  • Отклонённая проверка ничего не ставит в очередь. Разделите список, дождитесь следующего периода или перейдите на тариф выше.

Ошибки при запуске проверки#

HTTPКодКогда
400validation_failednumbers отсутствует, пуст или не является списком строк, или name пусто или слишком длинное
403plan_requiredТариф не включает проверку номеров
422no_valid_numbersНи один элемент не является номером телефона; skipped показывает, сколько их было
422too_many_numbersБольше 10 000 элементов или больше номеров, чем тариф позволяет на одну проверку
422number_check_quota_reachedПроверка превысила бы лимит номеров тарифа за этот расчётный период

Список проверок#

GEThttps://wbiztool.com/api/v2/number-checks

Проверки рабочего пространства, сначала самые новые, страницами (limit от 1 до 100, по умолчанию 25, и cursor), включая запущенные в панели. Каждая — это Number check.

curl https://wbiztool.com/api/v2/number-checks \
  -H "Authorization: Bearer $WBIZTOOL_API_KEY"

Получение проверки#

GEThttps://wbiztool.com/api/v2/number-checks/{id}

Проверка и её ход. Опрашивайте её примерно каждые 30 секунд, пока status не станет completed.

curl https://wbiztool.com/api/v2/number-checks/51207 \
  -H "Authorization: Bearer $WBIZTOOL_API_KEY"
{
  "id": 51207,
  "name": "October leads",
  "status": "processing",
  "counts": { "total": 3, "pending": 1, "on_whatsapp": 1, "not_on_whatsapp": 1, "cancelled": 0 },
  "created_at": "2026-10-18T10:40:02.511Z"
}

Проверка, которой не существует, возвращает 404 number_check_not_found.

Для проверки нужен номер WhatsApp рабочего пространства, подключённый по QR-коду или коду привязки, и она ждёт, пока ваши номера отправляют сообщения. Проверка может какое-то время оставаться в статусе pending или processing; см. Как идёт проверка.

Получение результатов#

GEThttps://wbiztool.com/api/v2/number-checks/{id}/results

Номера проверки и то, что о них выяснено, страницами (limit от 1 до 100, по умолчанию 25, и cursor). Их можно читать, пока проверка идёт: ещё не проверенные номера имеют статус pending.

curl "https://wbiztool.com/api/v2/number-checks/51207/results?limit=100" \
  -H "Authorization: Bearer $WBIZTOOL_API_KEY"
{
  "data": [
    { "number": "14155550123", "on_whatsapp": null, "status": "pending", "checked_at": null },
    { "number": "447700900123", "on_whatsapp": false, "status": "not_on_whatsapp", "checked_at": "2026-10-18T10:42:57.204Z" },
    { "number": "919876543210", "on_whatsapp": true, "status": "on_whatsapp", "checked_at": "2026-10-18T10:42:51.880Z" }
  ],
  "next_cursor": null
}
ПолеТипОписание
numberstringПроверенный номер: цифры с кодом страны, без +.
on_whatsappboolean or nulltrue или false после проверки; null, пока ожидает или если отменён.
statusstringpending, on_whatsapp, not_on_whatsapp или cancelled (остановлен до проверки).
checked_atstring or nullКогда он был проверен.

Объект Number check#

ПолеТипОписание
idintegerID проверки.
namestringЕё название.
statusstringpending (ещё ничего не проверено), processing (часть проверена) или completed (проверять больше нечего).
countsobjecttotal, pending, on_whatsapp, not_on_whatsapp и cancelled.
created_atstringКогда она была запущена.
skippedintegerТолько в ответе на Запуск проверки: элементы, которые не были номерами телефонов.

Связанные материалы#