mailkit.report.message.recipients

Funkce mailkit.report.message.recipients vrací podrobnosti o příjemcích konkrétní rozesílky.

Ukázka API volání:

JSON 

{  
   "function":"mailkit.report.message.recipients",
   "id":"client_id",
   "md5":"client_md5",
   "parameters":{  
      "ID_send":"ID_send"
   }
}

XML 

<?xml version="1.0"?>
<methodCall>
  <methodName>mailkit.report.message.recipients</methodName>
  <params>
    <param>
      <value>
        <int>client_id</int>
      </value>
    </param>
    <param>
      <value>
        <string>client_md5</string>
      </value>
    </param>
    <param>
      <value>
        <int>ID_send</int>
      </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_send * = ID rozesílky

* povinný parametr

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

JSON 

[  
   {  
      "DATE":"RRRR-MM-DD HH:MM:SS",
      "READ_COUNT":"2",
      "STATUS":"sent",
      "ID_EMAIL":"123456789",
      "EMAIL":"example@example.cz",
      "CLICK_COUNT":"2",
      "ID_SEND_MESSAGE":"123456798",
      "AB_VERSION":""
   }
]

XML 

<?xml version="1.0" encoding="utf-8"?>
<methodResponse>
  <params>
    <param>
    <value>
      <array>
        <data>
          <value>
            <struct>
              <member>
                <name>DATE</name>
                <value>
                  <string>yyyy-mm-dd hh:mm:ss</string>
                </value>
              </member>
              <member>
                <name>ID_SEND_MESSAGE</name>
                <value>
                  <i4>123456789</i4>
                </value>
              </member>
              <member>
                <name>EMAIL</name>
                <value>
                  <string>example@example.cz</string>
                </value>
              </member>
              <member>
              <member>
                <name>STATUS</name>
                <value>
                  <string>sent</string>
                </value>
              </member>
              <member>
                <name>AB_VERSION</name>
                <value>
                  <string></string>
                </value>
              </member>
              <member>
                <name>ID_EMAIL</name>
                <value>
                  <i4>123456789</i4>
                </value>
              </member>
              <member>
                <name>READ_COUNT</name>
                <value>
                  <i4>3</i4>
                </value>
              </member>
              <member>
                <name>CLICK_COUNT</name>
                <value>
                  <i4>0</i4>
                </value>
              </member>
            </struct>
          </value>
        </data>
      </array>
    </value>
    </param>
  </params>
</methodResponse>

Hodnoty

DATE = datum odeslání zprávy. Ve formátu yyyy-mm-dd hh:mm:ss
ID_SEND_MESSAGE = ID odeslané zprávy (individuální údaj pro každého příjemce)
EMAIL = e-mailová adresa příjemce
ID_EMAIL = ID e-mailové adresy příjemce
STATUS = stav doručení zprávy

  • sent = doručeno
  • failed = nedoručeno
  • wait = čeká na doručení (e-mail byl zařazen do odesílací fronty, ale dosud jsme od přijímací strany neobdrželi informaci o doručení či nedoručení zprávy)
  • wait_ab = čeká na vyhodnocení A/B testu

AB_VERSION = verze kampaně, která byla příjemci doručena v případě, že byl použitý A/B test kampaně. Nabývá hodnot A nebo B. V případě, že A/B test nebyl použit, je pole prázdné.
READ_COUNT = počet čtení. Nabývá hodnot 0 až X
CLICK_COUNT = počet kliknutí. Nabývá hodnot 0 až X

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

JSON 

{
    "error_status": 1,
    "error": "Invalid ID_send"
}

XML 

<?xml version="1.0"?>
<methodResponse>
    <params>
        <param>
            <value>
                <string>Missing ID_send</string>
            </value>
        </param>
    </params>
</methodResponse>

Hodnoty

Missing ID_send – chybějící ID rozesílky
Invalid ID_send – neplatné ID rozesílky