PodporaAPI dokumentace

mailkit.email.unsubscribe.getstatus

Funkce mailkit.email.unsubscribe.getstatus vrátí informaci o stavu odhlášení konkrétního příjemce.

Ukázka API volání:

XML

<?xml version="1.0"?>
<methodCall>
  <methodName>mailkit.email.unsubscribe.getstatus</methodName>
  <params>
    <param>
      <value>
        <int>client_id</int>
      </value>
    </param>
    <param>
      <value>
        <string>client_md5</string>
      </value>
    </param>
    <param>
      <value>
        <int>ID_email</int>
      </value>
    </param>
  </params>
</methodCall>
		

JSON

{  
   "function":"mailkit.email.unsubscribe.getstatus",
   "id":"client_id",
   "md5":"client_md5",
   "parameters":{  
      "email":"email",
      "ID_email":"ID_email"
   }
}

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_email * = Pro XML volání může obsahovat buď konkrétní ID e-mailu, nebo e-mailovou adresu.
email * = emailová adresa
V JSON volání může být použit bud parametr email, nebo parametr ID_email

* povinný parametr

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

XML

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

JSON

{
    "email": "example@example.eu",
    "error_status": "0",
    "topics": null,
    "ID_email": "123456789",
    "unsubscribe": "FALSE",
    "timeout": {
        "date": "0000-00-00"
    }
}

Hodnoty

FALSE = e-mailová adresa není odhlášená (pro XML)

email = e-mailová adresa
error_status = chybový stav
topics = Témata kampaní
ID_email = ID e-mailové adresy
unsubscribe = stav odhlášení příjemce (FALSE / TRUE)
timeout: date = datum vypršení timeoutu odhlášení (funkce dočasného odhlášení). Při 0000-00-00 není timeout nastaven.

XML

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

JSON

{
    "email": "example@example.cz",
    "error_status": "0",
    "topics": null,
    "ID_email": "123456789",
    "unsubscribe": "TRUE",
    "timeout": {
        "date": "2018-10-10"
    }
}

TRUE = e-mailová adresa je odhlášená (pro XML)
email = e-mailová adresa
error_status = chybový stav
topics = Témata kampaní
ID_email = ID e-mailové adresy
unsubscribe = stav odhlášení (TRUE / FALSE)
timeout: date = datum vypršení timeoutu odhlášení (funkce dočasného odhlášení). Při 0000-00-00 není timeout nastaven.

XML

<?xml version="1.0" encoding="utf-8"?>
<methodResponse>
  <params>
    <param>
      <value>
        <array>
          <data>
            <value>
              <struct>
                <member>
                  <name>UNSUBSCRIBE</name>
                  <value>
                    <string>TRUE</string>
                  </value>
                </member>
                <member>
                  <name>ID_AGENCY_CUSTOMER</name>
                  <value>
                    <i4>0</i4>
                  </value>
                </member>
                <member>
                  <name>NAME</name>
                  <value>
                    <string>Novinky</string>
                  </value>
                </member>
                <member>
                  <name>DESCRIPTION</name>
                  <value>
                    <string>Informace o novinkách a aktualizacích.</string>
                  </value>
                </member>
                <member>
                  <name>ID_UNSUBSCRIBE_GROUP</name>
                  <value>
                    <i4>14</i4>
                  </value>
                </member>
                <member>
                  <name>ID_TOPIC</name>
                  <value>
                    <i4>14</i4>
                  </value>
                </member>
                <member>
                  <name>STATUS</name>
                  <value>
                    <i4>enabled</i4>
                  </value>
                </member>
              </struct>
            </value>
          </data>
        </array>
      </value>
    </param>
  </params>
</methodResponse>
		

JSON

{
    "email": "example@example.com",
    "topics": [
        {
            "NAME": "Novinky",
            "TOPIC_UNSUBSCRIBE": "TRUE",
            "ID_TOPIC": "10",
            "STATUS": "enabled",
            "DESCRIPTION": "popis 1"
        },
        {
            "NAME": "Soutěže",
            "TOPIC_UNSUBSCRIBE": "FALSE",
            "ID_TOPIC": "11",
            "STATUS": "enabled",
            "DESCRIPTION": "popis 2"
        }
    ],
    "error_status": "0",
    "ID_email": "123456789",
    "unsubscribe": "FALSE",
    "timeout": {
        "date": "0000-00-00"
    }
}

UNSUBSCRIBE = zda je e-mailová adresa odhlášená. Nabývá hodnot TRUE nebo FALSE. (Pro XML)
unsubscribe = zda je e-mailová adresa odhlášená. Nabývá hodnot TRUE nebo FALSE. (Pro JSON)
topics = Témata kampaní
NAME = jméno Téma kampaně.
DESCRIPTION = popis Téma kampaně.
ID_TOPIC = ID Téma kampaně.
TOPIC_UNSUBSCRIBE = stav odhlášení příjemce z Téma kampaně
STATUS = stav Téma kampaně (enabled nebo disabled)
ID_AGENCY_CUSTOMER = ID agenturního zákazníka. V případě verze Syndicate vrací hodnotu 0. (Pouze v XML volání.)
error_status = chybový stav
ID_email = ID emailu
timeout: date = datum vypršení timeoutu odhlášení (funkce dočasného odhlášení). Při 0000-00-00 není timeout nastaven.