PodporaAPI dokumentace

mailkit.sendmail_mass.results

Funkce mailkit.sendmail_mass.results vrací možné chyby po použití funkce mailkit.sendmail_mass.

Funkci mailkit.sendmail_mass.results doporučujeme volat nejdříve 30 minut po zavolání funkce mailkit.sendmail_mass. V případě dřívějšího volaní nemusí být ještě známy všechny výsledky.

Ukázka API volání:

XML-RPC

<?xml version="1.0" encoding="UTF-8"?>
<methodCall>
  <methodName>mailkit.sendmail_mass.results</methodName>
  <params>
    <param>
      <value>
        <int>client_id</int>
      </value>
    </param>
    <param>
      <value>
        <string>client_md5</string>
      </value>
    </param>
    <param>
      <value>
        <i4>id_send</i4>
      </value>
    </param>
    <param>
      <value>
        <i4>request_id</i4>
      </value>
    </param>
  </params>
</methodCall>
		

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_send = ID rozesílky
request_id * = ID požadavku

* povinný parametr

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

XML-RPC

<?xml version="1.0" encoding="utf-8"?>
<methodResponse>
  <params>
    <param>
      <value>
        <struct>
          <member>
            <name>status</name>
            <value>
              <string>OK</string>
            </value>
          </member>
        </struct>
      </value>
    </param>
  </params>
</methodResponse>
		

XML-RPC

<?xml version="1.0" encoding="utf-8"?>
<methodResponse>
  <params>
    <param>
      <value>
        <struct>
          <member>
            <name>status</name>
            <value>
              <string>ERROR</string>
            </value>
          </member>
          <member>
            <name>results</name>
            <value>
              <array>
                <data>
                  <value>
                    <struct>
                      <member>
                        <name>ERROR_CODE</name>
                        <value>
                          <i4>1</i4>
                        </value>
                      </member>
					  <member>
                        <name>INFO</name>
                        <value>
                          <string>url return null</string>
                        </value>
                      </member>
					  <member>
                        <name>DATE</name>
                        <value>
                          <string>2015-05-13 09:43:50</string>
                        </value>
                      </member>
                      <member>
                        <name>ID_EMAIL</name>
                        <value>
                          <i4>123456789</i4>
                        </value>
                      </member>
					  <member>
                        <name>EMAIL</name>
                        <value>
                          <string>mail@mail.cz</string>
                        </value>
                      </member>
                      <member>
                        <name>ID_SEND</name>
                        <value>
                          <i4>12345</i4>
                        </value>
                      </member>
					  <member>
                        <name>ID_SEND_MESSAGE</name>
                        <value>
                          <i4>123456789</i4>
                        </value>
                      </member>
                    </struct>
                  </value>
                </data>
              </array>
            </value>
          </member>
        </struct>
      </value>
    </param>
  </params>
</methodResponse>
		

Hodnoty

status = OK = v požadavku / v konkrétním id_send požadavku nenastala (nebo se dosud neobjevila) žádná chyba. Tento stav se vrací i tehdy, kdy je požadavek stále zpracováván.
status = ERROR = v požadavku / konkrétním id_send požadavku nastaly níže uvedené chyby, díky kterým nebyly zprávy daným příjemcům odeslány

results:
ERROR_CODE

  • 1 = nebylo možné připojit přílohu (příloha nenalezena / nejedná se o transakční kampaň)
  • 2 = e-mailová adresa příjemce měla nevalidní formát
  • 3 = e-mailová adresa příjemce chyběla
  • 4 = bylo zadáno neplatné mailinglist_id
  • 5 = bylo zadáno neplatné id_message (campaign_id)
  • 6 = e-malová adresa příjemce byla odhlášena
  • 7 = kampaň neměla nastavenou odesílací adresu
  • 8 = neplatný soubor šablony

INFO = popis chyby
DATE = datum a čas zpracování požadavku
EMAIL = e-mailová adresa příjemce
ID_EMAIL # = ID e-mailové adresy
ID_SEND # = ID rozesílky
ID_SEND_MESSAGE # = ID neodeslané zprávy (individuální údaj pro každého příjemce)

# může vrátit hodnotu 0 a to v případě, kdy nedošlo k založení e-mailu, vytvoření rozesílky / konkrétní zprávy pro příjemce