Výpis skupin kontaktů Vašeho účtu. Kód skupiny z odpovědi pak použijete jako parametr list při přidávání, výpisu nebo odebírání kontaktů.
Pro přístup k API potřebujete chráněný klíč Vašeho Clipsan účtu.
Naleznete jej na stránce https://clipsan.com/cs/clipsan/securekey.
Výpis skupin kontaktů
Vrací všechny skupiny kontaktů v účtu seřazené podle názvu. Smazané skupiny se nevypisují.
Base URL:
https://clipsan.com/api/list/list/
Vyžadované parametry
- key – Chráněný klíč Clipsan účtu
Odpověď
{"result":"ok","data":[{"hash":"Kód skupiny","name":"Název skupiny"}]}
Příklad volání
https://clipsan.com/api/list/list/key/VASKLIC
https://clipsan.com/api/list/list/?key=VASKLIC
Příklad odpovědi
{"result":"ok","data":[{"hash":"3f9a2","name":"Newsletter"},{"hash":"b71c0","name":"Z\u00e1kazn\u00edci"}]}
Příklad volání (účet bez skupin)
https://clipsan.com/api/list/list/key/VASKLIC
Příklad odpovědi
{"result":"ok","data":[]}
Příklad volání (neplatný klíč)
https://clipsan.com/api/list/list/key/NEPLATNYKLIC
Příklad odpovědi
{"result":"error","error":"invalid secure key"}
Jak kód skupiny použít při přidávání a výpisu kontaktů, najdete v návodu „API: Kontakty“.