Валидация Email

Получить результаты валидации

Возвращает результаты проверки email для завершённой задачи в формате JSON или CSV.

Важно: результаты доступны только для задач в статусе completed. Для задач в других состояниях будет возвращена ошибка. Предварительно проверьте статус через GET /api/v1/tasks/:taskId.

Формат ответа:

  • json (по умолчанию) — массив объектов с полями email, validation_result и result (последнее — только если причина есть).
  • csv — текстовая строка из двух колонок: email,result.

Вердикт validation_result:

  • good — ящик существует и принимает почту
  • bad — ящик не существует или отверг проверку
  • unknown — доставляемость определить не удалось: нет MX-записей, MX-серверы недоступны, домен подозрителен или в чёрных списках
  • null — адрес ещё не проверен

Поле result — ответ сервера в формате SMTP-строки, свободный текст. Сравнивать на равенство нельзя, используйте validation_result либо GET /api/v1/tasks/:taskId/analytics.

Осторожно с CSV в этом эндпоинте: колонка называется result, но содержит вердикт (good/bad/unknown/pending), а не текст ответа сервера. Непроверенные адреса отдаются как pending. Если нужна причина — берите format=json или GET /api/v1/tasks/:taskId/results/csv с тремя колонками.

Совет: для скачивания файла используйте GET /api/v1/tasks/:taskId/results/csv (CSV-файл) или GET /api/v1/tasks/:taskId/download (ZIP из трёх файлов: good, bad, unknown).

get/api/v1/tasks/{taskId}/results

Request

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

Path parameters

taskIdnumber required
Example:123

Числовой идентификатор задачи

Query parameters

format'json' | 'csv'

Формат ответа. По умолчанию json. Формат csv возвращает данные как текстовую строку с заголовками.

limitnumber
Example:100

Только для json: вернуть не все строки, а страницу размером до 1000. В ответ добавятся total, limit, offset. Без параметра приходят все строки, как раньше.

offsetnumber

Смещение страницы при заданном limit. По умолчанию 0.

status'good' | 'bad' | 'unknown' | 'pending'

Только строки с этим вердиктом — как в колонке статуса: bad с маркером <risk> считается unknown.

reasonstring
Example:smtp_reject

Только строки с этой причиной отказа — ключ из reasons в GET /api/v1/tasks/:taskId/analytics. Выбирает ровно те строки, что посчитаны под этой причиной.

Response

Результаты валидации в запрошенном формате.

successboolean required

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

formatstring required

Формат данных в ответе

Example response

{
  "success": true,
  "format": "json",
  "data": [
    {
      "email": "user@example.com",
      "validation_result": "good",
      "result": "550-5.1.1 The email account is currently not functioning and is unable to receive messages."
    }
  ]
}

Changes

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