mailkit.email.topics

Funkce mailkit.email.topics nastaví téma kampaní konkrétnímu příjemci.

Témata kampaní dovolují třídit kampaně do různých typů jejich zaměření. Na základě tohoto rozdělení si mohou příjemci určit své preference, o jaké typy sdělení mají zájem. Prostřednictvím funkce mailkit.email.unsubscribe.getstatus je možné získat seznam témat, ze kterých je daný příjemce odhlášen.

Ukázka API volání:

XML

<?xml version="1.0"?>
<methodCall>
 <methodName>mailkit.email.topics</methodName>
 <params>
  <param>
   <value>
    <int>client_id</int>
   </value>
  </param>
  <param>
   <value>
    <string>client_md5</string>
   </value>
  </param>
  <param>
   <value>
    <struct>
     <member>
      <name>ID_topics</name>
      <value>
       <array>
        <data>
         <value>
          <i4>123</i4>
         </value>
		 <value>
          <i4>124</i4>
         </value>
        </data>
       </array>
      </value>
     </member>
     <member>
      <name>email</name>
      <value>
       <string>mail@mailkit.eu</string>
      </value>
     </member>
     <member>
      <name>activate_all</name>
      <value>
       <boolean>FALSE</boolean>
      </value>
     </member>
    </struct>
   </value>
  </param>
 </params>
</methodCall>

Hodnoty

client_id* = API ID naleznete ve svém Mailkit účtu v menu Profil / Integrace.
client_md5* = MD5 kód naleznete ve svém Mailkit účtu v menu Profil / Integrace.
ID_topics** = ID tématu kampaní
email* = e-mailová adresa příjemce
activate_all** = TRUE / FALSE (při TRUE se aktivují všechna témata)

* povinný parametr

** kombinací parametrů a jejich hodnot lze docílit různých nastavení témat:

• pokud activate_all = TRUE, dojde k přihlášení všech v účtu používaných témat. Pokud ve volání zadáte i hodnotu/hodnoty pro ID_topics, budou ignorovány, i tak dojde k přihlášení všech používaných témat
• pokud activate_all = FALSE (nebo nebude zaslána žádná hodnota pro tento parametr (hodnota FALSE je nastavena jako defaultní)) a zároveň ve volání nezadáte žádné hodnoty pro ID_topics, dojde k odhlášení všech používaných témat.
• pokud activate_all = FALSE (nebo nebude zaslána žádná hodnota pro tento parametr (hodnota FALSE je nastavena jako defaultní)) a zároveň zadáte hodnotu/hodnoty pro ID_topics, dojde k přihlášení témat, jejichž ID byla ve volání uvedena, ostatní témata (jejichž ID nebyla ve volání uvedena) budou odhlášena.

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

XML

<?xml version="1.0" encoding="utf-8"?>
<methodResponse>
    <params>
        <param>
            <value>
                <struct>
                    <member>
                        <name>names_inactive</name>
                             <value>
                                <array>
                                    <data></data>
                                </array>
                        </value>
                    </member>
                    <member>
                        <name>email</name>
                            <value>
                                <string>email@example.eu</string>
                            </value>
                    </member>
                    <member>
                        <name>status</name>
                    <value>
                        <string>OK</string>
                    </value>
                </member>
                <member>
                    <name>names_active</name>
                    <value>
                        <array>
                            <data>
                                <value>
                                    <string>Téma 1(123)</string>
                                </value>
                                <value>
                                    <string>Téma 2(124)</string>
                                </value>
                            </data>
                        </array>
                    </value>
                </member>
                <member>
                    <name>ID_topic_inactive</name>
                    <value>
                        <array>
                            <data></data>
                        </array>
                    </value>
                </member>
                <member>
                    <name>ID_topic_active</name>
                        <value>
                            <array>
                                <data>
                                    <value>
                                        <i4>123</i4>
                                    </value>
                                    <value>
                                        <i4>124</i4>
                                    </value>
                                </data>
                            </array>
                        </value>
                    </member>
                </struct>
            </value>
        </param>
    </params>
</methodResponse>

Hodnoty

status = OK
email = e-mailová adresa, které bylo provedeno nastavení témat kampaní
ID_topic_active = seznam aktivních témat kampaní
ID_topic_inactive = seznam vypnutých témat kampaní
names_active = názvy aktivních témat kampaní
names_inactive = názvy vypnutých témat kampaní