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

Метод listMessages

Данный метод используется для получения списка всех сообщений, созданных как через личный кабинет UniSender, так и через API. Метод работает как getMessages, отличие listMessages — не возвращается тело письма и вложения, но при этом возвращается login пользователя. Для получения тела и вложений используйте метод getMessage.

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

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

Синтаксис и URL для вызова метода
listMessages ([datetime date_from, datetime date_to], string format, int limit, int offset)
https://api.unisender.com/ru/api/listMessages?format=json&api_key=KEY
Аргументы
api_key * Ключ доступа к API
date_from * Дата и время создания сообщения, начиная с которой нужно выводить сообщения, в формате «ГГГГ-ММ-ДД чч:мм», часовой пояс UTC.
date_to * Дата и время создания сообщения, заканчивая которой нужно выводить сообщения, в формате «ГГГГ-ММ-ДД чч:мм», часовой пояс UTC.
Дополнительные параметры:
format Формат вывода принимает значения html | json, по умолчанию json (формат html предназначен только для визуального просмотра результата, парсер в данном формате работать не будет).
limit Количество записей в ответе на один запрос должно быть целым числом в диапазоне 1 — 100 , по умолчанию стоит 50 записей.
offset Параметр указывает, с какой позиции начинать выборку. Значение должно быть 0, или больше (позиция первой записи начинается с 0), по умолчанию 0.
Возвращаемое значение
JSON-массив, каждый элемент массива – объект с полями. Описание полей под примером.
Пример возвращаемого значения:

{
 "result": [
 {
 "id": 422231232,
 "login": "ALogin",
 "sub_user_login": "",
 "list_id": 1234567,
 "segment_id": null,
 "lang_code": "ru",
 "service_type": "email",
 "message_format": "block",
 "sender_email": "test.test@gmail.com",
 "sender_name": "User",
 "subject": "5"
 },
 {},
 {}
 ]
}

Где:

id — идентификатор шаблона в системе;
login — логин в системе UniSender;
sub_user_login — логин субпользователя, который создал шаблон, либо NULL, если письмо создал мастер-пользователь;
list_id — идентификатор списка контактов, к которому был прикреплен данный шаблон при создании;
segment_id — идентификатор фильтра, если письмо создано по сегменту;
service_type — тип письма (email или sms);
lang_code — двухбуквенный код языка для автоматического добавления к письму формы отписки (например, ‘ru’, ‘en’);
sender_email — email отправителя;
sender_name — имя отправителя;
subject — тема шаблона;
message_format — возвращает способ создания шаблона: «block» — блочный редактор, «raw_html» — html редактор.