Метод getMessages

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

Принцип использования

URL для вызова метода
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.
date_from* Дата создания больше чем, формат yyyy-mm-dd hh:mm UTC.
date_to* Дата создания меньше чем, формат yyyy-mm-dd hh:mm UTC.
format Формат вывода принимает значения html | json, по умолчанию json.
limit Количество  записей в ответе на один запрос, должно быть целое число в диапазоне 1 - 100, по умолчанию 50.
offset С какой позиции начинать выборку, должен быть 0 или больше (позиция первой записи начинается с 0), по умолчанию 0.
Возвращаемое значение
JSON-массив, каждый элемент массива – объект со следующим полями:
id Идентификатор письма в системе.
sub_user_login Либо логин субпользователя, который создал письмо, либо NULL, если письмо создал мастер-пользователь.
list_id Идентификатор списка рассылки.
segment_id Идентификатор фильтра, если письмо создано по сегменту.
created Дата и время создания сообщения UTC.
updated Дата и время обновления сообщения UTC.
service_type Тип письма (email или sms).
active_version_id Если активное, то здесь будет null, если есть версии и письмо не последняя ревизия, то здесь будет идентификатор активного письма.
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 Имя отправителя (только если сообщение - email).
Пример возвращаемого значения:

{
 "result": [
     {
       "id": 3769459,
       "sub_user_login": "",
       "list_id": 462767,
       "segment_id": null,
       "created": "2020-02-23 13:29:51", 
       "updated": "2020-04-17 16:31:51",
       "service_type": "email",
       "active_version_id": null,
       "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,
       "created": "2016-03-25 14:25:51", 
       "updated": "2016-05-18 16:31:33",
       "service_type": "sms",
       "active_version_id": null,
       "lang_code": "ru",
       "sms_from": "Serg local",
       "body": "bnvbnbvnvbnvn"
       "message_format":"raw_html"
     },
  ]
}

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

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

Вы нашли ответ?

2
4