Subskrybenci – zarządzanie subskrybentami

Kontroler służy do dodawania i aktualizowania danych o subskrybentach w listach subskrypcyjnych.

Kody statusów subskrybentów

Opis słowny Wartość Objaśnienie
Aktywny 1 Subskrybent aktywny do którego mogą być wysyłane kampanie
Do aktywacji 2 Subskrybent który musi kliknąć w link akceptacyjny w mailu potwierdzającym jego dodanie do listy
Nieaktywowany 3 Subskrybent który po okresie kilku dni nie kliknął w link akceptacyjny w mailu potwierdzającym
Wypisany 4 Subskrybent który wypisał się z subskrypcji
Odbijajacy „miękko” 5 Subskrybent którego skrzynka kilka razy z rzędu zwróciła maila z odpowiednim kodem (więcej: http://www.ietf.org/rfc/rfc1893.txt)
Odbijajacy „twardo” 8 Subskrybent którego skrzynka kilka razy z rzędu zwróciła maila z odpowiednim kodem (więcej: http://www.ietf.org/rfc/rfc1893.txt)

Dodanie subskrybenta 

Metoda dodaje subskrybenta jeśli nie było go w liście subskrypcyjnej lub aktualizuje jego status i dane jeśli nie był w statusie „Aktywny” oraz „Do aktywacji”

Wywołanie:

POST /rest/subscriber/add

 

Dane w POST:

  email   Wymagane    Adres email subskrybenta
  list   Wymagane   Hash list subskrypcyjnej
  state   Opcjonalne   Status jaki chcemy nadać subskrybentowi, jeśli pole będzie puste zostanie nadany status „Do aktywacji”, lista dostępnych statusów w dziale „Kody Statusów Subskrybentów”
  confirm   Opcjonalne   Czy do subskrybenta ma być wysłany email potwierdzający. Możliwe wartości to 0 oraz 1. Jeśli pole będzie puste zostanie wysłany email z potwierdzeniem. To pole jest ignorowane (email nie zostanie wysłany) jeśli nadamy subskrybentowi status inny niż „Do aktywacji”.
  custom_fields   Opcjonalne   Tablica z polami dodatkowymi i wartościami w postaci:{"tag personalizacji pola 1":"wartość","tag personalizacji pola 2":"wartość"}

 

Kody błędów:

  1301 Adres email jest niepoprawny
  1302 Lista subskrypcyjna nie istnieje lub brak hash'a listy
  1303 Jedno lub więcej pól dodatkowych jest niepoprawne
  1304 Subskrybent już istnieje w tej liście subskrypcyjnej i ma status Aktywny lub Do aktywacji
  1305 Próbowano nadać niepoprawny status subskrybenta

Modyfikowanie danych subskrybenta

Metoda aktualizuje status i dane subskrybenta 

Wywołanie:

POST /rest/subscriber/edit

 

Dane w POST:

  email Wymagane 

Adres email subskrybenta

  list Wymagane

Hash list subskrypcyjnej

  state Opcjonalne

Status jaki chcemy nadać subskrybentowi, jeśli pole będzie puste aktualny status subskrybenta nie zostanie zmieniony

  custom_fields Opcjonalne

Tablica z polami dodatkowymi i wartościami w formacie:

{"tag personalizacji pola 1":"wartość",

"tag personalizacji pola 2":"wartość"}

 

Kody błędów:

  1331 Subskrybent nie istnieje
  1302 Lista subskrypcyjna nie istnieje lub brak hash'a listy
  1305 Próbowano nadać niepoprawny status subskrybenta

Pobieranie danych subskrybenta

Wywołanie:

GET /rest/subscriber/get/[list]/[email]

 

Dane w GET:

  email Wymagane  Adres email subskrybenta
  list Wymagane Hash list subskrypcyjnej

 

Zwracane dane:

  email Adres email subskrybenta
  state Status subskrybenta (zgodny z opisem w dziale „Kody Statusów Subskrybentów”)
  custom_fields Wartość pól dodatkowych danego subskrybenta
  id_hash Unikalny identyfikator kampanii

 

Kody błędów:

  1311 Adres email jest niepoprawny
  1312 Lista subskrypcyjna nie istnieje

Kasowanie subskrybenta

Metoda kasuje subskrybenta z listy subskrypcyjnej

Wywołanie:

POST /rest/subscriber/delete

 

Dane w POST:

  email Wymagane  Adres email subskrybenta
  list Wymagane Hash list subskrypcyjnej

 

Kody błędów:

  1321 Adres email nie istnieje w tej liście subskrypcyjnej
  1322 Lista subskrypcyjna nie istnieje lub brak hash'a listy

Pobieranie historii akcji subskrybenta

Metoda pobiera ostatnie akcje subskrybenta

Wywołanie:

POST /rest/subscriber/getHistory

 

Dane w POST:

  email Wymagane  Adres email subskrybenta
  list Wymagane Hash list subskrypcyjnej
  limit Opcjonalne Ilość pobranych akcji subskrybenta (domyślnie 10)

 

Przykładowy request:

{"email":"tester1@freshmail.pl"
"list":"4zcnmd2ski"
"limit":"30"}

 

Zwracane dane:

  name Nazwa kampanii
  email_topic Temat kampanii
  scheduled_sent Data i czas wysłania kampanii (format: rrrr-mm-dd hh:ii:ss)
  state Status subskrybenta (dostarczony, odbicie miękkie, odbicie twarde)
  opens_count Ilość otwarć subskrybenta
  clicks_count Ilość kliknięć subskrybenta

 

Kody błędów:

  1311 Adres email jest niepoprawny
  1312 Lista subskrypcyjna nie istnieje
  1313 Subskrybent nie istnieje w podanej liście subskrypcyjnej
  1314 Wartość atrybutu limit jest niepoprawna
  1315 Subskrybent nie posiada akcji

 

Przykład odpowiedzi niepoprawnej:

{"status":"ERROR",
"errors":[{
"message":"Subscriber doesn't exist",
"code":1313 }]}

Przykład odpowiedzi poprawnej:

{"status":"OK",
"data":[{
"name":"4 kampania wtorkowa z dnia 30.07.2013",
"email_topic":"Jesienna promocja",
"scheduled_sent":"2013-07-30 21:37:42",
"state":"DELIVERED",
"opens_count":"1",
"clicks_count":"2" }]}