API call example:
JSON
{
"function":"mailkit.email.getstatus",
"id":"client_id",
"md5":"client_md5",
"parameters":{
"email":"email",
"ID_email":"ID_email",
"ID_send_message":"ID_send_message"
}
}
XML
<?xml version="1.0"?>
<methodCall>
<methodName>mailkit.email.getstatus</methodName>
<params>
<param>
<value>
<int>client_id</int>
</value>
</param>
<param>
<value>
<string>client_md5</string>
</value>
</param>
<param>
<value>
<int>email_id</int>
</value>
</param>
<param>
<value>
<int>ID_send_message</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.
email_id ** = may contain ID of e-mail address, (returned by mailkit.mailinglist.adduser), or e-mail address (XML only). If an email address is provided a list of all found records will be returned.
email ** = e-mail address (only for JSON)
ID_send_message ** = ID of message sent to specific recipient (XML and JSON)
* required value
** one of the values must be provided
Successful call response:
JSON
[
{
"CHANGE_DATE":"2016-02-19 10:44:07",
"CUSTOM_9":"custom 9",
"DATE":"2012-05-25 23:21:30",
"VOCATIVE":"",
"STATUS":"unknown",
"CUSTOM_8":"custom 8",
"CUSTOM_23":"",
"COMPANY":"",
"REPLY_TO":"",
"CUSTOM_15":"5.4.",
"CUSTOM_25":"",
"CUSTOM_5":"",
"ID_EMAIL":"53161278",
"FAX":"",
"CUSTOM_3":"6",
"MOBILE":"+420123456789",
"PREFIX":"",
"CUSTOM_4":"8",
"EMAIL":"email@example.com",
"CUSTOM_2":"so",
"ID_MAILING_LIST":"123456",
"CUSTOM_12":"86-04-05",
"NICK_NAME":"kuku",
"CUSTOM_14":"5.4.86",
"CUSTOM_18":"N",
"COUNTRY":"",
"CITY":"Praha",
"LAST_NAME":"",
"STREET":"",
"CUSTOM_7":"custom 7",
"CUSTOM_11":"1986-04-05",
"CUSTOM_16":"89",
"CUSTOM_19":"",
"GENDER":"",
"CUSTOM_6":"",
"CUSTOM_10":"2015-04-05",
"CUSTOM_1":"yes",
"CUSTOM_13":"5.4.1986",
"CUSTOM_20":"",
"CUSTOM_22":"",
"FIRST_NAME":"",
"CUSTOM_24":"",
"ZIP":"",
"CUSTOM_21":"",
"STATE":"",
"CUSTOM_17":"Y",
"PHONE":"9999999",
"CONSENT": "TRUE",
"CONSENT_CHANNEL": "subscribe insert",
"CONSENT_DATE": "2019-05-29 15:18:41",
"SCORE": "4",
"TREND": "-1"
}
]
XML
<?xml version="1.0" encoding="utf-8"?>
<methodResponse>
<params>
<param>
<value>
<array>
<data>
<value>
<struct>
<member>
<name>ID_EMAIL</name>
<value>
<i4>12345</i4>
</value>
</member>
<member>
<name>EMAIL</name>
<value>
<string>example@example.cz</string>
</value>
</member>
<member>
<name>ID_MAILING_LIST</name>
<value>
<i4>12345</i4>
</value>
</member>
<member>
<name>VOCATIVE</name>
<value>
<string>salutation</string>
</value>
</member>
<member>
<name>PREFIX</name>
<value>
<string>title</string>
</value>
</member>
<member>
<name>FIRST_NAME</name>
<value>
<string>first name</string>
</value>
</member>
<member>
<name>LAST_NAME</name>
<value>
<string>last name</string>
</value>
</member>
<member>
<name>NICK_NAME</name>
<value>
<string>nick</string>
</value>
</member>
<member>
<name>GENDER</name>
<value>
<string>F/M</string>
</value>
</member>
<member>
<name>REPLY_TO</name>
<value>
<string>example2@example2.cz</string>
</value>
</member>
<member>
<name>PHONE</name>
<value>
<string>12345</string>
</value>
</member>
<member>
<name>FAX</name>
<value>
<string>12345</string>
</value>
</member>
<member>
<name>MOBILE</name>
<value>
<string>12345</string>
</value>
</member>
<member>
<name>COMPANY</name>
<value>
<string>company</string>
</value>
</member>
<member>
<name>STREET</name>
<value>
<string>address</string>
</value>
</member>
<member>
<name>CITY</name>
<value>
<string>city</string>
</value>
</member>
<member>
<name>COUNTRY</name>
<value>
<string>country</string>
</value>
</member>
<member>
<name>ZIP</name>
<value>
<string>ZIP</string>
</value>
</member>
<member>
<name>STATE</name>
<value>
<string>state</string>
</value>
</member>
<member>
<name>DATE</name>
<value>
<string>yyyy-mm-dd hh:mm:ss</string>
</value>
</member>
<member>
<name>STATUS</name>
<value>
<string>enabled</string>
</value>
</member>
<member>
<name>CUSTOM_1</name>
<value>
<string>custom field n. 1</string>
</value>
</member>
<member>
<name>CUSTOM_25</name>
<value>
<string>custom field n. 25</string>
</value>
</member>
<member>
<name>CONSENT</name>
<value>
<string>TRUE</string>
</value>
</member>
<member>
<name>CONSENT_CHANNEL</name>
<value>
<string>subscribe insert</string>
</value>
</member>
<member>
<name>CONSENT_DATE</name>
<value>
<string>2019-05-29 15:18:41</string>
</value>
</member>
<member>
<name>SCORE</name>
<value>
<string>4</string>
</value>
</member>
<member>
<name>TREND</name>
<value>
<string>-1</string>
</value>
</member>
</struct>
</value>
</data>
</array>
</value>
</param>
</params>
</methodResponse>
Values
ID_EMAIL = ID of recipient's e-mail address
EMAIL = e-mail address of recipient
ID_MAILING_LIST = ID of mailing list
VOCATIVE = salutation of recipient
PREFIX = title of recipient
FIRST_NAME = first name of recipient
LAST_NAME = last name of recipient
NICK_NAME = nick of recipient
GENDER = gender of recipient. Possible values:
- F = female
- M = male
- empty field = without gender
REPLY_TO = e-mail address of recipient for reply-to
PHONE = phone of recipient
FAX = fax of recipient
MOBILE = mobile of recipient
COMPANY = company of recipient
STREET = address of recipient
CITY = city of recipient
COUNTRY = country of recipient
ZIP = ZIP of recipient
STATE = state of recipient
DATE = date recipient was added to the list
STATUS = status of recipient. Possible values:
- enabled
- disabled
- unknown
- temporary
- permanent
- unsubscribe
CUSTOM_1 = custom field of recipient n. 1. Total number of custom field is 25.
CONSENT = recipient consent record. Value of TRUE / FALSE.
CONSENT_CHANNEL = source of the consent. Values include:
- subscribe update (update of consent via subscribe form)
- rpc mailinglist.adduser (consent passed via API - mailkit.mailinglist.adduser)
- subscribe insert (consent confirmed using subscribe form)
- subscribe (previously stored consent)
- rpc email.revalidate (consent revalidated via API - mailkit.email.revalidate)
- confirm_url (consent confirmed using confirmation link from campaign)
SCORE = recipient's engagement score
TREND = recipient's engagement trend
Unsuccessful call response:
JSON
{
"error_status":1,
"error":"Missing ID_email"
}
XML
<?xml version="1.0" encoding="utf-8"?>
<methodResponse>
<params>
<param>
<value>
<string></string>
</value>
</param>
</params>
</methodResponse>
Values
Empty response - wrong e-mail ID and/or wrong e-mail address
Missing ID_email - missing e-mail address
