Получить информацию об ошибках доставки

/v2/Api/Bounces GET

Этот метод возвращает CSV файл со списком ошибок доставки за определенный период. Список включает в себя дату ошибки, email, код ошибки.

Формат запроса

Параметры запроса:

Параметр	Тип	Описание
apiKey	string	Ваш API-key, необходимый для авторизации. Обязательный.
startDate	date	Начальная дата отчета
endDate	date	Конечная дата отчета

Примеры:

https://api.esv2.com/v2/Api/Bounces?apiKey=YOUR_API_KEY_HERE&startDate=2010-05-20&endDate=2010-05-22

Ответ

Ответ для этого метода данные в формате CSV, а не в XML потому, что объем возвращаемых данных может быть очень большим. CSV ответ минимизирует затраты ресурсов и позволяет безболезненно проводить интеграцию с со сторонним кодом/системой. Content-type ответа — «text/csv». Данные содержат строку заголовков. CSV формируется, используя следующие настройки:

разделитель полей: запятая (,)
ограничитель: двойная кавычка (")
экранирующий символ: двойная кавычка (")
кодировка: UTF-8

Столбцы CSV ответа.

Name	Type	Notes
Date	datetime	Дата ошибки доставки в формате YYYY-MM-DD HH:MM:SS.
Email	string	Email с ошибкой доставки
BounceCode	string	Код ошибки доставки описывающий eё тип.
BounceType	string	Тип ошибки. Все типы ошибок описаны ниже.

Типы ошибок (Одно из этих значений будет в столбце BounceType в CSV ответе)

Название	Описание
UserUnknown	Email не существует.
MailboxFull	Ящик переполнен или временно недоступен.
Blocked	Письмо заблокировано, по причине связанной со спамом.
OutOfOffice	Почтовый ящик вернул сообщение автоответчика "out of office".
Unknown	Неизвестная причина, которая не может быть классифицирована.
Other	Иная причина ошибки доставки. Эта категория включает в себя проблемы связанные с ошибками передачи данных, ошибками почтовых серверов и т.п.

Примеры

Получение нескольких писем

Запрос:

GET https://api.esv2.com/v2/Api/Bounces?apiKey=Ваш_API-ключ&startDate=2010-10-01&endDate=2010-10-02 HTTP/1.1 
Accept-Encoding: gzip,deflate 
User-Agent: Jakarta Commons-HttpClient/3.1 
Host: api.esv2.com

Ответ:

HTTP/1.1 200 OK 
Cache-Control: private 
Content-Type: text/csv; charset=utf-8 
Server: Microsoft-IIS/7.5 
X-AspNetMvc-Version: 2.0 
X-AspNet-Version: 2.0.50727 
Set-Cookie: TIMEZONE=Central European Standard Time; path=/ 
X-Powered-By: ASP.NET 
Date: Thu, 08 Dec 2011 12:02:14 GMT 
Content-Length: 463  
 
Date,Email,BounceCode,BounceType
2010-10-01 17:10:00,test1@yahoo.com,some test bounce code,UserUnknown 
2010-10-01 17:10:00,test2@yahoo.com,some test bounce code,MailboxFull 
2010-10-01 17:11:00,test3@yahoo.com,some test bounce code,Blocked 
2010-10-01 17:11:00,test4@yahoo.com,some test bounce code,OutOfOffice 
2010-10-01 17:12:00,test5@yahoo.com,some test bounce code,Unknown
2010-10-01 19:20:00,john.doe@gmail.com,some test bounce code,Other

Методы API - меню