ResourcesAPI documentation

mailkit.campaigns.messages.test

Function mailkit.campaigns.messages.test sends test message. Only one test message every 30 seconds can be sent.

API call example:

XML

<?xml version="1.0" encoding="UTF-8"?>
<methodCall>
  <methodName>mailkit.campaigns.messages.test</methodName>
  <params>
    <param>
      <value>
        <int>client_id</int>
      </value>
    </param>
    <param>
      <value>
        <string>client_md5</string>
      </value>
    </param>
    <param>
      <value>
        <i4>ID_message</i4>
      </value>
    </param>
    <param>
      <value>
        <string>email</string>
      </value>
    </param>
    <param>
      <value>
        <i4></i4>
      </value>
    </param>
    <param>
      <value>
        <string>A/B</string>
      </value>
    </param>
  </params>
</methodCall>

Values

client_id * = client ID can be found in your Mailkit account's menu Profile / Integration / API settings.

client_md5 * = MD5 code can be found in your Mailkit account's menu Profile / Integration / API settings.

ID_message * = ID of campaign

email * = e-mail address where test message will be send

blank area = keep for compatibility

A/B = A or B version (campaign with enabled A/B testing)

* required value

Successful call response:

XML

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

Values

OK = test message was sent successfully

OK version A = test message in A version was sent successfully

OK version B = test message in B version was sent successfully

Unsuccessful call response:

XML

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

Values

Missing ID_message = ID of message is missing

Wrong email = wrong email address inserted

Invalid version = invalid version of A/B testing inserted

Invalid ID_preview_profile = invalid ID of preview profile inserted

Time limit = can be send only one test message for 30 seconds