PodporaAPI dokumentace

mailkit.email.revalidate

Funkce mailkit.email.revalidate znovu přihlásí odhlášeného příjemce.

Tato funkce bude v budoucnu zrušena ve prospěch funkce mailkit.mailinglist.adduser, která slouží jako jednotná metoda pro přidávání příjemců do seznamu.

Ukázka API volání:

XML

<?xml version="1.0"?>
<methodCall>
  <methodName>mailkit.email.revalidate</methodName>
  <params>
    <param>
    <value>
      <int>client_id</int>
    </value>
    </param>
    <param>
    <value>
      <string>client_md5</string>
    </value>
    </param>
    <param>
    <value>
      <int>ID_email</int>
    </value>
    </param>
    <param>
    <value>
      <int>ID_message</int>
    </value>
    </param>
    <param>
    <value>
      <boolean>agreement</boolean>
    </value>
    </param>
    <param>
    <value>
      <string>channel</string>
    </value>
    </param>
    <param>
    <value>
      <int>dummy</int>
    </value>
    </param>
    <param>
    <value>
      <string>language</string>
    </value>
    </param>
  </params>
</methodCall>
		

JSON

{  
   "id":"client_id",
   "md5":"client_md5",
   "function":"mailkit.email.revalidate",
   "parameters":{  
      "email":"email",
      "language":"CZ",
      "ID_message":"ID_message",
      "ID_email":"ID_email",
      "channel":"channel",
      "agreement":"FALSE"
   }
}

Hodnoty

client_id * = API ID naleznete ve svém Mailkit účtu v menu Profil / Integrace / Nastavení API.
client_md5 * = MD5 kód naleznete ve svém Mailkit účtu v menu Profil / Integrace / Nastavení API.
ID_email * = Pro XML volání může obsahovat buď konkrétní ID e-mailu (vrací např. funkce mailkit.mailinglist.adduser), nebo e-mailovou adresu.
email * = emailová adresa
V JSON volání může být použit bud parametr email, nebo parametr ID_email.
ID_message = ID kampaně, volitelný parametr. Z šablony této kampaně bude použit Soubor šablony přihlašovacího e-mailu - vzhled a obsah ověřovacího e-mailu, který bude zaslán znovu přihlašovanému příjemci.
ID_template = ID šablony, volitelný parametr, pouze u JSON. Z této šablony bude použit Soubor šablony přihlašovacího e-mailu - vzhled a obsah ověřovacího e-mailu, který bude zaslán znovu přihlašovanému příjemci.
agreement * = může nabývat hodnot TRUE / FALSE

  • TRUE = příjemce souhlasil se znovuzařazením do mailing listu. Nebude mu zaslán žádný další potvrzovací e-mail. Do parametru channel se může uložit, jakou cestou se příjemce znovu přihlásil (např. telefon)
  • FALSE = příjemci bude zaslán e-mail s verifikačním linkem a do seznamu bude znovu přidán až po kliknutí na ověřovací link

channel = kanál, jakým přišel souhlas s rozesíláním. V případě, že proměnná souhlas má hodnotu FALSE se doplní po přijetí potvrzení IP adresa.
dummy = prázdná hodnota, nutné zasílat pro zpětnou kompatibilitu (pouze pro XML)
language = jazyk, ve kterém má být příjemci zaslán e-mail s verifikačním linkem. Možné hodnoty jsou: cs,en,de,ru,pl,sk,hu
* povinný parametr

Po úspěšném volání se vrací:

XML

<?xml version="1.0" encoding="utf-8"?>
<methodResponse>
  <params>
    <param>
      <value>
        <string>example@example.cz</string>
      </value>
    </param>
  </params>
</methodResponse>
		

JSON

{
    "email": "email@example.com",
    "error_status": 0,
    "ID_email": "123456789",
    "error": "Sent subscribe email"
}

Hodnoty

e-mail = zaslaný e-mail byl znovupřihlášen / na daný e-mail byla zaslána zpráva s verifikačním linkem (XML)

Sent subscribe email = na daný e-mail byla zaslána zpráva s verifikačním linkem (JSON)
Email has been revalidated = e-mail byl znovupřihlášen (JSON)

Příklad neúspěšného volání:

XML

<?xml version="1.0" encoding="utf-8"?>
<methodResponse>
  <params>
    <param>
      <value>
        <string>example@example.cz is not unsubscribed</string>
      </value>
    </param>
  </params>
</methodResponse>
		

JSON

{
    "error_status": 0,
    "ID_email": "123456789",
    "error": "Email is not unsubscribed",
    "email": "sample@samplemail.com"
}

Hodnoty

Email is not unsubscribed = e-mail není odhlášený, nelze ho tedy znovu přihlásit