Webhooky

Kategorie Eventů

• Sezení

• Aktivity v Sezení

• E-maily

• Ostatní

Sezení

• SessionCreated

• SessionStarted

• SessionOperatorJoined

• SessionForwarded

• SessionEnded

• SessionOperatorLeft

• SessionOperatorConcluded

• SessionCallParamsUpdated

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	kanál sezení
source	string	zdroj sezení

Ukázkový JSON:

{
  "eventType": "SessionCreated",
  "data": {
    "id": 7371450,
    "tenantId": 62,
    "channel": "Phone",
    "source": "OutgoingCall"
  }
}

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	kanál sezení
source	string	zdroj sezení
started	datetime	yyyy-MM-dd'T'HH:mm:ss,SSSZZZZ

Ukázkový JSON:

{
  "eventType": "SessionStarted",
  "data": {
    "id": 7371450,
    "tenantId": 62,
    "channel": "Phone",
    "source": "OutgoingCall",
    "started": "2024-05-02T16:05:24.454661+02:00"
  }
}

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	kanál sezení
source	string	zdroj sezení
time	datetime	yyyy-MM-dd'T'HH:mm:ss,SSSZZZZ

Ukázkový JSON:

{
  "eventType": "SessionOperatorJoined",
  "data": {
    "id": 7371450,
    "tenantId": 62,
    "userId": 4,
    "channel": "Phone",
    "source": "OutgoingCall",
    "time": "2024-05-02T16:05:24.454661+02:00"
  }
}

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	kanál sezení
source	string	zdroj sezení
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.

Ukázkový JSON

{
  "eventType": "SessionForwarded",
  "data": {
    "id": 7373420,
    "tenantId": 62,
    "channel": "Chat",
    "source": "Default",
    "time": "2024-05-03T09:41:31.257306+02:00",
    "userId": null,
    "operatorGroupId": 7299,
    "chatbotId": null
  }
}

SessionEnded

Sezení bylo ukončeno.

Parametr	Hodnota	Příklad
id	number	7293902
tenantId	number	62
channel	string	kanál sezení
source	string	zdroj sezení
started	datetime	yyyy-MM-dd'T'HH:mm:ss,SSSZZZZ
ended	datetime	yyyy-MM-dd'T'HH:mm:ss,SSSZZZZ

Ukázkový JSON:

{
  "eventType": "SessionEnded",
  "data": {
    "id": 7363963,
    "tenantId": 62,
    "channel": "Chat",
    "source": "Default",
    "started": "2024-04-30T13:32:31.105138+02:00",
    "ended": "2024-05-02T15:34:12.871976+02:00"
  }
}

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	kanál sezení
source	string	zdroj sezení
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.

Ukázkový JSON:

{
  "eventType": "SessionOperatorLeft",
  "data": {
    "id": 7371193,
    "tenantId": 62,
    "userId": 4301,
    "channel": "AV",
    "source": "Invitation",
    "time": "2024-05-02T15:32:52.539588+02:00"
  }
}

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	kanál sezení
source	string	zdroj sezení
time	datetime	yyyy-MM-dd'T'HH:mm:ss,SSSZZZZ

Ukázkový JSON:

{
  "eventType": "SessionOperatorConcluded",
  "data": {
    "id": 7429963,
    "tenantId": 62,
    "userId": 2710,
    "channel": "Chat",
    "source": "Default",
    "time": "2024-05-20T14:46:29.969234+02:00"
  }
}

Aktivity v Sezení

• SessionActivityAutoActivity

• SessionActivityAvResponse

• SessionActivityAvRequest

• SessionActivityAvTerminated

• SessionActivityCallScript

• SessionActivityCallScriptSubmission

• SessionActivityCobrowsingStarted

• SessionActivityExternalMessage

• SessionActivityHeroCard

• SessionActivityHeroCardSubmission

• SessionActivityChatToMail

• SessionActivityLastFarewellMessage

• SessionActivityPreviewUrl

• SessionActivityOnHold

• SessionActivityOperatorInviteCanceled

• SessionActivityOperatorInvited

• SessionActivityOperatorInviteRejected

• SessionActivityResumeGuest

• SessionActivitySessionEnded

• SessionActivitySessionForwarded

• SessionActivitySharedFile

• SessionActivitySharedScreen

• SessionActivityWelcomeMessage

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í?"

Ukázkový JSON:

{
  "eventType": "SessionActivityAutoActivity",
  "data": {
    "sessionId": 7380342,
    "activityId": 50878507,
    "time": "2024-05-06T08:31:13.722852+02:00",
    "type": "AutoActivity",
    "heroCard": null,
    "heroCardParams": null,
    "callScript": null,
    "client": null,
    "text": "<p>zpráva</p>",
    "previewUrl": null,
    "file": null,
    "associatedSharedFileUrl": null,
    "toOperatorUserId": null,
    "toOperatorFullName": null,
    "toGroupId": null,
    "toGroupName": null,
    "toPhoneNumber": null,
    "note": null,
    "chatbotMessageContent": null,
    "submissionIdentification": null,
    "userId": null,
    "chatbotId": null,
    "chatbotHeroCardSubmissionKey": null,
    "chatbotHeroCardSubmissionValue": null,
    "formFieldSetUUID": null,
    "terminationReason": null
  }
}

SessionActivityAvResponse

Spustí se při reakci uživatele na pokus o AV spojení.

Vlastnost	Hodnota	Příklad
sessionId	number	7361303
operatorId	number	2710
response	SessionAVRequestState	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".

Ukázkový JSON:

{
  "eventType": "SessionActivityAvResponse",
  "data": {
    "sessionId": 7404708,
    "operatorId": 2710,
    "response": "Accepted",
    "time": "2024-05-13T11:22:23.653014+02:00"
  }
}

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

Ukázkový JSON:

{
  "eventType": "SessionActivityAvRequest",
  "data": {
    "sessionId": 7375793,
    "operatorId": 2710,
    "time": "2024-05-03T13:54:49.450758+02:00"
  }
}

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

Ukázkový JSON:

{
  "eventType": "SessionActivityAvTerminated",
  "data": {
    "sessionId": 7375793,
    "operatorId": 2710,
    "time": "2024-05-03T13:57:03.140972+02:00"
  }
}

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.

Struktura formuláře:

[

{"inputType": "RichText",

"label": "<p>byt</p>", "ordinal": 1

},

{"inputType": "Text",

"label": "dispozice",

"key": "Dispozice",

"required": true,

"ordinal": 2

},

{"InputType": "Radio",

"label": "centrum", "key": "somethingelse",

"required": true, "ordinal": 3,

"choiceOptions":[

{"value": "ano",

"label": "ano"},

{"value": "ne",

"label": "ne"}]

}

Ukázkový JSON:

{
  "eventType": "SessionActivityCallScript",
  "data": {
    "sessionId": 7383104,
    "activityId": 50894607,
    "time": "2024-05-06T13:46:07.605708+02:00",
    "type": "CallScript",
    "heroCard": null,
    "heroCardParams": null,
    "callScript": [
      {
        "inputType": "RichText",
        "label": "<p>Dobrý den, pane XXX</p>",
        "ordinal": 1
      },
      {
        "inputType": "Text",
        "label": "Dispozice",
        "key": "dispozice",
        "required": true,
        "ordinal": 2
      },
      {
        "inputType": "Radio",
        "label": "zvíře",
        "key": "somethingelse",
        "required": true,
        "ordinal": 3,
        "choiceOptions": [
          {
            "value": "kočka",
            "label": "kočka"
          }
        ]
      },
      {
        "inputType": "Radio",
        "label": "dfdfdfdfsdf",
        "key": "ujasnění",
        "required": true,
        "ordinal": 4,
        "choiceOptions": [
          {
            "value": "ano",
            "label": "ano"
          }
        ]
      }
    ],
    "client": null,
    "text": null,
    "previewUrl": null,
    "file": null,
    "associatedSharedFileUrl": null,
    "toOperatorUserId": null,
    "toOperatorFullName": null,
    "toGroupId": null,
    "toGroupName": null,
    "toPhoneNumber": null,
    "note": null,
    "chatbotMessageContent": null,
    "submissionIdentification": null,
    "userId": null,
    "chatbotId": null,
    "chatbotHeroCardSubmissionKey": null,
    "chatbotHeroCardSubmissionValue": null,
    "formFieldSetUUID": "afebe607-a007-489d-ba03-dd9deaa17f8d",
    "terminationReason": null
  }
}

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í.

Ukázkový JSON:

{
  "eventType": "SessionActivityCallScriptSubmission",
  "data": {
    "sessionId": 7383014,
    "activityId": 50894089,
    "time": "2024-05-06T13:37:57.649363+02:00",
    "type": "CallScriptSubmission",
    "heroCard": null,
    "heroCardParams": null,
    "callScript": null,
    "client": "Guest",
    "text": null,
    "previewUrl": null,
    "file": null,
    "associatedSharedFileUrl": null,
    "toOperatorUserId": null,
    "toOperatorFullName": null,
    "toGroupId": null,
    "toGroupName": null,
    "toPhoneNumber": null,
    "note": null,
    "chatbotMessageContent": null,
    "submissionIdentification": null,
    "userId": null,
    "chatbotId": null,
    "chatbotHeroCardSubmissionKey": null,
    "chatbotHeroCardSubmissionValue": null,
    "formFieldSetUUID": null,
    "terminationReason": null
  }
}

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

Ukázkový JSON:

{
  "eventType": "SessionActivityCobrowsingStarted",
  "data": {
    "sessionId": 7383263,
    "activityId": 50895810,
    "time": "2024-05-06T14:10:19.928721+02:00",
    "type": "CobrowsingStarted",
    "heroCard": null,
    "heroCardParams": null,
    "callScript": null,
    "client": "Guest",
    "text": null,
    "previewUrl": null,
    "file": null,
    "associatedSharedFileUrl": null,
    "toOperatorUserId": null,
    "toOperatorFullName": null,
    "toGroupId": null,
    "toGroupName": null,
    "toPhoneNumber": null,
    "note": null,
    "chatbotMessageContent": null,
    "submissionIdentification": null,
    "userId": null,
    "chatbotId": null,
    "chatbotHeroCardSubmissionKey": null,
    "chatbotHeroCardSubmissionValue": null,
    "formFieldSetUUID": null,
    "terminationReason": null
  }
}

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

Ukázkový JSON:

{
  "eventType": "SessionActivityExternalMessage",
  "data": {
    "sessionId": 7369378,
    "activityId": 50896981,
    "time": "2024-05-06T14:33:06.262+02:00",
    "type": "ExternalMessage",
    "heroCard": null,
    "heroCardParams": null,
    "callScript": null,
    "client": null,
    "text": "Dobrý den",
    "previewUrl": null,
    "file": null,
    "associatedSharedFileUrl": null,
    "toOperatorUserId": null,
    "toOperatorFullName": null,
    "toGroupId": null,
    "toGroupName": null,
    "toPhoneNumber": null,
    "note": null,
    "chatbotMessageContent": null,
    "submissionIdentification": null,
    "userId": null,
    "chatbotId": null,
    "chatbotHeroCardSubmissionKey": null,
    "chatbotHeroCardSubmissionValue": null,
    "formFieldSetUUID": null,
    "terminationReason": null
  }
}

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

Struktura HeroCard

[

{"inputType": "RichText",

"label": "<p>byt</p>", "ordinal": 1

},

{"inputType": "Text",

"label": "dispozice",

"key": "Dispozice",

"required": true,

"ordinal": 2

},

{"InputType": "Radio",

"label": "centrum", "key": "somethingelse",

"required": true, "ordinal": 3,

"choiceOptions":[

{"value": "ano",

"label": "ano"},

{"value": "ne",

"label": "ne"}]

}

Parametr "client" může nabývat hodnot (User, Chatbot). V závislosti na tom je vyplněna také hodnota parametru "userId", nebo "chatbotId".

Ukázkový JSON:

{
  "eventType": "SessionActivityHeroCard",
  "data": {
    "sessionId": 7383497,
    "activityId": 50897242,
    "time": "2024-05-06T14:37:20.236594+02:00",
    "type": "HeroCard",
    "heroCard": [
      {
        "inputType": "RichText",
        "label": "<p>Prosím, zadejte své kontaktní údaje.</p>",
        "ordinal": 1
      },
      {
        "inputType": "Text",
        "label": "Jméno",
        "key": "oo1_guest_ident",
        "required": true,
        "ordinal": 2
      },
      {
        "inputType": "Text",
        "label": "E-mail",
        "key": "oo1_guest_email",
        "required": true,
        "ordinal": 3
      },
      {
        "inputType": "Text",
        "label": "Telefon",
        "key": "oo1_guest_phone",
        "required": false,
        "ordinal": 4
      },
      {
        "inputType": "Confirmation",
        "label": "Confirm label",
        "ordinal": 5
      }
    ],
    "heroCardParams": null,
    "callScript": null,
    "client": "Chatbot",
    "text": null,
    "previewUrl": null,
    "file": null,
    "associatedSharedFileUrl": null,
    "toOperatorUserId": null,
    "toOperatorFullName": null,
    "toGroupId": null,
    "toGroupName": null,
    "toPhoneNumber": null,
    "note": null,
    "chatbotMessageContent": null,
    "submissionIdentification": null,
    "userId": null,
    "chatbotId": 329,
    "chatbotHeroCardSubmissionKey": null,
    "chatbotHeroCardSubmissionValue": null,
    "formFieldSetUUID": "e5e7d280-9d29-4668-ae92-2dd27a8902cf",
    "terminationReason": null
  }
}

SessionActivityHeroCardSubmission

Zaloguje se při potvrzení/zrušení (submitted/cancelled) HeroCard.

Parametr	Hodnota	Příklad
sessionId	number	7273902
originalFormID	number	3371
result	HeroCardSubmissionResult	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.

Ukázkový JSON:

{
  "eventType": "SessionActivityHeroCardSubmission",
  "data": {
    "sessionId": 7383497,
    "result": "Submitted",
    "originalFormID": 2273,
    "submittedByClient": false,
    "params": {
      "barva": "Červená",
      "model": "Focus",
      "palivo": "Benzín",
      "oo1_guest_ident": "Zbyněk Hostaš",
      "značka": "Volkswagen",
      "číslo ŘP": "ddd"
    },
    "time": "2024-05-06T14:44:07.799984+02:00"
  }
}

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.

Ukázkový JSON:

{
  "eventType": "SessionActivityChatToMail",
  "data": {
    "sessionId": 7383497,
    "activityId": 50897938,
    "time": "2024-05-06T14:49:23.808642+02:00",
    "type": "ChatToMail",
    "heroCard": null,
    "heroCardParams": null,
    "callScript": null,
    "client": "User",
    "text": null,
    "previewUrl": null,
    "file": null,
    "associatedSharedFileUrl": null,
    "toOperatorUserId": null,
    "toOperatorFullName": null,
    "toGroupId": null,
    "toGroupName": null,
    "toPhoneNumber": null,
    "note": null,
    "chatbotMessageContent": null,
    "submissionIdentification": null,
    "userId": 2710,
    "chatbotId": null,
    "chatbotHeroCardSubmissionKey": null,
    "chatbotHeroCardSubmissionValue": null,
    "formFieldSetUUID": null,
    "terminationReason": null
  }
}

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 ...

Ukázkový JSON:

{
  "eventType": "SessionActivityLastFarewellMessage",
  "data": {
    "sessionId": 7404414,
    "activityId": 51135367,
    "time": "2024-05-15T15:32:58.045333+02:00",
    "type": "LastFarewellMessage",
    "heroCard": null,
    "heroCardParams": null,
    "callScript": null,
    "client": null,
    "text": "We’re sorry, but your request was automatically closed due to exceeding the 24-hour response time set by WhatsApp and Facebook. If your question is still up to date, please contact us again. Thank you.",
    "previewUrl": null,
    "file": null,
    "associatedSharedFileUrl": null,
    "toOperatorUserId": null,
    "toOperatorFullName": null,
    "toGroupId": null,
    "toGroupName": null,
    "toPhoneNumber": null,
    "note": null,
    "chatbotMessageContent": null,
    "submissionIdentification": null,
    "userId": null,
    "chatbotId": null,
    "chatbotHeroCardSubmissionKey": null,
    "chatbotHeroCardSubmissionValue": null,
    "formFieldSetUUID": null,
    "terminationReason": null
  }
}

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.

Ukázkový JSON:

{
  "eventType": "SessionActivityPreviewUrl",
  "data": {
    "sessionId": 7383741,
    "activityId": 50899088,
    "time": "2024-05-06T15:10:16.12969+02:00",
    "type": "PreviewUrl",
    "heroCard": null,
    "heroCardParams": null,
    "callScript": null,
    "client": "Guest",
    "text": null,
    "previewUrl": {
      "title": "Seznam – najdu tam, co neznám",
      "imageUrl": "http://www.seznam.cz/media/img/logo-share-square_v2.png",
      "contentType": 1,
      "originalUrl": "http://www.seznam.cz/",
      "originalActivityId": 50899086
    },
    "file": null,
    "associatedSharedFileUrl": null,
    "toOperatorUserId": null,
    "toOperatorFullName": null,
    "toGroupId": null,
    "toGroupName": null,
    "toPhoneNumber": null,
    "note": null,
    "chatbotMessageContent": null,
    "submissionIdentification": null,
    "userId": null,
    "chatbotId": null,
    "chatbotHeroCardSubmissionKey": null,
    "chatbotHeroCardSubmissionValue": null,
    "formFieldSetUUID": null,
    "terminationReason": null
  }
}

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

Ukázkový JSON:

{
  "eventType": "SessionActivityOnHold",
  "data": {
    "sessionId": 7383730,
    "activityId": 50898864,
    "time": "2024-05-06T15:05:29.719899+02:00",
    "type": "OnHold",
    "heroCard": null,
    "heroCardParams": null,
    "callScript": null,
    "client": "User",
    "text": null,
    "previewUrl": null,
    "file": null,
    "associatedSharedFileUrl": null,
    "toOperatorUserId": null,
    "toOperatorFullName": null,
    "toGroupId": null,
    "toGroupName": null,
    "toPhoneNumber": null,
    "note": null,
    "chatbotMessageContent": null,
    "submissionIdentification": null,
    "userId": 2710,
    "chatbotId": null,
    "chatbotHeroCardSubmissionKey": null,
    "chatbotHeroCardSubmissionValue": null,
    "formFieldSetUUID": null,
    "terminationReason": null
  }
}

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

Ukázkový JSON:

{
  "eventType": "SessionActivityOperatorInviteCanceled",
  "data": {
    "sessionId": 7383741,
    "activityId": 50899127,
    "time": "2024-05-06T15:11:36.541724+02:00",
    "type": "OperatorInviteCanceled",
    "heroCard": null,
    "heroCardParams": null,
    "callScript": null,
    "client": "User",
    "text": null,
    "previewUrl": null,
    "file": null,
    "associatedSharedFileUrl": null,
    "toOperatorUserId": null,
    "toOperatorFullName": null,
    "toGroupId": null,
    "toGroupName": null,
    "toPhoneNumber": null,
    "note": null,
    "chatbotMessageContent": null,
    "submissionIdentification": null,
    "userId": 2710,
    "chatbotId": null,
    "chatbotHeroCardSubmissionKey": null,
    "chatbotHeroCardSubmissionValue": null,
    "formFieldSetUUID": null,
    "terminationReason": null
  }
}

SessionActivityOperatorInvited

Operátor přizval jiného operátora do sezení. UserId označuje operátora, který poslal pozvánku.

Parametr	Hodnota	Příklad
sessionId	number	7273902
activityId	number	50108494
time	datetime	yyyy-MM-dd'T'HH:mm:ss,SSSZZZZ
type	string	OperatorInvited
client	string	User
toOperatorUserId	number	4301
toOperatorFullName	string	Jan Novák
note	string	Prosím, připoj se.
userId	number	2710

Ukázkový JSON:

{
  "eventType": "SessionActivityOperatorInvited",
  "data": {
    "sessionId": 7383741,
    "activityId": 50899168,
    "time": "2024-05-06T15:12:44.604+02:00",
    "type": "OperatorInvited",
    "heroCard": null,
    "heroCardParams": null,
    "callScript": null,
    "client": "User",
    "text": null,
    "previewUrl": null,
    "file": null,
    "associatedSharedFileUrl": null,
    "toOperatorUserId": 4254,
    "toOperatorFullName": "Štěpán Bazala",
    "toGroupId": null,
    "toGroupName": null,
    "toPhoneNumber": null,
    "note": "",
    "chatbotMessageContent": null,
    "submissionIdentification": null,
    "userId": 2710,
    "chatbotId": null,
    "chatbotHeroCardSubmissionKey": null,
    "chatbotHeroCardSubmissionValue": null,
    "formFieldSetUUID": null,
    "terminationReason": null
  }
}

SessionActivityOperatorInviteRejected

Operátor přizval jiného operátora do sezení a ten pozvání odmítl. UserId označuje operátora, který pozvánku odmítl.

Parametr	Hodnota	Příklad
sessionId	number	7273902
activityId	number	50108494
time	datetime	yyyy-MM-dd'T'HH:mm:ss,SSSZZZZ
type	string	OperatorInviteRejected
client	string	User
userId	number	2710

Ukázkový JSON:

{
  "eventType": "SessionActivityOperatorInviteRejected",
  "data": {
    "sessionId": 7383936,
    "activityId": 50900431,
    "time": "2024-05-06T15:45:46.295607+02:00",
    "type": "OperatorInviteRejected",
    "heroCard": null,
    "heroCardParams": null,
    "callScript": null,
    "client": "User",
    "text": null,
    "previewUrl": null,
    "file": null,
    "associatedSharedFileUrl": null,
    "toOperatorUserId": null,
    "toOperatorFullName": null,
    "toGroupId": null,
    "toGroupName": null,
    "toPhoneNumber": null,
    "note": null,
    "chatbotMessageContent": null,
    "submissionIdentification": null,
    "userId": 4254,
    "chatbotId": null,
    "chatbotHeroCardSubmissionKey": null,
    "chatbotHeroCardSubmissionValue": null,
    "formFieldSetUUID": null,
    "terminationReason": null
  }
}

SessionActivityResumeGuest

Událost úzce souvisí s jinou údálostí (SessionActivityOnHold), která této předchází. Tentokrát operátor kliká na tlačítko "Pokračovat v hovoru".

Parametr	Hodnota	Příklad
sessionId	number	7273902
activityId	number	50108494
time	datetime	yyyy-MM-dd'T'HH:mm:ss,SSSZZZZ
type	string	ResumeGuest
client	string	User
userId	number	2710

Ukázkový JSON:

{
  "eventType": "SessionActivityResumeGuest",
  "data": {
    "sessionId": 7383786,
    "activityId": 50899230,
    "time": "2024-05-06T15:14:50.080729+02:00",
    "type": "ResumeGuest",
    "heroCard": null,
    "heroCardParams": null,
    "callScript": null,
    "client": "User",
    "text": null,
    "previewUrl": null,
    "file": null,
    "associatedSharedFileUrl": null,
    "toOperatorUserId": null,
    "toOperatorFullName": null,
    "toGroupId": null,
    "toGroupName": null,
    "toPhoneNumber": null,
    "note": null,
    "chatbotMessageContent": null,
    "submissionIdentification": null,
    "userId": 2710,
    "chatbotId": null,
    "chatbotHeroCardSubmissionKey": null,
    "chatbotHeroCardSubmissionValue": null,
    "formFieldSetUUID": null,
    "terminationReason": null
  }
}

SessionActivitySessionEnded

Zaloguje se pokaždé, kdy skončí sezení.

Parametr	Hodnota	Příklad
sessionId	number	7273902
activityId	number	50108494
time	datetime	yyyy-MM-dd'T'HH:mm:ss,SSSZZZZ
type	string	SessionEnded
client	string	Guest
userId	number	2710
terminationReason	string	Důvod ukončení

Sezení může být ukončeno ze strany klienta či operátora (podle toho se do parametru client uloží hodnota "guest", "user"). Pokud je sezení ukončeno ze strany operátora, ukládá se jeho ID do parametru "userId".

Ukázkový JSON:

{
  "eventType": "SessionActivitySessionEnded",
  "data": {
    "sessionId": 7383798,
    "activityId": 50899289,
    "time": "2024-05-06T15:16:43.605072+02:00",
    "type": "SessionEnded",
    "heroCard": null,
    "heroCardParams": null,
    "callScript": null,
    "client": "Guest",
    "text": null,
    "previewUrl": null,
    "file": null,
    "associatedSharedFileUrl": null,
    "toOperatorUserId": null,
    "toOperatorFullName": null,
    "toGroupId": null,
    "toGroupName": null,
    "toPhoneNumber": null,
    "note": null,
    "chatbotMessageContent": null,
    "submissionIdentification": null,
    "userId": null,
    "chatbotId": null,
    "chatbotHeroCardSubmissionKey": null,
    "chatbotHeroCardSubmissionValue": null,
    "formFieldSetUUID": null,
    "terminationReason": "GuestLeft"
  }
}

SessionActivitySessionForwarded

Děje se při přepojování sezení ze strany operátora (userId) či chatbota (chatbotId). Pokud operátor (chatbot) přepojují na operátora, použije se parametr "toOperatorUserId" či "toOperatorFullName".

Parametr	Hodnota	Příklad
sessionId	number	7273902
activityId	number	50108494
time	datetime	yyyy-MM-dd'T'HH:mm:ss,SSSZZZZ
type	string	SessionForwarded
client	string	User
toOperatorUserId	number	2710
toGroupId	number	7229

Jestliže je sezení přepojené na skupinu operátorů, použije se parametr "toGroupId" či "toGroupName". Zajímavostí je, že při přepojení na chatbota se také použijí stejné parametry.

Ukázkový JSON:

{
  "eventType": "SessionActivitySessionForwarded",
  "data": {
    "sessionId": 7383798,
    "activityId": 50899288,
    "time": "2024-05-06T15:16:41.556226+02:00",
    "type": "SessionForwarded",
    "heroCard": null,
    "heroCardParams": null,
    "callScript": null,
    "client": "User",
    "text": null,
    "previewUrl": null,
    "file": null,
    "associatedSharedFileUrl": null,
    "toOperatorUserId": 4,
    "toOperatorFullName": "Ondřej Fogatoš",
    "toGroupId": null,
    "toGroupName": null,
    "toPhoneNumber": null,
    "note": null,
    "chatbotMessageContent": null,
    "submissionIdentification": null,
    "userId": 2710,
    "chatbotId": null,
    "chatbotHeroCardSubmissionKey": null,
    "chatbotHeroCardSubmissionValue": null,
    "formFieldSetUUID": null,
    "terminationReason": null
  }
}

SessionActivitySharedFile

V rámci sezení je sdílený soubor (ze strany operátora či klienta).

Parametr	Hodnota	Příklad
sessionId	number	7273902
activityId	number	50108494
time	datetime	yyyy-MM-dd'T'HH:mm:ss,SSSZZZZ
type	string	SharedFile
client	string	User
userId	number	2710
File	-	-
.../id	number	2635914
.../operatorOwner	number	2710
.../departmentOwner	number	62
.../name	string	obrazek

Operátor může sdílet vlastní či společný (v tenantu) nahraný soubor. To poznáte podle parametrů "operatorOwner" a "departmentOwner". Pokud operátor nasdílí soubor ze svého dísku, oba zmíněné parametry budou prázdné.

Sdílet soubor může také klient, pokud ho k tomu vyzve operátor. V takovém případě se v parametru "client" objeví hodnota "Guest".

Ukázkový JSON:

{
  "eventType": "SessionActivitySharedFile",
  "data": {
    "sessionId": 7418778,
    "activityId": 51164839,
    "time": "2024-05-16T14:21:41.771847+02:00",
    "type": "SharedFile",
    "heroCard": null,
    "heroCardParams": null,
    "callScript": null,
    "client": "User",
    "text": null,
    "previewUrl": null,
    "file": {
      "id": 2572911,
      "operatorOwner": 2710,
      "departmentOwner": null,
      "name": "png-clipart-alarm-clock-nightstand-graphy-clock-digital-clock-time.png",
      "downloadUrl": null,
      "isUploading": false,
      "isDeleted": false
    },
    "associatedSharedFileUrl": null,
    "toOperatorUserId": null,
    "toOperatorFullName": null,
    "toGroupId": null,
    "toGroupName": null,
    "toPhoneNumber": null,
    "note": null,
    "chatbotMessageContent": null,
    "submissionIdentification": null,
    "userId": 2710,
    "chatbotId": null,
    "chatbotHeroCardSubmissionKey": null,
    "chatbotHeroCardSubmissionValue": null,
    "formFieldSetUUID": null,
    "terminationReason": null
  }
}

SessionActivitySharedScreen

Jde o sdílení obrazovky buď ze strany klienta, nebo operátora.

Parametr	Hodnota	Příklad
sessionId	number	7273902
activityId	number	50108494
time	datetime	yyyy-MM-dd'T'HH:mm:ss,SSSZZZZ
type	string	SharedScreen
client	string	User
userId	number	2710

Parametr "client" nabývá hodnot Guest, nebo User. Pokud sdílí obrazovku operátor, uloží se také jeho id do parametru userId.

Ukázkový JSON:

{
  "eventType": "SessionActivitySharedScreen",
  "data": {
    "sessionId": 7383872,
    "activityId": 50900005,
    "time": "2024-05-06T15:35:02.284622+02:00",
    "type": "SharedScreen",
    "heroCard": null,
    "heroCardParams": null,
    "callScript": null,
    "client": "User",
    "text": null,
    "previewUrl": null,
    "file": null,
    "associatedSharedFileUrl": null,
    "toOperatorUserId": null,
    "toOperatorFullName": null,
    "toGroupId": null,
    "toGroupName": null,
    "toPhoneNumber": null,
    "note": null,
    "chatbotMessageContent": null,
    "submissionIdentification": null,
    "userId": 2710,
    "chatbotId": null,
    "chatbotHeroCardSubmissionKey": null,
    "chatbotHeroCardSubmissionValue": null,
    "formFieldSetUUID": null,
    "terminationReason": null
  }
}

SessionActivityWelcomeMessage

V rámci sezení se objevila uvítací zpráva.

Parametr	Hodnota	Příklad
sessionId	number	7273902
activityId	number	50108494
time	datetime	yyyy-MM-dd'T'HH:mm:ss,SSSZZZZ
type	string	WelcomeMessage
text	string	Dobrý den, vítejte na chatu.
userId	number	2710

Ukázkový JSON:

{
  "eventType": "SessionActivityWelcomeMessage",
  "data": {
    "sessionId": 7383872,
    "activityId": 50899893,
    "time": "2024-05-06T15:31:14.63027+02:00",
    "type": "WelcomeMessage",
    "heroCard": null,
    "heroCardParams": null,
    "callScript": null,
    "client": null,
    "text": "Dobrý den, jsme rádi, že využíváte chat firmy mluvii. 
             Co vás k nám přivádí? ",
    "previewUrl": null,
    "file": null,
    "associatedSharedFileUrl": null,
    "toOperatorUserId": null,
    "toOperatorFullName": null,
    "toGroupId": null,
    "toGroupName": null,
    "toPhoneNumber": null,
    "note": null,
    "chatbotMessageContent": null,
    "submissionIdentification": null,
    "userId": null,
    "chatbotId": null,
    "chatbotHeroCardSubmissionKey": null,
    "chatbotHeroCardSubmissionValue": null,
    "formFieldSetUUID": null,
    "terminationReason": null
  }
}

SessionCallParamsUpdated

Zaloguje se při každé změně parametru sezení a nezáleží na tom, kdo změnu provádí (operátor, chatbot, nebo supervizor po skončení sezení).

Parametr	Hodnota	Příklad
id	number	7293902
tenantId	number	62

Ukázkový JSON:

{
  "eventType": "SessionCallParamsUpdated",
  "data": {
    "id": 7383872,
    "tenantId": 62
  }
}

E-maily

• EmailThreadCreated

• EmailThreadOperatorJoined

• EmailThreadOperatorLeft

• EmailThreadForwarded

• EmailThreadParamsUpdated

EmailThreadCreated

Webhook je doručen při vytvoření noveho emailového vlákna. Buď jej zahájí client, nebo operátor.

Vlastnost	Hodnota	Příklad
id	number	742633
created	datetime	yyyy-MM-dd'T'HH:mm:ss,SSSZZZZ
tenantId	number	62

Tato událost se zaloguje i v případě forwardu e-mailu (přeposlání na jinou e-mailovou adresu) ze strany operátora.

Ukázkový JSON:

{
  "eventType": "EmailThreadCreated",
  "data": {
    "id": 749422,
    "tenantId": 62,
    "created": "2024-05-09T14:40:38+02:00"
  }
}

EmailThreadOperatorJoined

Webhook je doručen, jakmile operátor přijme e-mailovou zprávu ze společné fronty.

Vlastnost	Hodnota	Příklad
id	number	742633
time	datetime	yyyy-MM-dd'T'HH:mm:ss,SSSZZZZ
userId	number	2710
tenantId	number	62

Ukázkový JSON:

{
  "eventType": "EmailThreadOperatorJoined",
  "data": {
    "id": 749425,
    "tenantId": 62,
    "userId": 2710,
    "time": "2024-05-13T12:03:15.57364+02:00"
  }
}

EmailThreadOperatorLeft

Spustí se při odpojení operátora od e-mail vlákna (operátor odpoví na e-mail, vrátí jej do fronty ke zpracování, nebo e-mail ignoruje).

Vlastnost	Hodnota	Příklad
id	number	742633
time	datetime	yyyy-MM-dd'T'HH:mm:ss,SSSZZZZ
userId	number	2710
tenantId	number	62

Ukázkový JSON:

{
  "eventType": "EmailThreadOperatorLeft",
  "data": {
    "id": 749425,
    "tenantId": 62,
    "userId": 2710,
    "time": "2024-05-13T12:04:36.435817+02:00"
  }
}

EmailThreadForwarded

Spustí se při přesměrování e-mailového vlákna.

Vlastnost	Hodnota	Příklad
id	number	742633
time	datetime	yyyy-MM-dd'T'HH:mm:ss,SSSZZZZ
userId	number	2710
operatorGroupId	number	388
tenantId	number	62

Společně s tímto eventem se zaloguje také EmailThreadOperatorLeft (původní operátor se odpojí).

Ukázkový JSON:

{
  "eventType": "EmailThreadForwarded",
  "data": {
    "id": 749422,
    "tenantId": 62,
    "time": "2024-05-13T12:23:20.866743+02:00",
    "userId": 4254,
    "operatorGroupId": null
  }
}

EmailThreadParamsUpdated

Spustí se při přidání parametru k e-mailovému vláknu operátorem, nebo pomocí Public API.

Vlastnost	Hodnota	Příklad
id	number	742633
tenantId	number	62

Ukázkový JSON:

{
  "eventType": "EmailThreadParamsUpdated",
  "data": {
    "id": 749422,
    "tenantId": 62
  }
}

Ostatní

• ApplicationSettingChanged

• GuestIdentityUpdated

• SessionRecordingPostProcessingCompleted

• UserStatusChanged

ApplicationSettingChanged

Zaloguje se při jakékoli změně nastavení tenantu (tenant/Aplikace/Všeobecné).

Parametr	Hodnota	Příklad
name	string	všeobecné nastavení
companyId	number	1
departmentId	number	62

Pro každou změnu provedenou v nastavení tenantu, vrátí Public API 18 odpovědí.

Ukázkový JSON:

{
  "eventType": "ApplicationSettingChanged",
  "data": {
    "name": "phoneCallNumberBlockMinutes",
    "companyId": 1,
    "departmentId": 62,
    "operatorGroupId": null,
    "userId": null,
    "routingRuleSetId": null
  }
}

GuestIdentityUpdated

Spustí se po editaci informací u klienta. id (níže) označuje id záznamu v Adresáři kontaktů.

Vlastnost	Hodnota	Příklad
id	number	345229
tenantId	number	62

Ukázkový JSON:

{
  "eventType": "GuestIdentityUpdated",
  "data": {
    "id": 3539865,
    "tenantId": 62
  }
}

SessionRecordingPostProcessingCompleted

Zpracování Audio/Video nahrávky po skončení sezení bylo dokončeno.

Parametr	Hodnota	Příklad
id	number	7293902
tenantId	number	62

Ukázkový JSON:

{
  "eventType": "SessionRecordingPostProcessingCompleted",
  "data": {
    "id": 7404608,
    "tenantId": 62
  }
}

UserStatusChanged

Spustí se při změně stavu operátora.

Vlastnost	Hodnota	Příklad
userId	number	2710
status	Stav operátora	ONLINE
availabilityStatus	Stav dostupnosti operátora	DEFAULT
availabilityStatusReason	string	null

Ukázkový JSON

{
  "eventType": "UserStatusChanged",
  "data": {
    "userId": 2710,
    "status": "AWAY",
    "availabilityStatus": "AWAY",
    "availabilityStatusReason": null
  }
}

Výčtové typy

HeroCardSubmissionResult

Hodnota	Popis
Submitted	Údaje potvrzeny
Cancelled	Vyplnění hero karty zrušeno

GetMediaResult

Hodnota	Popis
Success	Úspěšný přenos
NoCameraOnlyMic	Pouze mikrofon
NoDevices	Žádná zařízení pro přenos audio/video
UserDenied	Uživatel nepovolil audio/video zařízení

SessionAVRequestState

Hodnota	Popis
Requested	Vyžádáno
Accepted	Přijato
RejectedUser	Odmítnuto uživatelem
RejectedNoMic	Uživatel nemá mikrofon

Zdroj sezení

Hodnota	Popis
Default	WebChat
Callback	Callback
Invitation	Pozvánka
IncomingCall	Příchozí hovor
OutgoingCall	Odchozí hovor
Campaign	Kampaň
API	Public API
Facebook	Facebook
WhatsApp	WhatsApp
VK	VKontakte
Apple	Apple Messages for Business

Kanál sezení

Hodnota	Popis
AV	Audio video přenos
Chat	Textový kanál
Phone	Telefonní hovor

Stav operátora

Hodnota	Popis
OFFLINE	Odhlášený
ONLINE	Dostupný
AWAY	Nedostupný

Stav dostupnosti

Hodnota	Popis
DEFAULT	Online
AWAY	Pryč
ON_CALL	AV nebo telefonní hovor

Důvod ukončení

Hodnota	Popis
GuestLeft	Klient se odpojil
OperatorLeft	Operátor se odpojil
ChatbotLeft	Chatbot se odpojil

Všeobecné nastavení

Hodnota	Popis
GuestPreview	Náhled čekajícího klienta
PhoneNumberBlockMinutes	Délka blokace stejného čísla u CMB widgetu
widgetStateWhenAway	Stav balíčku při stavu pryč
emailTranscriptFrom	Adresát odpovědi na přepis konverzace
emailTranscriptFromVisibility	Odpovědi na přepis konverzace (e-mail operátora či e-mail společnosti)
allowOfflinePhoneCalls	Povolit offline callback
deleteSessionFiles	Smazat soubory po ukončení sezení
guestInfinityChat	Historie chatu u klienta
operatorCanBan	Banování klientů operátorem
recordSession	Nahrávání AV sezení
autoAnonymizeSessions	Automatická anonymizace starých sezení (ve dnech
guestUploadFiles	Odesílání souborů na straně klienta
guestDisconnectedTime	Délka odpojení klienta (v minutách)
operatorCanChooseCallerId	Výběr odchozího telefonního čísla u operátora
showRoutedOperators	Zobrazovat přiřazené operátory
emailRoutingRequestThrottlingPrecedence	Řazení a přiřazování e-mailů