mailkit.campaigns.create

Funkce mailkit.campaigns.create založí novou kampaň.

XML-RPC žádost musí být vydána ve formátu uvedeném níže.
UPOZORNĚNÍ: Formát zasílaných dat musí být v Base64.

Ukázka API volání:

JSON 

{
	"function": "mailkit.campaigns.create",
	"id": "client_id",
	"md5": "client_md5",
	"parameters": {
		"name": "bmFtZQ==",
		"subject": "c3ViamVjdA==",
		"ID_allow_email": "MTIzNDU2",
		"ID_mailing_list":"MTIzNDU2",
		"ID_delivery_feed":"NDU2Nw==",
		"ID_query":"MTIzNDU2",
		"ID_template":"MTIzNDU2",
		"type_message":"ZW1haWw=",
		"google_analytics":"VFJVRQ==",
		"analytic_name":"YW5hbHl0aWNfbmFtZQ==",
		"ID_tagset":"MTIz",
		"test_mode":"VFJVRQ==",
		"test_emails":"ZW1haWwxQGV4YW1wbGUuY29tLGVtYWlsMkBleGFtcGxhZS5jb20=",
		"content":"Y29udGVudCAxIChodG1sKQ==",
		"content2":"Y29udGVudCAyIChodG1sKQ==",
		"content3":"Y29udGVudCAzIChodG1sKQ==",
		"content4":"Y29udGVudCA0IChodG1sKQ==",
		"content5":"Y29udGVudCA1IChodG1sKQ==",
		"content6":"Y29udGVudCA2IChodG1sKQ==",
		"content7":"Y29udGVudCA3IChodG1sKQ==",
		"content8":"Y29udGVudCA4IChodG1sKQ==",
		"content9":"Y29udGVudCA5IChodG1sKQ==",
		"content10":"Y29udGVudCAxMCAoaHRtbCk=",
		"reply_to":"ZW1haWxAZG9tYWluLmNvbQ==",
		"type_reply_to":"ZGlzYWJsZWQ=",
		"unsubscribe_email":"ZW1haWxAZG9tYWluLmNvbQ==",
		"web_template":"VFJVRQ==",
		"style_inline":"RkFMU0U=",
		"ID_unsubscribe_group":"MTIz"
	},
	"ab_version":{
		"subject":"c3ViamVjdCBCIHZlcnNpb24=",
		"content":"Y29udGVudCAxIC0gQiB2ZXJzaW9u",
		"content2":"Y29udGVudCAyIC0gQiB2ZXJzaW9u",
		"ID_allow_email":"MzIxNjU0",
		"ID_template":"MTIzNDU2",
		"ab_percentage":"MjA=",
		"ab_evaluation":"b3Blbg==",
		"ab_evaluation_time":"NGg="
	}
}

XML 

<?xml version="1.0"?>
<methodCall>
    <methodName>mailkit.campaigns.create</methodName>
    <params>
        <param>
            <value>
                <int>client_id</int>
            </value>
        </param>
        <param>
            <value>
                <string>client-md5</string>
            </value>
        </param>
        <param>
            <value>
                <struct>
                    <member>
                        <name>name</name>
                        <value>
                            <string>bmFtZQ==</string>
                        </value>
                    </member>
                    <member>
                        <name>subject</name>
                        <value>
                            <string>c3ViamVjdA==</string>
                        </value>
                    </member>
                    <member>
                        <name>ID_allow_email</name>
                        <value>
                            <string>MTIzNDU2</string>
                        </value>
                    </member>
                    <member>
                        <name>type_message</name>
                        <value>
                            <string>ZW1haWw=</string>
                        </value>
                    </member>
                    <member>
                        <name>type_send</name>
                        <value>
                            <string>dHh0aHRtbA==</string>
                        </value>
                    </member>
                    <member>
                        <name>generate_txt</name>
                        <value>
                            <string>VFJVRQ==</string>
                        </value>
                    </member>
                    <member>
                        <name>ID_mailing_list</name>
                        <value>
                            <string>MTIzNDU2</string>
                        </value>
                    </member>
                    <member>
                        <name>ID_delivery_feed</name>
                        <value>
                            <string></string>
                        </value>
                    </member>
                    <member>
                        <name>ID_query</name>
                        <value>
                            <string>MTIzNDU2</string>
                        </value>
                    </member>
                    <member>
                        <name>ID_template</name>
                        <value>
                            <string>MTIzNDU2</string>
                        </value>
                    </member>
                    <member>
                        <name>google_analytics</name>
                        <value>
                            <string>VFJVRQ==</string>
                        </value>
                    </member>
                    <member>
                        <name>analytic_name</name>
                        <value>
                            <string>bmFtZQ==</string>
                        </value>
                    </member>
                    <member>
                        <name>ID_tagset</name>
                        <value>
                            <string>MTIz</string>
                        </value>
                    </member>
                    <member>
                        <name>content</name>
                        <value>
                            <string>CjwhRE9DVFlQRSBodG1sIFBVQkxJQyAiLS8vVzNDLy9EVEQgWEhUTUwgMS4wIFRyYW5zaXRpb25hbC8vRU4iICJodHRwOi8vd3d3LnczLm9yZy9UUi94aHRtbDEvRFREL3hodG1sMS10cmFuc2l0aW9uYWwuZHRkIj4KPGh0bWw+CjxoZWFkPgo8L2hlYWQ+Cjxib2R5PgpKbWVubzogW0ZJUlNUX05BTUVdPGJyPgpQcmlqbWVuaTogW0xBU1RfTkFNRV0KPC9ib2R5Pgo8L2h0bWw+ICAgIAo=</string>
                        </value>
                    </member>
                    <member>
                        <name>reply_to</name>
                        <value>
                            <string>cmVwbHlAcmVwbHkuY3o=</string>
                        </value>
                    </member>
                    <member>
                        <name>type_reply_to</name>
                        <value>
                            <string>ZGlzYWJsZWQ=</string>
                        </value>
                    </member>
                    <member>
                        <name>unsubscribe_email</name>
                        <value>
                            <string>cmVwbHlAcmVwbHkuY3o=</string>
                        </value>
                    </member>
                    <member>
                        <name>web_template</name>
                        <value>
                            <string>RkFMU0U=</string>
                        </value>
                    </member>
                    <member>
                        <name>style_inline</name>
                        <value>
                            <string>RkFMU0U=</string>
                        </value>
                    </member>
                    <member>
                        <name>ID_unsubscribe_group</name>
                        <value>
                            <string></string>
                        </value>
                    </member>
                </struct>
            </value>
        </param>
    
---nastavení AB testu, B verze kampaně---

        <param>
            <value>
                <struct>
                    <member>
                        <name>generate_txt</name>
                        <value>
                            <string>VFJVRQ==</string>
                        </value>
                    </member>
                    <member>
                        <name>subject</name>
                        <value>
                            <string>c3ViamVjdA==</string>
                        </value>
                    </member>
                    <member>
                        <name>content</name>
                        <value>
                            <string>CjwhRE9DVFlQRSBodG1sIFBVQkxJQyAiLS8vVzNDLy9EVEQgWEhUTUwgMS4wIFRyYW5zaXRpb25hbC8vRU4iICJodHRwOi8vd3d3LnczLm9yZy9UUi94aHRtbDEvRFREL3hodG1sMS10cmFuc2l0aW9uYWwuZHRkIj4KPGh0bWw+CjxoZWFkPgo8L2hlYWQ+Cjxib2R5PgpKbWVubzogW0ZJUlNUX05BTUVdPGJyPgpQcmlqbWVuaTogW0xBU1RfTkFNRV0KPC9ib2R5Pgo8L2h0bWw+ICAgIAo=</string>
                        </value>
                    </member>
                    <member>
                        <name>content2</name>
                        <value>
                            <string>CjwhRE9DVFlQRSBodG1sIFBVQkxJQyAiLS8vVzNDLy9EVEQgWEhUTUwgMS4wIFRyYW5zaXRpb25hbC8vRU4iICJodHRwOi8vd3d3LnczLm9yZy9UUi94aHRtbDEvRFREL3hodG1sMS10cmFuc2l0aW9uYWwuZHRkIj4KPGh0bWw+CjxoZWFkPgo8L2hlYWQ+Cjxib2R5PgpKbWVubzogW0ZJUlNUX05BTUVdPGJyPgpQcmlqbWVuaTogW0xBU1RfTkFNRV0KPC9ib2R5Pgo8L2h0bWw+ICAgIAo=</string>
                        </value>
                    </member>
                    <member>
                        <name>ID_allow_email</name>
                        <value>
                            <string>MTIzNDU2</string>
                        </value>
                    </member>
                    <member>
                        <name>ab_percentage</name>
                        <value>
                            <string>MjA=</string>
                        </value>
                    </member>
                    <member>
                        <name>ab_evalution</name>
                        <value>
                            <string>b3Blbg==</string>
                        </value>
                    </member>
                    <member>
                        <name>ab_evalution_time</name>
                        <value>
                            <string>NGg=</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.
name (v base64) * = jméno kampaně
subject (v base64) * = předmět kampaně
ID_allow_email (v base64) * = ID odesílacího e-mailu
type_message (v base64) = typ zprávy

  • email = pro e-mailovou kampaň (výchozí hodnota)
  • sms = pro SMS kampaň

type_send (v base64) = formát zprávy

  • html = pro HTML formát
  • txthtml = pro kombinaci HTML a TXT
  • txt = pro TXT formát

generate_txt (v base64) = automatické generování prostého textu z HTML

  • true = automatické generování zapnuto
  • false = automatické generování vypnuto

ID_mailing_list (v base64) = ID seznamu příjemců. V případě více seznamů jsou jednotlivá ID oddělena čárkou.
ID_delivery_feed (v base64) = ID zdroje doručování (delivery feedu). Ke kampani může být připojen buď pouze seznam(y) příjemců, nebo delivery feed.
ID_template (v base64) = ID šablony. Pokud není ID šablony uvedeno, bude založena kampaň ve Vizuálním tvůrci
ID_query (v base64) = ID podmínky (pouze v kombinaci se seznamem příjemců)
google_analytics (v base64) = automatické vkládání utm parametrů Google Analytics k odkazům

  • true = zapnuto
  • false = vypnuto (výchozí hodnota)

analytics_name (v base64) = název kampaně pro Google Analytics
ID_tagset (v base64) = ID sady tagování pro Google Analytics
content (v base64) = obsah 1
content2 (v base64) = obsah 2. Maximální počet obsahů je 10.
content_txt (v base64) = obsah v TXT formátu. Pouze v případě, že je vypnuté automatické generování TXT verze, nebo je e-mail čistě v TXT formátu.
reply_to (v base64) = e-mailová adresa pro odpovědi
type_reply_to (v base64) = nastavení typu “reply-to” adresy. Může mít tyto hodnoty:

  • disabled (výchozí hodnota)
  • force_campaign
  • force_recipient
  • prefer_recipient

unsubscribe_email (v base64) = e-mailová adresa, kam se mají zasílat informace o odhlášení
web_template (v base64) = použití microsite

  • true = zapnuto
  • false = vypnuto (výchozí hodnota)

style_inline (v base64) = převedení CSS stylů do inline

  • true = zapnuto
  • false = vypnuto (výchozí hodnota)

ID_unsubscribe_group (v base64) = ID tématu kampaně
ab_percentage (v base64) = testovací skupina AB testu v procentech (1 - 99)
ab_evalution (v base64) = vyhodnocení AB testu dle (open|click|conversion|ctr)
ab_evalution_time (v base64) = doba pro vyhodnocení AB testu (1h - 23h, 1d - 4d)

* povinný parametr

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

JSON 

{
    "message": "Campaign 123456789 created",
    "error_status": 0,
    "ID_message": "123456789"
}

XML 

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

Hodnoty

ID nově založené kampaně

Příklady neúspěšného volání:

JSON 

{
    "error_status": 1,
    "error_code": 1,
    "error": "Missing name of campaign"
}

XML 

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

Hodnoty

Missing allow email (error_code:3/53 pro verzi B) = chybí odesílací e-mail
error: status, (xxx) = odesílací e-mail není ověrený | byl uveden ve špatném formátu
error allow email: ID_allow_email:unknown,status:,SPF (error_code:4/54 pro verzi B): = neplatná odesílací adresa
Missing name of campaign (error_code:1) = chybí název kampaně
Missing subject of campaign (error_code:2/52 pro verzi B)= chybí předmět kampaně
Wrong ID_mailing_list = neplatný seznam příjemců
Wrong ID_template (error_code:5/55 pro verzi B) = neplatná šablona
Invalid ID_query (error_code:6) = neplatná podmínka (pravidlo)
Wrong ID_query (error_code: 7) = požadovaná podmínka (pravidlo) nemůže být použita
Unknown type_reply_to = neplatná hodnota “type_reply_to”
Invalid ID_delivery_feed (error_code: 8) = požadovaný delivery feed neexistuje, nebo zadané ID datového zdroje neodpovídá delivery feedu
No valid emails provided in test_emails param (error_code: 9) = neplatný testovací e-mail
Invalid tagset ID (error_code: 10) = neplatné ID tagovací sady
Wrong ID_mailing_list (error_code: 11) = neplatné číslo seznamu příjemců
Confused parameters - it is not possible to combine mailing lists and delivery feeds (error_code: 12) = nelze použít/kombinovat seznam příjemců a delivery feed - ke kampani může být připojen buď seznam příjemců, nebo delivery feed.
Confused parameters - it is not possible to combine delivery capping and delivery feeds (error_code: 13) = nelze kombinovat delivery feed a podmíněné doručení.
Content failed to save (error_code: 14) = při ukládání obsahu zprávy došlo k chybě.​​​​​​​
Missing ab percentage (error_code: 82) = chybí procentuální hodnota velikosti testovací skupiny pro AB test​​​​​​​
Wrong ab percentage (error_code: 83) = neplatná hodnota velikosti testovací skupiny pro AB test​​​​​​​
Wrong ab evaluation (error_code: 81) = neplatná hodnota parametru pro vyhodnocení AB testu
Wrong ab evaluation time (error_code: 81) = neplatná hodnota času pro vyhodnocení AB testu