Получить отчет о возвратах

Описание

Получить отчет о возвратах писем от 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 домену

Пример запроса

JSON

{
    "token": "abcdefghijklmnqrstuvwxyz",
    "campaign_id": 116,
    "date_from": "2024-04-26",
    "date_to": "2024-05-01",
    "format": "json",
    "top": 2
}

XML

<xml>
    <token>abcdefghijklmnqrstuvwxyz</token>
    <campaign_id>116</campaign_id>
    <date_from>2024-04-26</date_from>
    <date_to>2024-05-01</date_to>
    <format>xml</format>
    <top>2</top>
</xml>

Пример ответа

JSON

{
    "data": [
        {
            "data_id": "",
            "count": 3,
            "bounce_text": "Your message was not delivered because the other user mailbox was not available",
            "to_domain": "example.com"
        },
        {
            "data_id": "",
            "count": 3,
            "bounce_text": "This response is sent when the message simply failed. Often times this is not caused by you, but rather because of a far-end server problem",
            "to_domain": "jetwire.name"
        }
    ],
    "error": 0,
    "error_text": "Successful operation"
}

XML

<xml>
    <error>0</error>
    <error_text>Successful operation</error_text>
    <data>
        <data_id></data_id>
        <count>3</count>
        <bounce_text>Your message was not delivered because the other user mailbox was not available</bounce_text>
        <to_domain>example.com</to_domain>
    </data>
    <data>
        <data_id></data_id>
        <count>3</count>
        <bounce_text>This response is sent when the message simply failed. Often times this is not caused by you, but rather because of a far-end server problem</bounce_text>
        <to_domain>jetwire.name</to_domain>
    </data>
</xml>

Возвращаемые параметры

Параметр	Тип	Описание
error	int	Код ошибки
error_text	string	Текст ошибки
bounce_text	string	Ответ почтового сервера
count	int	Количество ответов почтового сервера
data_id	string	Идентификатор данных
to_domain	string	Домен