ResourcesAPI documentation

mailkit.campaigns.schedule.cancel

Funkce mailkit.campaigns.schedule.cancel zruší naplánovanou rozesílku.

Ukázka API volání:

XML-RPC

<?xml version="1.0" encoding="UTF-8"?>
<methodCall>
 <methodName>mailkit.campaigns.schedule.cancel</methodName>
 <params>
  <param>
   <value>
    <int>client_id</int>
   </value>
  </param>
  <param>
   <value>
    <string>client_md5</string>
   </value>
  </param>
  <param>
   <value>
    <i4>123456</i4>
   </value>
  </param>
  <param>
   <value>
    <struct>
     <member>
      <name>ID_send_message_queue</name>
      <value>
       <string>123</string>
      </value>
     </member>
    </struct>
   </value>
  </param>
 </params>
</methodCall>

JSON

{  
   "function":"mailkit.campaign.schedule.cancel,
   "id":"client_id",
   "md5":"client_md5",
     "parameters":{  
      "ID_message": "123456”,
      “ID_send_message_queue”:”123”
   }   
}

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ě
ID_send_message_queue * = ID naplánované rozesílky (vrací funkce mailkit.campaign.single.schedule.list)

* povinný parametr

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

XML-RPC

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

JSON

{
    "error_status": 0,
    "error": "Canceled"
}

Hodnoty:

Canceled = čekající rozesílka byla zrušena

Při error / error_status = 1 ... nastala chyba:
Invalid ID_message = neplatné ID kampaně
Invalid status cancel
 = ID již zpracované čekající rozesílky (již byla zrušena, nebo odeslána)
Invalid ID_send_message_queue = neplatné ID čekající rozesílky