PodporaAPI dokumentace

mailkit.mailinglist.unsubscribed

Funkce mailkit.mailinglist.unsubscribed vrátí seznam všech odhlášených příjemců v rámci daného účtu.

Ukázka API volání:

XML

<?xml version="1.0" encoding="UTF-8"?>
<methodCall>
  <methodName>mailkit.mailinglist.unsubscribed</methodName>
  <params>
    <param>
      <value>
        <int>client_id</int>
      </value>
    </param>
    <param>
      <value>
        <string>client_md5</string>
      </value>
    </param>
    <param>
      <value>
        <string>range_from</string>
      </value>
    </param>
  </params>
</methodCall>
		

JSON

{  
   "function":"mailkit.mailinglist.unsubscribed",
   "id":"client_id",
   "md5":"client_md5",
   "parameters":{  
      "range_from":"YYYY-MM-DD"
   }
}

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.
range_from = určení rozsahu vracených dat. Počáteční datum ve formátu YYYY-MM-DD. Za konečné datum je považován okamžik volání.

* povinný parametr

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

XML

<?xml version="1.0" encoding="utf-8"?>
<methodResponse>
  <params>
    <param>
      <value>
        <array>
          <data>
            <value>
              <struct>
                <member>
                  <name>DATE</name>
                  <value>
                    <string>2015-05-14 15:30:42</string>
                  </value>
                </member>
                <member>
                  <name>ID_UNSUBSCRIBE_GROUP</name>
                  <value>
                    <i4>0</i4>
                  </value>
                </member>
                <member>
                  <name>EMAIL</name>
                  <value>
                    <string>mail1@mail1.cz</string>
                  </value>
                </member>
              </struct>
            </value>
            <value>
              <struct>
                <member>
                  <name>DATE</name>
                  <value>
                    <string>2015-06-02 12:23:02</string>
                  </value>
                </member>
                <member>
                  <name>ID_UNSUBSCRIBE_GROUP</name>
                  <value>
                    <string>27,29,35</string>
                  </value>
                </member>
                <member>
                  <name>EMAIL</name>
                  <value>
                    <string>mail2@mail2.cz</string>
                  </value>
                </member>
              </struct>
            </value>
          </data>
        </array>
      </value>
    </param>
  </params>
</methodResponse>
		

JSON

[  
   {  
      "DATE":"2015-10-23 15:18:58",
      "ID_UNSUBSCRIBE_GROUP":"",
      "EMAIL":"mail@example.eu"
   }
]

Hodnoty

DATE = datum a čas odhlášení
ID_UNSUBSCRIBE_GROUP = ID odhlašovací skupiny / skupin, ze kterých je příjemce odhlášen. Pokud příjemce nespadá pod žádnou z odhlašovacích skupin a je odhlášen z veškeré komunikace, tak je hodnota prázdná.
EMAIL = e-mailová adresa odhlášeného příjemce