Ukázka volání API
JSON
{
"id":"client_id",
"md5":"client_md5",
"function":"mailkit.email.getstatus.history",
"parameters":{
"email":"email",
"ID_email":"ID_email"
}
}
XML
<?xml version="1.0" encoding="UTF-8"?>
<methodCall>
<methodName>mailkit.email.getstatus.history</methodName>
<params>
<param>
<value>
<int>client_id</int>
</value>
</param>
<param>
<value>
<string>client_md5</string>
</value>
</param>
<param>
<value>
<struct>
<member>
<name>email</name>
<value>
<string>example@example.cz</string>
</value>
</member>
<member>
<name>ID_email</name>
<value>
<i4>123456789</i4>
</value>
</member>
</struct>
</value>
</param>
</params>
</methodCall>
Construct
{
'id' => $client_id,
'md5' => $client_md5,
'function' => 'mailkit.email.getstatus.history',
'parameters' =>{
'ID_email' => $ID_email,
'email' => $email,
}
}
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_email ** = ID e-mailu (vrací funkce mailkit.mailinglist.adduser) – API vrátí historii příjemce vztahující se k e-mailové adrese v konkrétním seznamu příjemců (tzn. rozesílky, ve kterých byl daný seznam příjemců použitý)
email ** = e-mailová adresa. V případě, že se adresa nalézá ve více seznamech příjemců, bude vrácena historie ze všech seznamů.
* povinný parametr
** email nebo ID_email musí být vždy vyplněn. Pokud jsou vyplněny oba údaje, má přednost ID_email
Po úspěšném volání se vrací:
JSON
[
{
"MESSAGE_NAME":"Název kampaně",
"ID_MESSAGE":"123456",
"SUBJECT":"Předmět kampaně",
"PREVIEW":"https://u.mailkit.eu/XXXXX",
"READ_COUNT":"2",
"ID_EMAIL":"123456789",
"ID_SEND":"123456789",
"DATE_SEND":"2015-06-10 13:29:05",
"EMAIL_FROM":"example@example.cz",
"CLICK_COUNT":"1",
"ID_SEND_MESSAGE":"123456789",
"NAME_FROM":"Odesilatel",
"ID_USER_LIST":"123456",
"TYPE_MESSAGE":"email",
"RESPONSE_DATA":[
{
"URL":"http://www.example.cz",
"COUNTRY":"country",
"REGION_CODE":"rc",
"CITY":"city",
"DATE":"2015-06-10 13:30:27",
"ID_URL":"123456",
"TYPE":"click",
"BROWSER":"Chrome",
"OS":"Windows",
"REGION":"region"
}
]
}
]
XML
<?xml version="1.0" encoding="utf-8"?>
<methodResponse>
<params>
<param>
<value>
<array>
<data>
<value>
<struct>
<member>
<name>PREVIEW</name>
<value>
<string>https://u.mailkit.eu/XXXXXXX</string>
</value>
</member>
<member>
<name>DATE_SEND</name>
<value>
<string>2015-04-08 12:38:36</string>
</value>
</member>
<member>
<name>ID_MESSAGE</name>
<value>
<i4>123456789</i4>
</value>
</member>
<member>
<name>ID_SEND</name>
<value>
<i4>123456789</i4>
</value>
</member>
<member>
<name>ID_SEND_MESSAGE</name>
<value>
<i4>123456789</i4>
</value>
</member>
<member>
<name>ID_USER_LIST</name>
<value>
<string>123456789</string>
</value>
</member>
<member>
<name>MESSAGE_NAME</name>
<value>
<string>Název kampaně</string>
</value>
</member>
<member>
<name>SUBJECT</name>
<value>
<string>předmět zprávy</string>
</value>
</member>
<member>
<name>EMAIL_FROM</name>
<value>
<string>odesilatel@example.cz</string>
</value>
</member>
<member>
<name>NAME_FROM</name>
<value>
<string>Odesilatel</string>
</value>
</member>
<member>
<name>TYPE_MESSAGE</name>
<value>
<string>email</string>
</value>
</member>
<member>
<name>READ_COUNT</name>
<value>
<i4>4</i4>
</value>
</member>
<member>
<name>CLICK_COUNT</name>
<value>
<i4>2</i4>
</value>
</member>
<member>
<name>RESPONSE_DATA</name>
<value>
<array>
<data>
<value>
<struct>
<member>
<name>TYPE</name>
<value>
<string>click</string>
</value>
</member>
<member>
<name>DATE</name>
<value>
<string>2015-12-21 13:29:46</string>
</value>
</member>
<member>
<name>URL</name>
<value>
<string>http://www...</string>
</value>
</member>
<member>
<name>ID_URL</name>
<value>
<i4>123456</i4>
</value>
</member>
<member>
<name>REGION</name>
<value>
<string></string>
</value>
</member>
<member>
<name>REGION_CODE</name>
<value>
<string></string>
</value>
</member>
<member>
<name>CITY</name>
<value>
<string></string>
</value>
</member>
<member>
<name>BROWSER</name>
<value>
<string>Chrome</string>
</value>
</member>
<member>
<name>OS</name>
<value>
<string>Windows</string>
</value>
</member>
</struct>
</value>
</data>
</array>
</value>
</member>
</struct>
</value>
</data>
</array>
</value>
</param>
</params>
</methodResponse>
Hodnoty
PREVIEW = náhled odeslané zprávy
DATE_SEND = datum odeslání
ID_MESSAGE = ID kampaně
ID_SEND = ID rozesílky
ID_SEND_MESSAGE = ID odeslané zprávy
MESSAGE_NAME = název kampaně
SUBJECT = předmět kampaně
EMAIL_FROM = odesílatel kampaně
NAME_FROM = jméno odesílatele
TYPE_MESSAGE = typ zprávy (email X sms)
READ_COUNT = počet čtení
CLICK_COUNT = počet kliknutí
RESPONSE_DATA = reakce příjemce a získaná data:
- TYPE = typ reakce (read = čtení, click = kliknutí, conversion = konverze, unsubscribe = odhlášení, spam_report = spam report, print = tisk, forward = přeposlání, share = sdílení, polls = hlasování na anketu, polls_click = kliknutí na odkaz na anketu v e-mailu)
- DATE = datum reakce
- URL = url adresa (pouze v případě zaznamenaného kliknutí)
- ID_URL = ID url adresy (pouze v případě zaznamenaného kliknutí)
- REGION = zjištěný region
- REGION_CODE = kód zjištěného regionu
- CITY = zjištěné město
- BROWSER = zjištěný prohlížeč
- OS = zjištěný operační systém
V případě, kdy příjemci nebyla dosud odeslána žádná kampaň, vrací API prázdnou odpověď:
JSON
{}
XML
<?xml version="1.0" encoding="utf-8"?>
<methodResponse>
<params>
<param>
<value>
<string></string>
</value>
</param>
</params>
</methodResponse>
Ukázka odpovědi na neúspěšné volání:
JSON
{
"error_status":"1",
"error":"Invalid email"
}
XML
<?xml version="1.0" encoding="utf-8"?>
<methodResponse>
<params>
<param>
<value>
<string>Invalid ID_email</string>
</value>
</param>
</params>
</methodResponse>
Důvod chyby
Invalid ID_email = neplatné ID e-mailu
Invalid email = neplatný e-mail
