Метод getTemplate | Интеграция c UniSender по API

Метод getTemplate

Метод возвращает информацию о заданном шаблоне.

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

Синтаксис и URL для вызова метода
getTemplate (int template_id)
https://api.unisender.com/ru/api/getTemplate?format=json&api_key=KEY&template_id=ID
Аргументы
api_key * Ключ доступа к API.
template_id * ID пользовательского шаблона. Возвращается методами createEmailTemplate, а также getTemplates или listTemplates.
Параметр не обязателен, если указывается system_template_id
system_template_id ID системного шаблона. Возвращается методами getTemplates или listTemplates.
format Формат вывода возвращаемого результата. Может принимать значения html | json, по умолчанию json (формат html предназначен только для визуального просмотра результата, парсер в данном формате работать не будет).
Возвращаемое значение
JSON-массив, объект с полями. Описание полей под примером.
Пример возвращаемого значения:

{
 "result": {
 "id": "10423223",
 "sub_user_login": "",
 "title": "test",
 "description" : "This is the test template",
 "lang_code": "ru",
 "subject": "test",
 "attachments": "",
 "screenshot_url": "https://api.unisender.com/ru/v5/preview/template/
  5gkzx4yg4zjae1swo1cqzy1sbui",
 "fullsize_screenshot_url":"",
 "created": "2020-02-23 13:29:51",
 "updated": "2020-04-17 16:31:51",
 "message_format": "raw_html",
 "type": "user",
 "body": "<html>n<head><title></title></head>n<body></body>n</html>",
 "raw_body": ""}
}

Где:
id - идентификатор шаблона в системе;
sub_user_login - логин субпользователя, который создал шаблон, либо NULL, если письмо создал мастер-пользователь;
title - название шаблона в системе;
description - текстовое описание шаблона;
lang_code - двухбуквенный код языка для автоматического добавления к письму формы отписки (например, 'ru', 'en');
subject - тема шаблона;
screenshot_url - ссылка на скриншот шаблона;
fullsize_screenshot_url - возвращает ссылку на полноразмерное изображение системного шаблона;
created - дата и время создания шаблона UTC;
updated - дата и время обновления шаблона UTC;
type - тип шаблона (системный/пользовательский);
body - тело шаблона;
raw_body - системный параметр, содержащий json-структуру данных блочного редактора;
message_format - возвращает способ создания шаблона: "block" - блочный редактор, "raw_html" - html редактор.

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

{
   {"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]"}
}

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

0
0