Funkci mailkit.sendmail_mass.results doporučujeme volat nejdříve 30 minut po zavolání funkce mailkit.sendmail_mass. V případě dřívějšího volaní nemusí být ještě známy všechny výsledky.
Ukázka API volání:
JSON
{
"function": "mailkit.sendmail_mass.results",
"id": "client_id",
"md5": "client_md5",
"parameters": {
"ID_send": id_send,
"request_id": request_id
}
}
XML
<?xml version="1.0" encoding="UTF-8"?>
<methodCall>
<methodName>mailkit.sendmail_mass.results</methodName>
<params>
<param>
<value>
<int>client_id</int>
</value>
</param>
<param>
<value>
<string>client_md5</string>
</value>
</param>
<param>
<value>
<i4>id_send</i4>
</value>
</param>
<param>
<value>
<i4>request_id</i4>
</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_send = ID rozesílky
request_id * = ID požadavku
* povinný parametr
Odpověď při úspěšném volání bez chyb:
JSON
{
"error_status": 0,
"status": "OK"
}
XML
<?xml version="1.0" encoding="utf-8"?>
<methodResponse>
<params>
<param>
<value>
<struct>
<member>
<name>status</name>
<value>
<string>OK</string>
</value>
</member>
</struct>
</value>
</param>
</params>
</methodResponse>
Hodnoty
status = OK = v požadavku / v konkrétním id_send požadavku nenastala (nebo se dosud neobjevila) žádná chyba. Tento stav se vrací i tehdy, kdy je požadavek stále zpracováván.
Odpověď při úspěšném volání s chybami:
JSON
{
"results": [
{
"DATE": "2024-08-22 16:12:33",
"INFO": "invalid email status permanent",
"ID_EMAIL": 47086782,
"ERROR_CODE": 2,
"ID_SEND": 1214123,
"EMAIL": "mail1@mail.cz",
"ID_SEND_MESSAGE": 1392658739
},
{
"ID_EMAIL": 47036781,
"INFO": "unsubscribed email",
"DATE": "2024-08-22 16:12:33",
"ID_SEND_MESSAGE": 1392658739,
"EMAIL": "mail2@mail.cz",
"ERROR_CODE": 6,
"ID_SEND": 1214123
},
{
"ID_SEND_MESSAGE": 1392658739,
"ID_SEND": 1214123,
"ID_EMAIL": 47038678,
"DATE": "2024-08-22 16:12:33",
"EMAIL": "mail3@mail.cz",
"ERROR_CODE": 4,
"INFO": "missing mailinglist_id"
}
],
"error_status": 1,
"status": "ERROR"
}
XML
<?xml version="1.0" encoding="utf-8"?>
<methodResponse>
<params>
<param>
<value>
<struct>
<member>
<name>status</name>
<value>
<string>ERROR</string>
</value>
</member>
<member>
<name>results</name>
<value>
<array>
<data>
<value>
<struct>
<member>
<name>ERROR_CODE</name>
<value>
<i4>1</i4>
</value>
</member>
<member>
<name>INFO</name>
<value>
<string>url return null</string>
</value>
</member>
<member>
<name>DATE</name>
<value>
<string>2015-05-13 09:43:50</string>
</value>
</member>
<member>
<name>ID_EMAIL</name>
<value>
<i4>123456789</i4>
</value>
</member>
<member>
<name>EMAIL</name>
<value>
<string>mail@mail.cz</string>
</value>
</member>
<member>
<name>ID_SEND</name>
<value>
<i4>12345</i4>
</value>
</member>
<member>
<name>ID_SEND_MESSAGE</name>
<value>
<i4>123456789</i4>
</value>
</member>
</struct>
</value>
</data>
</array>
</value>
</member>
</struct>
</value>
</param>
</params>
</methodResponse>
Hodnoty
status = ERROR = v požadavku / konkrétním id_send požadavku nastaly níže uvedené chyby, díky kterým nebyly zprávy daným příjemcům odeslány
results:
ERROR_CODE
- 1 = nebylo možné připojit přílohu (příloha nenalezena / nejedná se o transakční kampaň)
- 2 = e-mailová adresa příjemce měla nevalidní formát
- 3 = e-mailová adresa příjemce chyběla
- 4 = bylo zadáno neplatné mailinglist_id
- 5 = bylo zadáno neplatné id_message (campaign_id)
- 6 = e-malová adresa příjemce byla odhlášena
- 7 = kampaň neměla nastavenou odesílací adresu
- 8 = neplatný soubor šablony
INFO = popis chyby
DATE = datum a čas zpracování požadavku
EMAIL = e-mailová adresa příjemce
ID_EMAIL # = ID e-mailové adresy
ID_SEND # = ID rozesílky
ID_SEND_MESSAGE # = ID neodeslané zprávy (individuální údaj pro každého příjemce)
# může vrátit hodnotu 0 a to v případě, kdy nedošlo k založení e-mailu, vytvoření rozesílky / konkrétní zprávy pro příjemce