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
