меню
Generic selectors
Exact matches only
Search in title
Search in content
Search in posts
Search in pages

Метод getMessages

Данный метод используется для получения списка писем, созданных как через личный кабинет UniSender, так и через API (createEmailMessage + createCampaign и т.п.). Для отображения списка писем необходимо задать временные рамки поиска и ваш API-ключ. Дополнительно можно указать количество писем для отображения в одном запросе, позицию, с которой будет отображаться список писем по данному запросу и формат для отображения возвращаемых данных (json/html).

https://api.unisender.com/ru/api/getMessages?api_key=KEY&date_from=
yyyy-mm-dd hh:mm&date_to=yyyy-mm-dd hh:mm

Метод принимает параметры

  • api_key* — Ключ доступа к API
  • format — формат вывода принимает значения html | json, по умолчанию json
  • date_from — дата создания больше чем, формат yyyy-mm-dd hh:mm UTC
  • date_to — дата создания меньше чем, формат yyyy-mm-dd hh:mm UTC
  • limit — количество  записей в ответе на один запрос, должен быть целое число в диапазоне 1 — 100 , по умолчанию 50
  • offset — с какой позиции начинать выборку, должен быть 0 или больше (позиция первой записи начинается с 0), по умолчанию 0

Возвращаемое значение

{
 "result": [
     {
       "id": 3769459,
       "sub_user_login": "",
       "list_id": 462767,
       "segment_id": null,
       "service_type": "email",
       "active_version_id": null,
       "is_draft": true,
       "lang_code": "ru",
       "sender_email": "test@unisender.com",
       "sender_name": "test",
       "subject": "test",
       "body": "<html></html>",
       "message_format":"raw_html"
     },
     {
       "id": 3769462,
       "sub_user_login": "",
       "list_id": 462767, 
       "segment_id": null,
       "service_type": "sms",
       "active_version_id": null,
       "is_draft": false,
       "lang_code": "ru",
       "sms_from": "Serg local",
       "body": "bnvbnbvnvbnvn"
       "message_format":"raw_html"
     },
  ]
}

где:

id — идентификатор письма в системе
sub_user_login — либо логин субпользователя, который создал письмо, либо NULL, если письмо создал мастер-пользователь
list_id — идентификатор списка рассылки
segment_id — идентификатор фильтра ели письмо создано по сегменту
service_type — тип письма (email или sms)
active_version_id — если активное то здесь будет null, ели есть версии и письмо не последняя ревизия то здесь будет идентификатор активного письма
is_draft — является ли письмо черновиком
lang_code — двухбуквенный код языка для автоматического добавления к письму формы отписки (например, ‘ru’, ‘en’)
body — тело письма
message_format — возвращает способ создания сообщения: block — блочный редактор, raw_html — html редактор, text — текстовая версия письма
attachments — возвращает приложенные к письму файлы массивом, где:
isInline — является ли вложение встроенным (может принимать значение true и false)
name — название вложения
size — размер вложения
url — путь к вложению
Если вложений в письмо нет, возвращается пустой массив «attachments»: []
sender_email (только если сообщение — email) — email отправителя
sender_name (только если сообщение — email) — имя отправителя
subject (только если сообщение — email) — тема письма
sender (только если сообщение — sms) — имя отправителя

Формат ошибок

{
    "error": "SZ150415-01 [ 'date_to' значение должно быть в формате 
    'yyyy-mm-dd hh:mm' \"2014-12-26 15:23:1\"]"
}