Аккаунт
Выйти

Обзор

Интеграции

Руководство пользователя

Справочник API

Вебхуки

API возвратов

Позволяет получить доступ ко всем отчетам о ваших отклоненных письмах для конкретного сервера. Информация об отклоненных письмах доступна в течение периода хранения, который по умолчанию составляет 45 дней.

Получение статистики по доставке #

get

/deliverystats

Заголовки запроса

Accept обязательный

application/json
X-Haskimail-Server-Token обязательный

Для этого запроса требуются права доступа на уровне сервера. Этот токен можно найти в настройках вашего сервера Haskimail на вкладке «Токены API».

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

curl "https://api.haskimail.ru/deliverystats" \
  -X GET \
  -H "Accept: application/json" \
  -H "X-Haskimail-Server-Token: server token"

Ответ

InactiveMails integer

Количество неактивных email-адресов.
Bounces array

Список типов отклоненных писем с общим количеством по каждому типу.

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

HTTP/1.1 200 OK
Content-Type: application/json

{
  
  "Bounces": [
    {
      "Name": "All",
      "Count": 253
    },
    {
      "Type": "HardBounce",
      "Name": "Hard bounce",
      "Count": 195
    },
    {
      "Type": "BulkBounce",
      "Name": "Bulk Bounce",
      "Count": 10
    },
    {
      "Type": "SoftBounce",
      "Name": "Soft bounce",
      "Count": 30
    },
    {
      "Type": "SpamBlock",
      "Name": "Spam Block",
      "Count": 1
    }
  ]
}

Получение списка возвратов #

get

/bounces

Поиск по отклоненным письмам позволяет получить до 10 000 записей за один запрос. Если вам нужно получить больше, используйте параметры, такие как todate и fromdate, для фильтрации результатов.

Заголовки запроса

Accept обязательный

application/json
X-Haskimail-Server-Token обязательный

Для этого запроса требуются права доступа на уровне сервера. Этот токен можно найти в настройках вашего сервера Haskimail на вкладке «Токены API».

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

curl "https://api.haskimail.ru/bounces?type=HardBounce&inactive=true&count=50&offset=0" \
  -X GET \
  -H "Accept: application/json" \
  -H "X-Haskimail-Server-Token: server token"

Параметры строки запроса (Querystring)

count обязательный

Количество отклоненных писем для возврата в одном запросе. Максимум 500. Сумма count и offset не может превышать 10 000.
offset обязательный

Количество отклоненных писем, которые нужно пропустить. Сумма count и offset не может превышать 10 000.
type

Фильтровать по типу отклоненного письма
emailFilter

Фильтровать по email-адресу
tag

Фильтровать по тегу
messageID

Фильтровать по ID сообщения (messageID).
fromdate

Фильтровать сообщения, начиная с указанной даты/времени (включительно) по МСК. Например: YYYY-MM-DD HH:MM:SS.
todate

Фильтровать сообщения до указанной даты/времени (включительно) по МСК. Например: YYYY-MM-DD HH:MM:SS.
messagestream

Фильтровать по ID канала. Если не указано, по умолчанию будет использован исходящий транзакционный канал.

Ответ

TotalCount integer

Количество возвращенных записей.
Bounces array

Список отдельных возвратов.
RecordType string

Тип записи
ID integer

ID возврата.
Type string

Тип возврата
TypeCode integer

Код возврата
Name string

Название возврата
Tag string

Название тега
MessageID string

ID сообщения
ServerID string

ID сервера, отправившего сообщение
MessageStream string

Исходящий канал, использованный для отправки сообщения.
Description string

Описание возврата
Email string

Email-адрес, с которого произошел возврат
BouncedAt string

TВременная метка возврата
Subject string

Тема письма

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

HTTP/1.1 200 OK
Content-Type: application/json

{
  "TotalCount": 253,
  "Bounces": [
    {
      "RecordType": "Bounce",
      "ID": 692560173,
      "Type": "HardBounce",
      "TypeCode": 1,
      "Name": "Hard bounce",
      "Tag": "Invitation",
      "MessageID": "2c1b63fe-43f2-4db5-91b0-8bdfa44a9316",
      "ServerID": 23,
      "MessageStream": "outbound",
      "Description": "The server was unable to deliver your message (ex: unknown user, mailbox not found).",
      
      "Email": "anything@blackhole.haskimail.ru",
      
      "BouncedAt": "2014-01-15T16:09:19Z",
      
      "Subject": "SC API5 Test"
    },
    {
      "RecordType": "Bounce",
      "ID": 676862817,
      "Type": "HardBounce",
      "TypeCode": 1,
      "Name": "Hard bounce",
      "Tag": "Invitation",
      "MessageID": "623b2e90-82d0-4050-ae9e-2c3a734ba091",
      "ServerID": 23,
      "MessageStream": "outbound",
      "Description": "The server was unable to deliver your message (ex: unknown user, mailbox not found).",
      
      "Email": "vicelcown@yahoo.com",
      
      "BouncedAt": "2013-10-18T09:49:59Z",
      
      "Subject": "Production API Test"
    }
  ]
}

Получение информации о конкретном возврате #

get

/bounces/{bounceid}

Заголовки запроса

Accept обязательный

application/json
X-Haskimail-Server-Token обязательный

Для этого запроса требуются права доступа на уровне сервера. Этот токен можно найти в настройках вашего сервера Haskimail на вкладке «Токены API».

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

curl "https://api.haskimail.ru/bounces/{bounceid}" \
  -X GET \
  -H "Accept: application/json" \
  -H "X-Haskimail-Server-Token: server token"

Ответ

ID integer

ID возврата
Type string

Тип возврата
TypeCode integer

Код возврата
Name string

Название возврата
Tag string

Название тега
MessageID string

ID сообщения
ServerID string

ID сервера, отправившего сообщение.
MessageStream string

Исходящий канал, использованный для отправки сообщения.
Description string

Описание возврата
Email string

Email-адрес, с которого произошел возврат.
BouncedAt string

Временная метка возврата
Subject string

Тема письма

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

HTTP/1.1 200 OK
Content-Type: application/json

{
  "ID": 692560173,
  "Type": "HardBounce",
  "TypeCode": 1,
  "Name": "Hard bounce",
  "Tag": "Invitation",
  "MessageID": "2c1b63fe-43f2-4db5-91b0-8bdfa44a9316",
  "ServerID": 23,
  "MessageStream": "outbound",
  "Description": "The server was unable to deliver your message (ex: unknown user, mailbox not found).",
  
  "Email": "anything@blackhole.haskimail.ru",
  
  "BouncedAt": "2014-01-15T16:09:19.6421112-05:00",
  
  "Subject": "SC API5 Test",
  
}

Активация возврата #

put

/bounces/{bounceid}/activate

Заголовки запроса

Content-Type обязательный

application/json
Accept обязательный

application/json
X-Haskimail-Server-Token обязательный

Для этого запроса требуются права доступа на уровне сервера. Этот токен можно найти в настройках вашего сервера Haskimail на вкладке «Токены API».

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

curl "https://api.haskimail.ru/bounces/{bounceid}/activate" \
  -X PUT \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -H "X-Haskimail-Server-Token: server token" \
  -d ""

Ответ

Message string

Сообщение ответа.
Bounce object

Детали возврата
ID integer

ID возврата
Type string

Тип возврата
TypeCode integer

Код возврата
Name string

Название возврата
Tag string

Название тега
MessageID string

ID сообщения
ServerID string

ID сервера, отправившего сообщение.
MessageStream string

Исходящий канал, использованный для отправки сообщения.
Description string

Описание возврата
Email string

Email-адрес, с которого произошел возврат
BouncedAt string

Временная метка возврата
Subject string

Тема письма

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

HTTP/1.1 200 OK
Content-Type: application/json

{
  "Message": "OK",
  "Bounce": {
    "ID": 692560173,
    "Type": "HardBounce",
    "TypeCode": 1,
    "Name": "Hard bounce",
    "Tag": "Invitation",
    "MessageID": "2c1b63fe-43f2-4db5-91b0-8bdfa44a9316",
    "ServerID": 23,
    "MessageStream": "outbound",
    "Description": "The server was unable to deliver your message (ex: unknown user, mailbox not found).",
    
    "Email": "anything@blackhole.haskimail.ru",
    
    "BouncedAt": "2014-01-15T16:09:19.6421112-05:00",
    
    "Subject": "SC API5 Test",
    
  }
}