# Webhooky

## Kategorie Eventů

* [Sezení](#sezeni)
* [Aktivity v Sezení](#aktivity-v-sezeni)
* [E-maily](#e-maily)
* [Ostatní](#ostatni)

## Sezení

* [SessionCreated](#sessioncreated)
* [SessionStarted](#sessionstarted)
* [SessionOperatorJoined](#sessionoperatorjoined)
* [SessionForwarded](#sessionforwarded)
* [SessionEnded](#sessionended)
* [SessionOperatorLeft](#sessionoperatorleft)
* [SessionOperatorConcluded](#sessionoperatorconcluded)
* [SessionCallParamsUpdated](#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.

<figure><img src="/files/Hx10wM0s58K6l2SpnZyt" alt=""><figcaption></figcaption></figure>

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

<table><thead><tr><th width="188.33333333333331">Parametr</th><th width="237">Hodnota</th><th>Příklad</th></tr></thead><tbody><tr><td>id</td><td>number</td><td>7293902</td></tr><tr><td>tenantId</td><td>number</td><td>62</td></tr><tr><td>channel</td><td>string</td><td><a href="#kanal-sezeni">kanál sezení</a></td></tr><tr><td>source</td><td>string</td><td><a href="#zdroj-sezeni">zdroj sezení</a></td></tr></tbody></table>

<details>

<summary>Ukázkový JSON:</summary>

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

</details>

### 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ů](#kanal-sezeni) v mluvii. S klientem může v sezení také komunikovat chatbot.

<table><thead><tr><th width="188.33333333333331">Parametr</th><th width="237">Hodnota</th><th>Příklad</th></tr></thead><tbody><tr><td>id</td><td>number</td><td>7293902</td></tr><tr><td>tenantId</td><td>number</td><td>62</td></tr><tr><td>channel</td><td>string</td><td><a href="#kanal-sezeni">kanál sezení</a></td></tr><tr><td>source</td><td>string</td><td><a href="#zdroj-sezeni">zdroj sezení</a></td></tr><tr><td>started</td><td>datetime</td><td>yyyy-MM-dd'T'HH:mm:ss,SSSZZZZ</td></tr></tbody></table>

<details>

<summary>Ukázkový JSON:</summary>

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

</details>

### SessionOperatorJoined

Děje se v momentě připojení operátora do sezení. Např. hned na začátku (po [SessionCreated](#sessioncreated)). Platí, že pro každého operátora v sezení se zaloguje vlastní událost.

<table><thead><tr><th width="188.33333333333331">Parametr</th><th width="237">Hodnota</th><th>Příklad</th></tr></thead><tbody><tr><td>id</td><td>number</td><td>7293902</td></tr><tr><td>tenantId</td><td>number</td><td>62</td></tr><tr><td>userId</td><td>number</td><td>2710</td></tr><tr><td>channel</td><td>string</td><td><a href="#kanal-sezeni">kanál sezení</a></td></tr><tr><td>source</td><td>string</td><td><a href="#zdroj-sezeni">zdroj sezení</a></td></tr><tr><td>time</td><td>datetime</td><td>yyyy-MM-dd'T'HH:mm:ss,SSSZZZZ</td></tr></tbody></table>

<details>

<summary>Ukázkový JSON:</summary>

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

</details>

### SessionForwarded

Sezení bylo přesměrováno. V tomto případě nejsou k dispozici žádné detaily jako je tomu v případě [SessionActivitySessionForwarded](#sessionactivitysessionforwarded).

<table><thead><tr><th width="188.33333333333331">Parametr</th><th width="237">Hodnota</th><th>Příklad</th></tr></thead><tbody><tr><td>id</td><td>number</td><td>7293902</td></tr><tr><td>tenantId</td><td>number</td><td>62</td></tr><tr><td>channel</td><td>string</td><td><a href="#kanal-sezeni">kanál sezení</a></td></tr><tr><td>source</td><td>string</td><td><a href="#zdroj-sezeni">zdroj sezení</a></td></tr><tr><td>time</td><td>datetime</td><td>yyyy-MM-dd'T'HH:mm:ss,SSSZZZZ</td></tr><tr><td>userId</td><td>number</td><td>2710</td></tr><tr><td>operatorGroupId</td><td>number</td><td>7299</td></tr></tbody></table>

{% hint style="info" %}
*V odpovědi se může objevit "userId", "operatorGroupId", nebo "chatbotId" podle toho, na jaký cíl operátor přepojuje.*
{% endhint %}

<details>

<summary>Ukázkový JSON</summary>

```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
  }
}
```

</details>

### SessionEnded

Sezení bylo ukončeno.

<table><thead><tr><th width="191.33333333333331">Parametr</th><th width="237">Hodnota</th><th>Příklad</th></tr></thead><tbody><tr><td>id</td><td>number</td><td>7293902</td></tr><tr><td>tenantId</td><td>number</td><td>62</td></tr><tr><td>channel</td><td>string</td><td><a href="#kanal-sezeni">kanál sezení</a></td></tr><tr><td>source</td><td>string</td><td><a href="#zdroj-sezeni">zdroj sezení</a></td></tr><tr><td>started</td><td>datetime</td><td>yyyy-MM-dd'T'HH:mm:ss,SSSZZZZ</td></tr><tr><td>ended</td><td>datetime</td><td>yyyy-MM-dd'T'HH:mm:ss,SSSZZZZ</td></tr></tbody></table>

<details>

<summary>Ukázkový JSON:</summary>

```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"
  }
}
```

</details>

### SessionOperatorLeft

Jakmile operátor ukončí sezení (klikne na tlačítko "Ukončit"). Následně se dostane do ACW stavu.&#x20;

<table><thead><tr><th width="188.33333333333331">Parametr</th><th width="237">Hodnota</th><th>Příklad</th></tr></thead><tbody><tr><td>id</td><td>number</td><td>7293902</td></tr><tr><td>tenantId</td><td>number</td><td>62</td></tr><tr><td>userId</td><td>number</td><td>2710</td></tr><tr><td>channel</td><td>string</td><td><a href="#kanal-sezeni">kanál sezení</a></td></tr><tr><td>source</td><td>string</td><td><a href="#zdroj-sezeni">zdroj sezení</a></td></tr><tr><td>time</td><td>datetime</td><td>yyyy-MM-dd'T'HH:mm:ss,SSSZZZZ</td></tr></tbody></table>

{% hint style="info" %}
*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)*.*
{% endhint %}

<details>

<summary>Ukázkový JSON:</summary>

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

</details>

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

<table><thead><tr><th width="188.33333333333331">Parametr</th><th width="237">Hodnota</th><th>Příklad</th></tr></thead><tbody><tr><td>id</td><td>number</td><td>7293902</td></tr><tr><td>tenantId</td><td>number</td><td>62</td></tr><tr><td>userId</td><td>number</td><td>2710</td></tr><tr><td>channel</td><td>string</td><td><a href="#kanal-sezeni">kanál sezení</a></td></tr><tr><td>source</td><td>string</td><td><a href="#zdroj-sezeni">zdroj sezení</a></td></tr><tr><td>time</td><td>datetime</td><td>yyyy-MM-dd'T'HH:mm:ss,SSSZZZZ</td></tr></tbody></table>

<details>

<summary>Ukázkový JSON:</summary>

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

</details>

## Aktivity v Sezení

* [SessionActivityAutoActivity](#sessionactivityautoactivity)
* [SessionActivityAvResponse](#sessionactivityavresponse)
* [SessionActivityAvRequest](#sessionactivityavrequest)
* [SessionActivityAvTerminated](#sessionactivityavterminated)
* [SessionActivityCallScript](#sessionactivitycallscript)
* [SessionActivityCallScriptSubmission](#sessionactivitycallscriptsubmission)
* [SessionActivityCobrowsingStarted](#sessionactivitycobrowsingstarted)
* [SessionActivityExternalMessage](#sessionactivityexternalmessage)
* [SessionActivityHeroCard](#sessionactivityherocard)
* [SessionActivityHeroCardSubmission](#sessionactivityherocardsubmission)
* [SessionActivityChatToMail](#sessionactivitychattomail)
* [SessionActivityLastFarewellMessage](#sessionactivitylastfarewellmessage)
* [SessionActivityPreviewUrl](#sessionactivitypreviewurl)
* [SessionActivityOnHold](#sessionactivityonhold)
* [SessionActivityOperatorInviteCanceled](#sessionactivityoperatorinvitecanceled)
* [SessionActivityOperatorInvited](#sessionactivityoperatorinvited)
* [SessionActivityOperatorInviteRejected](#sessionactivityoperatorinviterejected)
* [SessionActivityResumeGuest](#sessionactivityresumeguest)
* [SessionActivitySessionEnded](#sessionended)
* [SessionActivitySessionForwarded](#sessionforwarded)
* [SessionActivitySharedFile](#sessionactivitysharedfile)
* [SessionActivitySharedScreen](#sessionactivitysharedscreen)
* [SessionActivityWelcomeMessage](#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.

<table><thead><tr><th width="144">Parametr</th><th width="140">Hodnota</th><th>Příklad</th></tr></thead><tbody><tr><td>sessionId</td><td>number</td><td>7215873</td></tr><tr><td>activityId</td><td>number</td><td>50878507</td></tr><tr><td>time</td><td>datetime</td><td>yyyy-MM-dd'T'HH:mm:ss,SSSZZZZ</td></tr><tr><td>type</td><td>string</td><td>AutoActivity</td></tr><tr><td>text</td><td>string</td><td>"Jsme stále ve spojení?"</td></tr></tbody></table>

<details>

<summary>Ukázkový JSON:</summary>

```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
  }
}
```

</details>

### 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](#sessionavrequeststate) | Přijato |

{% hint style="info" %}
*Pokud klient přijme pozvánku do A/V hovoru, vrátí Public API hodnotu "Accepted" a v opačném případě "RejectedUser".*
{% endhint %}

<details>

<summary>Ukázkový JSON:</summary>

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

</details>

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

<table><thead><tr><th width="149">Parametr</th><th width="145">Hodnota</th><th>Příklad</th></tr></thead><tbody><tr><td>sessionId</td><td>number</td><td>7215873</td></tr><tr><td>userId</td><td>number</td><td>4555</td></tr><tr><td>time</td><td>datetime</td><td>yyyy-MM-dd'T'HH:mm:ss,SSSZZZZ</td></tr></tbody></table>

<details>

<summary>Ukázkový JSON:</summary>

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

</details>

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

<table><thead><tr><th width="159">Parametr</th><th width="138">Hodnota</th><th>Příklad</th></tr></thead><tbody><tr><td>sessionId</td><td>number</td><td>7215873</td></tr><tr><td>userId</td><td>number</td><td>4555</td></tr><tr><td>time</td><td>datetime</td><td>yyyy-MM-dd'T'HH:mm:ss,SSSZZZZ</td></tr></tbody></table>

<details>

<summary>Ukázkový JSON:</summary>

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

</details>

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

<table><thead><tr><th width="160">Parametr</th><th width="147">Hodnota</th><th>Příklad</th></tr></thead><tbody><tr><td>sessionId</td><td>number</td><td>7215873</td></tr><tr><td>time</td><td>datetime</td><td>yyyy-MM-dd'T'HH:mm:ss,SSSZZZZ</td></tr><tr><td>type</td><td>string</td><td>CallScript</td></tr><tr><td>callscript</td><td>array</td><td>struktura formuláře</td></tr></tbody></table>

{% hint style="info" %}
*Webhook je doručen v okamžiku přijetí kampaňového sezení klientem.*
{% endhint %}

<details>

<summary>Struktura formuláře:</summary>

*\[*

*{"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"}]*

*}*

</details>

<details>

<summary>Ukázkový JSON:</summary>

```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
  }
}
```

</details>

### SessionActivityCallScriptSubmission

V sezení je operátorem potvrzen nastavený CallScript. CallScript se využívá pouze u telefonních kampaní.

<table><thead><tr><th width="162">Parametr</th><th width="153">Hodnota</th><th>Příklad</th></tr></thead><tbody><tr><td>sessionId</td><td>number</td><td>7215873</td></tr><tr><td>time</td><td>datetime</td><td>yyyy-MM-dd'T'HH:mm:ss,SSSZZZZ</td></tr><tr><td>type</td><td>string</td><td>CallScriptSubmission</td></tr><tr><td>client</td><td>string</td><td>Guest</td></tr></tbody></table>

{% hint style="info" %}
*Webhook je doručen, jakmile skončí ACW sezení.*
{% endhint %}

<details>

<summary>Ukázkový JSON:</summary>

<pre class="language-json"><code class="lang-json"><strong>{
</strong>  "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
  }
}
</code></pre>

</details>

### SessionActivityCobrowsingStarted

V sezení byl zahájen cobrowsing a klient odsouhlasil žádost od operátora.

<table><thead><tr><th width="162">Parametr</th><th width="159">Hodnota</th><th>Příklad</th></tr></thead><tbody><tr><td>sessionId</td><td>number</td><td>7215873</td></tr><tr><td>activityId</td><td>number</td><td>49717950</td></tr><tr><td>time</td><td>datetime</td><td>yyyy-MM-dd'T'HH:mm:ss,SSSZZZZ</td></tr><tr><td>type</td><td>string</td><td>SessionActivityCobrowsingStarted</td></tr><tr><td>client</td><td>string</td><td>Guest</td></tr></tbody></table>

<details>

<summary>Ukázkový JSON:</summary>

```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
  }
}
```

</details>

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

<table><thead><tr><th width="162">Parametr</th><th width="159">Hodnota</th><th>Příklad</th></tr></thead><tbody><tr><td>sessionId</td><td>number</td><td>7215873</td></tr><tr><td>activityId</td><td>number</td><td>49717950</td></tr><tr><td>time</td><td>datetime</td><td>yyyy-MM-dd'T'HH:mm:ss,SSSZZZZ</td></tr><tr><td>type</td><td>string</td><td>ExternalMessage</td></tr><tr><td>text</td><td>string</td><td>odpověď z Facebooku</td></tr></tbody></table>

<details>

<summary>Ukázkový JSON:</summary>

```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
  }
}
```

</details>

### SessionActivityHeroCard

Během sezení byla odeslána HeroCard.

<table><thead><tr><th width="162">Parametr</th><th width="159">Hodnota</th><th>Příklad</th></tr></thead><tbody><tr><td>sessionId</td><td>number</td><td>7215873</td></tr><tr><td>activityId</td><td>number</td><td>49717950</td></tr><tr><td>time</td><td>datetime</td><td>yyyy-MM-dd'T'HH:mm:ss,SSSZZZZ</td></tr><tr><td>type</td><td>string</td><td>HeroCard</td></tr><tr><td>heroCard</td><td>array</td><td>struktura HeroCard</td></tr><tr><td>client</td><td>string</td><td>User</td></tr></tbody></table>

<details>

<summary>Struktura HeroCard</summary>

*\[*

*{"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"}]*

*}*

</details>

{% hint style="info" %}
*Parametr "client" může nabývat hodnot (User, Chatbot). V závislosti na tom je vyplněna také hodnota parametru "userId", nebo "chatbotId".*
{% endhint %}

<details>

<summary>Ukázkový JSON:</summary>

```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
  }
}
```

</details>

### SessionActivityHeroCardSubmission

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

<table><thead><tr><th width="185.33333333333331">Parametr</th><th width="236">Hodnota</th><th>Příklad</th></tr></thead><tbody><tr><td>sessionId</td><td>number</td><td>7273902</td></tr><tr><td>originalFormID</td><td>number</td><td>3371</td></tr><tr><td>result</td><td><a href="#herocardsubmissionresult">HeroCardSubmissionResult</a></td><td>submitted</td></tr><tr><td>submittedByClient</td><td>bool</td><td>true</td></tr><tr><td>params</td><td>string</td><td></td></tr><tr><td>time</td><td>datetime</td><td>yyyy-MM-dd'T'HH:mm:ss,SSSZZZZ</td></tr></tbody></table>

{% hint style="info" %}
*Parametr originalFormID označuje id existující HeroCard v mluvii.*
{% endhint %}

{% hint style="info" %}
*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").*
{% endhint %}

{% hint style="success" %}
*Existují i případy, kdy HeroCard potvrdí operátor místo klienta. V takovém případě se uloží do parametru "submittedByClient" hodnota false.*
{% endhint %}

<details>

<summary>Ukázkový JSON:</summary>

```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"
  }
}
```

</details>

### SessionActivityChatToMail

Vyskytuje se v momentě, kdy klient zadá ve [Výstupním formuláři](/pro-administratory/sprava-tenantu/nastaveni/formulare/formulare.md#aaf)  e-mail a zašle si přepis, případně zašle přepis operátor.

<table><thead><tr><th width="185.33333333333331">Parametr</th><th width="237">Hodnota</th><th>Příklad</th></tr></thead><tbody><tr><td>sessionId</td><td>number</td><td>7273902</td></tr><tr><td>activityId</td><td>number</td><td>50108494</td></tr><tr><td>time</td><td>datetime</td><td>yyyy-MM-dd'T'HH:mm:ss,SSSZZZZ</td></tr><tr><td>type</td><td>string</td><td>ChatToMail</td></tr><tr><td>client</td><td>string</td><td>Guest</td></tr></tbody></table>

{% hint style="info" %}
*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.*
{% endhint %}

<details>

<summary>Ukázkový JSON:</summary>

```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
  }
}
```

</details>

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

<table><thead><tr><th width="185.33333333333331">Parametr</th><th width="237">Hodnota</th><th>Příklad</th></tr></thead><tbody><tr><td>sessionId</td><td>number</td><td>7273902</td></tr><tr><td>activityId</td><td>number</td><td>50108494</td></tr><tr><td>time</td><td>datetime</td><td>yyyy-MM-dd'T'HH:mm:ss,SSSZZZZ</td></tr><tr><td>type</td><td>string</td><td>LastFarewellMessage</td></tr><tr><td>text</td><td>string</td><td>Omlouváme se, ale váš požadavek ...</td></tr></tbody></table>

<details>

<summary>Ukázkový JSON:</summary>

```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
  }
}
```

</details>

### SessionActivityPreviewUrl

V sezení se objeví zpráva obsahující URL link.&#x20;

<table><thead><tr><th width="192.33333333333331">Parametr</th><th width="237">Hodnota</th><th>Příklad</th></tr></thead><tbody><tr><td>sessionId</td><td>number</td><td>7273902</td></tr><tr><td>activityId</td><td>number</td><td>50108494</td></tr><tr><td>time</td><td>datetime</td><td>yyyy-MM-dd'T'HH:mm:ss,SSSZZZZ</td></tr><tr><td>type</td><td>string</td><td>PreviewUrl</td></tr><tr><td>client</td><td>string</td><td>User</td></tr><tr><td>previewUrl</td><td>                        -</td><td>                                  -</td></tr><tr><td>.../title</td><td>string</td><td>Seznam - najdu tam, co neznám</td></tr><tr><td>.../imageUrl</td><td>string</td><td>https://www.seznam.cz/media/...</td></tr><tr><td>.../contentType</td><td>number</td><td>1</td></tr><tr><td>.../originalUrl</td><td>string</td><td>https://www.seznam.cz/</td></tr><tr><td>.../originalActivityId</td><td>number</td><td>114253</td></tr><tr><td>userId</td><td>number</td><td>2004014</td></tr></tbody></table>

{% hint style="info" %}
*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.*
{% endhint %}

<details>

<summary>Ukázkový JSON:</summary>

```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
  }
}
```

</details>

### SessionActivityOnHold

Operátor v průběhu tel. hovoru přidrží probíhající hovor (tlačítko "Přidržet hovor").

<table><thead><tr><th width="185.33333333333331">Parametr</th><th width="237">Hodnota</th><th>Příklad</th></tr></thead><tbody><tr><td>sessionId</td><td>number</td><td>7273902</td></tr><tr><td>activityId</td><td>number</td><td>50108494</td></tr><tr><td>time</td><td>datetime</td><td>yyyy-MM-dd'T'HH:mm:ss,SSSZZZZ</td></tr><tr><td>type</td><td>string</td><td>OnHold</td></tr><tr><td>client</td><td>string</td><td>User</td></tr><tr><td>userId</td><td>number</td><td>2710</td></tr></tbody></table>

<details>

<summary>Ukázkový JSON:</summary>

```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
  }
}
```

</details>

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

<table><thead><tr><th width="185.33333333333331">Parametr</th><th width="237">Hodnota</th><th>Příklad</th></tr></thead><tbody><tr><td>sessionId</td><td>number</td><td>7273902</td></tr><tr><td>activityId</td><td>number</td><td>50108494</td></tr><tr><td>time</td><td>datetime</td><td>yyyy-MM-dd'T'HH:mm:ss,SSSZZZZ</td></tr><tr><td>type</td><td>string</td><td>OperatorInviteCanceled</td></tr><tr><td>client</td><td>string</td><td>User</td></tr><tr><td>userId</td><td>number</td><td>2710</td></tr></tbody></table>

<details>

<summary>Ukázkový JSON:</summary>

```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
  }
}
```

</details>

### SessionActivityOperatorInvited

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

<table><thead><tr><th width="203.33333333333331">Parametr</th><th width="237">Hodnota</th><th>Příklad</th></tr></thead><tbody><tr><td>sessionId</td><td>number</td><td>7273902</td></tr><tr><td>activityId</td><td>number</td><td>50108494</td></tr><tr><td>time</td><td>datetime</td><td>yyyy-MM-dd'T'HH:mm:ss,SSSZZZZ</td></tr><tr><td>type</td><td>string</td><td>OperatorInvited</td></tr><tr><td>client</td><td>string</td><td>User</td></tr><tr><td>toOperatorUserId</td><td>number</td><td>4301</td></tr><tr><td>toOperatorFullName</td><td>string</td><td>Jan Novák</td></tr><tr><td>note</td><td>string</td><td>Prosím, připoj se.</td></tr><tr><td>userId</td><td>number</td><td>2710</td></tr></tbody></table>

<details>

<summary>Ukázkový JSON:</summary>

```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
  }
}
```

</details>

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

<table><thead><tr><th width="185.33333333333331">Parametr</th><th width="237">Hodnota</th><th>Příklad</th></tr></thead><tbody><tr><td>sessionId</td><td>number</td><td>7273902</td></tr><tr><td>activityId</td><td>number</td><td>50108494</td></tr><tr><td>time</td><td>datetime</td><td>yyyy-MM-dd'T'HH:mm:ss,SSSZZZZ</td></tr><tr><td>type</td><td>string</td><td>OperatorInviteRejected</td></tr><tr><td>client</td><td>string</td><td>User</td></tr><tr><td>userId</td><td>number</td><td>2710</td></tr></tbody></table>

<details>

<summary>Ukázkový JSON:</summary>

```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
  }
}
```

</details>

### SessionActivityResumeGuest

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

<table><thead><tr><th width="185.33333333333331">Parametr</th><th width="237">Hodnota</th><th>Příklad</th></tr></thead><tbody><tr><td>sessionId</td><td>number</td><td>7273902</td></tr><tr><td>activityId</td><td>number</td><td>50108494</td></tr><tr><td>time</td><td>datetime</td><td>yyyy-MM-dd'T'HH:mm:ss,SSSZZZZ</td></tr><tr><td>type</td><td>string</td><td>ResumeGuest</td></tr><tr><td>client</td><td>string</td><td>User</td></tr><tr><td>userId</td><td>number</td><td>2710</td></tr></tbody></table>

<details>

<summary>Ukázkový JSON:</summary>

```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
  }
}
```

</details>

### SessionActivitySessionEnded

Zaloguje se pokaždé, kdy skončí sezení.&#x20;

<table><thead><tr><th width="188.33333333333331">Parametr</th><th width="237">Hodnota</th><th>Příklad</th></tr></thead><tbody><tr><td>sessionId</td><td>number</td><td>7273902</td></tr><tr><td>activityId</td><td>number</td><td>50108494</td></tr><tr><td>time</td><td>datetime</td><td>yyyy-MM-dd'T'HH:mm:ss,SSSZZZZ</td></tr><tr><td>type</td><td>string</td><td>SessionEnded</td></tr><tr><td>client</td><td>string</td><td>Guest</td></tr><tr><td>userId</td><td>number</td><td>2710</td></tr><tr><td>terminationReason</td><td>string</td><td><a href="#duvod-ukonceni">Důvod ukončení</a></td></tr></tbody></table>

{% hint style="info" %}
*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".*
{% endhint %}

<details>

<summary>Ukázkový JSON:</summary>

```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"
  }
}
```

</details>

### 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".&#x20;

<table><thead><tr><th width="188.33333333333331">Parametr</th><th width="237">Hodnota</th><th>Příklad</th></tr></thead><tbody><tr><td>sessionId</td><td>number</td><td>7273902</td></tr><tr><td>activityId</td><td>number</td><td>50108494</td></tr><tr><td>time</td><td>datetime</td><td>yyyy-MM-dd'T'HH:mm:ss,SSSZZZZ</td></tr><tr><td>type</td><td>string</td><td>SessionForwarded</td></tr><tr><td>client</td><td>string</td><td>User</td></tr><tr><td>toOperatorUserId</td><td>number</td><td>2710</td></tr><tr><td>toGroupId</td><td>number</td><td>7229</td></tr></tbody></table>

{% hint style="info" %}
*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.*
{% endhint %}

<details>

<summary>Ukázkový JSON:</summary>

```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
  }
}
```

</details>

### SessionActivitySharedFile

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

<table><thead><tr><th width="205.33333333333331">Parametr</th><th width="237">Hodnota</th><th>Příklad</th></tr></thead><tbody><tr><td>sessionId</td><td>number</td><td>7273902</td></tr><tr><td>activityId</td><td>number</td><td>50108494</td></tr><tr><td>time</td><td>datetime</td><td>yyyy-MM-dd'T'HH:mm:ss,SSSZZZZ</td></tr><tr><td>type</td><td>string</td><td>SharedFile</td></tr><tr><td>client</td><td>string</td><td>User</td></tr><tr><td>userId</td><td>number</td><td>2710</td></tr><tr><td>File</td><td>                      -</td><td>                                 -                                                                      </td></tr><tr><td>.../id</td><td>number</td><td>2635914</td></tr><tr><td>.../operatorOwner</td><td>number</td><td>2710</td></tr><tr><td>.../departmentOwner</td><td>number</td><td>62</td></tr><tr><td>.../name</td><td>string</td><td>obrazek</td></tr></tbody></table>

{% hint style="info" %}
*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".*
{% endhint %}

<details>

<summary>Ukázkový JSON:</summary>

```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
  }
}
```

</details>

### SessionActivitySharedScreen

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

<table><thead><tr><th width="188.33333333333331">Parametr</th><th width="237">Hodnota</th><th>Příklad</th></tr></thead><tbody><tr><td>sessionId</td><td>number</td><td>7273902</td></tr><tr><td>activityId</td><td>number</td><td>50108494</td></tr><tr><td>time</td><td>datetime</td><td>yyyy-MM-dd'T'HH:mm:ss,SSSZZZZ</td></tr><tr><td>type</td><td>string</td><td>SharedScreen</td></tr><tr><td>client</td><td>string</td><td>User</td></tr><tr><td>userId</td><td>number</td><td>2710</td></tr></tbody></table>

{% hint style="info" %}
*Parametr "client" nabývá hodnot Guest, nebo User. Pokud sdílí obrazovku operátor, uloží se také jeho id do parametru userId.*
{% endhint %}

<details>

<summary>Ukázkový JSON:</summary>

```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
  }
}
```

</details>

### SessionActivityWelcomeMessage

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

<table><thead><tr><th width="188.33333333333331">Parametr</th><th width="237">Hodnota</th><th>Příklad</th></tr></thead><tbody><tr><td>sessionId</td><td>number</td><td>7273902</td></tr><tr><td>activityId</td><td>number</td><td>50108494</td></tr><tr><td>time</td><td>datetime</td><td>yyyy-MM-dd'T'HH:mm:ss,SSSZZZZ</td></tr><tr><td>type</td><td>string</td><td>WelcomeMessage</td></tr><tr><td>text</td><td>string</td><td>Dobrý den, vítejte na chatu.</td></tr><tr><td>userId</td><td>number</td><td>2710</td></tr></tbody></table>

<details>

<summary>Ukázkový JSON:</summary>

```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
  }
}
```

</details>

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

<table><thead><tr><th width="188.33333333333331">Parametr</th><th width="237">Hodnota</th><th>Příklad</th></tr></thead><tbody><tr><td>id</td><td>number</td><td>7293902</td></tr><tr><td>tenantId</td><td>number</td><td>62</td></tr></tbody></table>

<details>

<summary>Ukázkový JSON:</summary>

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

</details>

## E-maily

* [EmailThreadCreated](#emailthreadcreated)
* [EmailThreadOperatorJoined](#emailthreadoperatorjoined)
* [EmailThreadOperatorLeft](#emailthreadoperatorleft)
* [EmailThreadForwarded](#emailthreadforwarded)
* [EmailThreadParamsUpdated](#emailthreadparamsupdated)

### EmailThreadCreated

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

<table><thead><tr><th width="303">Vlastnost</th><th width="134.33333333333331">Hodnota</th><th>Příklad</th></tr></thead><tbody><tr><td>id</td><td>number</td><td>742633</td></tr><tr><td>created</td><td>datetime</td><td>yyyy-MM-dd'T'HH:mm:ss,SSSZZZZ</td></tr><tr><td>tenantId</td><td>number</td><td>62</td></tr></tbody></table>

{% hint style="info" %}
*Tato událost se zaloguje i v případě forwardu e-mailu (přeposlání na jinou e-mailovou adresu) ze strany operátora.*
{% endhint %}

<details>

<summary>Ukázkový JSON:</summary>

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

</details>

### EmailThreadOperatorJoined

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

<table><thead><tr><th width="302">Vlastnost</th><th width="140">Hodnota</th><th>Příklad</th></tr></thead><tbody><tr><td>id</td><td>number</td><td>742633</td></tr><tr><td>time</td><td>datetime</td><td>yyyy-MM-dd'T'HH:mm:ss,SSSZZZZ</td></tr><tr><td>userId</td><td>number</td><td>2710</td></tr><tr><td>tenantId</td><td>number</td><td>62</td></tr></tbody></table>

<details>

<summary>Ukázkový JSON:</summary>

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

</details>

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

<table><thead><tr><th width="302">Vlastnost</th><th width="140">Hodnota</th><th>Příklad</th></tr></thead><tbody><tr><td>id</td><td>number</td><td>742633</td></tr><tr><td>time</td><td>datetime</td><td>yyyy-MM-dd'T'HH:mm:ss,SSSZZZZ</td></tr><tr><td>userId</td><td>number</td><td>2710</td></tr><tr><td>tenantId</td><td>number</td><td>62</td></tr></tbody></table>

<details>

<summary>Ukázkový JSON:</summary>

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

</details>

### EmailThreadForwarded

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

<table><thead><tr><th>Vlastnost</th><th width="141.33333333333331">Hodnota</th><th>Příklad</th></tr></thead><tbody><tr><td>id</td><td>number</td><td>742633</td></tr><tr><td>time</td><td>datetime</td><td>yyyy-MM-dd'T'HH:mm:ss,SSSZZZZ</td></tr><tr><td>userId</td><td>number</td><td>2710</td></tr><tr><td>operatorGroupId</td><td>number</td><td>388</td></tr><tr><td>tenantId</td><td>number</td><td>62</td></tr></tbody></table>

{% hint style="info" %}
*Společně s tímto eventem se zaloguje také EmailThreadOperatorLeft (původní operátor se odpojí).*
{% endhint %}

<details>

<summary>Ukázkový JSON:</summary>

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

</details>

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

<details>

<summary>Ukázkový JSON:</summary>

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

</details>

## Ostatní

* [ApplicationSettingChanged](#applicationsettingchanged)
* [GuestIdentityUpdated](#guestidentityupdated)
* [SessionRecordingPostProcessingCompleted](#sessionrecordingpostprocessingcompleted)
* [UserStatusChanged](#userstatuschanged)

### ApplicationSettingChanged

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

<table><thead><tr><th width="268.3333333333333">Parametr</th><th width="237">Hodnota</th><th>Příklad</th></tr></thead><tbody><tr><td>name</td><td>string</td><td><a href="#vseobecne-nastaveni">všeobecné nastavení</a></td></tr><tr><td>companyId</td><td>number</td><td>1</td></tr><tr><td>departmentId</td><td>number</td><td>62</td></tr></tbody></table>

{% hint style="info" %}
*Pro každou změnu provedenou v* [*nastavení tenantu*](/pro-administratory/sprava-tenantu/nastaveni/aplikace.md#vseobecne)*, vrátí Public API 18 odpovědí.*
{% endhint %}

<details>

<summary>Ukázkový JSON:</summary>

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

</details>

### GuestIdentityUpdated

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

<table><thead><tr><th>Vlastnost</th><th width="210.33333333333331">Hodnota</th><th>Příklad</th></tr></thead><tbody><tr><td>id</td><td>number</td><td>345229</td></tr><tr><td>tenantId</td><td>number</td><td>62</td></tr></tbody></table>

<details>

<summary>Ukázkový JSON:</summary>

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

</details>

### SessionRecordingPostProcessingCompleted

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

<table><thead><tr><th width="300.3333333333333">Parametr</th><th width="164">Hodnota</th><th>Příklad</th></tr></thead><tbody><tr><td>id</td><td>number</td><td>7293902</td></tr><tr><td>tenantId</td><td>number</td><td>62</td></tr></tbody></table>

<details>

<summary>Ukázkový JSON:</summary>

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

</details>

### UserStatusChanged

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

<table><thead><tr><th width="296">Vlastnost</th><th width="169">Hodnota</th><th>Příklad</th></tr></thead><tbody><tr><td>userId</td><td>number</td><td>2710</td></tr><tr><td>status</td><td><a href="#stav-operatora">Stav operátora</a></td><td>ONLINE</td></tr><tr><td>availabilityStatus</td><td><a href="#stav-dostupnosti">Stav dostupnosti operátora</a></td><td>DEFAULT</td></tr><tr><td>availabilityStatusReason</td><td>string</td><td>null</td></tr></tbody></table>

<details>

<summary>Ukázkový JSON</summary>

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

</details>

## Výčtové typy

### HeroCardSubmissionResult

<table><thead><tr><th width="332">Hodnota</th><th>Popis</th></tr></thead><tbody><tr><td>Submitted</td><td>Údaje potvrzeny</td></tr><tr><td>Cancelled</td><td>Vyplnění hero karty zrušeno</td></tr></tbody></table>

### GetMediaResult

<table><thead><tr><th width="336">Hodnota</th><th>Popis</th></tr></thead><tbody><tr><td>Success</td><td>Úspěšný přenos</td></tr><tr><td>NoCameraOnlyMic</td><td>Pouze mikrofon</td></tr><tr><td>NoDevices</td><td>Žádná zařízení pro přenos audio/video</td></tr><tr><td>UserDenied</td><td>Uživatel nepovolil audio/video zařízení</td></tr></tbody></table>

### SessionAVRequestState

<table><thead><tr><th width="340">Hodnota</th><th>Popis</th></tr></thead><tbody><tr><td>Requested</td><td>Vyžádáno</td></tr><tr><td>Accepted</td><td>Přijato</td></tr><tr><td>RejectedUser</td><td>Odmítnuto uživatelem</td></tr><tr><td>RejectedNoMic</td><td>Uživatel nemá mikrofon</td></tr></tbody></table>

### Zdroj sezení

<table><thead><tr><th width="342">Hodnota</th><th>Popis</th></tr></thead><tbody><tr><td>Default</td><td>WebChat</td></tr><tr><td>Callback</td><td>Callback</td></tr><tr><td>Invitation</td><td>Pozvánka</td></tr><tr><td>IncomingCall</td><td>Příchozí hovor</td></tr><tr><td>OutgoingCall</td><td>Odchozí hovor</td></tr><tr><td>Campaign</td><td>Kampaň</td></tr><tr><td>API</td><td>Public API</td></tr><tr><td>Facebook</td><td>Facebook</td></tr><tr><td>WhatsApp</td><td>WhatsApp</td></tr><tr><td>VK</td><td>VKontakte</td></tr><tr><td>Apple</td><td>Apple Messages for Business</td></tr></tbody></table>

### Kanál sezení

<table><thead><tr><th width="343">Hodnota</th><th>Popis</th></tr></thead><tbody><tr><td>AV</td><td>Audio video přenos</td></tr><tr><td>Chat</td><td>Textový kanál</td></tr><tr><td>Phone</td><td>Telefonní hovor</td></tr></tbody></table>

### Stav operátora

<table><thead><tr><th width="349">Hodnota</th><th>Popis</th></tr></thead><tbody><tr><td>OFFLINE</td><td>Odhlášený</td></tr><tr><td>ONLINE</td><td>Dostupný</td></tr><tr><td>AWAY</td><td>Nedostupný</td></tr></tbody></table>

### Stav dostupnosti

<table><thead><tr><th width="351">Hodnota</th><th>Popis</th></tr></thead><tbody><tr><td>DEFAULT</td><td>Online</td></tr><tr><td>AWAY</td><td>Pryč</td></tr><tr><td>ON_CALL</td><td>AV nebo telefonní hovor</td></tr></tbody></table>

### Důvod ukončení

<table><thead><tr><th width="351">Hodnota</th><th>Popis</th></tr></thead><tbody><tr><td>GuestLeft</td><td>Klient se odpojil</td></tr><tr><td>OperatorLeft</td><td>Operátor se odpojil</td></tr><tr><td>ChatbotLeft</td><td>Chatbot se odpojil</td></tr></tbody></table>

### Všeobecné nastavení

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


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.mluvii.com/pro-it-specialisty/public-api/webhooky.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.