Получить отчет о возвратах
Описание
Получить отчет о возвратах писем от email-провайдеров.
Провайдер выражает сигнал о возврате письма, отвечая на него ошибкой с кодом от 400 до 499.
URL-адрес
Метод: POST
https://example.com/api/v1.1/reports/bounces
Параметры запроса
Параметр | Тип | Пример | Обязательный | Описание |
---|---|---|---|---|
token | string | "abcdefghijklmnqrstuvwxyz" | Да | API токен |
format | string | "json" | Нет | Формат возвращаемых данных по умолчанию – "json" |
date_from | string | "2018-08-10" | Да | Начало временного диапазона |
date_to | string | "2018-08-15" | Да | Конец временного диапазона |
campaign_id | int | 1 | Нет | Идентификатор кампании |
group_by | string | "from_domain" | Нет | Группировать по ... |
top | int | 2 | Нет | Выбрать X наиболее частых возвратов |
Возможные значения параметра group_by
:
ip
– группировать по IP-адресу сендераfrom_domain
– группировать по from домену
Пример запроса
{
"campaign_id": 1,
"date_from": "2018-08-10",
"date_to": "2018-08-15",
"format": "json",
"token": "abcdefghijklmnqrstuvwxyz",
"top": 2
}
Пример ответа
{
"data": [
{
"bounce_text": "403 Softbounce.",
"count": 5,
"data_id": "",
"to_domain": "softbounce.report.net"
},
{
"bounce_text": "409 Server on the maintenance.",
"count": 5,
"data_id": "",
"to_domain": "softbounce.report.net"
}
],
"error": 0,
"error_text": "Successful operation"
}
Возвращаемые параметры
Параметр | Тип | Описание |
---|---|---|
error | int | Код ошибки |
error_text | string | Текст ошибки |
bounce_text | string | Ответ почтового сервера |
count | int | Количество ответов почтового сервера |
data_id | string | Идентификатор данных |
to_domain | string | Домен |