Podporované aktivity
Last updated
Was this helpful?
Last updated
Was this helpful?
Ne všechny tyto aktivity fungují ve všech kanálech. Facebook například podporuje jen některé aktivity. WhatsApp podporuje pouze základní text.
✔
✔
✘
✘
✘
✔
✔
✘
✘
✘
✔
✘
✘
✘
✘
✔
✘
✘
✘
✘
✔
✘
✔
✔
✘
✔
✘
✔
✔
✘
✔
✘
✔
✔
✘
✔
✘
✘
✘
✘
✔
✘
✘
✘
✘
✔
✘
✘
✘
✘
✔
✘
✘
✔
✔
✔
✘
✘
✔
✘
Apple = Apple Messages for Business Facebook = Facebook Messenger
Způsob odeslání aktivity se liší podle typu chatbota:
Chatbot přes API posílá aktivity na API endpoint /api/v1/Chatbot/{chatbotId}/activity
Získá seznam operátorů, kteří jsou přihlášeni a mají volné kapacity.
Pokud je parametr groupId
nastaven, je vrácen seznam dostupných operátorů z vybrané skupiny.
Request JSON:
Odpověď aktivity:
Získá seznam skupin operátorů a jejich aktuální stavy.
Pokud je pole groupIds
definováno, je vrácen seznam skupin podle tohoto pole.
Stav skupiny může nabývat těchto hodnot:
ONLINE - skupina má volné operátory
BUSY - všichni operátoři jsou obsazeni ale je volné místo ve frontě skupiny
OFFLINE - viz pole groupOfflineReasons
Pokud je skupina offline, pole groupOfflineReasons nabývá jedné nebo více hodnot:
BUSINESS_HOURS - skupina je mimo otevírací hodiny
NO_OPERATORS - ve skupině nejsou přihlášeni žádní operátoři
QUEUE_FULL - skupina má plnou frontu
DELETED - skupina byla smazána administrátorem
CHANNEL_BLOCKED - všichni operátoři mají zablokovaný kanál (ve kterém je sezení s chatbotem)
Request JSON:
Odpověď aktivity:
groupWorkload
maxSlots: Součet slotů všech přihlášených operátorů ve skupině
usedSlotsWaiting: Součet všech obsazených slotů čekajícími ve skupině
usedSlotsAccepted: Součet všech slotů obsazených odbavovanými sezeními ve skupině
freeSlots: Součet volných slotů všech operátorů ve skupině
queueWorkload
freeQueueSlotsCountTotal: Počet volných slotů ve frontě na skupině
inQueueCountTotal: Počet využitých slotů ve frontě na skupině
isQueueFull: freeQueueSlotsCountTotal == 0
Získá CallParams spojené s aktivním sezením.
Request JSON:
Odpověď aktivity:
Nastaví CallParams k aktivnímu sezení.
Request JSON:
Response Activity:
Odešle email na adresu pro zprávy z offline formuláře. Offline formulář musí být nastaven na balíčku.
Request JSON:
Vrátí všechny známé identifikátory uživatele.
Request JSON:
Odpověď aktivity:
Přesměruje interakci na živého operátora nebo skupinu. Alespoň jeden z parametrů operatorGroupId
nebo userId
musí být vyplněn.
Request:
Výsledek operace HandOff závisí na stavu skupiny:
ONLINE - sezení se přiřadí operátorovi
BUSY - sezení půjde do fronty skupiny
OFFLINE - klientovi se zobrazí offline formulář
Je nutné nastavit routingové podmínky tak, aby nedošlo ke zpětnému zaroutovaní zpět na chatbota.
Příklad správného použití:
Routingová pravidla:
1
Skupina "Sales"
HandoffReason = Sales
2
Skupina "Reklamace"
HandoffReason = Reklamace
3
Chatbot
bez podmínky
4
Fallback - vypnutý
-
Request:
Ukončí sezení.
Request:
Zobrazí/skryje informaci zda chatbot má "rozepsanou" zprávu.
Request:
Skryje chatové pole a neumožní uživateli psát do chatu.
Request:
Odpověď aktivity:
Zobrazí chatové pole a umožní tak uživateli psát do chatu.
Request:
Odpověď aktivity:
Vrátí seznam existujících HeroCards.
Request:
Response:
Posílá vybranou HeroCard do chatu klienta. Pro nastavení předvyplněných hodnot v HeroCard je možné využít objekt initialParams.
Pokud chci poslat HeroCard, ve které je použito textové pole, které ukládá hodnotu do proměnné "call_param_fullname", initialParams bude vypadat následovně:
Pokud chci poslat hero kartu s výběrem časů (termínů) 6. 12. 2021 od 14:00 do 14:30 a k 7. 12. 2021 od 8:00 do 9:00, která ukládá hodnotu do proměnné "call_param_time_picker", initialParams bude vypadat následovně:
Pokud chci poslat WhatsApp hero kartu s parametry, použiji proměnnou additionalParams, která má nasledující formát:
Request JSON:
Response Activity:
Chatbot donedávna nebyl schopný zjistit, že došlo k potvrzení Hero Card klientem a byl odkázaný na to sledat změnu parametru sezení. To již není nutné, protože informaci o potvrzení je možné získat přes webhook.
Informace pro chatbota, že klient potvrdil HeroCard nebo vybral některou z možností (platí pro WhatsApp).
Otevře dialog, který umožní uživateli nahrát soubor.
Request JSON:
Odpověď aktivity:
Povolit funkce, které umožňují nahrávání uživatelských souborů.
Request JSON:
Odpověď aktivity:
Zakázat funkce, které umožňují nahrávání uživatelských souborů.
Request JSON:
Odpověď aktivity:
Vrátí seznam souborů, které jsou uložené v mluvii a dostupné pro dané sezení.
Request JSON:
Odpověď aktivity:
Vrací seznam existujících záznamů z Adresáře Kontaktů, u kterých je nalezena alespoň minimální shoda v identifikačních údajích klienta v daném sezení (např. klientovo jméno, tel. číslo, e-mail, ...).
Request JSON:
Odpověď aktivity:
Často se může stát, že výsledků API vrátí více a bude na vás, podle jakého klíče označíte nejrelevantnější záznam, který chatbot vybere pro přiřazení klientské identity. Jako vodítko můžete použít parametr "score".
Request JSON:
Odpověď activity:
Jestliže v odpovědi na activitu ObtainCrmIdentity dostanete záznamy s určitou shodou, použijete v requestu hodnotu parametru "crmIdentityID". Pokud žádné shody nejsou nalezeny, jako hodnotu parametru "crmIdentityId" použijete "null".
Odešle soubor do chatu. Lze provést dvěma způsoby:
Kombinace GetMediaObjects, což slouží k získání seznamu všech souborů uložených v Souborech (name + id). V druhém kroku použijete v rámci aktivity ShareFile name konkrétního souboru.
Příklad: Request JSON s použitím name:
Volání aktivity ShareFile s URL souboru hostovaného mimo mluvii.
Příklad: Request JSON s použitím url:
Odpověď aktivity:
Přehled povolených souborů pro daný kanál
Na úrovni společnosti se dají omezit povolené soubory - tato tabulka z ní vychází a upřesňuje, které soubory jsou pro který kanál funkční. Například poslání a přehrání mp3 souboru funguje pro WhatsApp sezení, ale nikoliv pro Facebook.
WAV
✔
✘
✘
✔
✔
MP3
✔
✘
✔
✔
✔
MP4
✔
✘
✔
✔
✔
JPG
✔
✔
✔
✔
✔
PNG
✔
✔
✔
✔
✔
GIF
✔
✔
✔
✔
✔
✔
✔
✔
✔
✔
TXT
✔
✔
✔
✔
✔
Příklad použití adaptive card carousel:
Request JSON:
Odpověď na vybrané tlačítko (Button 2) je pak aktivita typu Text v následujícím formátu:
Jakmile klient odešle textovou zprávu do chatu, v Callback URL se zobrazí následující aktivita:
Pokud klient nahraje soubor pomocí kancelářské sponky ve vstupním poli chatu, přijde botovi Aktivita v následujícím formátu.
posílá aktivity pomocí
Pokud parametr groupId
není nastaven, dojde k opětovnému vyhodnocení a je vrácen seznam dostupných operátoru pouze ze skupin, které splňují podmínky. Routingové podmínky se znovu vyhodnocují. Lze tedy a dostat seznam dostupných operátoru podle aktuálních parametrů.
Pokud parametr groupId
není nastaven, dojde k opětovnému vyhodnocení a je vrácen seznam skupin, které splňují podmínky. Routingové podmínky se znovu vyhodnocují. Lze tedy a dostat seznam dostupných operátoru podle aktuálních parametrů.
Takto přesměrovaná sezení se chovají stejně jako sezení přesměrována ručně - tzn. ignorují nastavená kapacitní pravidla (velikost fronty skupiny/sloty operátora). Pokud chcete aby sezení nepřekročilo nastavená kapacitní pravidla použijte aktivitu nebo před přesměrovaním zjistěte aktuální vytížení operátorů pomocí aktivit /
Routingové parametry jsou znovu nevyhodnocují. Pokud chcete zaroutovat sezení znovu (například po ), lze použít aktivitu .
Vrátí interakci zpět do routingu a vyhodnotí znovu parametry sezení. Po zavolání této aktivity je chatbot ze sezení odpojen. Doporučujeme tedy nejprve zjistit dostupnost cílových operátorů/skupin pomocí aktivit / .
Při prvním naroutování je vybrán chatbot, protože parametr HandoffReason ještě není nastaven. Chatbot by měl nastavit tento parametr pomocí aktivity , než vrátí sezení do routingu. Tím je zajištěno, že sezení nebude naroutováno zpět na chatbota.
Používá se pro přiřazení klientské identity k existujícímu či novému záznamu v Adresáři kontaků. Typicky tento request zavoláte na základě výsledku .
Api podporuje formátování zpráv podle standardu .
Tlačítka lze poslat pomocí .