Poradnik - Dokumentacja API

Mailingi

Lista operacji dla zasobu

Nazwa URL Opis
Lista szablonów mailingów /mailing/templates Zwraca listę wszystkich szablonów mailingów dla zalogowanego użytkownika. Szablony posortowane wg. daty dodania rosnąco.
Tworzenie mailingu /mailing/create Operacja do zdefiniowania mailingu. Argumentami są id szablonu oraz zestaw respondentów. Mailing po stworzeniu zostaje niezwłocznie wysłany do adresatów

Opis parametrów odpowiedzi

Nazwa/ścieżka Opis Możliwe wartości
id ID ankiety
name  Tytuł szablonu
subject Tytuł mailingu
content Treść wiadomości w mailingu
date_created Data utworzenia szablonu
id_mailing ID stworzonego mailingu w systemie
receivers liczba respondentów, którzy otrzymają zaproszenie
footer możliwość wyłączenia stopki z informacją o nadawcy. Domyślnie stopka jest włączona

Lista szablonów mailingów

URL

(GET) https://www.webankieta.pl/api/mailing/templates

Parametry opcjonalne (POST)

Brak

Przykładowa odpowiedź


{
  ["total"] => string(1) "2"
  ["list"] => array(2) {
    [0] => array(5) {
      ["id"] => int(7)
      ["name"] => string(7) "Testowa"
      ["subject"] => string(35) "Zaproszenie do wypełnienia ankiety"
      ["content"] => string(251) "<p>Witaj,<br /> <br /> Zapraszam do wypełnienia ankiety na temat ...<br /> Wypełnienie ankiety powinno zająć około ... minut<br /> <br /> Aby wypełnić ankietę kliknij na link:<br /> [LINK]<br /> <br /> <br /> <br /> Dziękuję i pozdrawiam</p>"
      ["date_created"] => string(19) "2015-04-24 13:36:00"
    }
    [1] => array(5) {
      ["id"] => int(8)
      ["name"] => string(8) "Testowa2"
      ["subject"] => string(35) "Zaproszenie do wypełnienia ankiety"
 <p>testowa 2<br /> <br /> Zapraszam do wypełnienia ankiety na temat ...<br /> Wypełnienie ankiety powinno zająć około ... minut<br /> <br /> Aby wypełnić ankietę kliknij na link:<br /> [LINK]<br /> <br /> <br /> <br /> Dziękuję i pozdrawiam</p>"
      ["date_created"] => string(19) "2015-04-24 13:36:19"
    }
  }
}

Zwracane błędy

Brak

Tworzenie mailingu

URL

(GET) https://www.webankieta.pl/api/mailing/create

Parametry POST

Nazwa Opis
id_survey ID ankiety
id_template ID szablonu mailingu
date_send Data wysyłki mailingu w formacie yyyy-mm-dd hh:mm:ss
mode Możliwe zbiory adresatów mailingu:
all – wszyscy respondenci z listy
new – wszyscy nowo dodani respondenci, do których jeszcze nie było wysyłane zaproszenie
reminders – przypomnienia do osób, które otrzymały wcześniej zaproszenie, ale nie wypełniły ankiety
selected – respondenci wybrani. Przy wyborze tego parametru należy przekazać ID respondentów w kolejnym parametrze.
respondents_ids ID respondentów przekazanych po przecinku. Ten parametr jest obowiązkowy w przypadku przekazania mode=selected

Przykładowa odpowiedź

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

Zwracane błędy

  • 400 Bad request – Nieprawidłowy format daty, nieprawidłowy status lub nieprawidłowy poziom bezpieczeństwa
  • 401 Unautorized – Brak dostępu do szablonu o podanym ID
  • 403 Forbidden – Przekroczone limity wysyłek zaproszeń na koncie
  • 404 Not found – Nie znaleziono ankiety o podanym ID na koncie zalogowanego użytkownika
  • 500 Internal Server Error – Wewnętrzny błąd serwera.

Czy ten artykuł był pomocny?

Dziękujemy za udzielenie odpowiedzi