W tym artykule dowiesz się, jak krok po kroku wysłać mailing do wielu respondentów. Opisuję jakie operacje należy wykorzystać, w jakiej kolejności i w jaki sposób powiązać je ze sobą w logiczną całość.
Pozwolę sobie pominąć kwestie związane z autoryzacją i logowaniem się na konto. Zakładam, że wiesz jak to zrobić.
Ankieta
Zakładam też, że znasz ID ankiety, do której będziesz zapraszać. Jeżeli nie znasz ID swojej ankiety, to jest to liczba, która pojawia się w podstawowym linku do ankiety, np.:
123456 to ID Twojej ankiety.
Alternatywnie możesz skorzystać z operacji API do pobrania listy ankiet na Twoim koncie. W odpowiedzi uzyskasz ID swojej ankiety
Import respondentów i wysyłka mailingu
Tworzymy batch (proces), do którego będziemy dodawać respondentów. Szczegóły znajdują się w dokumentacji operacji
/api/v2/respondents/batch
.Zapamiętujemy parametr
batch_id
, który otrzymamy po wywołaniu operacji tworzenia batch-aWysyłamy batch_id do operacji
/api/respondents/patch
, razem z danymi o respondentach. Te operację wywołujemy tyle razy, aż załadujemy w kolejnych paczkach wszystkich respondentów do mailingu. Nie ma tutaj ograniczenia na liczbę respondentów.Po wgraniu wszystkich respondentów Tworzymy mailing z wykorzystaniem
batch_id
. Służy do tego operacja:/api/v2/mailings/batch
.W wywołaniu tej operacji przekazujemy
batch_id
z pierwszej operacji i id_template szablonu wiadomości, który chcesz wysłać.Sprawdzamy, czy mailing zdefiniował się prawidłowo za pomocą metody /api/v2/mailings/:mailingId, gdzie za mailingId podstawiamy zwrócone ID mailingu. Mailing może być w jednym z następujących statusów: preparing (jeżeli załadowałeś bardzo dużo respondentów zlecenie mailingu może zająć dłuższą chwilę), waiting/pending (jeżeli mailing jest już przygotowany i czeka na wysyłkę) lub sent(jeżeli Twój mailing został już wysłany)
Jeżeli nie wiesz skąd pobrać template_id
, opisujemy to w tym artykule.