Перейти к содержанию

Шаблоны информационных писем

Эти вызовы поменяли формат принимаемых и возвращаемых данных на совместимый с issue.send

Поля старого формата ответов будут ещё некоторое время возвращаться для обратной совместимости.

Старый формат изменения данных будет ещё некоторое время приниматься для обратной совместимости.

Список шаблонов информационных писем

{

  "action" : "infolett.list" 

-- параметры фильтрации, должен быть хотя бы один параметр
--
-- если выбрана последняя порция списка то ответ содержит "last_page" : 1
--
-- доступны поля
--
-- issue_infolett.id             -- "код информационного письма" 
-- issue_infolett.name           -- "название" 
-- issue_infolett.channel        -- канал отправки email|sms|viber|push|vk|tg|vknotify|pushapp|max
-- issue_infolett.create.time    -- "дата и время создания" -- Ys, null
-- issue_infolett.update.time    -- "дата и время последнего изменения" -- Ys, null
-- issue_infolett.alias          -- "альтернативный идентификатор" 
-- issue_infolett.reltype        -- число
-- issue_infolett.relref         -- число
-- issue_infolett.public_preview -- "ссылка просмотра черновика без пароля" 
-- issue_infolett.onmoderation : -- 0|1  0 - шаблон одобрен для использования, 1 - шаблон на модерации
--

,"filter" : [ фильтр в синтаксисе stat.uni ]

,"order" : [ сортировка ответа в синтаксисе stat.uni ]

,"skip" : количество пропускаемых записей от начала списка -- по умолчанию 0

,"first" : количество выбираемых записей после skip -- по умолчанию 50, не более 50

}

ответ

{

 <общие поля>

,"list" : [

            {

             "id" : уникальный идентификатор

            ,"format" : "viber|sms|html|text|push|vk|tg|vknotify|pushapp|max" -- формат

            ,"name" : "название" 

            ,"onmoderation" : 0|1 -- 0 - шаблон одобрен для использования, 1 - шаблон на модерации

            }

            ...

           ]

}

Чтение шаблона информационного письма

{

  "action" : "infolett.get" 

 ,"id" : идентификатор шаблона

}

ответ

{

  <общие поля>

  "obj" : {

           "id" : идентификатор шаблона

          ,"name" : "название" 

          ,"onmoderation" : 0|1 -- 0 - шаблон одобрен для использования, 1 - шаблон на модерации

          ,"letter" : {
                       параметры содержимого письма как у issue.send

                       -- и дополнительно

                      ,"link.qsid" : "..." 
                      ,"campaign.id" : "код кампании" 
                      }
          }

}

Создание или изменение шаблона информационного письма

При создании или изменении шаблона он автоматически попадает на модерацию и использовать его при высылке писем нельзя. Но его можно повторно менять и удалять.

По результатам модерации вам придёт уведомление.

{

  "action" : "infolett.set" 

  ,"obj" : {

            "name" : "название" 

            ,"letter" : {
                         параметры содержимого письма как у issue.send
                         для текстовых писем обязательны не пустые - адрес отправителя, тема и как минимум один текст
                         для sms сообщения обязательны не пустые - имя отправителя и текст

                         -- дополнительно для email. не обязательно

                        ,"link.qsid" : "..." 
                        }

           }

 -- необязательные

  ,"id" : идентификатор шаблона -- если не указан, создается новый

 ,"return_fresh_obj" : "нужно вернуть данные объекта -- да, нет ( 1 | 0 )" 

}

ответ

{

 <общие поля>

 ,obj  { ... } -- объект в формате infolett.get если "return_fresh_obj" : 1

}

Удаление шаблона информационного письма

{

  "action" : "infolett.delete" 

-- одного

  ,"id" : код шаблона

--- или нескольких

  ,"id" : [код шаблона1, код шаблона2, .. ]

}

ответ

{

 <общие поля>

}

Предпросмотр информационного письма

{

  "action" : "infolett.preview" 

 ,"email" : "адрес для параметризации подстановок" -- не обязательно

-- одно из

 ,"id" : номер письма

-- или

,"obj" : { -- можно передавать объект из infolett.get - лишние поля будут проигнорированы

           "letter" : {
                        параметры содержимого письма как у issue.send
                      }
        }
}

ответ

{

 <общие поля>,

 "text" : "текст письма" 

}