API tools faq
paste
Advertisement
Guest User

Untitled

a guest
Feb 20th, 2019
111
0
Never
Add comment
Not a member of Pastebin yet? Sign Up, it unlocks many cool features!
text 64.11 KB | None | 0 0
raw download clone embed print report
  1. {
  2. "action" : "issue.send" или "issue.send.test",
  3.  
  4. "name" : "Название выпуска", -- не обязательно, при отсутствии используется тема письма или имя отправителя sms
  5. -- из-за особенностей учёта выходов транзакционных писем personal данный параметр
  6. -- для них будет работать не так как ожидается и в, целом, бесполезен
  7.  
  8. "label" : "метка" или [ "метка1", "метка2".. ], -- набор произвольных меток выпуска позволяющих фильтровать/классифицировать
  9. -- от 0 до 8 строк не длиннее 128 символов
  10. -- необязательно
  11.  
  12. * параметры содержимого выпуска. Для Транзакционных писем - только указание черновика и прикреплённых файлов.
  13.  
  14. "letter" : {
  15.  
  16. *** для sms
  17.  
  18. * содержимое сообщения
  19.  
  20. или указание параметров
  21.  
  22. "from.name" : "Имя отправителя" -- обязителен и имя отправителя должно быть в списке уже промодерированных имён (вызовы issue.smssender.*)
  23.  
  24. ,"message": {
  25.  
  26. "sms" : "sms cообщение"
  27.  
  28. }
  29.  
  30. или черновик из которого их взять. приоритет описан выше.
  31.  
  32. "draft.id": "номер черновика содержимое которого даст выпуск" -- должен иметь sms-версию
  33.  
  34. *** для viber
  35.  
  36. * содержимое сообщения
  37.  
  38. или указание параметров
  39.  
  40. "button.url" : "ссылка с кнопки" -- обязательно если нужна кнопка после сообщения
  41.  
  42. ,"button.text" : "надпись на кнопке" -- не обязательно, по умолчанию "Узнать"
  43.  
  44. ,"message": {
  45.  
  46. "viber" : "viber cообщение" -- текст без форматирования
  47.  
  48. }
  49.  
  50. ,"attaches": [ -- не обязательно, одна и только одна ссылка на возможную картинку отображаемую между текстом и кнопкой
  51.  
  52. -- при выпуске по черновику, прикрепляемые файлы из черновика добавляются к указанным в списке
  53. -- если одноимённый файл или ccылка тут отсутствуют
  54.  
  55. { "url" : "Внешниение ссылки http / https / ftp / ftps / sftp" },
  56.  
  57. -- или
  58.  
  59. { "url" : "персонализованный url - для каждого свой" }, -- подробнее в разделе "Персонализация выпуска"
  60.  
  61. или черновик из которого их взять. приоритет описан выше.
  62.  
  63. "draft.id": "номер черновика содержимое которого даст выпуск" -- должен иметь viber-версию
  64.  
  65. *** для push в браузеры
  66.  
  67. * содержимое сообщения
  68.  
  69. или указание параметров
  70.  
  71. "subject" : "тема" -- обязательно
  72.  
  73. ,"click.url" : "ссылка для клика"
  74.  
  75. ,"message": {
  76.  
  77. "push" : "текст cообщения" -- текст, возможно с переводами строк
  78.  
  79. }
  80.  
  81. ,"icon.url" : "ссылка на иконку" -- https://, обычно 192х192.
  82.  
  83. ,"image.url" : "ссылка на картинку" -- https://
  84.  
  85. или черновик из которого их взять. приоритет описан выше.
  86.  
  87. "draft.id": "номер черновика содержимое которого даст выпуск" -- должен иметь push-версию
  88.  
  89. *** для email
  90.  
  91. * содержимое письма
  92.  
  93. или указание параметров (дополнительно смотрите параметр letter.zip ниже
  94.  
  95. "subject" : "Тема письма" -- обязательно не пусто
  96.  
  97. ,"from.name" : "Имя отправителя"
  98.  
  99. ,"from.email" : "Адрес отправителя (email)" -- обязательно не пустой для текстовых писем; адрес должен быть в списке уже подтверждённых адресов (вызовы issue.emailsender.*)
  100. --
  101. -- Использование в качестве адреса отправителя адреса принадлежащие Почте Mail.ru (mail.ru, bk.ru, inboc.ru, list.ru, mail.ua) - запрещено настройками Mail.Ru
  102. -- Рассылка с таким адресом не выйдет. Черновик - не сохранится.
  103. ---Более подробную информацию вы можете прочитать по адресу https://corp.mail.ru/ru/press/releases/9593/
  104.  
  105. ,"reply.name" : "Имя для обратного адреса для ответа"
  106.  
  107. ,"reply.email" : "Обратный адрес для ответа (email)" -- адрес должен быть в списке уже подтверждённых адресов (вызовы issue.emailsender.*)
  108. -- возможен учёт и статистика ответов получателей
  109. -- для этого необходимо активировать через Службу Поддержки настройку "Перехват ответов на письма выпуска"
  110. -- статистика доступна через deliv.replyed.* вызова stat.uni
  111.  
  112. ,"to.name" : "Имя получателя" -- в этом поле уместна персонализация для подстановки имени и фамилии получателя
  113.  
  114. ,"message": { -- одна или обе не пустые версии письма
  115.  
  116. "html" : "html-версия письма"
  117.  
  118. ,"text" : "текстовая версия письма"
  119. }
  120.  
  121. или черновик из которого их взять. приоритет описан выше.
  122.  
  123. "draft.id": "номер черновика содержимое которого даст выпуск", -- должен иметь html и/или текстовую версию
  124.  
  125. * генерация текстовой версии из html
  126.  
  127. -- при отсутствии текстовой версии и включённой её автоматической генерации из html-версии письма создаётся текстовая версия
  128. -- поддерживаются базовые виды выделения текста. таблицы не поддерживаются по умолчанию, но это можно обсудить со Службой Поддержки
  129.  
  130. "autotext" : "0|1|ширина" -- 0 - отключено (по умолчанию)
  131. -- 1 - включено, ширина строки 80 символов
  132. -- ширина - включено, ширина строки - как указано
  133.  
  134. * прикреплённые файлы письма
  135.  
  136. -- по умолчанию, mime-тип файла определяется по расширению
  137.  
  138. -- по умолчанию, кодировкой текстовых файлов text/* считается utf-8
  139.  
  140. -- следующие имена файлов зарезервированы для внутренних нужд и не должны использоваться
  141. --
  142. -- все начинающиеся с _
  143. --
  144. -- message.text
  145. -- message.sms
  146. -- message.viber
  147. -- message.push
  148. --
  149. -- index.html
  150. -- index.htm
  151. -- index.shtml
  152. -- index.shtm
  153. --
  154. -- attach.html
  155. -- attach.htm
  156. -- attach.shtml
  157. -- attach.shtm
  158. --
  159. -- message.html
  160. -- message.htm
  161. -- message.shtml
  162. -- message.shtm
  163.  
  164. ,"attaches": [
  165.  
  166. -- при выпуске по черновику, прикрепляемые файлы из черновика добавляются к указанным в списке
  167. -- если одноимённый файл или ccылка тут отсутствуют
  168.  
  169. {
  170. "name" : "имя файла",
  171.  
  172. ,"content": "содержимое файла закодированное base64",
  173.  
  174. ,"encoding" : "base64",
  175.  
  176. ,"mime-type" : "тип атача", -- не обязательно, заменяет тип установленный по расширению имени атача
  177.  
  178. ,"charset" : "набор символов атача", -- не обязательно, заменяет используемое по умолчанию utf-8
  179. },
  180.  
  181. {
  182. "name" : "имя файла",
  183.  
  184. ,"content": "содержимое файла",
  185.  
  186. ,"mime-type" : "тип файла", -- не обязательно, заменяет тип установленный по расширению имени файла
  187.  
  188. ,"charset" : "набор символов файла" -- не обязательно, заменяет используемое по умолчанию utf-8
  189. },
  190.  
  191. {
  192. "url" : "url откуда заборать. Внешиение ссылки http / https / ftp / ftps / sftp или из хранилища загрузок rfs://upload/путь-до-файла "
  193.  
  194. ,"mime-type" : "тип атача", -- не обязательно, заменяет тип установленный по расширению имени атача или полученный в ответ на запрос
  195.  
  196. ,"charset" : "набор символов атача", -- не обязательно, заменяет используемое по умолчанию utf-8 или полученный в ответ на запрос
  197. },
  198.  
  199. { "url" : "персонализованный url откуда забирать - для каждого свой" }, -- подробнее в разделе "Персонализация выпуска"
  200.  
  201. -- генерация персонального pdf-документа на ходу. подробнее в разделе "Персонализация выпуска"
  202.  
  203. { "pdf" : "номер черновика"}
  204.  
  205. -- генерация персонального excel-документа на ходу. подробнее в разделе "Персонализация выпуска"
  206.  
  207. { "xlsx" : "номер черновика"}
  208.  
  209. ...
  210.  
  211. ]
  212. }
  213.  
  214. * текст выпуска и картинки из архива (для email). не для транзакционных выпусков
  215.  
  216. -- В архиве ищется индексный файл который даст текст выпуска -это первый регистронезависимый файл *.htm(l) с наименьшим уровнем вложенности и наименьшим среди одноуровневых именем
  217. -- Остальное содержимое каталога в котором он находится сохраняется в Хранилище картинок.
  218. -- Остальные части архива игнорируются
  219. -- В содержимом индексного файла относительные ссылки в img-src и ссs-url() дополняются веб-базой каталога куда было сохранено содержимое.
  220. -- Полученный результат записывается в letter-> message->html (т.е. это будет email)
  221. -- Остальные параметры по прежнему передаются через явно указаный в вызове letter (например тема)
  222. -- Если в вызове уже есть letter и в нём есть есть message, то это ошибка
  223.  
  224. ,"letter.zip" : "содержимое архива закодированное в base64" -- zip-архив содержащий текст выпуска и сопровождающие картики для оформления
  225.  
  226. * получатели выпуска
  227.  
  228. ."group" : "id группы | masssending - если это Экспресс-Выпуск | personal - Транзакционное письмо",
  229. -- старый параметр gid переименован в group для совместимости с другими вызовами
  230. -- можно продолжать указывать gid - он будет использоваться при отсутствии group
  231.  
  232. -- если фильтр группы описан в формате КД и в нём используется оператор has с параметром save,
  233. -- то один участник группы может попасть в рассылку несколько раз в зависимости от количества
  234. -- срабатываний has/save и параметра выпуска "multiple".
  235. -- В описании фильтра формата КД описано когда и чем это полезно.
  236.  
  237. * параметры способа выпуска
  238.  
  239. "class.id" : "идентификатор класса выпуска" -- возможный источник параметров выпуска для тех, что не указаны непосредственно в issue.send
  240.  
  241. "group.exclude" : [ "id-группы1", "id-группы2" .... ] -- Группы списки для исключения получателей
  242. -- Если адрес получателя присутствует хотя бы в одной из указанных групп-списков,
  243. -- то он исключается из выпуска
  244. -- Эта возможность позволяет, например, реализовать "стоп-лист по тематикам" - в письме
  245. -- размещается дополнительная ссылка "Не хочу получать эту тематику" ведущая на Форму
  246. -- А в выпусках "этой тематики" указывается исключить группу-список "Заполнившие Форму"
  247.  
  248. "sendwhen": "Когда выпустить (now - сейчас | later - отложенный | delay - задержаный | save - отложить на хранение | test - тестовый)",
  249. -- при использовании в "Действиях по расписанию" допустимы только now и test
  250. -- Тестовый выпуск не доступен для Экспресс-Выпуска, Транзакционных писем, SMS, Viber, Push
  251.  
  252. "dkim.id" : "номер проверенного dkim-ключа или 0" -- если строго "0", то будет использоваться общий системный ключ
  253. -- если пусто/не задано/невалиден, то будет взят из черновика
  254. - если в черновике строго "0", то будет использоваться общий системный ключ
  255. -- если в черновике не задан или на момент выпуска выбранный ключ из черновика окажется не проверенным,
  256. -- то будет использоваться самый свежий из ключей имеющихся для домена отправителя (from.email из вызова или черновика)
  257. -- если ключа точно по домену не будет, то домен будет сокращён на один уровеньт и поиск будет повторён. и так до домена второго уровня включительно
  258. -- если и ключа по домену и его сокращённым вариантам не будет или на момент выпуска выбранный ключ по домену окажется не проверенным,
  259. -- то будет использоваться значение установленное через sys.settings.set
  260. -- если и его нет или не проверено, то будет использоваться общий системный ключ
  261.  
  262. "campaign.id" : "код кампании"
  263.  
  264. -- или
  265.  
  266. "campaign.id" : [ "код кампании 1", "код кампании 2" ...]
  267.  
  268. -- Код кампании в которую будет включён выпуск
  269. -- пусто или не указан - будет включён в кампанию, если она указана в черновике
  270. -- 0 - не будет включён ни в какую кампанию, даже указанную в черновику
  271. -- не может быть указан с другими кодами если их несколько
  272.  
  273. -- Код кампании (указаный или полученый из черновика) игнорирует если выпуск выходит
  274. -- в рамках АБ-тестирования или тригерной рассылки
  275.  
  276. -- При успешном создании задания отложенного выпуска, он автоматически вносится в кампании указанные в campaign.id
  277. -- При выходе отложенного выпуска ранее заданный campaign.id игнорируется и выпуск вносится только в те кампании,
  278. -- в которых на момент выпуска состоит задание отложенного выпуска сработавшее в кроне естественным путём (cron.runonce не считается)
  279.  
  280. * при отложеном выпуске (later) указывается дополнительно дата, час и минута не ранее которых выпускать
  281.  
  282. -- Если такие же дату-время уже запланирован выпуск по такой же группе, то новое задание принято не будет.
  283. -- ИСКЛЮЧЕНИЕ - Экспресс-Выпуск и Транзакционные Письма.
  284. -- Выпуски по этим группам могут быть запланированы на одну и ту же дату в любом количестве.
  285.  
  286. "later.time" : "YYYY-MM-DD hh:mm" -- рекомендуемая точность - 5 минут. Т.е. mm из набора 0,5,10,15,20,25,30,35,40,45,50,55
  287. -- другие значение mm допустимы, но фактически при выпуске могут быть округлены системой
  288. -- до ближайшего большего значения из указанного набора
  289.  
  290. * при задержаном выпуске (delay) указывается дополнительно на сколько минут задержать выпуск
  291.  
  292. -- Так как "задержка" реализуется созданием отложенного выпуска на "текущее время + delay.time",
  293. -- то действуют ТАКИЕ ЖЕ ОГРАНИЧЕНИЯ, что и при использовании later.time
  294.  
  295. "delay.time" : "mm"
  296.  
  297. * для Email - при выпуске теста (test) указываются адреса получателей. не более пяти.
  298.  
  299. "mca": [
  300.  
  301. "e@mail.1",
  302.  
  303. "e@mail.2",
  304.  
  305. ......
  306.  
  307. ]
  308.  
  309. * для Email - параметры преобразования ссылок для учёта перехода по ним в системе
  310.  
  311. "relink" : 0|1 -- Преобразовывать ссылки автоматически
  312. -- 1 - да, 0 - нет, по умолчанию - 0
  313. --
  314. -- !!!
  315. -- С 17 АВГУСТА 2018 ГОДА ПО УМОЛЧАНИЮ - 1 для не sms-выпусков !!!
  316. -- !!!
  317.  
  318. "relink.param" : {
  319. -- если relink = 1, а какой то из параметров relink.param не указан,
  320. -- то считается что: link=1, image=0 и test=1 соответственно для всех рассылок кроме personal
  321. -- для personal это: link=1, image=0 и test=0 - объяснение ниже
  322.  
  323. "link" : 0|1 -- преобразовывать ссылки тега <A>
  324. -- 1 - да, 0 - нет
  325. -- преобразуются ссылки со схемами: http(s)://, ftp(s)://, viber://, fb-messenger://, skype://
  326.  
  327. "image": 0|1 -- преобразовывать ссылка на внешние картинки для тега <IMG>
  328. -- и фоновых изображений в <BODY> и <TABLE>
  329. -- 1 - да, 0 - нет
  330. -- преобразуются ссылки со схемами: http(s)://, ftp(s)://, viber://, fb-messenger://, skype://
  331.  
  332. "test": 0|1 -- проверять существование адресов (только если адрес подлежит преобразованию)
  333. -- при включённой проверке выпуск не выйдет если ссылка
  334. -- не действительна (ответ не 200, не 301 и не 302)
  335. -- 1 - да, 0 - нет
  336.  
  337. -- настройка "test"=1 не действует на домены vk.com, vkontake.ru, ok.ru, my.mail.ru, facebook.com, fb.com, instagram.com, twitter.com,
  338. -- pintrest.com, youtube.com, rutube.com, rutube.com, linked.in, odnoklassniki.ru, ok.ru, telegram.me, t.me
  339. -- и их мобильные версии с префиксом "m" и версии с префиксом "www"
  340. -- ссылки с их использованием не проверяются на существование из-за непредсказуемости результата
  341. -- указывайте таким ссылкам явно x-do-link-test=1 для осуществления проверки
  342.  
  343. -- никогда не проверяются ссылки с персонализицией, и со схемами viber://, fb-messenger://, skype://
  344.  
  345. -- Обратите внимание, что массовая отсылка выпусков Персональных Писем, может вызвать
  346. -- проблему выпуска из-за неудавшейся проверки адресов. Причина - система анализа частоты
  347. -- запросов сайта для которого проверяется ссылка может воспринять многократные постоянные
  348. -- запросы несколько подряд раз за короткое время (а именно так это будет выглядеть при массовой
  349. -- отсылке Персональных писем) как атаку на сайт и не давать проверить ссылку.
  350. -- По этому, по умолчанию, для personal проверка ссылок не производится.
  351. -- Включить её для всего выпуска вы всегда можете задав параметр test в явном виде.
  352. -- Включить её для отдельных выпусков вы всегда можете атрибутом x-do-link-test
  353.  
  354. -- Глобальные настройки из relink.param можно переопределить для любого
  355. -- конкретного тега A и IMG указав в них не стандартные атрибуты
  356. -- "x-do-link-relink" и "x-do-link-test" влияющие на преобразование
  357. -- и тестирование по следующим правилам:
  358. --
  359. -- Атрибут отсутствует или пуст - учитывается глобальная настройка
  360. -- Атрибут = 1 - делать действие не смотря на глобальную настройку
  361. -- Атрибут = 0 - не делать действие не смотря на глобальную настройку
  362. --
  363. -- В отличи от параметра "test", зависящего от "link" и "image",
  364. -- явное указание атрибута x-do-link-test="1" всегда вызывает проверку ссылки
  365. -- не смотря на то, что преобразование для неё может и не проводиться
  366. -- из-за настроек link/image/x-do-link-relink
  367. }
  368.  
  369. * для Viber - параметры преобразования ссылок для учёта перехода по ним
  370.  
  371. -- Аналогично как для Email но действует только на ссылку button.link
  372. -- По этому не имеет варианта image и не применимы замечания про атрибуты x-do-relink-*
  373.  
  374. "relink" : 0|1 -- Преобразовывать ссылки автоматически
  375. -- 1 - да, 0 - нет
  376. --
  377. -- !!!
  378. -- С 17 АВГУСТА 2018 ГОДА ПО УМОЛЧАНИЮ - 1 !!!
  379. -- !!!
  380.  
  381. "relink.param" : {
  382. "link" : 0|1
  383.  
  384. "test" : 0|1
  385. }
  386.  
  387. * для Push - параметры преобразования ссылок для учёта перехода по ним
  388.  
  389. -- Не имеет варианта image и не применимы замечания про атрибуты x-do-relink-*
  390.  
  391. "relink" : 0|1 -- Преобразовывать ссылки автоматически
  392. -- 1 - да, 0 - нет
  393. --
  394. -- !!!
  395. -- С 17 АВГУСТА 2018 ГОДА ПО УМОЛЧАНИЮ - 1 !!!
  396. -- !!!
  397.  
  398. "relink.param" : {
  399. "link" : 0|1 -- действует на click.url
  400.  
  401. "test": 0|1 -- действует на click,url, icon.url, image.url
  402. }
  403.  
  404. * для SMS - параметры преобразования ссылок для учёта перехода по ним
  405.  
  406. -- Ссылки преобразуются через сокращатель, что дополнительно снижает длину (и, значит, цену) сообщения
  407. -- Доступна статистика переходов для тех ссылок которыми воспользовались получатели
  408.  
  409. "relink" : 0|1 -- Преобразовывать ссылки автоматически
  410. -- 1 - да, 0 - нет
  411. -- По умолчанию 0 - в отличии от других форматов
  412.  
  413. "relink.param" : {
  414. "link" : 0|1 -- по умолчанию 0
  415.  
  416. "test" : 0|1 -- по умолчанию 0
  417. }
  418.  
  419. * для Email - параметр преобразования ссылок для отслеживания перехода по ним с помощью сторонних сервисов
  420.  
  421. "link.qsid": "Параметр для отслеживания переходов по ссылкам через сторонние сервисы"
  422. -- добавляется ко всем ссылкам через query-string
  423. -- значение должно быть уже url-encoded
  424. -- при выпуске по черновику, если этот параметр пуст, то берётся link.qsid из черновика
  425. -- обычно содержит utm-метки и используется для отслеживания через сервисы типа Google Analitics
  426. -- не имеет ни какого отношения к параметра relink*
  427. -- если к какой-то ссылке параметр добавлять не требуется, то укажите в теге нестандартный
  428. -- параметр x-no-qsid со значением 1
  429.  
  430. * для Viber - параметр преобразования ссылок для отслеживания перехода по ним с помощью сторонних сервисов
  431. -- Аналогично как и для Email но действует только на ссылку button.link
  432.  
  433. "link.qsid": "Параметр для отслеживания переходов по ссылкам через сторонние сервисы"
  434.  
  435. * для Push - параметр преобразования ссылок для отслеживания перехода по ним с помощью сторонних сервисов
  436. -- Аналогично как и для Email но действует только на ссылку click.url
  437.  
  438. "link.qsid": "Параметр для отслеживания переходов по ссылкам через сторонние сервисы"
  439.  
  440. * список получателей и данные персонализации для Экcпресс-Выпуска
  441. -- подробнее в разделе "Форматы данных для импортирования и Экспресс-Выпуска"
  442. -- данные персонализации могут быть дополнены внешними данными в процессе выпуска
  443. -- подробнее в разделе "Внешние данные для персонализации"
  444.  
  445. "users.list": адреса и данные персонализации -- непосредственно в СSV или XLSX
  446.  
  447. или
  448.  
  449. "users.list" : {
  450. "encoding" : "base64"
  451. ,"content" : "адреса и данные персонализации в base64" -- вариант для CSV и XLSX которые не получается передать в двоичном виде
  452. },
  453.  
  454. или
  455.  
  456. "users.list" : [ -- данные в формате JSON-массив
  457. { данные одного получателя }
  458. ..............
  459. ]
  460.  
  461. или
  462.  
  463. "users.list" : { -- данные в формате JSON-объект-ABO
  464. "caption" : [ описание столбцов ]
  465. ,"rows" : [
  466. [ данные одного получателя ]
  467. ..............
  468. ]
  469. }
  470.  
  471. или
  472.  
  473. "users.url": "url" -- по которому находятся список адресов с данными для персонализации
  474. -- внешиение ссылки http / https / ftp / ftps / sftp или из хранилища загрузок rfs://upload/путь-до-файла
  475.  
  476. -- Для запросов по SOAP (например к Siebel) схемы soap:// и soaps:// - обратитесь с Службу Поддержки
  477. -- для получения дополнительной информации
  478.  
  479. -- Для запросов из Google Big Query настройте внешнюю авторизация для схемы gbd:// (описано в вызовах authext.*)
  480. -- Данные получаются полной выборкой из указанной в урле вида gbd://authext:AUTHEXT_ID@DATASET_ID/TABLE_ID таблицы.
  481. -- Одна из колонок таблицы должна называться email - она послужит источником адресов получателей и доступно при персонализации текста письма под стандартным именем anketa.member.email
  482. -- Название остальных колонок не важно, но оно должно начитаться с латинской буквы и продолжаться латинскими буквами и цифрами.
  483. -- Для использования данных в персонализации используйте подстановки вида [% anketa.t.НАЗВАНИЕ-КОЛОНКИ-ТАБЛИЦЫ %] для всех колонок таблицы кроме email
  484.  
  485. -- При оформлении выпуска как действия по расписанию не забудьте, что эту ссылку можно кастомизировать
  486. -- временем и указать количество и интервал попыток получения данных. Подробнее в разделе Замечания
  487.  
  488. * параметры списка получателей для Экпресс-Выпуска
  489.  
  490. "only_unique": 0|1 -- Следить за уникальностью адресов в списке
  491. -- 1 - да, повторно встреченные адреса исключаются из выпуска
  492. -- 0 - нет, повторно встреченные адреса участвуют в рассылке
  493. * параметры объединения Экпресс-Выпусков
  494.  
  495. accumulate" : 0|1 -- только для Экспресс-Выпуска
  496. -- если Экспресс-Выпуск с такими же именем (параметр "name") когда-либо уже выпускался в текущем месяце,
  497. -- то этот запускаемый выпуск будет оформлен не как новый, а как продолжение уже вышедшего.
  498. -- полезно в случае если ваши CRM не может выдать весь реестр для рассылки за раз,
  499. -- а только порциями.
  500. -- с учётом параллельности приёма и выпуска заданий на рассылку, настоятельно рекомендуется
  501. -- выпустить сначала первую порцию и потом уже последующие можно запускать параллельно
  502.  
  503. * учёт множественных совпадений итератор в фильтре
  504.  
  505. "multiple" : 0|1 -- что делать с множественными совпадениями итератора
  506. -- 0 - по умолчанию, выпустить одно письмо
  507. -- 1 - по одному письму на совпадение
  508. -- В описании фильтра формата КД описано когда и чем это полезно.
  509.  
  510. * получатель для Транзакционных писем
  511.  
  512. "email" : "адрес получателя или номер телефона получателя"
  513. -- данные для персонализации берутся из базы
  514. --
  515. -- данные персонализации могут быть дополнены внешними данными в процессе выпуска
  516. -- подробнее в разделе "Внешние данные для персонализации"
  517. --
  518. -- при этом способе указания получателя он проверяется на возможность отсылки ему письма
  519. -- (синтаксическая верность адреса, стоп-лист, ошибки доставки, отписался) и вы сразу получите
  520. -- в ответ описание ошибки если она есть
  521. -- при других способах задания получателя, проверка на возможность выпуска происходит
  522. -- только при формировании рассылки
  523.  
  524. или
  525.  
  526. "users.list": один адрес и данные персонализации -- непосредственно в JSON (два варианта) или в СSV или XLSX
  527. -- подробнее в разделе "Форматы данных для импортирования и Экспресс-Выпуска"
  528. -- при указании только адреса данные персонализации берутся из базы
  529. -- при указании более чем одного адреса - ошибка выпуска
  530. -- данные персонализации могут быть дополнены внешними данными в процессе выпуска
  531. -- подробнее в разделе "Внешние данные для персонализации"
  532.  
  533. * Ограничение на размер тиража
  534.  
  535. -- не обязательно, по умолчанию - "100%"
  536.  
  537. ,"users.slice" : "число" - тираж составит не более "число" первых получателей. число - целое число больше нуля
  538.  
  539. или
  540.  
  541. ,"users.slice" : "процент%" - тираж составит указанный процент от всех получателей. процент - целое число больше нуля и меньше 101
  542.  
  543. * Ограничение количества контактов на получателя
  544.  
  545. -- ограничивает число высылаемых сообщений для каждого получателя
  546. --
  547. -- если за последний interval получателю уже сфомировано max и более сообщений, то он исключается из текущего выпуска
  548. --
  549. -- если у выпуска есть класс (указан или получен из черновика), то в расчёт лимита берутся только выпуски вышедшие по такому же классу
  550. --
  551. -- если у выпуска класс нет, то в расчёт лимита берутся вообще все выпуски
  552. --
  553. -- должны быть заданы оба параметра сразу или ни одного
  554. --
  555. -- не обязательно, по умолчанию не ограничено
  556.  
  557. ,"contact_rate" : {
  558. "interval" : "часы" -- за сколько последних часов проверять. число от 1 или -1 за всё время
  559. -- или
  560. "interval" : "днейd" -- за сколько последних дней проверять. день начинается в 00:00:00. число от 1 с окончанием "d"
  561. -- например:
  562. -- 1d - за сегодня, т.е с 00:00:00 сегодня
  563. -- 2d - за вчера и сегодня, т.е с 00:00:00 вчера
  564.  
  565. ,"max" : "число" -- лимит сообщений. число от 1
  566. }
  567.  
  568. * Высылка письма в наиболее подходящее для каждого получателя время индивидуально на основе его прошлой активности
  569.  
  570. -- например
  571. -- day и 4 - учитывая статистику дней недели выбрать наилучшее время в ближайшие 4 часа
  572. -- week и 12 -учитывая суммарную статистику недели выбрать наилучшее время в ближайшие 12 часа
  573. --
  574. -- если используется day и в указанном интервале вообще не было активности, то алгоритм переключается на week при этом interval устанавливается в 24 если он был более 24
  575. --
  576. -- если в указанном интервале лучшими являются несколько часов, то выбирается самый ранний
  577. --
  578. -- не совместимо с выпуском по часовым поясам tz_observance
  579. --
  580. -- заданы оба параметра сразу или ни одного
  581. --
  582.  
  583. ,"tz_best" : {
  584. "source" : "day" или "week" -- лучшее время определять с учётом дня недели выпуска рассылки (day) или по суммарным данным всех дней недели (week). по умолчанию - day
  585.  
  586. ,"interval" : число от 1 до 24 для week и от 1 до 168 для day -- число ближайших от выпуска часов среди которых искать наилучший (считая и час выпуска). по умолчанию - 4
  587. }
  588.  
  589. * Для email / viber / push ограничение на частоту отправки
  590. --
  591. -- все ограничения касаются только первой попытки отправки сообщения.
  592. -- если сообщение не принято сразу, то ограничения могут не быть соблюдены.
  593.  
  594. -- при совместном использовании с tz_observance, ограничение на частоту отправки действует независимо в каждом
  595. -- часовом поясе
  596.  
  597. ,"tz_limit" {
  598.  
  599. "default" : {
  600.  
  601. -- ограничение на частоту отправки сообщений
  602. -- за rate минут будет передано в доставку в не более number сообщений
  603. -- начиная со второго раз, number будет увеличиваться на increase каждый раз от текущего значения
  604.  
  605. -- если параметр отсутствует или пуст или обе величины равны 0,
  606. -- то ограничения нет
  607.  
  608. "batch" : { -- или отсутствуют или указаны оба значения
  609. "number" : "сколько cообщений" -- обязательно, >= 200
  610. ,"rate" : "за сколько минут" -- обязательно, >= 0
  611.  
  612. -- не обязательно, по умолчанию 0
  613.  
  614. ,"increase" : число -- увеличение number на указанное целое число, >= 0
  615.  
  616. -- или
  617.  
  618. ,"increase" : "число%" -- увеличение number на указанное число процентов, >= 0
  619. -- процент принимается с точностью до сотых
  620. -- при малых number, если наращивание даёт менее 1 получателя
  621. -- то принимается увеличение на 1 получателя
  622. -- процент равный нулю - отсутствие наращивания
  623. }
  624.  
  625. }
  626. }
  627.  
  628. * Для email / viber / push учёт часового пояса получателя
  629.  
  630. -- Не обязательно, при отсутствии учёта часового пояса нет и всё выходит сразу (если нет прочих настроек)
  631.  
  632. -- Не совместимо с tz_best
  633.  
  634. -- При выпуске с учётом временной зоны, письма будут заранее сформированы, но их первая попытка
  635. -- доставки начнётся не ранее, чем во временной зоне получателя начнётся указанный час
  636. -- по его локальному времени.
  637. --
  638. -- Источником данных может быть один или несколько пунктов анкеты подписчика.
  639. --
  640. -- Берётся первое определившееся время по порядку указания источников.
  641. --
  642. -- Если часовой пояс не удалось определить ни по одному из источников, то письмо начинает
  643. -- доставляться сразу (с учётом tz_limit)
  644. --
  645. -- В качестве указания на часовой пояс понимаются названия большинства стран и крупных городом
  646. -- в английском и русском написании (регистр не важен)
  647. --
  648. -- А так же, числовые смещения относительно UTC в виде
  649. --
  650. -- +hhmm -hhmm UTC+hhmm UTC-hhmm
  651. -- +hh -hh UTC+hh UTC-hh
  652. -- +h -h UTC+h UTC-h
  653. -- hh
  654. -- h
  655. --
  656. -- Используйте вызов sys.settings.get, что бы проверить понимает ли система ваш способ записи.
  657. -- Если нет - обратитесь в Службу Поддержки за расширением нашего списка городов и стран.
  658. --
  659. -- Во избежание путаницы с пониманием часовых поясов, настоятельно рекомендуется планировать
  660. -- такие рассылки не менее чем за 24 часа и учитывать особенности России - текущий час в Москве
  661. -- по всех других часовых поясах страны (за исключением Калининграда) уже прошёл и настанет
  662. -- там через через 15-23 часа в зависимости от удалённости.
  663.  
  664. -- при совместном использовании с tz_limit, ограничение на частоту отправки действует независимо в каждом
  665. -- часовом поясе
  666.  
  667. -- Настройка может быть указана и будет учтена по убыванию приоритета: при выпуске, в классе выпуска,в черновике, в классе черновика, глобально (sys.settings.set)
  668.  
  669. -- Если требуется отключить соблюдение местного времени, то в более приоритетном источнике необходимо задать tz_observance.source с не существующим ключём данных.
  670.  
  671. ,"tz_observance" : { -- не обязательно
  672.  
  673. "hour" : "час" -- от 00 до 23
  674. -- час по местному времени для начала доставки писем
  675. -- не обязательно, по умолчанию - текущий час для выпуска "сейчас"
  676. -- или час запуска для отложенного выпуска
  677.  
  678. ,"source" : [ -- обязательно. источники данных о временной зоне подписчика в его анкете.
  679. -- один и болеее.
  680. -- при отсутствии своих данных, можно использовать member.last.tz - автоматически
  681. -- обновляющееся системой значение на основании последнего клика или чтения
  682. "ключ-данных"
  683. ,"ключ-данных"
  684. ,"ключ-данных"
  685. ........
  686. ]
  687. }
  688.  
  689. * Для sms ограничение на частоту и время отправки
  690.  
  691. -- все ограничения касаются только первой попытки отправки сообщения в sms-центр.
  692. -- если sms-центр не принял сообщение сразу или принял, но внутри себя
  693. -- по какой-то причине не пытался доставить сразу, то ограничения могут не быть соблюдены.
  694.  
  695. -- допустимы временные зоны относительно GMT от -23 до +23 и default. знаки "+" и "-" обязательны.
  696.  
  697. -- временная зона телефонного номера сотовой связи определяется по базе Федерального Агентства Связи.
  698.  
  699. -- если при выпуске tz_limit не задан явно, то транзакционные смс выходят сразу, а на остальные действует
  700. -- ограничение по умолчанию - время отправки с 9 по 21 час местного времени
  701.  
  702. ,"tz_limit" {
  703.  
  704. "default" : { -- настройки по умолчанию для не описанных зон или отсутствующих описаний с описанной зоне
  705.  
  706. -- ограничение на частоту отправки сообщений
  707. -- за rate минут будет передано в доставку в sms-центр не более number сообщений
  708. --
  709. -- если параметр отсутствует или пуст или обе величины равны 0,
  710. -- то ограничения нет
  711.  
  712. "batch" : { -- или отсутствуют или указаны оба значения
  713. "number" : "сколько cообщений" -- обязательно, >= 0
  714. ,"rate" : "за сколько минут" -- обязательно, >= 0
  715. }
  716.  
  717. -- ограничение по времени отправки
  718. -- *все даты и часы по местному времени временной зоны !!!*
  719.  
  720. ,"time" : {
  721. "dt" : "YYYY-MM-DD" -- отправка начнётся не ранее указанного дня.
  722. -- если не указано или пусто или в прошлом,
  723. -- то используется текущая даты зоны MSK/MSD
  724.  
  725. ,"hour" : [ час, час, час, ... ] -- разрешённые часы местного времени (0-23) в которые будет осуществлять отправка
  726. -- если не указано или пусто, то разрешены часы с 9 по 21
  727. -- подумайте, стоит ли расширять этот диапазон на утреннее и ночное время !
  728. --
  729. -- порядок следования часов важен для первого дня отправки !
  730. -- запись
  731. -- {
  732. -- "dt" : "2012-09-17"
  733. -- ,"hour" : [ 20, 21, 22, 23, 06 08 07 ]
  734. -- }
  735. -- задаёт разрешённые часы с 6, 7, 8, 20, 22 и 23 и начало рассылки 17го декабря
  736. -- но именно 17го она начнётся не в 6 часов, а в 20, так как 20 указано первым
  737. -- а 18го и далее - начиная с 6
  738. --
  739. -- разрешается весь час - последняя отправка в нём может быть
  740. -- даже в 59 минут 59 секунд, что может выглядеть как уже "не разрешённый" час
  741. -- т.к. сообщение будет доставлено уже явно в следующем часе.
  742. }
  743.  
  744. }
  745.  
  746. ,"+4" : { -- ограничение для временной зоны GMT+4
  747.  
  748. -- полностью отсутствующий или пустой компонент берётся из default
  749.  
  750. "batch" : { .... } -- используйте 0 для rate и number что-бы снять ограничение из default
  751.  
  752. ,"time" : { .... } -- *дата и часы по местному времени временной зоны !!!*
  753. --
  754. -- если задано только dt, то действуют стандартные разрешённые часы с 9 по 21
  755. -- подумайте, стоит ли расширять этот диапазон на утреннее и ночное время !
  756. --
  757. -- если задано только time, то то используется текущая даты зоны MSK/MSD
  758. --
  759. -- если не задано ни dt ни time, то действуют ограничения из default
  760.  
  761. }
  762.  
  763. ,"-2" : { -- ограничение для зоны GMT-2
  764. ..........
  765. }
  766.  
  767. ..........
  768.  
  769. }
  770.  
  771. * время жизни сообщения для Email
  772.  
  773. ,"ttl" : число -- время в секундах хранения сообщения при невозможности доставить сразу (ошибки доставки 4xx)
  774. -- не обязательно. по умолчанию 4 дня
  775. -- не рекомендуется задавать менее 1 часа. если всё же попробуете - расскажите нам как получилось.
  776.  
  777. * время жизни сообщения для Push
  778.  
  779. ,"ttl" : число -- время в секундах хранения сообщения при невозможности отобразить сразу
  780. -- не обязательно. по умолчанию 12 часов
  781.  
  782. * данные произвольной структуры *одинаковые для всех подписчиков*
  783.  
  784. -- эти данные трактуются в по моделе КД
  785.  
  786. -- эти данные будут доступны для шаблонизатора выпуска как переменные с именем совпадающим с именем ключа хэша
  787.  
  788. -- эти данные могут быть дополнены из черновика. указанные здесь имеют больший приоритет.
  789.  
  790. -- эти данные могут быть дополнены внешними данными в процессе выпуска - подробнее в разделе "Внешние данные для персонализации"
  791.  
  792. -- в настоящий момент зарезервированы имена:
  793. -- anketa - данные о конкретном подписчике
  794. -- lenta - данные для подстановки rss/atom каналов
  795. -- date - интерфейс к функциям работы с датой и временем
  796. -- form - форма опроса
  797.  
  798. -- во избежание пересечений с новыми стандартными именами рекомендуется
  799. -- свои имена начинать с большой буквы
  800.  
  801. ,"extra" : {
  802. "Key1" : [ 12, 34 ,56 ] -- пример использования [% Key1[2] %]
  803.  
  804. ,"City" : { -- пример использования [% City.rus.long %]
  805. "rus" : {
  806. "long" : "Санкт-Петербург"
  807. ,"short" : "СПБ"
  808. ,"eng" : {
  809. "long" : "Leningrad"
  810. ,"short" : "LED"
  811. }
  812. }
  813.  
  814. }
  815.  
  816. ,"reltype" : ...
  817. ,"relref" : ...
  818. }
  819.  
  820. ответ
  821.  
  822. {
  823.  
  824. <общие поля>
  825.  
  826. ,"track.id" : номер -- номер асинхронного запроса для отслеживания с помощью track.*
  827. --
  828. -- так же можно получать callback по достижению трекром конечного состояния - т.е. по завершения выпуска
  829. --
  830. -- после выпуска Транзакционного письма полученный письмом номер "letter" будет в отчёте track.get
  831. -- для данного track.id. Используя letter в stat.uni можно получить информацию по данному конкретному
  832. -- Транзакционному письму.
  833.  
  834. }
  835. Список отложенных выпусков
  836.  
  837. {
  838.  
  839. "action" : "issue.later.list",
  840.  
  841. ,"from" : "YYYY-MM-DD" -- от даты (не обязательно)
  842.  
  843. ,"upto" : "YYYY-MM-DD" -- до даты (не обязательно)
  844.  
  845. ,"group" : [ -- фильтр по группам (не обязательно)
  846.  
  847. код-группы-1
  848.  
  849. ,код-группы-2
  850.  
  851. ...
  852.  
  853. ]
  854.  
  855. ,"format" : "email|sms|viber|push|html|text" -- фильтр по формату (не обязательно).
  856. -- email это "html или text"
  857.  
  858. ,"draft" : номер черновика" -- фильтр по черновику (не обязательно)
  859. -- параметр отсутствует - не фильтровать
  860. -- параметр присутствует но пустой - все выпуски не по черновикам
  861.  
  862. }
Advertisement
Add Comment
Please, Sign In to add comment
Advertisement
Public Pastes
Advertisement
We use cookies for various purposes including analytics. By continuing to use Pastebin, you agree to our use of cookies as described in the Cookies Policy.  OK, I Understand
Not a member of Pastebin yet?
Sign Up, it unlocks many cool features!