Ukázka API volání:
JSON
{
"function":"mailkit.report.raw.messages",
"id":"client_id",
"md5":"client_md5",
"parameters":{
"ID_message":"12345",
"ID_send": "123456",
"ID_send_message": "123456789",
"limit":"1000"
}
}
XML
<?xml version="1.0"?>
<methodCall>
<methodName>mailkit.report.raw.messages</methodName>
<params>
<param>
<value>
<int>client_id</int>
</value>
</param>
<param>
<value>
<string>client_md5</string>
</value>
</param>
<param>
<value>
<int>ID_message</int>
</value>
</param>
<param>
<value>
<int>ID_send</int>
</value>
</param>
<param>
<value>
<int>ID_send_message</int>
</value>
</param>
<param>
<value>
<int>limit</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.
ID_message = ID kampaně
ID_send = ID rozesílky
ID_send_message = počáteční ID zprávy, od které chcete, aby začal datový výstup
limit = počet záznamů, které chcete přenést (standardně 25000).
* povinný parametr
Po úspěšném volání se vrací:
JSON
[
{
"ID_message": "123456",
"ID_send": "123456",
"ID_send_message": "1234567890",
"ID_user_list": "",
"ID_email": "1234567890",
"ID_template": "",
"type_message": "email",
"email": "email@example.com",
"email_date": "2001-01-01 01:01:01",
"message_date": "2016-01-01 01:01:00",
"date_sent": "2016-01-01 01:01:01",
"ab_version": "",
"message_status": "sent",
"tld": "com",
"domain": "example.com",
"custom_1": "",
"custom_2": "",
"custom_3": "",
"custom_4": "",
"custom_5": "",
"custom_6": "",
"custom_7": "",
"custom_8": "",
"custom_9": "",
"custom_10": "",
"custom_11": "",
"custom_12": "",
"custom_13": "",
"custom_14": "",
"custom_15": "",
"custom_16": "",
"custom_17": "",
"custom_18": "",
"custom_19": "",
"custom_20": "",
"custom_21": "",
"custom_22": "",
"custom_23": "",
"custom_24": "",
"custom_25": "",
"prefix": "",
"vocative": "",
"first_name": "Vigor",
"last_name": "Tester",
"full_name": "Vigor Tester",
"utm_campaign": "order confirmation",
"nick_name": "",
"gender": "",
"reply_to": "",
"campaign_name": "T01 - ORDER CONFIRMED",
"company": "",
"street": "",
"city": "",
"state": "",
"country": "",
"zip": "",
"phone": "",
"mobile": "",
"subject": "Order Nr. 40600732861 confirmed",
"fax": "",
"s_continent": "europe",
"s_country": "Czech Republic",
"s_region": "Prazsky",
"s_city": "",
"s_org": "Mailkit s.r.o.",
"s_browser": "Thunderbird",
"s_os": "Windows",
"preview_url": https://u.mailkit.eu/user.fcgi/action,view_email/dc,1234/ds,1234567/code,aa6123712130dcb57ce8039dfbda568d
}
]
XML
<?xml version="1.0" encoding="utf-8"?>
<methodResponse>
<params>
<param>
<value>
<array>
<data>
<value>
<struct>
<member>
<name>ID_message</name>
<value>
<i4>32443</i4>
</value>
</member>
<member>
<name>ID_send</name>
<value>
<i4>601181</i4>
</value>
</member>
<member>
<name>ID_send_message</name>
<value>
<i4>723043605</i4>
</value>
</member>
<member>
<name>ID_user_list</name>
<value>
<i4>46061</i4>
</value>
</member>
<member>
<name>ID_email</name>
<value>
<i4>351431738</i4>
</value>
</member>
<member>
<name>ID_template</name>
<value>
<i4>3858</i4>
</value>
</member>
<member>
<name>type_message</name>
<value>
<string>email</string>
</value>
</member>
<member>
<name>utm_campaign</name>
<value>
<string>order confirmation</string>
</value>
</member>
<member>
<name>email</name>
<value>
<string>0100marc@seznam.cz</string>
</value>
</member>
<member>
<name>email_date</name>
<value>
<string>2016-02-16 04:30:15</string>
</value>
</member>
<member>
<name>message_date</name>
<value>
<string>2016-06-20 14:37:47</string>
</value>
</member>
<member>
<name>date_sent</name>
<value>
<string>2016-06-20 16:07:00</string>
</value>
</member>
<member>
<name>ab_version</name>
<value>
<string>A</string>
</value>
</member>
<member>
<name>campaign_name</name>
<value>
<string>T01 - ORDER CONFIRMED</string>
</value>
</member>
<member>
<name>message_status</name>
<value>
<string>sent</string>
</value>
</member>
<member>
<name>subject</name>
<value>
<string>Order Nr. 40600732861 confirmed</string>
</value>
</member>
<member>
<name>tld</name>
<value>
<string>cz</string>
</value>
</member>
<member>
<name>domain</name>
<value>
<string>seznam.cz</string>
</value>
</member>
<member>
<name>custom_1</name>
<value>
<i4>520636</i4>
</value>
</member>
<member>
<name>custom_2</name>
<value>
<string></string>
</value>
</member>
<member>
<name>custom_3</name>
<value>
<string>2016-02-15 14:52:22+01</string>
</value>
</member>
<member>
<name>custom_4</name>
<value>
<i4>1</i4>
</value>
</member>
<member>
<name>custom_5</name>
<value>
<i4>1</i4>
</value>
</member>
<member>
<name>custom_6</name>
<value>
<i4>4</i4>
</value>
</member>
<member>
<name>custom_7</name>
<value>
<string></string>
</value>
</member>
<member>
<name>custom_8</name>
<value>
<string></string>
</value>
</member>
<member>
<name>custom_9</name>
<value>
<i4>1</i4>
</value>
</member>
<member>
<name>custom_10</name>
<value>
<i4>927</i4>
</value>
</member>
<member>
<name>custom_11</name>
<value>
<i4>69</i4>
</value>
</member>
<member>
<name>custom_12</name>
<value>
<string></string>
</value>
</member>
<member>
<name>custom_13</name>
<value>
<string>Znojmo</string>
</value>
</member>
<member>
<name>custom_14</name>
<value>
<string>Nároční</string>
</value>
</member>
<member>
<name>custom_15</name>
<value>
<i4>6</i4>
</value>
</member>
<member>
<name>custom_16</name>
<value>
<i4>99220</i4>
</value>
</member>
<member>
<name>custom_17</name>
<value>
<i4>3667</i4>
</value>
</member>
<member>
<name>custom_18</name>
<value>
<i4>2206</i4>
</value>
</member>
<member>
<name>custom_19</name>
<value>
<i4>69</i4>
</value>
</member>
<member>
<name>custom_20</name>
<value>
<i4>99220</i4>
</value>
</member>
<member>
<name>custom_21</name>
<value>
<i4>6</i4>
</value>
</member>
<member>
<name>custom_22</name>
<value>
<string></string>
</value>
</member>
<member>
<name>custom_23</name>
<value>
<string>2016-02-15</string>
</value>
</member>
<member>
<name>custom_24</name>
<value>
<string>2016-02-15</string>
</value>
</member>
<member>
<name>custom_25</name>
<value>
<i4>2206</i4>
</value>
</member>
<member>
<name>prefix</name>
<value>
<string></string>
</value>
</member>
<member>
<name>vocative</name>
<value>
<string></string>
</value>
</member>
<member>
<name>first_name</name>
<value>
<string>marketa</string>
</value>
</member>
<member>
<name>last_name</name>
<value>
<string>fialova</string>
</value>
</member>
<member>
<name>full_name</name>
<value>
<string>marketa fialova</string>
</value>
</member>
<member>
<name>nick_name</name>
<value>
<string></string>
</value>
</member>
<member>
<name>gender</name>
<value>
<string></string>
</value>
</member>
<member>
<name>reply_to</name>
<value>
<string></string>
</value>
</member>
<member>
<name>company</name>
<value>
<string></string>
</value>
</member>
<member>
<name>street</name>
<value>
<string></string>
</value>
</member>
<member>
<name>city</name>
<value>
<string>suchohrdly =znojmo</string>
</value>
</member>
<member>
<name>state</name>
<value>
<string></string>
</value>
</member>
<member>
<name>country</name>
<value>
<string></string>
</value>
</member>
<member>
<name>zip</name>
<value>
<string></string>
</value>
</member>
<member>
<name>phone</name>
<value>
<string></string>
</value>
</member>
<member>
<name>mobile</name>
<value>
<string></string>
</value>
</member>
<member>
<name>fax</name>
<value>
<string></string>
</value>
</member>
<member>
<name>s_continent</name>
<value>
<string>europe</string>
</value>
</member>
<member>
<name>s_country</name>
<value>
<string>Czech Republic</string>
</value>
</member>
<member>
<name>s_region</name>
<value>
<string></string>
</value>
</member>
<member>
<name>s_city</name>
<value>
<string></string>
</value>
</member>
<member>
<name>s_org</name>
<value>
<string>Seznam.cz, a.s.</string>
</value>
</member>
<member>
<name>s_browser</name>
<value>
<string>Email.cz</string>
</value>
</member>
<member>
<name>s_os</name>
<value>
<string></string>
</value>
</member>
<member>
<name>preview_url</name>
<value>
<string>https://u.mailkit.eu/user.fcgi/action,view_email/dc,1234/ds,1234567/code,randomhashhere</string>
</value>
</member>
</struct>
</value>
</data>
</array>
</value>
</param>
</params>
</methodResponse>
Hodnoty
ID_message – ID kampaně
ID_send – ID rozesílky
ID_send_message – ID zprávy
ID_user_list – ID seznamu příjemců
ID_email – ID emailové adresy
ID_template – ID použité šablony
type_message – druh zprávy
email – e-mailová adresa příjemce
email_date – datum přidání adresy do seznamu
message_date – datum a čas naplánování rozesílky
date_sent – datum odeslání zprávy příjemci
ab_version – varianta zprávy v případě A/B testování
message_status – stav doručování zprávy – sent u odeslaných, failed v případě, že zprávu nebylo možné doručit z důvodu okamžité chyby (neplatný formát adresy, neexistující doména, etc), wait u zpráv které zatím čekají na odeslání (resp. wait_ab. u A/B testingu)
tld – top-level doména adresáta
domain – doména adresáta
custom_1 – hodnota v poli CUSTOM1 příjemce
custom_2 – hodnota v poli CUSTOM2 příjemce
custom_3 – hodnota v poli CUSTOM3 příjemce
custom_4 – hodnota v poli CUSTOM4 příjemce
custom_5 – hodnota v poli CUSTOM5 příjemce
custom_6 – hodnota v poli CUSTOM6 příjemce
custom_7 – hodnota v poli CUSTOM7 příjemce
custom_8 – hodnota v poli CUSTOM8 příjemce
custom_9 – hodnota v poli CUSTOM9 příjemce
custom_10 – hodnota v poli CUSTOM10 příjemce
custom_11 – hodnota v poli CUSTOM11 příjemce
custom_12 – hodnota v poli CUSTOM12 příjemce
custom_13 – hodnota v poli CUSTOM13 příjemce
custom_14 – hodnota v poli CUSTOM14 příjemce
custom_15 – hodnota v poli CUSTOM15 příjemce
custom_16 – hodnota v poli CUSTOM16 příjemce
custom_17 – hodnota v poli CUSTOM17 příjemce
custom_18 – hodnota v poli CUSTOM18 příjemce
custom_19 – hodnota v poli CUSTOM19 příjemce
custom_20 – hodnota v poli CUSTOM20 příjemce
custom_21 – hodnota v poli CUSTOM21 příjemce
custom_22 – hodnota v poli CUSTOM22 příjemce
custom_23 – hodnota v poli CUSTOM23 příjemce
custom_24 – hodnota v poli CUSTOM24 příjemce
custom_25 – hodnota v poli CUSTOM25 příjemce
prefix – titul příjemce
vocative – oslovení příjemce
first_name – jméno příjemce
last_name – příjmení příjemce
full_name – celé jméno příjemce
nick_name – přezdívka přijemce
gender – pohlaví příjemce
reply_to – adresa pro odpovědi
company – firma příjemce
street – ulice
city – město
state – kraj
country – země
zip – psč příjemce
phone – telefonní číslo
mobile – mobilní telefon
fax – faxové číslo
s_continent – kontinent – získaná geolokační informace
s_country – země – získaná geolokační informace
s_region – kraj – získaná geolokační informace
s_city – město – získaná geolokační informace
s_org – organizace – získaná geolokační informace
s_browser – prohlížeč – získaná informace
s_os – operační systém – získaná informace
preview_url – url náhledu odeslané zprávy
Po neúspěšném volání se vrací:
1) V případě neplatného ID kampaně:
JSON
{
"error_status": 1,
"error": "Invalid ID_message"
}
XML
<?xml version="1.0"?>
<methodResponse>
<params>
<param>
<value>
<string>Invalid ID_message</string>
</value>
</param>
</params>
</methodResponse>
2) V ostatních případech vrací API prázdnou odpověď, případně "Error" (XML):
JSON
{}
XML
<?xml version="1.0" encoding="utf-8"?>
<methodResponse>
<params>
<param>
<value>
<string></string>
</value>
</param>
</params>
</methodResponse>
XML (Error)
<?xml version="1.0" encoding="utf-8"?>
<methodResponse>
<params>
<param>
<value>
<string>Error</string>
</value>
</param>
</params>
</methodResponse>
