×

Получите 5 готовых email-стратегий для любого бизнеса БЕСПЛАТНО!

После регистрации

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

Метод listTemplates

Данный метод используется для получения списка всех шаблонов, созданных как через личный кабинет UniSender, так и через API. Метод работает как getTemplates, единственное отличие listTemplates — не возвращается параметр body. Для получения body используйте метод getTemplate

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

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

Синтаксис и URL для вызова метода
listTemplates ([datetime date_from, datetime date_to], string format, int limit, int offset)
https://api.unisender.com/ru/api/listTemplates?format=json&api_key=KEY
Аргументы
api_key *Ключ доступа к API.
typeТип шаблона, принимает значения: system|user;system — системные шаблоны (их вывод не зависит от даты и времени создания шаблонов — параметров date_from и date_to);

user — пользовательские шаблоны (значение по умолчанию).

date_fromДата и время создания шаблона, начиная с которой нужно выводить шаблоны, в формате «ГГГГ-ММ-ДД чч:мм», часовой пояс UTC.
date_toДата и время создания шаблона, заканчивая которой нужно выводить шаблоны, в формате «ГГГГ-ММ-ДД чч:мм», часовой пояс UTC.
formatФормат вывода принимает значения html | json, по умолчанию json (формат html предназначен только для визуального просмотра результата, парсер в данном формате работать не будет).
limitКоличество записей в ответе на один запрос должно быть целым числом в диапазоне 1 — 100 , по умолчанию стоит 50 записей.
offsetПараметр указывает, с какой позиции начинать выборку. Значение должно быть 0, или больше (позиция первой записи начинается с 0), по умолчанию 0.
Возвращаемое значение
JSON-массив, каждый элемент массива – объект с полями. Описание полей под примером.
Пример возвращаемого значения:

{
 "result": [
 {
 "id": 943434,
 "sub_user_login": "",
 "title": "test",
 "description": "",
 "lang_code": "ru",
 "subject": "test",
 "attachments": "",
 "screenshot_url": "https://api.unisender.com/ru/v5/preview/template/
   57szc6e88kxw6osb7cuj5k11wwe",
 "created": "2015-10-06 14:54:23",
 "message_format": "block",
 "type": "user",
 "fullsize_screenshot_url":"" 
 },
 {},
 {}
 ]
}

Где:

id — идентификатор шаблона в системе;
sub_user_login — логин субпользователя, который создал шаблон, либо NULL, если письмо создал мастер-пользователь;
title — название шаблона в системе;
description — текстовое описание шаблона;
lang_code — двухбуквенный код языка для автоматического добавления к письму формы отписки (например, ‘ru’, ‘en’);
subject — тема шаблона;
attachments — вложения;
screenshot_url — ссылка на скриншот шаблона;
created — дата и время создания шаблона UTC;
message_format — возвращает способ создания шаблона: «block» — блочный редактор, «raw_html» — html редактор;
type — тип шаблона (системный/пользовательский);
fullsize_screenshot_url — возвращает ссылку на полноразмерное изображение системного шаблона. Параметр будет возвращен при type = system.

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

{
   {"error":"VK151214-01 [ 'date_from' value is not a valid datetime \"2015-12-14 12:5x\"]"} 
   {"error":"VK151214-01 [ 'date_to' value is not a valid datetime \"2015-12-14 22:0x\"]"} 
   {"error":"VK151214-01 [ 'limit' value should be a valid number]"} 
   {"error":"VK151214-01 [ 'offset' value should be greater than or equal to 0]"}
}