• Features
  • Services
    • Email Authentication
    • Agency Partnerships
    • Email Training
    • Inbox Brand Visibility
    • Deliverability
  • Resources
    • Knowledge Base
    • API documentation
    • Blog
    • Status
    • BIMI inspector
  • About us
    • Contact
    • Terms and Conditions
    • Privacy Policy
    • Privacy recommendations
  • Features
  • Services
    • Email Authentication
    • Agency Partnerships
    • Email Training
    • Inbox Brand Visibility
    • Deliverability
  • Resources
    • Knowledge Base
    • API documentation
    • Blog
    • Status
    • BIMI inspector
  • About us
    • Contact
    • Terms and Conditions
    • Privacy Policy
    • Privacy recommendations
  • Login
    EN CS
Mailkit logo
  • Features
  • Services
    • Email Authentication
    • Agency Partnerships
    • Email Training
    • Inbox Brand Visibility
    • Deliverability
  • Resources
    • Knowledge Base
    • API documentation
    • Blog
    • Status
    • BIMI inspector
  • About us
    • Contact
    • Terms and Conditions
    • Privacy Policy
    • Privacy recommendations
  • Features
  • Services
    • Email Authentication
    • Agency Partnerships
    • Email Training
    • Inbox Brand Visibility
    • Deliverability
  • Resources
    • Knowledge Base
    • API documentation
    • Blog
    • Status
    • BIMI inspector
  • About us
    • Contact
    • Terms and Conditions
    • Privacy Policy
    • Privacy recommendations
  • Login
    EN CS
EN CS
Login
  • Mailkit
  • Resources
  • API documentation
  • Reporting
  • mailkit.report.message.recipients
    API Introduction
  • Campaign management (11)
    mailkit.campaigns.list mailkit.campaigns.create mailkit.campaigns.update mailkit.campaigns.single.schedule mailkit.campaigns.schedule.list mailkit.campaigns.schedule.timezone mailkit.campaigns.schedule.cancel mailkit.campaigns.messages mailkit.campaigns.messages.last mailkit.campaigns.messages.test mailkit.campaigns.history
  • Mailing list management (18)
    mailkit.mailinglist.list mailkit.mailinglist.create mailkit.mailinglist.delete mailkit.mailinglist.adduser mailkit.mailinglist.edituser mailkit.mailinglist.import mailkit.mailinglist.getstatus mailkit.mailinglist.unsubscribed mailkit.mailinglist.engagement mailkit.email.getstatus mailkit.email.getstatus.history mailkit.email.move mailkit.email.delete mailkit.email.unsubscribe mailkit.email.unsubscribe.getstatus mailkit.email.revalidate mailkit.email.topics mailkit.email.wipe
  • Campaign delivery (4)
    mailkit.sendmail mailkit.sendmail_mass mailkit.sendmail_mass.results mailkit.sendsms
  • Reporting (11)
    mailkit.report mailkit.report.campaign mailkit.report.message mailkit.report.message.recipients mailkit.report.message.feedback mailkit.report.message.links mailkit.report.message.links.visitors mailkit.report.message.bounces mailkit.report.raw.messages mailkit.report.raw.bounces mailkit.report.raw.responses
  • Profile (2)
    mailkit.profile.emails.list mailkit.profile.queries.list
  • Other (4)
    Event API mailkit.filemanager.upload mailkit.filemanager.list mailkit.filemanager.delete
  • Examples (3)
    PHP example 1 (Example of mailkit.mailinglist.list call) PHP example 2 (example of mailkit.campaigns.single.schedule call) PERL example of mailkit.mailinglist.adduser call
  • API Introduction
  • Campaign management
  • Mailing list management
  • Campaign delivery
  • Reporting
  • Profile
  • Other
  • Examples
API Introduction
mailkit.campaigns.list mailkit.campaigns.create mailkit.campaigns.update mailkit.campaigns.single.schedule mailkit.campaigns.schedule.list mailkit.campaigns.schedule.timezone mailkit.campaigns.schedule.cancel mailkit.campaigns.messages mailkit.campaigns.messages.last mailkit.campaigns.messages.test mailkit.campaigns.history
mailkit.mailinglist.list mailkit.mailinglist.create mailkit.mailinglist.delete mailkit.mailinglist.adduser mailkit.mailinglist.edituser mailkit.mailinglist.import mailkit.mailinglist.getstatus mailkit.mailinglist.unsubscribed mailkit.mailinglist.engagement mailkit.email.getstatus mailkit.email.getstatus.history mailkit.email.move mailkit.email.delete mailkit.email.unsubscribe mailkit.email.unsubscribe.getstatus mailkit.email.revalidate mailkit.email.topics mailkit.email.wipe
mailkit.sendmail mailkit.sendmail_mass mailkit.sendmail_mass.results mailkit.sendsms
mailkit.report mailkit.report.campaign mailkit.report.message mailkit.report.message.recipients mailkit.report.message.feedback mailkit.report.message.links mailkit.report.message.links.visitors mailkit.report.message.bounces mailkit.report.raw.messages mailkit.report.raw.bounces mailkit.report.raw.responses
mailkit.profile.emails.list mailkit.profile.queries.list
Event API mailkit.filemanager.upload mailkit.filemanager.list mailkit.filemanager.delete
PHP example 1 (Example of mailkit.mailinglist.list call) PHP example 2 (example of mailkit.campaigns.single.schedule call) PERL example of mailkit.mailinglist.adduser call
Search

mailkit.report.message.recipients

Function mailkit.report.message.recipients returns details about recipitents of the specific campaign delivery.

API call example:

JSON

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

XML

<?xml version="1.0"?>
<methodCall>
  <methodName>mailkit.report.message.recipients</methodName>
  <params>
    <param>
      <value>
        <int>client_id</int>
      </value>
    </param>
    <param>
      <value>
        <string>client_md5</string>
      </value>
    </param>
    <param>
      <value>
        <int>ID_send</int>
      </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

[  
   {  
      "DATE":"RRRR-MM-DD HH:MM:SS",
      "READ_COUNT":"2",
      "STATUS":"sent",
      "ID_EMAIL":"123456789",
      "EMAIL":"example@example.cz",
      "CLICK_COUNT":"2",
      "ID_SEND_MESSAGE":"123456798",
      "AB_VERSION":""
   }
]

XML

<?xml version="1.0" encoding="utf-8"?>
<methodResponse>
  <params>
    <param>
    <value>
      <array>
        <data>
          <value>
            <struct>
              <member>
                <name>DATE</name>
                <value>
                  <string>yyyy-mm-dd hh:mm:ss</string>
                </value>
              </member>
              <member>
                <name>ID_SEND_MESSAGE</name>
                <value>
                  <i4>123456789</i4>
                </value>
              </member>
              <member>
                <name>EMAIL</name>
                <value>
                  <string>example@example.cz</string>
                </value>
              </member>
              <member>
              <member>
                <name>STATUS</name>
                <value>
                  <string>sent</string>
                </value>
              </member>
              <member>
                <name>AB_VERSION</name>
                <value>
                  <string></string>
                </value>
              </member>
              <member>
                <name>ID_EMAIL</name>
                <value>
                  <i4>123456789</i4>
                </value>
              </member>
              <member>
                <name>READ_COUNT</name>
                <value>
                  <i4>3</i4>
                </value>
              </member>
              <member>
                <name>CLICK_COUNT</name>
                <value>
                  <i4>0</i4>
                </value>
              </member>
            </struct>
          </value>
        </data>
      </array>
    </value>
    </param>
  </params>
</methodResponse>

Values

DATE = date message was sent (yyyy-mm-dd hh:mm:ss)
ID_SEND_MESSAGE = ID of message (individual for each recipient)
EMAIL = e-mail address of recipient
ID_EMAIL = ID of recipient's e-mail address
STATUS = message delivery status

  • sent = sent
  • failed = failed (bounced)
  • wait = the email has been placed in the sending queue, but we have not yet received information from the receiving party about the delivery or non-delivery of the message
  • wait_ab = waiting for A/B test evaluation

AB_VERSION = version of campaign which was delivered to the recipient. Possible values: A, B, empty field (when A/B test was disabled)
READ_COUNT = read count
CLICK_COUNT = click count

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

Contact us

Let us know what your campaign objectives are and we'll create a plan that works for you.

+420 277 001 800
sales@mailkit.com


Processing of information provided using this form is governed by our Privacy Policy.

Required
Required
Required
Mailkit logo

A Czech emailing platform with its own infrastructure, that is a leader in international mailing distribution.

 

  • Features
  • Services
  • Resources
  • About us

services

  • Email Authentication
  • Agency Partnerships
  • Email Training
  • Inbox Brand Visibility
  • Deliverability

ReSOURCES

  • Knowledge Base
  • API documentation
  • Blog
  • Status
  • BIMI inspector
Logo Maawg
Logo Experience
Logo CSA
Logo Signal spam
Logo ISO-27001
Logo ISO-9001
This site is protected by reCAPTCHA and the Google Privacy Policy and Terms of Service apply.
© 2006-2022 Mailkit - All rights reserved