ResourcesAPI documentation

mailkit.campaigns.single.schedule.list

Funkce mailkit.campaigns.single.schedule.list vrátí seznam naplánovaných rozesílek kampaně.

Ukázka API volání:

XML-RPC

<?xml version="1.0" encoding="UTF-8"?>
<methodCall>
  <methodName>mailkit.campaigns.schedule.list</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>
  </params>
</methodCall>

JSON

{  
   "function":"mailkit.campaigns.schedule.list",
   "id":"client_id",
   "md5":"client_md5",
   "parameters":{  
      "ID_message": "123456"
   }   
}

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ě

* povinný parametr

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

XML-RPC bez čekajících rozesílek

<?xml version="1.0" encoding="utf-8"?>
<methodResponse>
 <params>
  <param>
   <value>
    <struct>
     <member>
      <name>ID_message</name>
      <value>
       <i4>123456</i4>
      </value>
     </member>
     <member>
      <name>data</name>
      <value>
       <string></string>
      </value>
     </member>
     <member>
      <name>error</name>
      <value>
       <i4>0</i4>
      </value>
     </member>
    </struct>
   </value>
  </param>
 </params>
</methodResponse>

XML-RPC čekající rozesílky

<?xml version="1.0" encoding="utf-8"?>
<methodResponse>
 <params>
  <param>
   <value>
    <struct>
     <member>
      <name>data</name>
      <value>
       <array>
        <data>
         <value>
          <struct>
           <member>
            <name>DATE</name>
            <value>
             <string>2018-03-26 11:48:44</string>
            </value>
           </member>
           <member>
            <name>SUBJECT</name>
            <value>
             <string>subject</string>
            </value>
           </member>
           <member>
            <name>SUBJECT_B</name>
            <value>
             <string></string>
            </value>
           </member>
           <member>
            <name>USE_AB</name>
            <value>
             <string>FALSE</string>
            </value>
           </member>
           <member>
            <name>TIME_ZONE</name>
            <value>
             <string>+02:00</string>
            </value>
           </member>
           <member>
            <name>ID_SEND_MESSAGE_QUEUE</name>
            <value>
             <i4>123</i4>
            </value>
           </member>
           <member>
            <name>DATE_SEND</name>
            <value>
             <string>2018-04-29 14:35:00</string>
            </value>
           </member>
          </struct>
         </value>
        </data>
       </array>
      </value>
     </member>
     <member>
      <name>ID_message</name>
      <value>
       <i4>123456</i4>
      </value>
     </member>
     <member>
      <name>error</name>
      <value>
       <i4>0</i4>
      </value>
     </member>
    </struct>
   </value>
  </param>
 </params>
</methodResponse>

JSON bez čekajících rozesílek

{
    "ID_message": "123456",
    "data": "",
    "error_status": 0
}

JSON čekající rozesílky

{
    "data": [
        {
            "SUBJECT": "subject",
            "TIME_ZONE": "+01:00",
            "DATE_SEND": "2018-03-31 08:25:00",
            "USE_AB": "FALSE",
            "SUBJECT_B": "",
            "DATE": "2018-03-13 10:26:23",
            "ID_SEND_MESSAGE_QUEUE": 123
        }
    ],
    "error_status": 0,
    "ID_message": "123456"
}

Hodnoty:

DATE = datum a čas, kdy byla rozesílka naplánována
SUBJECT = předmět rozesílky
SUBJECT_B = předmět rozesílky B verze kampaně (při zapnutém AB testu)
USE_AB = zapnutý AB test (TRUE / FALSE)
TIME_ZONE = časová zóna
ID_SEND_MESSAGE_QUEUE = ID naplánované rozesílky
DATE_SEND = datum a čas, kdy má být rozesílka odeslána
ID_message = ID kampaně
error = 0 ... volání proběhlo v pořádku (XML-RPC)
error_status = 0 ... volání proběhlo v pořádku (JSON)

Při error / error_status = 1 ... nastala chyba:
Invalid ID_message = neplané ID kampaně