mailkit.report.message.bounces

Function mailkit.report.message.bounces returns a list of bounced e-mail addresses for a specified campaign delivery.

API call example:

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>

Values

client_id * = client ID can be found in your Mailkit account's menu Profile/Integration.
client_md5 * = MD5 code can be found in your Mailkit account's menu Profile/Integration.
ID_send * = Campaign delivery ID

* required value

Succesfull call response:

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>

Values

EMAIL = recipient email address
ID_EMAIL = recipient email address ID
ID_USER_LIST = mailing list ID of recipient email
ID_SEND_MESSAGE = ID of sent message (unique for each recipient)
DATE = date of bounce record
STATUS = numeric error status code (DSN)
EMAIL_STATUS = email status based on bounce error. Can be any of:

  • enabled = recipient is valid with an existing proof of activity
  • unknown = recipient is valid but with no proof of activity
  • permanent = recipient permanently unreachable
  • temporary = recipient temporarily unreachable
  • unsubscribe = recipient has unsubscribed

BOUNCE_CAT = bounce category
REASON = reason for non-delivery

If there are no undelivered messages in the campaign delivery, the API returns an empty response:

JSON 

{}

XML 

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

Unsuccessful call response:

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>

Values

Missing ID_send – missing campaign delivery ID
Invalid ID_send – invalid campaign delivery ID