Метод getTemplates

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

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

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

Синтаксис и URL для вызова метода
getTemplates ([string type, datetime date_from, datetime date_to, string format, int limit, int offset])         
https://api.unisender.com/ru/api/getTemplates?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": "",
"list_id": "12121212",
"segment_id": "",
"lang_code": "ru",
"sender_email": "sender@gmail.com",
"sender_name": "SenderName",
"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",
"body": "<html><head></head><body>Some code</body></html>",
"raw_body": null,
"fullsize_screenshot_url":""
},
{},
{}
]
}

Где:

id - идентификатор шаблона в системе;
sub_user_login - логин субпользователя, который создал шаблон, либо NULL, если письмо создал мастер-пользователь;
title - название шаблона в системе;
description - текстовое описание шаблона;
list_id - идентификатор списка контактов, к которому был прикреплен данный шаблон при создании;
segment_id - идентификатор фильтра, если письмо создано по сегменту;
service_type - тип письма (email или sms);
active_version_id - если активное, то здесь будет null, если есть версии и письмо не последняя ревизия, то здесь будет идентификатор активного письма;
is_draft - возвращаемое значение показывает, является ли письмо черновиком;
lang_code - двухбуквенный код языка для автоматического добавления к письму формы отписки (например, 'ru', 'en');
type - тип шаблона (системный/пользовательский);
raw_body - системный параметр, содержащий json-структуру данных блочного редактора;
body - тело шаблона;
sender_email - email отправителя;
sender_name - имя отправителя;
subject - тема шаблона;
screenshot_url - ссылка на скриншот шаблона;
created - дата и время создания шаблона UTC;
message_format - возвращает способ создания шаблона: "block" - блочный редактор, "raw_html" - html редактор;
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]"} }