Webhooky
Kategorie Eventů
Sezení
Níže uvedený diagram popisuje veškeré události v rámci životního cyklu sezení od jeho vzniku až po ukončení. K přesměrování sezení na jiného operátora nemusí dojít a je uvedeno pouze pro úplnost.
Událost | Čas |
---|---|
SessionCreated | "2024-05-02T08:58:58:888364+02:00" |
SessionStarted | "2024-05-02T08:58:58:888364+02:00" |
SessionOperatorJoined | "2024-05-02T08:59:18:467643+02:00" |
SessionForwarded (volitelně) | "2024-05-02T09:02:26:568252+02:00" |
SessionEnded | "2024-05-02T09:13:07:965191+02:00" |
SessionOperatorLeft | "2024-05-02T09:13:07:965191+02:00" |
SessionOperatorConcluded | "2024-05-02T09:15:50:838056+02:00" |
SessionCreated
V tenantu byla vytvořeno nové sezení a událost se zaloguje ještě před přijetím sezení ze strany operátora či chatbota.
Parametr | Hodnota | Příklad |
---|---|---|
id | number | 7293902 |
tenantId | number | 62 |
channel | string | |
source | string |
SessionStarted
Sezení začalo (např. klient vstoupil do fronty a hledá se pro něho volný operátor). Toto se týká všech kanálů v mluvii. S klientem může v sezení také komunikovat chatbot.
Parametr | Hodnota | Příklad |
---|---|---|
id | number | 7293902 |
tenantId | number | 62 |
channel | string | |
source | string | |
started | datetime | yyyy-MM-dd'T'HH:mm:ss,SSSZZZZ |
SessionOperatorJoined
Děje se v momentě připojení operátora do sezení. Např. hned na začátku (po SessionCreated). Platí, že pro každého operátora v sezení se zaloguje vlastní událost.
Parametr | Hodnota | Příklad |
---|---|---|
id | number | 7293902 |
tenantId | number | 62 |
userId | number | 2710 |
channel | string | |
source | string | |
time | datetime | yyyy-MM-dd'T'HH:mm:ss,SSSZZZZ |
SessionForwarded
Sezení bylo přesměrováno. V tomto případě nejsou k dispozici žádné detaily jako je tomu v případě SessionActivitySessionForwarded.
Parametr | Hodnota | Příklad |
---|---|---|
id | number | 7293902 |
tenantId | number | 62 |
channel | string | |
source | string | |
time | datetime | yyyy-MM-dd'T'HH:mm:ss,SSSZZZZ |
userId | number | 2710 |
operatorGroupId | number | 7299 |
V odpovědi se může objevit "userId", "operatorGroupId", nebo "chatbotId" podle toho, na jaký cíl operátor přepojuje.
SessionEnded
Sezení bylo ukončeno.
Parametr | Hodnota | Příklad |
---|---|---|
id | number | 7293902 |
tenantId | number | 62 |
channel | string | |
source | string | |
started | datetime | yyyy-MM-dd'T'HH:mm:ss,SSSZZZZ |
ended | datetime | yyyy-MM-dd'T'HH:mm:ss,SSSZZZZ |
SessionOperatorLeft
Jakmile operátor ukončí sezení (klikne na tlačítko "Ukončit"). Následně se dostane do ACW stavu.
Parametr | Hodnota | Příklad |
---|---|---|
id | number | 7293902 |
tenantId | number | 62 |
userId | number | 2710 |
channel | string | |
source | string | |
time | datetime | yyyy-MM-dd'T'HH:mm:ss,SSSZZZZ |
Pokud je v sezení aktivních více operátorů, pouze u jednoho z nich se zaloguje SessionOperatorLeft. Pro ostatní se zaloguje event SessionOperatorConcluded.
SessionOperatorConcluded
Děje se v momentě, kdy je automaticky/manuálně ukončeno ACW. Pak také v případě, kdy je sezení přesměrováno z operátora na další cíl (operátora/skupinu/chatbota/externí tel. číslo).
Parametr | Hodnota | Příklad |
---|---|---|
id | number | 7293902 |
tenantId | number | 62 |
userId | number | 2710 |
channel | string | |
source | string | |
time | datetime | yyyy-MM-dd'T'HH:mm:ss,SSSZZZZ |
Aktivity v Sezení
SessionActivityAutoActivity
Událost se loguje s každou automatickou zprávou v sezení. Může se jednat např. o automatickou zprávu zaslanou z důvodu neaktivity klienta či zaneprázdněním operátora, který odbavuje více interakcí najednou.
Parametr | Hodnota | Příklad |
---|---|---|
sessionId | number | 7215873 |
activityId | number | 50878507 |
time | datetime | yyyy-MM-dd'T'HH:mm:ss,SSSZZZZ |
type | string | AutoActivity |
text | string | "Jsme stále ve spojení?" |
SessionActivityAvResponse
Spustí se při reakci uživatele na pokus o AV spojení.
Vlastnost | Hodnota | Příklad |
---|---|---|
sessionId | number | 7361303 |
operatorId | number | 2710 |
response | Přijato |
Pokud klient přijme pozvánku do A/V hovoru, vrátí Public API hodnotu "Accepted" a v opačném případě "RejectedUser".
SessionActivityAvRequest
Událost zachycuje okamžik, kdy operátor povyšuje webchat na Audio/Video hovor. Operátor v rozhraní kliká na záložku "Volat", vstupuje do A/V místnosti a přizve klienta.
Parametr | Hodnota | Příklad |
---|---|---|
sessionId | number | 7215873 |
userId | number | 4555 |
time | datetime | yyyy-MM-dd'T'HH:mm:ss,SSSZZZZ |
SessionActivityAvTerminated
Děje se v případě, že operátor ukončí A/V hovor a dále pokračuje jen v textové komunikaci. Operátor kliká na tlačítko "Odpojit klienta" nebo křížkem v rohu A/V bladu.
Parametr | Hodnota | Příklad |
---|---|---|
sessionId | number | 7215873 |
userId | number | 4555 |
time | datetime | yyyy-MM-dd'T'HH:mm:ss,SSSZZZZ |
SessionActivityCallScript
Děje se vždy při navolávání každého kontaktu v rámci kampaně, kde je CallScript nastaven. CallScript nemusí být potvrzen operátorem.
Parametr | Hodnota | Příklad |
---|---|---|
sessionId | number | 7215873 |
time | datetime | yyyy-MM-dd'T'HH:mm:ss,SSSZZZZ |
type | string | CallScript |
callscript | array | struktura formuláře |
Webhook je doručen v okamžiku přijetí kampaňového sezení klientem.
SessionActivityCallScriptSubmission
V sezení je operátorem potvrzen nastavený CallScript. CallScript se využívá pouze u telefonních kampaní.
Parametr | Hodnota | Příklad |
---|---|---|
sessionId | number | 7215873 |
time | datetime | yyyy-MM-dd'T'HH:mm:ss,SSSZZZZ |
type | string | CallScriptSubmission |
client | string | Guest |
Webhook je doručen, jakmile skončí ACW sezení.
SessionActivityCobrowsingStarted
V sezení byl zahájen cobrowsing a klient odsouhlasil žádost od operátora.
Parametr | Hodnota | Příklad |
---|---|---|
sessionId | number | 7215873 |
activityId | number | 49717950 |
time | datetime | yyyy-MM-dd'T'HH:mm:ss,SSSZZZZ |
type | string | SessionActivityCobrowsingStarted |
client | string | Guest |
SessionActivityExternalMessage
Může se jednat o úvodní zprávu nastavenou na úrovni Facebook stránky, nebo o zprávy odesílané klientovi mimo aplikaci mluvii (přes Facebook Messenger).
Parametr | Hodnota | Příklad |
---|---|---|
sessionId | number | 7215873 |
activityId | number | 49717950 |
time | datetime | yyyy-MM-dd'T'HH:mm:ss,SSSZZZZ |
type | string | ExternalMessage |
text | string | odpověď z Facebooku |
SessionActivityHeroCard
Během sezení byla odeslána HeroCard.
Parametr | Hodnota | Příklad |
---|---|---|
sessionId | number | 7215873 |
activityId | number | 49717950 |
time | datetime | yyyy-MM-dd'T'HH:mm:ss,SSSZZZZ |
type | string | HeroCard |
heroCard | array | struktura HeroCard |
client | string | User |
Parametr "client" může nabývat hodnot (User, Chatbot). V závislosti na tom je vyplněna také hodnota parametru "userId", nebo "chatbotId".
SessionActivityHeroCardSubmission
Zaloguje se při potvrzení/zrušení (submitted/cancelled) HeroCard.
Parametr | Hodnota | Příklad |
---|---|---|
sessionId | number | 7273902 |
originalFormID | number | 3371 |
result | submitted | |
submittedByClient | bool | true |
params | string | |
time | datetime | yyyy-MM-dd'T'HH:mm:ss,SSSZZZZ |
Parametr originalFormID označuje id existující HeroCard v mluvii.
V params jsou uloženy parametry použité v dané HeroCard společně se zadanými hodnotami (např. "oo1_guest_email", "oo1_guest_ident", "oo1_guest_phone").
Existují i případy, kdy HeroCard potvrdí operátor místo klienta. V takovém případě se uloží do parametru "submittedByClient" hodnota false.
SessionActivityChatToMail
Vyskytuje se v momentě, kdy klient zadá ve Výstupním formuláři e-mail a zašle si přepis, případně zašle přepis operátor.
Parametr | Hodnota | Příklad |
---|---|---|
sessionId | number | 7273902 |
activityId | number | 50108494 |
time | datetime | yyyy-MM-dd'T'HH:mm:ss,SSSZZZZ |
type | string | ChatToMail |
client | string | Guest |
Do parametru "client" se uloží hodnota Guest, pokud si přepis sezení pošle sám klient. Nebo se použíje hodnota User a parametr „userID", které je vyplněné pouze v případě, že iniciátorem akce je operátor.
SessionActivityLastFarewellMessage
Zaloguje se v případě, že je sezení automaticky ukončeno po 24 hodinách čekání ve frontě. Toto se týká zejména WhatsAppu. Můžete tuto událost sledovat i u Facebook Messenger sezení.
Parametr | Hodnota | Příklad |
---|---|---|
sessionId | number | 7273902 |
activityId | number | 50108494 |
time | datetime | yyyy-MM-dd'T'HH:mm:ss,SSSZZZZ |
type | string | LastFarewellMessage |
text | string | Omlouváme se, ale váš požadavek ... |
SessionActivityPreviewUrl
V sezení se objeví zpráva obsahující URL link.
Parametr | Hodnota | Příklad |
---|---|---|
sessionId | number | 7273902 |
activityId | number | 50108494 |
time | datetime | yyyy-MM-dd'T'HH:mm:ss,SSSZZZZ |
type | string | PreviewUrl |
client | string | User |
previewUrl | - | - |
.../title | string | Seznam - najdu tam, co neznám |
.../imageUrl | string | https://www.seznam.cz/media/... |
.../contentType | number | 1 |
.../originalUrl | string | https://www.seznam.cz/ |
.../originalActivityId | number | 114253 |
userId | number | 2004014 |
V závislosti na tom, která strana link odeslala se u parametru "Client" zaloguje hodnota "guest", "user" nebo "chatbot"., který se vykreslí (v obou případech se mění akorát parametry „Client“ (guest, user)). Pokud URL pošle operátor, vyplní se navíc userId.
SessionActivityOnHold
Operátor v průběhu tel. hovoru přidrží probíhající hovor (tlačítko "Přidržet hovor").
Parametr | Hodnota | Příklad |
---|---|---|
sessionId | number | 7273902 |
activityId | number | 50108494 |
time | datetime | yyyy-MM-dd'T'HH:mm:ss,SSSZZZZ |
type | string | OnHold |
client | string | User |
userId | number | 2710 |
SessionActivityOperatorInviteCanceled
Operátor přizval jiného operátora do sezení a ještě před jeho připojením pozvánku zrušil. UserId označuje operátora, který pozvánku zrušil.
Parametr | Hodnota | Příklad |
---|---|---|
sessionId | number | 7273902 |
activityId | number | 50108494 |
time | datetime | yyyy-MM-dd'T'HH:mm:ss,SSSZZZZ |
type | string | OperatorInviteCanceled |
client | string | User |
userId | number | 2710 |