PodporaAPI dokumentace

mailkit.sendmail_mass

Rozeslání zprávy na vícero příjemců.

Ukázka API volání:

XML

<?xml version="1.0"?>
<methodCall>
  <methodName>mailkit.sendmail_mass</methodName>
  <params>
    <param>
      <value>
        <int>client_id</int>
      </value>
    </param>
    <param>
      <value>
        <string>client_md5</string>
      </value>
    </param>
    <param>
        <value>
          <array>
            <data>
              <value>
                <struct>
                  <member>
                    <name>send_to</name>
                    <value>
                      <string>email@email.com</string>
                    </value>
                  </member>
                  <member>
                    <name>mailinglist_id</name>
                    <value>
                      <int>ID seznamu příjemců</int>
                    </value>
                  </member>
                  <member>
                    <name>campaign_id</name>
                    <value>
                      <int>ID kampaně</int>
                    </value>
                  </member>
                  <member>
                    <name>subject</name>
                    <value>
                      <string>předmět kampaně</string>
                    </value>
                  </member>
                  <member>
                    <name>message_data</name>
                    <value>
                      <string>obsah e-mailu</string>
                    </value>
                  </member>
                  <member>
                    <name>template_file</name>
                    <value>
                      <string>název šablony</string>
                    </value>
                  </member>
                  <member>
                    <name>create_email</name>
                    <value>
                      <string>TRUE</string>
                    </value>
                  </member>
                  <member>
                    <name>customs</name>
                    <value>
                        <struct>
                            <member>
                                <name>custom1</name>
                                <value>Vlastní pole č.1</value>
                            </member>
                            <member>
                                <name>custom25</name>
                                <value>Vlastní pole č.25</value>
                            </member>
                            <member>
                                <name>first_name</name>
                                <value>Jméno</value>
                            </member>
                            <member>
                                <name>last_name</name>
                                <value>Příjmení</value>
                            </member>            
                        </struct>
                    </value>
                  </member>
                  <member>
                    <name>attachement</name>
                    <value>
                      <array>
                        <data>
                          <value>
                            <struct>
                              <member>
                                <name>url</name>
                                <value>
                                  <string>url přílohy</string>
                                </value>
                              </member>
                              <member>
                                <name>name</name>
                                <value>
                                  <string>název přílohy</string>
                                </value>
                              </member>
                              nebo
                              <member>
                                <name>data</name>
                                <value>data přílohy v base64</value>
                              </member>
                            </struct>
                          </value>
                        </data>
                      </array>
                    </value>
                  </member>
                  <member>
                    <name>content</name>
                    <value>
                      <struct>
                        <member>
                          <name>var1</name>
                          <value>
                            <string>proměnná 1</string>
                          </value>
                        </member>
                        <member>
                          <name>jiny_nazev</name>
                          <value>
                            <string>proměnná 2</string>
                          </value>
                        </member>
                      </struct>
                    </value>
                  </member>
                </struct>
              </value>
            </data>
          </array>
        </value>
    </param>
    <param>
        <value>
            <struct>
                <member>
                  <name>id_send</name>
                  <value>
                    <string>today</string>
                  </value>
                </member>
            </struct>
        </value>
    </param>
  </params>
</methodCall>
		

JSON

{
    "function": "mailkit.sendmail_mass",
    "id": "client_id",
    "md5": "client_md5",
    "recipients": [
        {
            "send_to": "email@email.eu",
            "mailinglist_id": 123456,
            "campaign_id": 123456,
            "subject":"Message subject",
            "message_data":"base64 encoded message body",
            "create_email":true,
            "customs": {
                "first_name": "First name",
                "last_name": "Last name",
                "custom1": "custom field",
                "custom2": "custom field"
            },
            "content": {
                "var1": "variable content"
            }
        },
        {
            "send_to": "email2@email2.eu",
            "mailinglist_id": 123456,
            "campaign_id": 123456,
            "subject":"Message subject",
            "message_data":"base64 encoded message body",
            "create_email":true,
            "customs": {
                "first_name": "First name",
                "last_name": "Last name",
                "custom1": "custom field",
                "custom2": "custom field"
            },
            "content": {
                "var1": "variable content"
            }
        }
    ]
}

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.
send_to * = e-mailová adresa příjemce
mailinglist_id * = ID seznamu příjemců
campaign_id * = ID kampaně
subject = volitelný jiný předmět kampaně
message_data (v Base64) = volitelný jiný obsah e-mailu, než je u dané kampaně
template_file = volitelná jiná šablona kampaně
create_email = vložení e-mailové adresy do seznamu příjemců:

  • TRUE = v případě, že zadaná e-mailová adresa není na seznamu příjemců, bude do něj vložena
  • FALSE = v případě, že zadaná e-mailová adresa není na seznamu příjemců, nebude do něj vložena a zároveň na danou adresu nebude zaslán žádný e-mail

customs = volitelná personalizační data příjemce (jméno, vlastní pole atp.), které rovněž budou aktualizovány u příjemce v mailinglistu

attachement = volitelné přílohy kampaně. Je dvojí možnost vložení - odkázání na url adresu, kde je příloha umístěna, nebo zaslání dat přílohy. Přílohy jsou možné pouze u transakčních zpráv! Pokud bude příloha použita u netransakční zprávy, nedojde k jejímu odeslání!

- name = název přílohy
- url = url přílohy
- data (v base64) = data přílohy

content = proměnný obsah, který se uloží do struktur shared (pro pár název/hodnota), resp. data (pro komplexní struktury a pole). Hodnoty z těchto struktur lze následně použít v šabloně prostřednictvím tagů [% shared.NAZEV_VETVE -%], resp. [% data.NAZEV_STRUKTURY -%].

id_send s hodnotou today = volitelná možnost sloučit více rozesílek v jednom dni do jedné

* povinný parametr

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

XML

<methodResponse>
  <params>
    <param>
    <value>
      <struct>
        <member>
          <name>data</name>
          <value>
            <string>OK</string>
          </value>
        </member>
        <member>
          <name>request_id</name>
          <value>
            <i4>123456789</i4>
          </value>
        </member>
        <member>
          <name>list</name>
          <value>
            <array>
              <data>
                <value>
                  <string>email@email.eu</string>
                </value>
                <value>
                  <string>email2@email2.eu</string>
                </value>
              </data>
            </array>
          </value>
        </member>
      </struct>
    </value>
    </param>
  </params>
</methodResponse>
		

JSON

{
    "list": [
        "email@email.eu",
        "email2@email2.eu"
    ],
    "data": "OK",
    "request_id": "123456",
    "error_status": 0
}

Hodnoty

data = OK = požadavek na hromadné odeslání byl v pořádku přijat
request_id = ID požadavku, pomocí kterého se lze dotázat na stav a možné chyby, které nastaly při zpracování tohoto požadavku.
list = seznam e-mailových adres přijatých k rozeslání
error_status

  • volání proběhlo úspešně
  • volání selhalo