Ukázka API volání:
JSON
{
"function":"mailkit.email.getstatus",
"id":"client_id",
"md5":"client_md5",
"parameters":{
"email":"email",
"ID_email":"ID_email",
"ID_send_message":"ID_send_message"
}
}
XML
<?xml version="1.0"?>
<methodCall>
<methodName>mailkit.email.getstatus</methodName>
<params>
<param>
<value>
<int>client_id</int>
</value>
</param>
<param>
<value>
<string>client_md5</string>
</value>
</param>
<param>
<value>
<int>email_id</int>
</value>
</param>
<param>
<value>
<int>ID_send_message</int>
</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.
email_id ** = pole v XML-RPC může obsahovat buď konkrétní ID e-mailu (vrací funkce mailkit.mailinglist.adduser), nebo e-mailovou adresu. V případě e-mailové adresy bude vrácen seznam všech nalezených záznamů. V JSON pole obsahuje ID e-mailu.
email ** = e-mailová adresa (pouze pro JSON)
ID_send_message ** = ID odeslané zprávy konkrétnímu příjemci (XML i JSON)
* povinný parametr
** alespoň jeden z parametrů musí být vyplněn
Po úspěšném volání se vrací:
JSON
[
{
"CHANGE_DATE":"2016-02-19 10:44:07",
"CUSTOM_9":"vlastní 9",
"DATE":"2012-05-25 23:21:30",
"VOCATIVE":"",
"STATUS":"unknown",
"CUSTOM_8":"vlastní 8",
"CUSTOM_23":"",
"COMPANY":"",
"REPLY_TO":"",
"CUSTOM_15":"5.4.",
"CUSTOM_25":"",
"CUSTOM_5":"",
"ID_EMAIL":"53161278",
"FAX":"",
"CUSTOM_3":"6",
"MOBILE":"+420123456789",
"PREFIX":"",
"CUSTOM_4":"8",
"EMAIL":"email@example.cz",
"CUSTOM_2":"so",
"ID_MAILING_LIST":"123456",
"CUSTOM_12":"86-04-05",
"NICK_NAME":"kuku",
"CUSTOM_14":"5.4.86",
"CUSTOM_18":"N",
"COUNTRY":"",
"CITY":"Praha",
"LAST_NAME":"",
"STREET":"",
"CUSTOM_7":"vlastní 7",
"CUSTOM_11":"1986-04-05",
"CUSTOM_16":"89",
"CUSTOM_19":"",
"GENDER":"",
"CUSTOM_6":"",
"CUSTOM_10":"2015-04-05",
"CUSTOM_1":"ano",
"CUSTOM_13":"5.4.1986",
"CUSTOM_20":"",
"CUSTOM_22":"",
"FIRST_NAME":"",
"CUSTOM_24":"",
"ZIP":"",
"CUSTOM_21":"",
"STATE":"",
"CUSTOM_17":"Y",
"PHONE":"9999999",
"CONSENT": "TRUE",
"CONSENT_CHANNEL": "subscribe insert",
"CONSENT_DATE": "2019-05-29 15:18:41",
"SCORE": "4",
"TREND": "-1"
}
]
XML
<?xml version="1.0" encoding="utf-8"?>
<methodResponse>
<params>
<param>
<value>
<array>
<data>
<value>
<struct>
<member>
<name>ID_EMAIL</name>
<value>
<i4>12345</i4>
</value>
</member>
<member>
<name>EMAIL</name>
<value>
<string>example@example.cz</string>
</value>
</member>
<member>
<name>ID_MAILING_LIST</name>
<value>
<i4>12345</i4>
</value>
</member>
<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>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_25</name>
<value>
<string>Vlastní pole číslo 25</string>
</value>
</member>
<member>
<name>CONSENT</name>
<value>
<string>TRUE</string>
</value>
</member>
<member>
<name>CONSENT_CHANNEL</name>
<value>
<string>subscribe insert</string>
</value>
</member>
<member>
<name>CONSENT_DATE</name>
<value>
<string>2019-05-29 15:18:41</string>
</value>
</member>
<member>
<name>SCORE</name>
<value>
<string>4</string>
</value>
</member>
<member>
<name>TREND</name>
<value>
<string>-1</string>
</value>
</member>
</struct>
</value>
</data>
</array>
</value>
</param>
</params>
</methodResponse>
Hodnoty
ID_EMAIL = ID e-mailové adresy příjemce
EMAIL = e-mailová adresa příjemce
ID_MAILING_LIST = ID seznamu příjemců
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í
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 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.
CONSENT = existence souhlasu. Může nabývat hodnot TRUE / FALSE.
CONSENT_CHANNEL = zdroj souhlasu. Může nabývat hodnot:
- subscribe update (aktualizace souhlasu)
- rpc mailinglist.adduser (souhlas zajištěn přes API mailkit.mailinglist.adduser)
- subscribe insert (souhlas zajištěn prostřednictvím Přihlašovacího formuláře)
- subscribe (dříve uložený souhlas)
- rpc email.revalidate (souhlas zajištěn přes API mailkit.email.revalidate)
- confirm_url (souhlas zajištěn rekonfirmační kampaní)
SCORE = engagement skóre příjemce
TREND = engagement trend příjemce
Příklady neúspěšného volání:
JSON
{
"error_status":1,
"error":"Missing ID_email"
}
XML
<?xml version="1.0" encoding="utf-8"?>
<methodResponse>
<params>
<param>
<value>
<string></string>
</value>
</param>
</params>
</methodResponse>
Důvod chyby
Prázdná odpověď – vloženo neexistující ID e-mailu a/nebo vložena neexistující e-mailová adresa
Missing ID email – chybí e-mailová adresa
