PodporaAPI dokumentace

mailkit.mailinglist.getstatus

Funkce mailkit.mailinglist.getstatus vrací dostupné informace o příjemcích v seznamu, jako je jejich stav, jméno, či jakékoli jiné informace uvedené ve vlastních polích.

Ukázka API volání:

XML

<?xml version="1.0"?>
<methodCall>
<methodName>mailkit.mailinglist.getstatus</methodName>
<params>
    <param>
        <value>
            <int>client_id</int>
        </value>
    </param>
    <param>
        <value>
            <string>client_md5</string>
        </value>
    </param>  
    <param>
        <value>
            <int>mailinglist_id</int>
        </value>
    </param>
    <param>
        <value>
            <string>status</string>
        </value>
    </param>
    <param>
        <value>
            <string>change_date</string>
        </value>
    </param>
    <param>
        <value>
            <string>ID_email</string>
        </value>
    </param>
    <param>
        <value>
            <string>limit</string>
        </value>
    </param>
</params>
</methodCall>

JSON

{  
   "function":"mailkit.mailinglist.getstatus",
   "id":"client_id",
   "md5":"client_md5",
   "parameters":{  
      "status":"status",
      "change_date":"YYYY-MM-DD HH:MM:SS",
      "ID_user_list":"ID_user_list",
      "ID_email":"ID_email",
      "limit":"100"
   }
}

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.
mailinglist_id * = ID seznamu příjemců
status = status příjemce, volitelný parametr. V případě vyplnění se vrátí pouze e-maily s daným statusem. Status může nabývat těchto hodnot:

  • enabled (stav aktivní)
  • unknown (stav neznámý)
  • temporary (stav dočasně nedostupný)
  • permanent (stav trvale nedostupný)
  • unsubscribe (stav odhlášený)

change_date = datum poslední změny příjemce, volitelný parametr ve tvaru "yyyy-mm-dd hh:mm:ss". Volání vrátí jen e-maily s datem změny větším nebo rovno uvedenému datu v parametru.
ID_email = ID_emailové adresy od které se má zpočít výpis adres při iteraci
limit = počet záznamů ve výstupu (max. 10000)

* 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>VOCATIVE</name>
                  <value>
                    <string>Oslovení</string>
                  </value>
                </member>
                <member>
                  <name>PREFIX</name>
                  <value>
                    <string>titul</string>
                  </value>
                </member>
                <member>
                  <name>FIRST_NAME</name>
                  <value>
                    <string>Jméno</string>
                  </value>
                </member>
                <member>
                  <name>LAST_NAME</name>
                  <value>
                    <string>Příjmení</string>
                  </value>
                </member>
                <member>
                  <name>NICK_NAME</name>
                  <value>
                    <string>přezdívka</string>
                  </value>
                </member>
                <member>
                  <name>GENDER</name>
                  <value>
                    <string>F/M</string>
                  </value>
                </member>
                <member>
                  <name>EMAIL</name>
                  <value>
                    <string>example@example.cz</string>
                  </value>
                </member>
                <member>
                  <name>ID_EMAIL</name>
                  <value>
                    <int>12345</int>
                  </value>
                </member>
                <member>
                  <name>REPLY_TO</name>
                  <value>
                    <string>example2@example2.cz</string>
                  </value>
                </member>
                <member>
                  <name>PHONE</name>
                  <value>
                    <string>12345</string>
                  </value>
                </member>
                <member>
                  <name>FAX</name>
                  <value>
                    <string>12345</string>
                  </value>
                </member>
                <member>
                  <name>MOBILE</name>
                  <value>
                    <string>12345</string>
                  </value>
                </member>
                <member>
                  <name>COMPANY</name>
                  <value>
                    <string>Společnost</string>
                  </value>
                </member>
                <member>
                  <name>STREET</name>
                  <value>
                    <string>Adresa</string>
                  </value>
                </member>
                <member>
                  <name>CITY</name>
                  <value>
                    <string>Město</string>
                  </value>
                </member>
                <member>
                  <name>COUNTRY</name>
                  <value>
                    <string>Kraj</string>
                  </value>
                </member>
                <member>
                  <name>ZIP</name>
                  <value>
                    <string>PSČ</string>
                  </value>
                </member>
                <member>
                  <name>STATE</name>
                  <value>
                    <string>země</string>
                  </value>
                </member>
                <member>
                  <name>DATE</name>
                  <value>
                    <string>yyyy-mm-dd hh:mm:ss</string>
                  </value>
                </member>
                <member>
                  <name>CHANGE_DATE</name>
                  <value>
                    <string>yyyy-mm-dd hh:mm:ss</string>
                  </value>
                </member>
                <member>
                  <name>STATUS</name>
                  <value>
                    <string>enabled</string>
                  </value>
                </member>
                <member>
                  <name>CUSTOM_1</name>
                  <value>
                    <string>Vlastní pole číslo 1</string>
                  </value>
                </member>
                <member>
                  <name>CUSTOM_2</name>
                  <value>
                    <string>Vlastní pole číslo 2</string>
                  </value>
                </member>
                <member>
                  <name>CUSTOM_25</name>
                  <value>
                    <string>Vlastní pole číslo 25</string>
                  </value>
                </member>
              </struct>
            </value>
          </data>
        </array>
      </value>
    </param>
  </params>
</methodResponse>

JSON

[  
   {  
      "CHANGE_DATE":"2016-03-17 10:42:35",
      "CUSTOM_9":"vlastní 9",
      "DATE":"2012-05-25 23:21:30",
      "VOCATIVE":"Vážený pan",
      "STATUS":"enabled",
      "CUSTOM_8":"vlastní 8",
      "CUSTOM_23":"",
      "COMPANY":"",
      "REPLY_TO":"",
      "CUSTOM_15":"31.12.",
      "CUSTOM_25":"",
      "CUSTOM_5":"",
      "ID_EMAIL":"123456789",
      "FAX":"ne",
      "MOBILE":"7771234565",
      "CUSTOM_3":"1",
      "PREFIX":"",
      "CUSTOM_4":"13",
      "EMAIL":"mail@mailmail.cz",
      "CUSTOM_2":"po",
      "CUSTOM_12":"15-12-31",
      "NICK_NAME":"Nicky",
      "CUSTOM_14":"31.12.15",
      "CUSTOM_18":"",
      "COUNTRY":"",
      "CITY":"Praha",
      "LAST_NAME":"Příjmení",
      "STREET":"ne",
      "CUSTOM_7":"vlastní 7",
      "CUSTOM_11":"2015-12-31",
      "CUSTOM_16":"11",
      "CUSTOM_19":"ano",
      "GENDER":"M",
      "CUSTOM_6":"ne",
      "CUSTOM_10":"2015-12-31",
      "CUSTOM_1":"ano",
      "CUSTOM_13":"31.12.2015",
      "CUSTOM_20":"",
      "CUSTOM_22":"",
      "FIRST_NAME":"Robert",
      "CUSTOM_24":"kočka",
      "ZIP":"15000",
      "CUSTOM_21":"",
      "STATE":"ČR",
      "CUSTOM_17":"Y",
      "PHONE":"7771234567"
   }
]

Hodnoty

VOCATIVE = oslovení příjemce
PREFIX = titul příjemce
FIRST_NAME = jméno příjemce
LAST_NAME = příjmení příjemce
NICK_NAME = přezdívka příjemce
GENDER = pohlaví příjemce. Může nabývat těchto hodnot:

  • F = žena
  • M = muž
  • prázdné pole = bez pohlaví

EMAIL = e-mailová adresa příjemce
ID_EMAIL = ID příjemce - tento údaj se používá i pro iteraci velkými seznamy
REPLY_TO = individuální adresa příjemce pro odpovědi
PHONE = telefon příjemce
FAX = fax příjemce
MOBILE = mobil příjemce
COMPANY = firma příjemce
STREET = adresa (ulice) příjemce
CITY = město příjemce
COUNTRY = kraj příjemce
ZIP = PSČ příjemce
STATE = země příjemce
DATE = datum přidání příjemce na seznam
CHANGE_DATE = datum poslední změny údajů příjemce
STATUS = stav příjemce. Stav může nabývat těchto hodnot:

  • enabled (stav aktivní)
  • disabled (stav neaktivní)
  • unknown (stav neznámý)
  • temporary (stav dočasně nedostupný)
  • permanent (stav trvale nedostupný)
  • unsubscribe (stav odhlášený)

CUSTOM_1 = vlastní pole příjemce č. 1. Celkový počet vlastních polí u každého příjemce je 25.

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

XML

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

JSON

{
    "error_status": 1,
    "error": "Invalid ID_user_list"
}

Důvod chyby

Prázdná odpověď - vložen nesprávný formát stavu příjemce a/nebo vložen nesprávný formát data poslední změny příjemce a/nebo zadaným parametrům neodpovídá žádný příjemce
Invalid ID_user_list - neplatné ID seznamu příjemců
Unknown status - neplatný status příjemce
Invalid change_date format = neplatný formát datumu poslední změny příjemce