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.
client_md5 * = MD5 kód naleznete ve svém Mailkit účtu v menu Profil / Integrace.
ID_email * = Pro XML volání může obsahovat buď konkrétní ID e-mailu, nebo e-mailovou adresu.
email * = e-mailová 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í:


Příklad 1 – příjemce NENÍ odhlášen a pokud jsou v účtu používána témata kampaní, všechna používaná témata má aktivní (není odhlášen z žádného používaného tématu)

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 = příjemce není odhlášen)
timeout: date = datum vypršení timeoutu odhlášení (funkce dočasného odhlášení). Při 0000-00-00 není timeout nastaven.

 

Příklad 2 – příjemce JE dočasně odhlášen (odhlásil se např. pomocí odkazu v e-mailu nebo pomocí API volání mailkit.email.unsubscribe a zároveň byla nastavena hodnota pro timeout)

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í příjemce (TRUE = příjemce je odhlášen)
timeout: date = datum vypršení timeoutu odhlášení (funkce dočasného odhlášení). Při 0000-00-00 není timeout nastaven.

 

Příklad 3 – příjemce JE částečně odhlášen (odhlásil si pouze odběr některých v účtu používaných témat)

XML

<?xml version="1.0" encoding="utf-8"?>
<methodResponse>
    <params>
        <param>
            <value>
                <array>
                    <data>
                        <value>
                            <struct>
                                <member>
                                    <name>ID_TOPIC</name>
                                    <value>
                                        <i4>123</i4>
                                    </value>
                                </member>
                                <member>
                                    <name>UNSUBSCRIBE</name>
                                    <value>
                                        <string>FALSE</string>
                                    </value>
                                </member>
                                <member>
                                    <name>ID_UNSUBSCRIBE_GROUP</name>
                                    <value>
                                        <i4>123</i4>
                                    </value>
                                </member>
                                <member>
                                    <name>NAME</name>
                                    <value>
                                        <string>Novinky</string>
                                    </value>
                                </member>
                                <member>
                                    <name>STATUS</name>
                                    <value>
                                        <string>enabled</string>
                                    </value>
                                </member>
                                <member>
                                    <name>DESCRIPTION</name>
                                    <value>
                                        <string>Novinky v sortimentu, speciální akce.</string>
                                    </value>
                                </member>
                            </struct>
                        </value>
                        <value>
                            <struct>
                                <member>
                                    <name>ID_TOPIC</name>
                                    <value>
                                        <i4>456</i4>
                                    </value>
                                </member>
                                <member>
                                    <name>UNSUBSCRIBE</name>
                                    <value>
                                        <string>TRUE</string>
                                    </value>
                                </member>
                                <member>
                                    <name>ID_UNSUBSCRIBE_GROUP</name>
                                    <value>
                                        <i4>456</i4>
                                    </value>
                                </member>
                                <member>
                                    <name>NAME</name>
                                    <value>
                                        <string>Blog</string>
                                    </value>
                                </member>
                                <member>
                                    <name>STATUS</name>
                                    <value>
                                        <string>enabled</string>
                                    </value>
                                </member>
                                <member>
                                    <name>DESCRIPTION</name>
                                    <value>
                                        <string>Tipy, triky, návody..</string>
                                    </value>
                                </member>
                            </struct>
                        </value>
                    </data>
                </array>
            </value>
        </param>
    </params>
</methodResponse>
		

JSON

{
    "error_status": "0",
    "timeout": {
        "date": "0000-00-00"
    },
    "email": "example@example.com",
    "topics": [
        {
            "ID_TOPIC": 123,
            "UNSUBSCRIBE": "FALSE",
            "ID_UNSUBSCRIBE_GROUP": 123,
            "NAME": "Obchodní",
            "STATUS": "enabled",
            "DESCRIPTION": "Novinky v sortimentu, speciální akce."            
        },
        {
            "ID_TOPIC": 456,
            "UNSUBSCRIBE": "TRUE",            
            "ID_UNSUBSCRIBE_GROUP": 456,
            "NAME": "Blog",
            "STATUS": "enabled",
            "DESCRIPTION": "Tipy, triky, návody.."            
        }
    ],
    "unsubscribe": "FALSE",
    "ID_email": 123456789
}

UNSUBSCRIBE = zda je e-mailová adresa odhlášená z konkrétního tématu. Nabývá hodnot TRUE (příjemce JE z tématu odhlášen) nebo FALSE (příjemce NENÍ z tématu odhlášen)
unsubscribe (pouze pro JSON) = zda je e-mailová adresa odhlášená z odběru všech sdělení. Nabývá hodnot TRUE (příjemce je odhlášen) nebo FALSE (příjemce není odhlášen)
ID_TOPIC = ID tématu kampaně
NAME = jméno tématu kampaně
STATUS = stav tématu kampaně (enabled (aktivní = zobrazováno na odhlašovací stránce) nebo disabled (vypnuté = není zobrazováno na odhlašovací stránce)​​​​​​​
DESCRIPTION = popis tématu kampaně​​​​​​​
error_status (JSON) = chybový stav​​​​​​​
timeout: date (JSON) = datum vypršení timeoutu odhlášení (funkce dočasného odhlášení). Při 0000-00-00 není timeout nastaven.​​​​​​​
email (JSON) = e-mailová adresa příjemce
topics (JSON) = témata kampaní
ID_email (JSON) = ID e-mailu