API Сообщений

Позволяет получить подробную информацию о любом исходящем или входящем сообщении, отправленном или полученном через определенный сервер. Сообщения удаляются по истечении периода хранения, который по умолчанию составляет 45 дней (но может быть настроен в диапазоне от 7 до 365 дней).

Поиск писем #

get

/messages/outbound

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

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

Accept	обязательный application/json
X-Haskimail-Server-Token	обязательный Для этого запроса требуются права доступа на уровне сервера. Этот токен можно найти в настройках вашего сервера Haskimail на вкладке «Токены API».

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

curl "https://api.haskimail.ru/messages/outbound?recipient=john.doe@yahoo.com&count=50&offset=0&tag=welcome&status=sent&todate=2015-01-12&fromdate=2015-01-01" \
  -X GET \
  -H "Accept: application/json" \
  -H "X-Haskimail-Server-Token: server token"

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

count	обязательный Количество сообщений, возвращаемых в одном запросе. Макс. 500. Сумма count и offset не может превышать 10 000.
offset	обязательный Количество сообщений, которое нужно пропустить. Сумма count и offset не может превышать 10 000.
recipient	Фильтровать по получателю письма.
fromemail	Фильтровать по email-адресу отправителя.
tag	Фильтровать по тегу.
status	Фильтровать по статусу (`queued` или `sent` / `processed`). Обратите внимание, что `sent` и `processed` возвращают одинаковые результаты и могут использоваться взаимозаменяемо.
todate	Фильтровать сообщения до указанной даты/времени (включительно). Например, 2021-01-01T12:00:00. Наш API использует время МСК.
fromdate	Фильтровать сообщения начиная с указанной даты/времени (включительно). Например, 2021-01-01T12:00:00. Наш API использует время МСК.
subject	Фильтровать по теме письма.
messagestream	Фильтровать по ID канала. Если не указан, по умолчанию будет использоваться исходящий транзакционный канал 'outbound'.
metadata_	Фильтровать по значению метаданных. Например, metadata_color. В настоящее время поиск возможен только по одному полю метаданных за раз.

Ответ

TotalCount	integer	Указывает количество сообщений, соответствующих указанным вами критериям поиска. Письмо, отправленное нескольким получателям, считается за 1 сообщение в API Сообщений, поэтому `TotalCount` будет меньше общего числа отправленных писем, если некоторые сообщения были отправлены нескольким получателям. На странице Статистики в интерфейсе Haskimail сообщение, отправленное нескольким получателям, засчитывается один раз для каждого получателя, поэтому число «Отправлено» на странице Статистики отражает общее количество отправленных писем. Это обеспечивает точное отслеживание открытий, кликов по ссылкам и т. д.
Messages	array	Список объектов, каждый из которых представляет одно сообщение.

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

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

{
  "TotalCount": 194,
  "Messages": [
    {
      "Tag": "Invitation",
      "MessageID": "0ac29aee-e1cd-480d-b08d-4f48548ff48d",
      "MessageStream": "outbound",
      "To": [
        {
          "Email": "john.doe@yahoo.com",
          "Name": null
        }
      ],
      "Cc": [],
      "Bcc": [],
      "Recipients": [
        "john.doe@yahoo.com"
      ],
      "ReceivedAt": "2014-02-20T07:25:02.8782715-05:00",
      "From": "\"Joe\" <joe@domain.com>",
      "Subject": "staging",
      "Attachments": [],
      "Status": "Sent",
      "TrackOpens" : true,
      "TrackLinks" : "HtmlAndText",
      "Metadata": {
      "color": "blue",
      "client-id": "12345"
      },
      "Sandboxed": false
    }
  ]
}

Детали письма #

get

/messages/outbound/{messageid}/details

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

Accept	обязательный application/json
X-Haskimail-Server-Token	обязательный Для этого запроса требуются права доступа на уровне сервера. Этот токен можно найти в настройках вашего сервера Haskimail на вкладке «Токены API».

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

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

Ответ

TextBody	string	Текстовая часть сообщения.
HtmlBody	string	HTML часть сообщения.
Body	string	Необработанный исходный код сообщения.
Tag	string	Теги, связанные с этим сообщением.
MessageID	string	Уникальный ID сообщения.
MessageStream	string	Исходящий канал, использованный для отправки сообщения.
To	string	Список объектов, содержащих получателей из поля "To".
Cc	string	Список объектов, содержащих получателей из поля "Cc".
Bcc	string	Список объектов, содержащих получателей из поля "Bcc".
Recipients	string	Список получателей.
ReceivedAt	string	Временная метка отправки сообщения сервисом Haskimail. Соответствует событию «Обработано» (Processed) в интерфейсе.
From	string	Email-адрес отправителя.
Subject	string	Тема письма.
Attachments	array	Список объектов, каждый из которых представляет вложение.
Status	string	Статус сообщения в вашей Активности Haskimail. Возможные статусы: `Sent`, `Processed`, or `Queued`.
TrackOpens	boolean	Указывает, было ли включено отслеживание открытий для этого сообщения.
TrackLinks	string	Указывает, было ли включено отслеживание ссылок для этого сообщения. Возможные значения: `None` `HtmlAndText` `HtmlOnly` `TextOnly`
Metadata	array	Пары метаданных ключ/значение. В настоящее время поиск возможен только по одному полю метаданных за раз.
Sandboxed	boolean	Указывает, было ли сообщение отправлено в режиме песочницы. Определяется типом Сервера.
MessageEvents	array	Список сводок (MessageEvent) о событиях, произошедших с этим сообщением. Типы событий, указанные в поле type, могут быть:`SubscriptionChanged`, `Delivered`, `Transient`, `Opened`, `LinkClicked`, или `Bounced`.

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

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

{
  "TextBody": "Thank you for your order...",
  "HtmlBody": "<p>Thank you for your order...</p>",
  "Body": "SMTP dump data",
  "Tag": "product-orders",
  "MessageID": "07311c54-0687-4ab9-b034-b54b5bad88ba",
  "MessageStream": "outbound",
  "To": [
    {
      "Email": "john.doe@yahoo.com",
      "Name": null
    }
  ],
  "Cc": [],
  "Bcc": [],
  "Recipients": [
    "john.doe@yahoo.com"
  ],
  "ReceivedAt": "2014-02-14T11:12:54.8054242-05:00",
  "From": "\"Joe\" <joe@domain.com>",
  "Subject": "Parts Order #5454",
  "Attachments": [
      "myimage.png",
      "mypaper.doc"
  ],
  "Status": "Sent",
  "TrackOpens" : true,
  "TrackLinks" : "HtmlOnly",
  "Metadata": {
    "color": "blue",
    "client-id": "12345"
  },
  "Sandboxed": false,
  "MessageEvents": [
    {
      "Recipient": "john.doe@yahoo.com",
      "Type": "Delivered",
      "ReceivedAt": "2014-02-14T11:13:10.8054242-05:00",
      "Details": {
        "DeliveryMessage": "smtp;250 2.0.0 OK l10si21599969igu.63 - gsmtp",
        "DestinationServer": "yahoo-smtp-in.l.yahoo.com (433.899.888.26)",
        "DestinationIP": "173.194.74.256"
      }
    },
    {
      "Recipient": "john.doe@yahoo.com",
      "Type": "Transient",
      "ReceivedAt": "2014-02-14T11:12:10.8054242-05:00",
      "Details": {
        "DeliveryMessage": "smtp;400 Server cannot accept messages at this time, please try again later",
        "DestinationServer": "yahoo-smtp-in.l.yahoo.com (433.899.888.26)",
        "DestinationIP": "173.194.74.256"
      }
    },
    {
      "Recipient": "john.doe@yahoo.com",
      "Type": "Opened",
      "ReceivedAt": "2014-02-14T11:20:10.8054242-05:00",
      "Details": {
        "Summary": "Email opened with Mozilla/5.0 (Windows NT 5.1; rv:11.0) Gecko Firefox/11.0 (via ggpht.com GoogleImageProxy)"
      }
    },
    {
      "Recipient": "badrecipient@example.com",
      "Type": "Bounced",
      "ReceivedAt": "2014-02-14T11:20:15.8054242-05:00",
      "Details": {
        "Summary": "smtp;550 5.1.1 The email account that you tried to reach does not exist. Please try double-checking the recipient's email address for typos or unnecessary spaces.",
        "BounceID": "374814878"
      }
    },
    {
      "Recipient": "badrecipient@example.com",
      "Type": "SubscriptionChanged",
      "ReceivedAt": "2014-02-14T11:21:15.8054242-05:00",
      "Details": {
        "Origin": "Recipient",
        "SuppressSending": "True"
      }
    },
    {
      "Recipient":"click-tracked@example.com",
      "Type":"LinkClicked",
      "ReceivedAt":"2016-10-05T16:03:56.0000000-04:00",
      "Details":{
        "Summary":"Tracked Link 'https://example.com/a/path/to/the/future?queryValue=1&queryValue=2' was clicked from the HTMLBody.",
        "Link":"https://example.com/a/path/to/the/future?queryValue=1&queryValue=2",
        "ClickLocation":"HTML"
      }
    }
  ]
}

Дамп исходящего сообщения #

get

/messages/outbound/{messageid}/dump

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

Accept	обязательный application/json
X-Haskimail-Server-Token	обязательный Для этого запроса требуются права доступа на уровне сервера. Этот токен можно найти в настройках вашего сервера Haskimail на вкладке «Токены API».

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

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

Ответ

Body	string	Необработанный исходный код сообщения. Если дамп недоступен, будет возвращена пустая строка.

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

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

{
  "Body": "From: \"John Doe\" <john.doe@yahoo.com> \r\nTo: \"john.doe@yahoo.com\" <john.doe@yahoo.com>\r\nReply-To: joe@domain.com\r\nDate: Fri, 14 Feb 2014 11:12:56 -0500\r\nSubject: Parts Order #5454\r\nMIME-Version: 1.0\r\nContent-Type: text/plain; charset=UTF-8\r\nContent-Transfer-Encoding: quoted-printable\r\nX-Mailer: aspNetEmail ver 4.0.0.22\r\nX-Job: 44013_34141\r\nX-virtual-MTA: shared1\r\nX-Complaints-To: abuse@haskimail.ru\r\nX-PM-RCPT: |bTB8NDQwMTN8MzQxNDF8anBAd2lsZGJpdC5jb20=|\r\nX-PM-Tag: product-orders\r\nX-PM-Message-Id: 07311c54-0687-4ab9-b034-b54b5bad88ba\r\nMessage-ID: <SC-ORD-MAIL4390fbe08b95f4257984dcaed896b4730@SC-ORD-MAIL4>\r\n\r\nThank you for your order=2E=2E=2E\r\n"
}

Открытия писем #

get

/messages/outbound/opens

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

Accept	обязательный application/json
X-Haskimail-Server-Token	обязательный Для этого запроса требуются права доступа на уровне сервера. Этот токен можно найти в настройках вашего сервера Haskimail на вкладке «Токены API».

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

curl "https://api.haskimail.ru/messages/outbound/opens?recipient=john.doe@yahoo.com&count=50&offset=0" \
  -X GET \
  -H "Accept: application/json" \
  -H "X-Haskimail-Server-Token: server token"

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

count	обязательный Количество сообщений, возвращаемых в одном запросе. Максимум 500. Сумма count и offset не может превышать 10 000.
offset	обязательный Количество пропускаемых сообщений. Сумма count и offset не может превышать 10 000.
recipient	Фильтровать по получателю (To, Cc, Bcc).
tag	Фильтровать по тегу.
messagestream	Фильтровать по ID канала. Если не указано, поиск по умолчанию будет производиться по исходящему транзакционному каналу.
client_name	Фильтровать по имени почтового клиента, например, Outlook, Gmail.
client_company	Фильтровать по устройству, например, Microsoft, Apple, Google.
client_family	Фильтровать по семейству клиента, например, OS X, Chrome.
os_name	Фильтровать по полному имени и версии ОС, например, OS X 10.9 Mavericks, Windows 7.
os_family	Фильтровать по типу ОС без указания конкретной версии, например, OS X, Windows.
os_company	Фильтровать по компании-производителю ОС, например, Apple Computer, Inc., Microsoft Corporation.
platform	Фильтровать по платформе, например, webmail, desktop, mobile.
country	Фильтровать по стране, в которой было открыто письмо, например, Россия, Белоруссия.
region	Фильтровать по полному названию региона, в котором было открыто письмо, например, Москва, Камчатский край.
city	Фильтровать по полному названию города, в котором было открыто письмо, например, Подольск, Московская область.

Ответ

Постоянные поля

Эти поля будут возвращаться всегда.

TotalCount	integer	Указывает, сколько открытий соответствует указанным вами критериям поиска. Это число может быть больше, чем количество, полученное в одном запросе.
Opens	array	Список записей, каждый из которых представляет одно открытие письма. Обратите внимание, что одно открытие привязано к одному получателю. Поэтому, если одно и то же письмо было отправлено двум получателям и оба его открыли, это будет представлено двумя записями в данном массиве.
RecordType	string	Тип записи.
UserAgent	string	Полный заголовок `user-agent`, переданный клиентским ПО в Haskimail. Haskimail заполняет поля `Platform` `Client` и `OS` на основе этого заголовка.
MessageID	string	Уникальный ID сообщения.
MessageStream	string	Исходящий канал, использованный для отправки сообщения.
ReceivedAt	string	Временная метка, когда сообщение было открыто.

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

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

{
  "TotalCount": 1,
  "Opens": [
    {
      "RecordType": "Open",
      "Client": {
        "Name": "Chrome 34.0.1847.131",
        "Company": "Google Inc.",
        "Family": "Chrome"
      },
      "OS": {
        "Name": "OS X 10.7 Lion",
        "Company": "Apple Computer, Inc.",
        "Family": "OS X"
      },
      "Platform": "WebMail",
      "UserAgent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_7_5) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/34.0.1847.131 Safari/537.36",
      "Geo": {
        "CountryISOCode": "RS",
        "Country": "Serbia",
        "RegionISOCode": "VO",
        "Region": "Autonomna Pokrajina Vojvodina",
        "City": "Novi Sad",
        "Zip": "21000",
        "Coords": "45.2517,19.8369",
        "IP": "188.2.95.4"
      },
      "MessageID": "927e56d4-dc66-4070-bbf0-1db76c2ae14b",
      "MessageStream": "outbound",
      "ReceivedAt": "2014-04-30T05:04:23.8768746-04:00",
      "Tag": "welcome-user",
      "Recipient": "john.doe@yahoo.com"
    }
  ]
}

Дополнительные поля

При обработке полученного JSON, пожалуйста, учитывайте, что любое из следующих полей может отсутствовать. Если Haskimail не смог получить какую-либо часть информации, это поле не будет присутствовать в итоговом JSON.

Client	object	Показывает почтовый клиент (или браузер), использованный для открытия письма. Name, company и family описаны в спецификации параметров для этого эндпоинта.
OS	object	Показывает операционную систему, использованную для открытия письма.
Platform	string	Показывает, какая платформа была использована для открытия письма: `WebMail` `Desktop` `Mobile` `Unknown`
Geo	object	Содержит IP-адрес устройства получателя, на котором было открыто письмо, и информацию, основанную на этом IP: географические координаты (Coords), а также страну, регион, город и почтовый индекс (zip).

Открытия для одного письма #

get

/messages/outbound/opens/{messageid}

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

Accept	обязательный application/json
X-Haskimail-Server-Token	обязательный Для этого запроса требуются права доступа на уровне сервера. Этот токен можно найти в настройках вашего сервера Haskimail на вкладке «Токены API».

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

curl "https://api.haskimail.ru/messages/outbound/opens/{messageid}?count=10&offset=0" \
  -X GET \
  -H "Accept: application/json" \
  -H "X-Haskimail-Server-Token: server token"

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

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

Ответ

Постоянные поля

Эти поля будут возвращаться всегда.

TotalCount	integer	API Haskimail сохраняет только первое открытие, поэтому TotalCount всегда будет равен «1». Вебхук открытий (Open Webhook) будет отправлять уведомления о каждом отдельном открытии, если это необходимо.
Opens	array	Список записей, каждый из которых представляет одно открытие письма. Обратите внимание, что одно открытие привязано к одному получателю. Поэтому, если одно и то же письмо было отправлено двум получателям и оба его открыли, это будет представлено двумя записями в данном массиве.
UserAgent	string	Полный заголовок `user-agent`, переданный клиентским ПО в Haskimail. Haskimail заполняет поля `Platform` `Client` и `OS` на основе этого заголовка.
MessageID	string	Уникальный ID сообщения.
MessageStream	string	Исходящий канал, использованный для отправки сообщения.

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

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

{
  "TotalCount": 1,
  "Opens": [
    {
      "Client": {
        "Name": "Chrome 34.0.1847.131",
        "Company": "Google Inc.",
        "Family": "Chrome"
      },
      "OS": {
        "Name": "OS X 10.7 Lion",
        "Company": "Apple Computer, Inc.",
        "Family": "OS X"
      },
      "Platform": "WebMail",
      "UserAgent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_7_5) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/34.0.1847.131 Safari/537.36",
      "Geo": {
        "CountryISOCode": "RS",
        "Country": "Serbia",
        "RegionISOCode": "VO",
        "Region": "Autonomna Pokrajina Vojvodina",
        "City": "Novi Sad",
        "Zip": "21000",
        "Coords": "45.2517,19.8369",
        "IP": "188.2.95.4"
      },
      "MessageID": "927e56d4-dc66-4070-bbf0-1db76c2ae14b",
      "MessageStream": "outbound",
      "ReceivedAt": "2014-04-30T05:04:23.8768746-04:00",
      "Tag": "welcome-user",
      "Recipient": "john.doe@yahoo.com"
    }
  ]
}

Дополнительные поля

При обработке полученного JSON, пожалуйста, учитывайте, что любое из следующих полей может отсутствовать. Если Haskimail не смог получить какую-либо часть информации, это поле не будет присутствовать в итоговом JSON.

Client	object	Показывает почтовый клиент (или браузер), использованный для открытия письма. Name, company и family описаны в спецификации параметров для этого эндпоинта.
OS	object	Показывает операционную систему, использованную для открытия письма.
Platform	string	Показывает, какая платформа была использована для открытия письма: `WebMail` `Desktop` `Mobile` `Unknown`
Geo	object	Содержит IP-адрес устройства получателя, на котором было открыто письмо, и информацию, основанную на этом IP: географические координаты (Coords), а также страну, регион, город и почтовый индекс (zip).

Клики по ссылкам в письмах #

get

/messages/outbound/clicks

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

Accept	обязательный application/json
X-Haskimail-Server-Token	обязательный Для этого запроса требуются права доступа на уровне сервера. Этот токен можно найти в настройках вашего сервера Haskimail на вкладке «Токены API».

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

curl "https://api.haskimail.ru/messages/outbound/clicks?recipient=john.doe@yahoo.com&count=50&offset=0" \
  -X GET \
  -H "Accept: application/json" \
  -H "X-Haskimail-Server-Token: server token"

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

count	обязательный Количество кликов, возвращаемых в одном запросе. Максимум 500.
offset	обязательный Количество пропускаемых кликов.
recipient	Фильтровать по получателю (To, Cc, Bcc).
tag	Фильтровать по тегу.
messagestream	Фильтровать по ID канала. Если не указано, поиск по умолчанию будет производиться по исходящему транзакционному каналу.
client_name	Фильтровать по имени почтового клиента, например, Outlook, Gmail.
client_company	Фильтровать по устройству, например, Microsoft, Apple, Google.
client_family	Фильтровать по семейству клиента, например, OS X, Chrome.
os_name	Фильтровать по полному имени и версии ОС, например, OS X 10.9 Mavericks, Windows 7.
os_family	Фильтровать по типу ОС без указания конкретной версии, например, OS X, Windows.
os_company	Фильтровать по компании-производителю ОС, например, Apple Computer, Inc., Microsoft Corporation.
platform	Фильтровать по платформе, например, webmail, desktop, mobile.
country	Фильтровать по стране, в которой было открыто письмо, например, Россия, Белоруссия.
region	Фильтровать по полному названию региона, в котором было открыто письмо, например, Москва, Камчатский край.
city	Фильтровать по полному названию города, в котором было открыто письмо, например, Подольск, Московская область.

Ответ

Постоянные поля

Эти поля будут возвращаться всегда.

TotalCount	integer	Указывает, сколько кликов соответствует указанным вами критериям поиска. Это число может быть больше, чем количество, полученное в одном запросе.
Clicks	array	Список событий, каждое из которых представляет один клик по ссылке. Обратите внимание, что каждый клик привязан к конкретному получателю и уникальной ссылке. Если письмо было отправлено двум получателям и оба кликнули по ссылкам, каждое такое событие будет отражено в этом массиве.
RecordType	string	Тип записи.
UserAgent	string	Полный заголовок `user-agent`, переданный клиентским ПО в Haskimail. Haskimail заполняет поля `Platform` `Client` и `OS` на основе этого заголовка.
MessageID	string	Уникальный ID сообщения.
ReceivedAt	string	Временная метка, когда был совершен клик по ссылке.

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

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

{
  "TotalCount": 1,
  "Clicks": [
    {
      "RecordType": "Click",
      "ClickLocation" : "HTML",
      "Client": {
        "Name": "Chrome 34.0.1847.131",
        "Company": "Google Inc.",
        "Family": "Chrome"
      },
      "OS": {
        "Name": "OS X 10.7 Lion",
        "Company": "Apple Computer, Inc.",
        "Family": "OS X"
      },
      "Platform": "WebMail",
      "UserAgent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_7_5) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/34.0.1847.131 Safari/537.36",
      "OriginalLink" : "https://example.com",
      "Geo": {
        "CountryISOCode": "RS",
        "Country": "Serbia",
        "RegionISOCode": "VO",
        "Region": "Autonomna Pokrajina Vojvodina",
        "City": "Novi Sad",
        "Zip": "21000",
        "Coords": "45.2517,19.8369",
        "IP": "188.2.95.4"
      },
      "MessageID": "927e56d4-dc66-4070-bbf0-1db76c2ae14b",
      "MessageStream": "Outbound",
      "ReceivedAt": "2014-04-30T05:04:23.8768746-04:00",
      "Tag": "welcome-user",
      "Recipient": "john.doe@yahoo.com"
    }
  ]
}

Дополнительные поля

При обработке полученного JSON, пожалуйста, учитывайте, что любое из следующих полей может отсутствовать. Если Haskimail не смог получить какую-либо часть информации, это поле не будет присутствовать в итоговом JSON.

Client	object	Показывает почтовый клиент (или браузер), использованный для открытия письма. Name, company и family описаны в спецификации параметров для этого эндпоинта.
OS	object	Показывает операционную систему, использованную для открытия письма.
Platform	string	Показывает, какая платформа была использована для открытия письма: `WebMail` `Desktop` `Mobile` `Unknown`
Geo	object	Содержит IP-адрес устройства получателя, на котором было открыто письмо, и информацию, основанную на этом IP: географические координаты (Coords), а также страну, регион, город и почтовый индекс (zip).

Клики по ссылкам в одном письме #

get

/messages/outbound/clicks/{messageid}

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

Accept	обязательный application/json
X-Haskimail-Server-Token	обязательный Для этого запроса требуются права доступа на уровне сервера. Этот токен можно найти в настройках вашего сервера Haskimail на вкладке «Токены API».

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

curl "https://api.haskimail.ru/messages/outbound/clicks/{messageid}?count=10&offset=0" \
  -X GET \
  -H "Accept: application/json" \
  -H "X-Haskimail-Server-Token: server token"

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

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

Ответ

Постоянные поля

Эти поля будут возвращаться всегда.

TotalCount	integer	Указывает, сколько кликов соответствует указанным вами критериям поиска. Это число может быть больше, чем количество, полученное в одном запросе.
Clicks	array	Список событий, каждое из которых представляет один клик по ссылке. Обратите внимание, что каждый клик привязан к конкретному получателю и уникальной ссылке. Если письмо было отправлено двум получателям и оба кликнули по ссылкам, каждое такое событие будет отражено в этом массиве.
UserAgent	string	Полный заголовок `user-agent`, переданный клиентским ПО в Haskimail. Haskimail заполняет поля `Platform` `Client` и `OS` на основе этого заголовка.
MessageID	string	Уникальный ID сообщения.
MessageStream	string	Исходящий канал, использованный для отправки сообщения..
ReceivedAt	string	Временная метка, когда был совершен клик по ссылке.

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

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

{
  "TotalCount": 1,
  "Clicks": [
    {
      "ClickLocation" : "HTML",
      "Client": {
        "Name": "Chrome 34.0.1847.131",
        "Company": "Google Inc.",
        "Family": "Chrome"
      },
      "OS": {
        "Name": "OS X 10.7 Lion",
        "Company": "Apple Computer, Inc.",
        "Family": "OS X"
      },
      "OriginalLink" : "https://example.com",
      "Platform": "WebMail",
      "UserAgent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_7_5) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/34.0.1847.131 Safari/537.36",
      "Geo": {
        "CountryISOCode": "RS",
        "Country": "Serbia",
        "RegionISOCode": "VO",
        "Region": "Autonomna Pokrajina Vojvodina",
        "City": "Novi Sad",
        "Zip": "21000",
        "Coords": "45.2517,19.8369",
        "IP": "188.2.95.4"
      },
      "MessageID": "927e56d4-dc66-4070-bbf0-1db76c2ae14b",
      "MessageStream": "outbound",
      "ReceivedAt": "2014-04-30T05:04:23.8768746-04:00",
      "Tag": "welcome-user",
      "Recipient": "john.doe@yahoo.com"
    }
  ]
}

Дополнительные поля

При обработке полученного JSON, пожалуйста, учитывайте, что любое из следующих полей может отсутствовать. Если Haskimail не смог получить какую-либо часть информации, это поле не будет присутствовать в итоговом JSON.

Client	object	Показывает почтовый клиент (или браузер), использованный для открытия письма. Name, company и family описаны в спецификации параметров для этого эндпоинта.
OS	object	Показывает операционную систему, использованную для открытия письма.
Platform	string	Показывает, какая платформа была использована для открытия письма: `WebMail` `Desktop` `Mobile` `Unknown`
Geo	object	Содержит IP-адрес устройства получателя, на котором было открыто письмо, и информацию, основанную на этом IP: географические координаты (Coords), а также страну, регион, город и почтовый индекс (zip).

Обзор

Интеграции

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

Справочник API

Вебхуки

API Сообщений

Поиск писем #

/messages/outbound

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

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

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

Ответ

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

Детали письма #

/messages/outbound/{messageid}/details

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

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

Ответ

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

Дамп исходящего сообщения #

/messages/outbound/{messageid}/dump

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

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

Ответ

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

Открытия писем #

/messages/outbound/opens

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

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

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

Ответ

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

Дополнительные поля

Открытия для одного письма #

/messages/outbound/opens/{messageid}

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

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

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

Ответ

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

Дополнительные поля

Клики по ссылкам в письмах #

/messages/outbound/clicks

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

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

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

Ответ

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

Дополнительные поля

Клики по ссылкам в одном письме #

/messages/outbound/clicks/{messageid}

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

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

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

Ответ

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

Дополнительные поля