mailkit.report.message.bounces

Funkce mailkit.report.message.bounces vráti seznam nedoručených e-mailů z konkrétní rozesílky kampaně.

Ukázka API volání:

JSON 

{  
   "function":"mailkit.report.message.bounces",
   "id":"client_id",
   "md5":"client_md5",
   "parameters":{ 
        "ID_send":"123456"
   }
}

XML 

<?xml version="1.0" encoding="UTF-8"?>
<methodCall>
  <methodName>mailkit.report.message.bounces</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>
  </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

* povinný parametr

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

JSON 

[
  {
    "ID_SEND_MESSAGE": "123456789",
    "ID_USER_LIST": "12345",
    "DATE": "RRRR-MM-DD HH:MM:SS",
    "STATUS": "4.4.1",
    "ID_EMAIL": "1234567890",
    "EMAIL": "adresa1@nejakadomena.cz",
    "EMAIL_STATUS": "temporary",
    "BOUNCE_CAT": "full-mailbox",
    "REASON": "Full Mailbox"
  },
  {
    "ID_SEND_MESSAGE": "123456790",
    "ID_USER_LIST": "12345",
    "DATE": "RRRR-MM-DD HH:MM:SS",
    "STATUS": "5.1.1",
    "ID_EMAIL": "1234567891",
    "EMAIL": "adresa2@nejakadomena.cz",
    "EMAIL_STATUS": "permanent",
    "BOUNCE_CAT": "bad-mailbox",
    "REASON": "Bad Mailbox"
  }
]

XML 

<?xml version="1.0" encoding="utf-8"?>
<methodResponse>
  <params>
    <param>
      <value>
        <array>
          <data>
            <value>
              <struct>
                <member>
                  <name>EMAIL</name>
                  <value>
                    <string>mail@mail.com</string>
                  </value>
                </member>
                <member>
                  <name>ID_EMAIL</name>
                  <value>
                    <int>49872054</int>
                  </value>
                </member>
                <member>
                  <name>ID_USER_LIST</name>
                  <value>
                    <int>123</int>
                  </value>
                </member>
                <member>
                  <name>ID_SEND_MESSAGE</name>
                  <value>
                    <int>1234567890</int>
                  </value>
                </member>
                <member>
                  <name>DATE</name>
                  <value>
                    <string>2014-12-23 12:36:02</string>
                  </value>
                </member>
                <member>
                  <name>STATUS</name>
                  <value>
                    <string>4.4.2</string>
                  </value>
                </member>
                <member>
                  <name>EMAIL_STATUS</name>
                  <value>
                    <string>temporary/permanent</string>
                  </value>
                </member>
                <member>
                  <name>BOUNCE_CAT</name>
                  <value>
                    <string>bad-mailbox</string>
                  </value>
                </member>
                <member>
                  <name>REASON</name>
                  <value>
                    <string>Bad Mailbox</string>
                  </value>
                </member>
              </struct>
            </value>
          </data>
        </array>
      </value>
    </param>
  </params>
</methodResponse>

Hodnoty

EMAIL = e-mailová adresa příjemce
ID_EMAIL = ID e-mailové adresy příjemce
ID_USER_LIST = ID seznamu příjemců, kde je daný příjemce umístěn
ID_SEND_MESSAGE = ID odeslané zprávy (individuální údaj pro každého příjemce)
DATE = datum vrácené chybové odpovědi
STATUS = číselný status důvodu nedoručení
EMAIL_STATUS = stav příjemce. Může nabývat hodnot:

  • enabled (stav aktivní)
  • unknown (stav neznámý)
  • temporary (stav dočasně nedostupný)
  • permanent (stav trvale nedostupný)
  • unsubscribe (stav odhlášený)

BOUNCE_CAT = kategorizace důvodu nedoručení
REASON = důvod nedoručení

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

JSON 

{}

XML 

<?xml version="1.0"?>
<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_send"
}

XML 

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

Hodnoty

Missing ID_send – chybějící ID rozesílky
Invalid ID_send – neplatné ID rozesílky