Валидация Email

Получить статус и прогресс задачи

Возвращает текущее состояние задачи валидации, включая прогресс обработки в процентах.

Когда использовать: Вызывайте этот эндпоинт для отслеживания прогресса задачи перед получением результатов. Результаты доступны только для задач в статусе completed.

Рекомендуемый polling-паттерн:

  1. Отправьте запрос на валидацию (POST /api/v1/validate/single или /bulk).
  2. Запрашивайте статус каждые 5–10 секунд.
  3. Когда status станет completed — вызовите GET /api/v1/tasks/:taskId/results.

Состояния задачи:

  • pending — задача в очереди, обработка не начата
  • processing — идёт проверка, поле progress_percent показывает прогресс (0–100)
  • completed — все email проверены, результаты доступны
  • failed — произошла ошибка (обратитесь в поддержку с task_id)

Безопасность: задача доступна только владельцу аккаунта, создавшему её.

get/api/v1/tasks/{taskId}

Request

  • Base URL: https://api.uchecker.net
  • URL: https://api.uchecker.net/api/v1/tasks/{taskId}
  • Auth: one of:
    • HTTP bearer
    • API key in header x-api-key

Path parameters

taskIdnumber required
Example:123

Числовой идентификатор задачи, полученный при создании через POST /api/v1/validate/single или /bulk

Response

Текущий статус задачи с информацией о прогрессе.

successboolean required

Признак успешного выполнения запроса

task_idnumber required

Идентификатор задачи

status'pending' | 'processing' | 'completed' | 'failed' required

Текущее состояние задачи: pending (ожидает), processing (обрабатывается), completed (завершена), failed (ошибка)

total_emailsnumber required

Общее количество email-адресов в задаче

processed_emailsnumber required

Количество уже проверенных email-адресов

progress_percentnumber required

Прогресс выполнения в процентах (0–100). Используйте для отображения прогресс-бара.

created_atstring date-time required

Дата и время создания задачи. Формат ISO 8601.

finished_atstring date-time nullable required

Дата и время завершения задачи. null, если задача ещё выполняется. Формат ISO 8601.

Example response

{
  "success": true,
  "task_id": 123,
  "status": "processing",
  "total_emails": 100,
  "processed_emails": 45,
  "progress_percent": 45,
  "created_at": "2024-01-01T12:00:00.000Z"
}

Changes

No recorded changes to this operation across all 1 revision of this API.