PodporaAPI dokumentace

mailkit.mailinglist.list

Funkce mailkit.mailinglist.list slouží k získání přehledu dostupných seznamů příjemců v daném Mailkit účtu.

Ukázka API volání:

XML

<?xml version="1.0"?>
<methodCall>
<methodName>mailkit.mailinglist.list</methodName>
<params>
 <param>
  <value>
   <int>client_id</int>
  </value>
 </param>
 <param>
  <value>
   <string>client_md5</string>
  </value>
 </param>
</params>
</methodCall>
		

JSON

{  
   "function":"mailkit.mailinglist.list",
   "id":"client_id",
   "md5":"client_md5"
}

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.
* povinný parametr

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

XML

<?xml version="1.0" encoding="utf-8"?>
<methodResponse>
<params>
 <param>
  <value>
   <array>
    <data>
     <value>
      <struct>
       <member>
        <name>NAME</name>
        <value>
         <string>Jméno seznamu příjemců</string>
        </value>
       </member>
       <member>
        <name>ID_USER_LIST</name>
        <value>
         <i4>12345</i4>
        </value>
       </member>
       <member>
        <name>STATUS</name>
        <value>
         <string>enabled</string>
        </value>
       </member>
       <member>
        <name>DESCRIPTION</name>
        <value>
         <string>Popis seznamu příjemců</string>
        </value>
       </member>
      </struct>
     </value>
    </data>
   </array>
  </value>
 </param>
</params>
</methodResponse>
		

JSON

[  
   {  
      "NAME":"Testovací seznam",
      "ID_USER_LIST":"123456",
      "STATUS":"enabled",
      "DESCRIPTION":"popis seznamu"
   },
   {  
      "NAME":"Druhý seznam",
      "ID_USER_LIST":"123457",
      "STATUS":"disabled",
      "DESCRIPTION":""
   }
]

Hodnoty

NAME = název seznamu příjemců
ID_USER_LIST = ID seznamu příjemců
STATUS = status seznamu příjemců. Může nabývat hodnot: enabled (aktivní) a disabled (vypnutý).
DESCRIPTION = popis seznamu příjemců