×

Получите 5 готовых email-стратегий для любого бизнеса БЕСПЛАТНО!

После регистрации

меню
Generic selectors
Exact matches only
Search in title
Search in content
Search in posts
Search in pages

Метод checkEmail

Метод позволяет проверить статус доставки email-сообщений, отправленных методом sendEmail.

Для ускорения работы метода sendEmail статусы доставки хранятся ограниченное время – только один месяц.

Принцип использования

Синтаксис и URL для вызова метода
checkEmail (string email_id)
https://api.unisender.com/ru/api/checkEmail?format=json&api_key=KEY&email_id=ID1,ID2,ID3
АргументыОписание
api_key *Ключ доступа к API.
email_id *Код сообщения, возвращённый методом sendEmail. Возможно указание до 500 кодов email через запятую.
Возвращаемое значение
JSON-объект с массивом statuses, каждый из элементов которого — объект с двумя полями: поле «id» с кодом сообщения и поле «status» со статусом этого сообщения.
Если был запрошен один код сообщения, то в целях обратной совместимости на одном уровне с массивом statuses присутствует ещё и одиночное поле status, значение которого совпадает со значением поля status первого (и единственного в этом случае) элемента массива statuses.
Возможные значения поля status описаны ниже. В будущем вероятно появление новых значений, но будет соблюдаться принцип: если статус начинается с err_ – значит, доставка не удалась. Если с ok_ – то доставка ещё идёт или удачно завершена. Исключение – статус ‘not_sent’.
Поскольку мы не сохраняем полный текст всех писем, отправляемых через API sendEmail, для некоторых результатов отправки вам может понадобиться переотправить письмо. В частности, это результат err_lost.
not_sentСообщение еще не было обработано.
ok_sentСообщение было отправлено, промежуточный статус до получения ответа о доставке/недоставке.
ok_deliveredСообщение доставлено. Может измениться на ‘ok_read’, ‘ok_link_visited’, ‘ok_unsubscribed’ или ‘ok_spam_folder’.
ok_readСообщение доставлено и зарегистрировано его прочтение. Может измениться на ‘ok_link_visited’, ‘ok_unsubscribed’ или ‘ok_spam_folder’.
ok_fblСообщение доставлено, но помещено в папку «спам» получателем.
ok_link_visitedСообщение доставлено, прочитано и выполнен переход по одной из ссылок. Может измениться на ‘ok_unsubscribed’ или ‘ok_spam_folder’.
ok_unsubscribedСообщение доставлено и прочитано, но пользователь отписался по ссылке в письме. Статус окончательный.
err_blacklistedСообщение отвергнуто из-за блеклистинга. Будет переотправлено.
err_will_retryОдна или несколько попыток доставки оказались неудачными, но попытки продолжаются. Статус неокончательный.
err_resendФактически эквивалентен err_will_retry, с некоторыми несущественными внутренними особенностями.
err_internalВнутренний сбой. Необходима переотправка письма. Статус окончательный.
err_user_unknownАдрес не существует, доставка не удалась. Статус окончательный.
err_user_inactiveАдрес когда-то существовал, но сейчас отключен. Доставка не удалась. Статус окончательный.
err_mailbox_discardedПочтовый ящик получателя удален. Статус окончательный.
err_mailbox_fullПочтовый ящик получателя переполнен. Статус окончательный.
err_no_dnsНет записи или некорректная запись в DNS.
err_no_smtpЗапись в DNS есть, но smtp сервер отсутствует.
err_domain_inactiveДомен не принимает почту или не существует. Статус окончательный.
err_destination_misconfiguredДомен не принимает почту из-за неверной настройки на стороне получателя, причем ответ сервера содержит информацию об устранимой причине (например, используется неработающий блеклист и т. п.)
err_spam_rejectedПисьмо отклонено сервером как спам.
err_too_largeПисьмо превышает допустимый размер по данным сервера получателя. Также причиной может быть отклонение письма сервером получателя из-за непринимаемого типа вложения. Например, .exe.
err_giveupВ этот статус переводятся сообщения из статусов err_will_retry, err_resend после истечения срока повторных попыток.
err_spam_removedОтправка отменена из-за блокировки рассылки как спама. Статус неокончательный, может быть изменён на not_sent, delayed или err_spam_may_retry после переговоров с почтовой службой получателя.
err_spam_may_retryЭквивалент err_spam_rejected, но вы можете переотправить сообщение путём генерации нового такого же письма.
ok_spam_folderПисьмо доставлено, но сервер получателя поместил его в папку «Спам». Статус окончательный.
err_delivery_failedДоставка не удалась по иным причинам. Статус окончательный.
err_will_retryОдна или несколько попыток доставки оказались неудачными, но попытки продолжаются. Статус неокончательный.
err_skip_letterОтправка отменена, так как email адрес недоступен (кроме случаев err_unsubscribed и err_not_allowed).
err_spam_skippedОтправка отменена из-за блокировки рассылки как спама. Результат неокончательный, может быть изменён на not_sent, delayed или err_spam_may_retry после переговоров с почтовой службой получателя.
err_unsubscribedОтправка не выполнялась, т.к. адрес, по которому пытались отправить письмо, ранее отписался. Вы можете пометить этот адрес как отписавшийся и в своей базе данных и больше не отправлять на него. Статус окончательный.
err_src_invalidНеправильный адрес отправителя. Используется, если «невалидность email-а отправителя» обнаружилась не на стадии приёма задания и проверки параметров, а на более поздней стадии, когда осуществляется детальная проверка того, что нужно отправить. Статус окончательный.
err_dest_invalidНеправильный адрес получателя. Используется, если «невалидность email-а получателя» обнаружилась не на стадии приёма задания и проверки параметров, а на более поздней стадии, когда осуществляется подробная проверка того, что нужно отправить. Статус окончательный.
err_not_allowedОтправка отменена, так как сотрудники технической поддержки заблокировали рассылку или же из-за заблокированного адреса получателя или блокировки вашего аккаунта. Статус окончательный.
err_over_quotaОтправка отменена, из-за нехватки средств на счету или из-за превышений по тарифу.
err_not_availableАдрес, по которому вы пытались отправить письмо, не является доступным (т.е. ранее отправки на него приводили к ответу от сервера вида  «адрес не существует» или «блокировка по спаму») Доступность адреса теоретически может быть восстановлена через несколько дней или недель, поэтому можно его не вычёркивать полностью из списка потенциальных адресатов. Статус окончательный.
err_unreachableОтправка отменена, так как адрес недоступен, но, в отличие от статуса err_not_available, доступность адресу возвращена не будет. Статус окончательный.
err_lostПисьмо не было отправлено из-за несогласованности его частей (например, в теле письма передается ссылка на изображение во вложениях, но само изображение во вложениях не передано), или было утеряно из-за сбоя на нашей стороне. Отправитель должен переотправить письмо самостоятельно, т.к. оригинал не сохранился. Статус окончательный.
skip_dup_unreachableАдрес недоступен, отправка не удалась. Статус окончательный.
skip_dup_temp_unreachableАдрес временно недоступен. Отправка не удалась. Статус окончательный.
skip_dup_mailbox_fullПочтовый ящик получателя переполнен. Статус окончательный.
Пример возвращаемого значения:

{
  "result": {
    "statuses": [
      {
        "id": "8219732882",
        "status": "not_sent"
      },
      {
        "id": "8269722886",
        "status": "ok_delivered"
      },
      {
        "id": "8219722800",
        "status": "err_unsubscribed"
      }
    ]
  },
  "failed_email_id": [
    {
      "23": "email_id does not exist"
    },
    {
      "573405639": "passed email_id doesn't match passed api_key"
    }
  ]
}