mailkit.report.raw.bounces

Funkce mailkit.report.raw.bounces vrací kompletní záznamy o nedoručitelných příjemcích kampaně a/nebo jejích rozesílek v RAW podobě.

Tato funkce je určena k přenosu kompletních dat k dalšímu zpracování v externích databázových systémech. Vzhledem k velkému množství dat, prodlevě v reakcích a omezení četnosti dotazů ji NEDOPORUČUJEME používat k běžné integraci, ke které jsou vhodnější rekurzivní funkce mailkit.report.message.bounces. Vzhledem k tomu, že funkce vrátí max. 25000 záznamů, je pro kompletní přenos statistik nutné iterovat záznamy uvedením ID_undelivered_log jako identifikátoru počátečního záznamu.

Ukázka API volání:

JSON 

{  
   "function":"mailkit.report.raw.bounces",
   "id":"client_id",
   "md5":"client_md5",
   "parameters":{ 
        "ID_message":"12345",
        "ID_send": "123456",
        "ID_undelivered_log": "123456789",
        "limit":"1000"
   }
}

XML 

<?xml version="1.0"?>
<methodCall>
  <methodName>mailkit.report.raw.bounces</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_undelivered_log</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_undelivered_log = počáteční ID záznamu, od kterého 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": "12345",
    "TEXT_STATUS": "smtp;550 5.1.1 sorry, no such mailbox here",
    "STATUS": "5.1.1",
    "BOUNCE_CAT": "bad-mailbox",
    "ID_EMAIL": "1234567890",
    "ID_SEND": "123456",
    "EMAIL": "email@example.com",
    "ID_SEND_MESSGE": "1234567890",
    "ID_USER_LIST": "12345",
    "REMOTE_MTA": "",
    "ID_UNDELIVERED_LOG": "1",
    "RECIPIENT_STATUS": "permanent"
  },
  {
    "ID_MESSAGE": "12345",
    "TEXT_STATUS": "X-Postfix; Mailbox is full",
    "STATUS": "5.2.2",
    "BOUNCE_CAT": "quota-issues",
    "ID_EMAIL": "1234567891",
    "ID_SEND": "123456",
    "EMAIL": "email1@example.com",
    "ID_SEND_MESSGE": "1234567891",
    "ID_USER_LIST": "12345",
    "REMOTE_MTA": "",
    "ID_UNDELIVERED_LOG": "2",
    "RECIPIENT_STATUS": "temporary"
  }
]

XML 

<?xml version="1.0" encoding="utf-8"?>
<methodResponse>
  <params>
    <param>
      <value>
        <array>
          <data>
            <value>
              <struct>
                <member>
                  <name>ID_MESSAGE</name>
                  <value>
                    <i4>12345</i4>
                  </value>
                </member>
                <member>
                  <name>TEXT_STATUS</name>
                  <value>
                    <string>smtp; 552 4.2.2 User has full mailbox.</string>
                  </value>
                </member>
                <member>
                  <name>STATUS</name>
                  <value>
                    <string>4.2.2</string>
                  </value>
                </member>
                <member>
                  <name>BOUNCE_CAT</name>
                  <value>
                    <string>quota-issues</string>
                  </value>
                </member>
                <member>
                  <name>ID_EMAIL</name>
                  <value>
                    <i4>1234567890</i4>
                  </value>
                </member>
                <member>
                  <name>ID_SEND</name>
                  <value>
                    <i4>123456</i4>
                  </value>
                </member>
                <member>
                  <name>EMAIL</name>
                  <value>
                    <string>email@example.com</string>
                  </value>
                </member>
                <member>
                  <name>ID_SEND_MESSGE</name>
                  <value>
                    <i4>1234567890</i4>
                  </value>
                </member>
                <member>
                  <name>ID_USER_LIST</name>
                  <value>
                    <i4>12345</i4>
                  </value>
                </member>
                <member>
                  <name>REMOTE_MTA</name>
                  <value>
                    <string>dns; mx1.seznam.cz</string>
                  </value>
                </member>
                <member>
                  <name>ID_UNDELIVERED_LOG</name>
                  <value>
                    <i4>1</i4>
                  </value>
                </member>
                <member>
                  <name>RECIPIENT_STATUS</name>
                  <value>
                    <string>temporary</string>
                  </value>
                </member>
              </struct>
            </value>
            <value>
              <struct>
                <member>
                  <name>ID_MESSAGE</name>
                  <value>
                    <i4>12345</i4>
                  </value>
                </member>
                <member>
                  <name>TEXT_STATUS</name>
                  <value>
                    <string>smtp;550 5.1.1 sorry, no such mailbox here</string>
                  </value>
                </member>
                <member>
                  <name>STATUS</name>
                  <value>
                    <string>5.2.2</string>
                  </value>
                </member>
                <member>
                  <name>BOUNCE_CAT</name>
                  <value>
                    <string>bad-mailbox</string>
                  </value>
                </member>
                <member>
                  <name>ID_EMAIL</name>
                  <value>
                    <i4>1234567891</i4>
                  </value>
                </member>
                <member>
                  <name>ID_SEND</name>
                  <value>
                    <i4>123456</i4>
                  </value>
                </member>
                <member>
                  <name>EMAIL</name>
                  <value>
                    <string>email1@example.com</string>
                  </value>
                </member>
                <member>
                  <name>ID_SEND_MESSGE</name>
                  <value>
                    <i4>1234567891</i4>
                  </value>
                </member>
                <member>
                  <name>ID_USER_LIST</name>
                  <value>
                    <i4>12345</i4>
                  </value>
                </member>
                <member>
                  <name>REMOTE_MTA</name>
                  <value>
                    <string></string>
                  </value>
                </member>
                <member>
                  <name>ID_UNDELIVERED_LOG</name>
                  <value>
                    <i4>2</i4>
                  </value>
                </member>
                <member>
                  <name>RECIPIENT_STATUS</name>
                  <value>
                    <string>permanent</string>
                  </value>
                </member>
              </struct>
            </value>
          </data>
        </array>
      </value>
    </param>
  </params>
</methodResponse>

Hodnoty

ID_MESSAGE – ID kampaně
TEXT_STATUS – chybová odpověď serveru v textové podobě
STATUS – stavový SMTP kód chyby
BOUNCE_CAT – důvod selhání doručení
ID_EMAIL – ID e-mailu příjemce
ID_SEND – ID rozesílky
EMAIL – e-mailová adresa příjemce
ID_SEND_MESSGE – ID zprávy
ID_USER_LIST – ID seznamu příjemců
REMOTE_MTA – identifikace vzdáleného mail serveru
ID_UNDELIVERED_LOG – ID záznamu v logu
RECIPIENT_STATUS – aktuální status příjemce

Pokud neexistují žádné nedoručené zprávy, vrací API prázdnou odpověď:

JSON 

{}

XML 

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

Po neúspěšném volání se vrací:

JSON 

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

XML 

<?xml version="1.0"?>
<methodResponse>
    <params>
        <param>
            <value>
                <string>Invalid ID_send</string>
            </value>
        </param>
    </params>
</methodResponse>

Hodnoty

Invalid ID_message – neplatné ID kampaně (JSON i XML)
Invalid ID_send – neplatné ID rozesílky (XML)

V ostatních případech vrací API prázdnou odpověď:

JSON 

{}

XML 

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