mailkit.campaigns.single.schedule

Funkce mailkit.campaigns.single.schedule naplánuje jednorázové rozeslání kampaně.

Touto funkcí je možné naplánovat jednorázové odeslání kampaně. Kampaň může mít naplánovaných několik rozesílek zároveň. Pro zrušení rozesílky je nutné použít funkci mailkit.campaigns.schedule.cancel.

Ukázka API volání:

JSON 

{   
   "function":"mailkit.campaigns.single.schedule",
   "id":"client_id",
   "md5":"client_md5",
   "parameters":{   
        "ID_message": "ID kampaně",
        "subject": "předmět kampaně",
        "send_date": "now",
        "time_zone": "",
        "ID_delivery_feed": "1234",
        "ID_query":"ID dotazu"
   }    
}

XML 

<?xml version="1.0" encoding="UTF-8"?>
<methodCall>
    <methodName>mailkit.campaigns.single.schedule</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>subject</string>
            </value>
        </param>
        <param>
            <value>
                <string>send_date</string>
            </value>
        </param>
        <param>
            <value>
                <string>time_zone</string>
            </value>
        </param>
<!-- prázdný parametr - začátek -->
        <param>
            <value>
                <string></string>
            </value>
        </param>
<!-- prázdný parametr - konec -->
        <param>
            <value>
                <i4>ID_template</i4>
            </value>
        </param>
        <param>
            <value>
                <struct>
                    <member>
                        <name>ID_query</name>
                        <value>
                            <string>123</string>
                        </value>
                    </member>
                    <member>
                        <name>ID_delivery_feed</name>
                        <value>
                            <string>123</string>
                        </value>
                    </member>
                </struct>
            </value>
        </param>
    </params>
</methodCall>

Hodnoty

client_id * = API ID naleznete ve svém Mailkit účtu v menu Profil/Integrace.
client_md5 * = MD5 kód naleznete ve svém Mailkit účtu v menu Profil/Integrace.
ID_message * = ID kampaně
subject = předmět kampaně. V případě, že hodnota pro předmět není ve volání poslána, bude použit předmět nastavený v kampani.
send_date * = datum odeslání kampaně ve formátu rrrr-mm-dd hh:mm, nebo 'now' pro okamžité rozeslání
time_zone ** = časové pásmo ve formátu hh:mm nebo -hh:mm (02:00, -03:00...) – vrací funkce mailkit.campaigns.schedule.timezones
prázdný parametr = prázdná větev (je ignorovaná) z důvodu zachování zpětné kompatibility
ID_template = ID šablony
ID_query = ID dotazu pro podmíněné doručení (vrací funkce mailkit.profile.queries.list). Pokud není hodnota pro ID_query v API volání poslána a zároveň je v kampani nastaveno podmíněné doručení, budou pro rozesílku použita pravidla nastavená v podmíněném doručení. Pokud je v API volání zaslána hodnota pro ID_query a zároveň je v kampani nastaveno podmíněné doručení, bude aplikována podmínka zaslaná v API volání (tzn. podmíněné doručení nastavené v kampani bude ignorováno)
ID_delivery_feed = ID delivery feedu (ID datového zdroje doručování)

* povinný parametr
** povinný parametr v případě, kdy je parametr send_date nastaven na konkrétní datum/čas (v případě hodnoty "now" pro parametr send_date je time_zone parametr nepovinný, resp. jeho hodnota je ignorována)

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

JSON 

{
    "error": "OK, send_date: 2022-05-13 12:45:00 (Europe/Prague)",
    "error_status": 0
}

XML 

<?xml version="1.0" encoding="utf-8"?>
<methodResponse>
  <params>
    <param>
      <value>
        <string>OK, send_date: rrrr-mm-dd hh:mm:ss</string>
      </value>
    </param>
  </params>
</methodResponse>

Hodnoty

OK = kampaň bude odeslána, datum rozeslání

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

JSON 

{
    "error": "Missing send date of campaign",
    "error_status": 1
}

XML 

<?xml version="1.0" encoding="utf-8"?>
<methodResponse>
  <params>
    <param>
      <value>
        <string>Missing send date of campaign</string>
      </value>
    </param>
  </params>
</methodResponse>

Hodnoty

Missing send date of campaign = chybí datum rozesílky
Missing ID of campaign = chybí ID kampaně​​​​​​​
The send date is in the past = datum rozeslání je v minulosti​​​​​​​
Invalid ID_delivery_feed = neplatné ID delivery feedu​​​​​​​
Invalid ID_query = neplatné ID pravidla​​​​​​​
​​​​​​​error: Confused parameters - it is not possible to combine delivery capping and delivery feeds = není možné kombinovat podmíněné doručení (aktivní pravidlo) s delivery feedem

  • Pokud má kampaň přiřazený seznam příjemců a ve volání mailkit.campaign.single.schedule je přiřazen delivery feed, dojde k přiřazení delivery feedu ke kampani a odřazení seznamu příjemců od kampaně.
  • Pokud je ve volání mailkit.campaign.single.schedule volané platné pravidlo (ID_query), dojte k přiřazení tohoto pravidla ke kampani (aktivní podmíněné doručení).
  • Pokud je u kampaně nastavené podmíněné doručení a ve volání mailkit.campaign.single.schedule je voláno ID_query = 0, dojde k vynulování podmíněného doručení u kampaně. Pokud parametr ID_query není zasílán žádný, zůstane podmíněné doručení u kampaně nastavené.