PodporaAPI dokumentace

mailkit.campaigns.messages.test

Funkce mailkit.campaigns.messages.test odešle testovací zprávu. Lze odeslat pouze 1 testovací zprávu za 30 sekund.

Ukázka API volání:

XML-RPC

<?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>
    <string>ID_message</string>
   </value>
  </param>
  <param>
   <value>
    <string>email</string>
   </value>
  </param>
  <param>
   <value>
    <string>ID_preview_email</string>
   </value>
  </param>
  <param>
   <value>
    <string>A/B</string>
   </value>
  </param>
  <param>
   <value>
    <struct>
     <member>
      <name>content</name>
      <value>
       <struct>
        <member>
         <name>vlastni_promenna1</name>
         <value>
          <string>dmxhc3RuaV9wcm9tZW5uYTE=</string>
         </value>
        </member>
        <member>
         <name>vlastni_promenna2</name>
         <value>
          <string>dmxhc3RuaV9wcm9tZW5uYTI=</string>
         </value>
        </member>
        <member>
         <name>vlastni_promenna3</name>
         <value>
          <string>dmxhc3RuaV9wcm9tZW5uYTM=</string>
         </value>
        </member>
       </struct>
      </value>
     </member>
    </struct>
   </value>
  </param>
 </params>
</methodCall>
		

Hodnoty

client_id * = API ID uživatele naleznete ve svém Mailkit účtu v menu Profil / Integrace / Nastavení API.
client_md5 * = MD5 kód naleznete ve svém Mailkit účtu v menu Profil / Integrace / Nastavení API.
ID_message * = ID kampaně
email * = e-mailová adresa, kam bude zaslána testovací zpráva
ID_preview_email = ID příjemce, jehož data (jméno, vlastní pole atp.) mají být použita v personalizované zprávě namísto vložených tagů
A/B = A nebo B verze kampaně při zapnutém A/B testu
content (v base64) = obsah, který bude dostupný v šabloně v datových strukturách [% shared.NAZEV_PROMENNE -%], nebo [% data.NAZEV_POLE -%]

* povinný parametr

Po úspěšném volání se vrací:

XML-RPC

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

Hodnoty

OK = testovací zpráva byla úspěšně odeslána
OK version A = testovací zpráva ve verzi A byla úspěšně odeslána
OK version B = testovací zpráva ve verzi B byla úspěšně odeslána

Příklad chybových odpovědí:

Missing ID_message = vloženo neplatné ID kampaně
Wrong email = vložena neplatná e-mailová adresa
Invalid version = vložena neplatná verze A/B testu
Time limit = je možné odeslat pouze 1 testovací zprávu za 30 sekund