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

Проверяйте регистрацию номеров в Botim пакетно и загружайте экспортированные результаты.

Параметры продукта

Параметр	Значение
Тип задачи	botim
Тип ввода	Номер телефона в формате E.164
Минимум корректных записей	500

estimated_amount рассчитывается по тарифу аккаунта и является ориентиром стоимости задачи.

Формат ввода

Загрузите .txt или .csv с одним номером в строке. Рекомендуется E.164.

+14155552671
+442071838750

Создание задачи

POST https://api.checknumber.ai/v1/tasks

curl --location 'https://api.checknumber.ai/v1/tasks' \
--header 'X-API-Key: YOUR_API_KEY' \
--form 'file=@"./numbers.txt"' \
--form 'task_type="botim"'

API возвращает ID задачи. Сохраните его для опроса статуса.

Ответ загрузки

{
  "task_id": "d4g8o46p2jvh04o9uolg",
  "status": "pending",
  "total": 500,
  "estimated_amount": {
    "amount": "0.250000",
    "currency": "USD"
  },
  "message": "Task created successfully"
}

Проверка статуса

POST https://api.checknumber.ai/v1/gettasks

curl --location 'https://api.checknumber.ai/v1/gettasks' \
--header 'X-API-Key: YOUR_API_KEY' \
--form 'task_id="d4g8o46p2jvh04o9uolg"'

Опрашивайте до status=exported. pending и processing не означают завершение.

Ответ при обработке

{
  "task_id": "d4g8o46p2jvh04o9uolg",
  "status": "processing",
  "total": 500,
  "success": 250,
  "failure": 0
}

Ответ после экспорта

{
  "task_id": "d4g8o46p2jvh04o9uolg",
  "status": "exported",
  "total": 500,
  "success": 500,
  "failure": 0,
  "result_url": "https://example-link-to-results.zip",
  "actual_amount": {
    "amount": "0.250000",
    "currency": "USD"
  }
}

Поля результата

Поле	Описание	Пример
number / Number	Входной номер. В CSV — number, в XLSX — Number.	+14155552671
activated	Обнаружен ли аккаунт для номера.	yes / no

Если аккаунт не найден, возвращается activated=no; недоступные поля профиля остаются пустыми.

Обработка файла

Загружайте пакет по result_url только после экспорта и сохраняйте имена столбцов.

Поля ответа

Поле	Описание
created_at	Время создания.
updated_at	Время последнего обновления.
task_id	Уникальный ID задачи.
status	pending, processing, exported или failed.
total	Число корректных входных значений.
success	Успешно обработанные значения.
failure	Ошибки обработки.
result_url	URL загрузки после экспорта.
actual_amount	Итоговая сумма, если доступна.
estimated_amount	Оценочная сумма при создании.

Коды состояния

Статус	Описание
200	Запрос выполнен.
202	Задача создана, применено оценочное списание.
400	Некорректный файл, неподдерживаемый тип или недостаточно записей.
401	API Key отсутствует или недействителен.
402	Недостаточный баланс.
404	Задача не найдена.
413	Файл слишком большой.
500	Внутренняя ошибка; повторите позже.

Эксплуатационные заметки

• Задача асинхронная; используйте ID для опроса.
• В минимум входят только корректные нормализованные номера.
• При сбое задачи средства возвращаются автоматически по правилам биллинга.