Sprievodca - API

Mailing

Zoznam operácií pre zdroj

NázovURLPopis
Zoznam šablón mailingov/mailing/templatesVracia zoznam všetkých šablón mailingu pre prihláseného užívateľa. Šablóny sú triedené vzostupne podľa dátumu pridania.
Tvorba mailingu/mailing/createOperácie pre definovanie mailingu. Argumenty sú ID šablóny a skupina respondentov. Po vytvorení je mailing okamžite rozoslaný príjemcom

Opis parametrov odpovede

Názov/cestaPopisMožné hodnoty
idID dotazníka
nameNázov šablóny
subjectSubjekt mailingu
contentObsah správy mailingu
date_createdDátum vytvorenia šablóny
id_mailingID vytvoreného mailingu v systéme
receiversPočet respondentov, ktorí obdržia pozvánku
footerMožnosť vypnutia zápätia s informáciami o odosielateľovi. Štandardne zapnuté

Zoznam šablón mailingov

URL

(GET) https://www.netquest.sk/api/mailing/templates

Nepovinné parametre (POST)

Žiadne

ukážka odpovede

{
  ["total"] => string(1) "2"
  ["list"] => array(2) {
    [0] => array(5) {
      ["id"] => int(7)
      ["name"] => string(7) "Test"
      ["subject"] => string(35) "Pozvánka k vyplneniu dotazníka"
      ["content"] => string(251) "<p>Ahoj,<br /> <br />rád by som Vás pozval na vyplnenie dotazníka ... <br />Vyplnenie by nemalo zabrať viac ako ... minút <br /> <br />  Pre vyplnenie dotazníka kliknite na nasledujúci odkaz. <br /> [LINK]<br /> <br /> <br /> <br />Ďakujem. <br /> S pozdravom  </p>"       
      ["date_created"] => string(19) "2019-04-24 13:36:00"     } 

Ahoj,

rád by som Vás pozval na vyplnenie dotazníka …
Vyplnenie by nemalo zabrať viac ako … minút

Pre vyplnenie dotazníka kliknite na nasledujúci odkaz.
[LINK]

Ďakujem.
S pozdravom

Chybové hlášky

Žiadne

Tvorba mailingu

URL

(GET) https://www.netquest.sk/api/mailing/create

Parametre (POST)

NázovPopis
id_surveyID dotazníka
id_templateID šablóny mailingu
date_sendDátum rozoslania mailingu vo formáte yyyy-mm-dd hh: mm: ss
modeMožný výber respondentov mailingu:
all – všetci respondenti zo zoznamu
new – všetci novo pridaní respondenti, ktorým ešte nebol mailing odoslaný
reminders – pripomenutie osobám, ktorí si prezreli pozvánku, ale ešte nevyplnili dotazník
selected – vybraní respondenti. Pri výbere tohto parametra je nutné odovzdať ID respondentov v nasledujúcom parametri.
respondents_idsID respondentov poskytnutých za desatinnou čiarkou. Tento parameter je povinný v prípade režime mode = selected

Ukážka odpovede

[
  {
    ["id_mailing"] => string(3) "585"
    ["receivers"] => int(0)
  }
]

Chybové hlášky

400 Zlá požiadavka – nesprávny formát dátumu, nesprávny status alebo nesprávna úroveň zabezpečenia dotazníka
401 Neautorizovaný – žiadny prístup k šablóne s daným ID
404 Nenájdené – neboli nájdené žiadne dotazníky daného ID v účte prihláseného užívateľa
500 Interná chyba servera – interná chyba servera

Pomohol Vám tento článok?

Ďakujeme za odpoveď