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>ID_preview_email</i4>
      </value>
    </param>
    <param>
      <value>
        <string>A/B</string>
      </value>
    </param>
    <param>
      <value>
        <struct>
         <member>
          <name>content</name>
          <value>
           <struct>
            <member>
             <name>custom_variable1</name>
             <value>
              <string>dmxhc3RuaV9wcm9tZW5uYTE=</string>
             </value>
            </member>
            <member>
             <name>custom_variable2</name>
             <value>
              <string>dmxhc3RuaV9wcm9tZW5uYTI=</string>
             </value>
            </member>
            <member>
             <name>custom_variable3</name>
             <value>
              <string>dmxhc3RuaV9wcm9tZW5uYTM=</string>
             </value>
            </member>
           </struct>
          </value>
         </member>
        </struct>
      </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

ID_preview_email = ID of the recipient who's data (name, address, custom fields, etc.) should be used for the personalization.

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

* required value

content (base64 encoded) = content with custom variables that will be passed on to the template in the shared or data structure and accessible using [% shared.VARIABLE_NAME -%] or [% data.ARRAY_NAME -%].

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

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