Проверка доставляемости почты API
Для каждой загрузки выберите тип задачи: email_check для проверки доставляемости или email_avatar для аватаров. Оба используют описанный ниже асинхронный пакетный процесс.
Проверка доставляемости (email_check)
Проверяет, активны ли адреса электронной почты и могут ли они получать письма. Поддерживаются только Gmail, Yandex, Mail.ru, iCloud, Outlook и Yahoo.
Проверка аватара (email_avatar)
Проверяет наличие публичного аватара у адреса электронной почты и возвращает его URL. Поддерживаются только Gmail, Yandex и Mail.ru.
Адреса вне перечисленных почтовых сервисов и поддерживаемых доменов-алиасов исключаются из обработки, результатов и оплаты.
Формат входных данных
Загрузите текстовый файл с одним поддерживаемым адресом электронной почты в строке.
user@gmail.comanother@yandex.comСоздание задачи
POST https://api.numberchecker.ai/v1/tasks
curl --location 'https://api.numberchecker.ai/v1/tasks' \--header 'X-API-Key: YOUR_API_KEY' \--form 'file=@"./input.txt"' \--form 'task_type="email_check"'Проверка аватара (email_avatar)
curl --location 'https://api.numberchecker.ai/v1/tasks' \--header 'X-API-Key: YOUR_API_KEY' \--form 'file=@"./input.txt"' \--form 'task_type="email_avatar"'API возвращает ID задачи. Сохраните его и используйте для проверки статуса.
Ответ при загрузке
{ "task_id": "d4g8o46p2jvh04o9uolg", "status": "pending", "total": 5000, "estimated_amount": { "amount": "0.500000", "currency": "USD" }, "message": "Task created successfully"}Проверка статуса задачи
POST https://api.numberchecker.ai/v1/gettasks
curl --location 'https://api.numberchecker.ai/v1/gettasks' \--header 'X-API-Key: YOUR_API_KEY' \--form 'task_id="d4g8o46p2jvh04o9uolg"'Проверяйте статус, пока status не станет exported. Значения pending и processing не означают завершение.
Ответ при обработке
{ "task_id": "d4g8o46p2jvh04o9uolg", "status": "processing", "total": 5000, "success": 2500, "failure": 0}Экспортированный ответ
{ "task_id": "d4g8o46p2jvh04o9uolg", "status": "exported", "total": 5000, "success": 5000, "failure": 0, "result_url": "https://example-link-to-results.zip", "actual_amount": { "amount": "2.000000", "currency": "USD" }}Поля результата
Проверка доставляемости (email_check)
| Поле | Описание | Пример |
|---|---|---|
email | Адрес электронной почты из переданного файла. | user@gmail.com |
activated | Показывает, был ли вход активным или зарегистрированным. | yes |
Проверка аватара (email_avatar)
| Поле | Описание | Пример |
|---|---|---|
email | Входной адрес электронной почты из отправленного файла. | user@gmail.com |
activated | Есть ли у адреса публичный аватар. | yes |
avatar | Ссылка на изображение аватара, если есть; пусто при стандартной заглушке. | https://… |
name | Отображаемое имя, если провайдер его раскрывает; иначе пусто. | John Doe |
Обработка файла результата
Скачивайте файл по result_url только после экспорта задачи. Сохраняйте имена возвращённых столбцов при дальнейшей обработке.
Поля ответа
| Поле | Описание |
|---|---|
created_at | Время создания задачи. |
updated_at | Время последнего обновления статуса. |
task_id | Уникальный идентификатор задачи. |
status | pending, processing, exported или failed. |
total | Общее число обработанных входных значений. |
success | Успешно обработанные значения. |
failure | Значения, обработка которых завершилась ошибкой. |
result_url | URL для скачивания после экспорта задачи. |
actual_amount | Итоговая сумма, если доступна. |
estimated_amount | Расчётная сумма, возвращаемая при создании задачи. |
Коды состояния
| Status | Описание |
|---|---|
200 | Запрос выполнен успешно. |
202 | Задача создана успешно, применена предварительная стоимость. |
400 | Недопустимый файл, неподдерживаемый тип задачи или слишком мало корректных записей. |
401 | API-ключ отсутствует или недействителен. |
402 | Недостаточно средств на счёте. |
403 | Продукт недоступен для вашего аккаунта (снят с продажи или доступен только по белому списку); обратитесь в поддержку. |
404 | Задача не найдена. |
413 | Загруженный файл слишком велик. |
500 | Внутренняя ошибка сервера; повторите попытку позже. |
503 | Продукт временно недоступен (приостановлен на обслуживание); средства не списываются, повторите попытку позже. |
Рабочие примечания
- Задача выполняется асинхронно; используйте ID задачи для проверки статуса.
- Перед загрузкой проверьте ограничения продукта на входные данные.
- Ошибочные строки указаны в экспортированном результате и отражены в счётчиках задачи.
- Поля выше основаны на текущем live sample и могут измениться при изменении схемы экспорта.