API pro integraci chatbota
Last updated
Was this helpful?
Last updated
Was this helpful?
Volání api chatbot musí být ověřena pomocí následujících kroků.
Mluvii aplikace posílá eventy do vašeho webhooku pro notifikaci bota, když se uskuteční různé interakce nebo události, včetně zaslání zprávy klientem. Webhook eventy jsou odeslány z Mluvii jako POST request na váš webhook.
Tento callback přijde, když byla odeslána aktivita z mluvii chatbot sezení do vašeho chatbota. Můžete přijmout textové zprávy, nebo zprávy s přílohami.
Callback si nastavíte v detailu vašeho konkrétního chatbota v sekci .
Váš webhook by měl splňovat tyto minimální výkonnostní standardy:
200 OK odpověď na všechny webhook eventy
odpověď na všechny webhook eventy do 2 sekund
Pokud váš webhook nesplní tyto požadavky po dobu víc než 15 minut, chatbot bude odpojen od přijímání webhook eventů a bude vypnutý v Mluvii.
Je doporučeno použít autorizaci pro callback URL. Například access token nebo basic authorization v URL. Příklad callback url:
Na zaregistrovaný webhook se poslají tyto typy událostí:
ping
rezervováno pro ověření funkčnosti služby. Tento typ eventu musí být implementován s response 200 OK.
activity
aktivita zaslána uživatelem, operátorem nebo systémem. Seznam aktivit odesílaných na webhook.
Send API je hlavní API použité pro posílání zpráv uživatelům, včetně textu, příloh, strukturovaných šablon, akcí odesílatele a dalších. Chatbot může odpovědět jenom na konverzaci, kterou přijal a je na ní naroutován. Formát API naleznete v této sekci.
Váš request by měl splnit následující výkonnostní požadavky:
maximální počet requestů je 120/min v 1 sezení
V případě, že chatbot pošle nevalidní zprávu, kterou nelze zobrazit, tato zpráva se ve Facebook Messengeru nezobrazí.
Facebook podporuje zobrazení maximálně 3 tlačítek.
Každé tlačítko má omezený počet znaků.
Není možné poslat tlačítka bez textu v title, subtitle, nebo v textu.
Každá akce mezi chatbotem a sezením se nazývá aktivita. Pro posílání aktivit je nutné znát chatbotId. ChatbotId lze nalézt v url při editování chatbota. Například:
Pokud pošlete request, dostanete okamžitě zpět odpověď se statusem 200 OK. Pokud na request čekáte nějakou odpověď, např. při GetAvailableGroups, dostanete také ihned 200 OK, ale odpověď GetAvailableGroupsResponse vám přijde do webhooku.
Každý request musí obsahovat sessionId a měl by mít následující formát:
Každé sezení začíná aktivitou ConversationStarted. Pokud je jako source uvedena hodnota Default, jedná se o WebChat. Pro kompletní výčet viz .
Aktivity jsou rozdělené podle kanálu, který je podporuje. najdete seznam podporovaných aktivit.
Pro Facebook je nutné dodržet přísnější pravidla, veškerá omezení jsou dostupná v oficiální dokumentaci