Swagger
V této části dokumentace jsme připravili shrnutí těch nejzajímavějších funkcí, které můžete využít v rámci integrací se systémy třetích stran.
Kompletní přehled všech Public API volání naleznete na zde.
V případě on-premise řešení si upravte defaultní URL "app.mluvii.com".
Emailové zprávy (EmailMessages)
Emailové vlákna (EmailThreads)
Campaigns
V rámci kampaní můžete vyhledávat seznamy či konkrétní kampaně. Dále můžete vytvářet telefonní či WhatsApp kampaně, měnit některé jejich parametry či je smazat (pokud nebyly spuštěny). Pomocí API můžete také měnit stav kampaní (spustit, pozastavit, ukončit) nebo také přidávat další kontakty pro účely navolání z Adresáře kontaktů.
Chatbot
Pomocí API lze nastavit odeslání callback URL (neplatí pro Microsoft Bot Framework chatboty), či odeslání vybrané chatbot aktivity v rámci sezení.
Contacts
Zde dokážeme například anonymizovat konkrétní záznam v Adresáři kontaktů (v rámci všech sezení s daným kontaktem), získat seznam kontaktů z Adresáře kontaktů seřazených podle ID, vytvořit nový kontakt v Adresáři kontaktů, získat vybraný záznam z Adresáře kontaktů dle ID, aktualizovat nebo odstranit konkrétní kontakt v Adresáři kontaktů, či třeba sloučit kontakty do jednoho.
Companies
Tato oblast API slouží především pro správce serveru, který jej může využít pro získání existující(ch) spočenosti(í) a bližších detailů ohledně nastavení jednotlivých společností.
Departments
Zde lze zjistit seznam existujících tenantů, zakládat nové tenanty v rámci společnosti, nebo můžete pomocí API také zařazovat uživatele do existujících tenantů. Také můžete zjistit stav fronty skupiny pro jednotlivé komunikační kanály.
EmailMessages
Zde lze exportovat e-mailové zprávy do .json souboru. Můžete exportovat konkrétní zprávy dle ID, nebo zvolte hromadný export, kde můžete využít a kombinovat více podmínek (e-mail odesílatele, datum zpracování apod.). V neposlední řadě můžete API použít pro generování e-mailové zprávy pro vaše operátory. Adresa a obsah e-mailu mohou být již předvyplněny a stejně tak mohou být k e-mailové zprávě přiloženy relevantní přílohy.
EmailThreads
V případě jednotlivých vláken je možné je exportovat (všechny zprávy včetně poznámek od operátorů) dle jejich ID, přidávat či mazat tagy , získat (případně aktualizovat) parametry pro dané ID e-mailového vlákna nebo například získat historii routingu emailového vlákna.
Forms
V případě potřeby můžete získat informace o všech dostupných formulářích.
Groups
Zde máte možnost získat seznam všech existujících skupin, a nebo jen detail jedné konkrétní.
Guests
Anonymizuje identitu klienta. Odstraní vztah mezi cookie klienta a ID klientské identity v rámci Adresáře Kontaktů.
Metrics
Slouží k vytvoření dashboardů, získání obsažených dat a také pro smazání dashboardů.
Phones
Je užitečné pro získání všech dostupných telefonních čísel pro danou společnost a také v případě vytváření odchozího hovoru nebo získání dat pro analýzu konkrétního telefonního hovoru.
Sessions
U sezení je možné pomocí API vyhledat relaci podle ID sezení, anonymizovat jednotlivá sezení, získat (či aktualizovat) parametry podle ID sezení, přidávat či mazat tagy dle tagID či jména tagu. Můžete získat také informace o routingu daného sezení či zahájit odchozí telefonní hovor. Zároveň je možné přepojení probíhajícího sezení (v rámci tenantu) na konkrétního operátora, skupinu operátorů či chatbota.
Tags
Pomocí API můžete získávat ID tagů, jména či jejich štítky. Získané informace mohou sloužit jako podklad pro následující volání Public API.
Users
V oblasti uživatelů můžete vyhledávat uživatele podle jejich ID, získat seznam všech uživatelů, provést restart hesla, získat stav jednotlivých operátorů, nastavit stav operátora, získat stavy všech operátorů, odeslat/smazat pozvánku.
Webhooks
Zde je možné dostat, smazat či aktualizovat jednotlivý webhook. Získat všechny webhooky, registrovat webhook pro danou událost nebo smazat všechny webhooky.
Widgets
Na úrovni widgetu můžete pomocí API po zjištění aktuálního stavu, jeho stav změnit. Je možné u daného widgetu celkově upravovat jeho vzhled a chování. Případně také nastavit požadovaný konkrétní formulář
WhatsApp
Toto API je v beta verzi
Současné api obsahuje 3 endpointy
GET
/api/v1/WhatsAppPOST
/api/v1/WhatsApp/{id}/sendTemplatesGET
/api/v1/WhatsApp/{id}/sentTemplates
První endpoint vrací všechny WA subskripce(id, id tenantu, jméno a telefonní číslo). Důležitý je parametr id, který je hodnotou {id} v URL dalších dvou volání
Druhý je endpoint pro bulk poslání WA zpráv s následujícími parametry
formID - id formuláře v mluvii
language - jazyková mutace, která se má použít
recipients - pole jednotlivých kontaktů, na která se má formulář poslat
contactId - telefonní číslo v mezinárodním formátu
fieldValues - hodnoty, které se doplní do formuláře na definovaná místa. Hodnoty musí být ve stejném pořadí, jako se mají doplnit do formuláře.
Třetí je endpoint pro získání dat o poslaných zprávách pro jednotlivé WA subskripce s doplňujícími atributy since, offset, limit.
Přehled všech API volání najdete zde.
Last updated