PodporaAPI dokumentace

mailkit.campaigns.list

Funkce mailkit.campaigns.list vrátí seznam dostupných kampaní s podrobnostmi jejich rozesílání a nastavení.

Ukázka XML-RPC volání:

XML-RPC volání

<?xml version="1.0"?>
<methodCall>
  <methodName>mailkit.campaigns.list</methodName>
  <params>
    <param>
      <value>
        <int>client_id</int>
      </value>
    </param>
    <param>
      <value>
        <string>client_md5</string>
      </value>
    </param>
    <param>
      <value>
        <int>ID_message</int>
      </value>
    </param>
  </params>
</methodCall>
		

Hodnoty

client_id * = API ID 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ě. Volitelný parametr - při vyplnění tohoto parametru vrátí funkce informace pouze o kampani s tímto ID.

* povinný parametr

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

XML-RPC odpověď

<?xml version="1.0" encoding="utf-8"?>
<methodResponse>
  <params>
    <param>
      <value>
        <array>
          <data>
            <value>
              <struct>
                <member>
                  <name>NAME</name>
                  <value>
                    <string>Jméno kampaně</string>
                  </value>
                </member>
                <member>
                  <name>ID_MESSAGE</name>
                  <value>
                    <i4>12345</i4>
                  </value>
                </member>
                <member>
                  <name>SUBJECT</name>
                  <value>
                    <string>Předmět kampaně</string>
                  </value>
                </member>
                <member>
                  <name>USER_LIST</name>
                  <value>
                    <i4>12345</i4>
                  </value>
                </member>
                <member>
                  <name>LAST_SENT</name>
                  <value>
                    <string>yyyy-mm-dd hh:mm:ss</string>
                  </value>
                </member>
                <member>
                  <name>TYPE</name>
                  <value>
                    <string>immediate</string>
                  </value>
                </member>
                <member>
                  <name>REPEAT</name>
                  <value>
                    <string></string>
                  </value>
                </member>
                <member>
                  <name>REPEAT_COUNT</name>
                  <value>
                    <string></string>
                  </value>
                </member>
                <member>
                  <name>DAYS</name>
                  <value>
                    <string></string>
                  </value>
                </member>
                <member>
                  <name>TIME_ZONE</name>
                  <value>
                    <string></string>
                  </value>
                </member>
                <member>
                  <name>PERIOD</name>
                  <value>
                    <string></string>
                  </value>
                </member>
                <member>
                  <name>SEND_DATE</name>
                  <value>
                    <string></string>
                  </value>
                </member>
              </struct>
            </value>
          </data>
        </array>
      </value>
    </param>
  </params>
</methodResponse>
		

Hodnoty

NAME = jméno kampaně

ID_MESSAGE = ID kampaně

SUBJECT = předmět kampaně

USER_LIST = ID seznamu/seznamů příjemců, který je přiřazen ke kampani. V případě více seznamů, jsou jednotlivá ID oddělena čárkou.

LAST_SENT = datum posledního odeslání dané kampaně. Ve formátu yyyy-mm-dd hh:mm:ss

TYPE = typ (posledního) odeslání kampaně.

  • immediate = okamžité odeslání kampaně
  • single = bezobslužné odeslání kampaně
  • multiple = plánované odeslání kampaně (automaticky opakovaně odesílaná kampaň

REPEAT = nabývá hodnoty TRUE v případě, že je u kampaně nastavené plánované odesílání.

REPEAT_COUNT = zda a v jakém intervalu se opakuje plánované odeslání kampaně. Hodnoty 1 až x.

DAYS = v jaké dny se kampaň bude rozesílat v případě nastaveného plánovaného odesílání kampaně. Vrací hodnoty 1 až 7 (1= pondělí, 7= neděle).

TIME_ZONE = časové pásmo, které je nastavené u plánovaného odesílání kampaně. Nabývá hodnot -12:00 (pro UTC-12) až 12:00 (pro UTC+12).

PERIOD = perioda, v jaké se odesílá kampaň při plánovaném odesílání

  • week = týdně
  • month = měsíčně

SEND_DATE = datum příštího odeslání dané kampaně. Ve formátu yyyy-mm-dd hh:mm:ss