}
```
### ObtainCrmIdentity
Vrací seznam existujících záznamů z Adresáře Kontaktů, u kterých je nalezena alespoň minimální shoda v identifikačních údajích klienta v daném sezení (např. klientovo jméno, tel. číslo, e-mail, ...).
{% hint style="info" %}
*Chování je identické jako v případě sezení se živým operátorem, který dostává informace o nalezených shodách s existujícími záznamy v Adresáři Kontaktů.*
{% endhint %}
Request JSON:
```json
{
"activity": "ObtainCrmIdentity",
"sessionId": 7418277
}
```
Odpověď aktivity:
{
"activity": "ObtainCrmIdentityResponse",
"assignedCrmIdentityId": null,
"matchedCrmIdentities": [
{
"crmIdentityId": 9943973,
"score": 95,
"data": {
"oo1_guest_facebook_psid": [
"1901491179944737",
"2075406945856826"
],
"oo1_guest_guid": [
"09ac8a24-b342-14e5-f1cd-6cdf50c5a25e"
],
"oo1_guest_email": [
"marek.maly@gmail.com",
"marek48@gmail.com",
"malymarek@gmail.com",
"maly@mluvii.com"
],
"CrmUrl": [
"https://org39940337.crm4.dynamics.com/main.aspx?app=d365default&forceUCI=1&pagetype=entityrecord&etn=contact&id="
],
"oo1_guest_phone": [
"+420258963147"
]
}
},
{
"crmIdentityId": 8527408,
"score": 64,
"data": {
"oo1_guest_facebook_psid": [
"1901491179944737"
],
"oo1_guest_guid": [
"8cc011e1-3889-9e58-2dba-07bc824ffbb3"
],
"oo1_guest_email": [
"karelsdfdfserwer"
],
"oo1_guest_phone": [
"16567879778"
]
}
}
}
{% hint style="success" %}
*Často se může stát, že výsledků API vrátí více a bude na vás, podle jakého klíče označíte nejrelevantnější záznam, který chatbot vybere pro přiřazení klientské identity. Jako vodítko můžete použít parametr "score".*
{% endhint %}
### AssignCrmIdentity
Používá se pro přiřazení klientské identity k existujícímu či novému záznamu v Adresáři kontaků. Typicky tento request zavoláte na základě výsledku [ObtainCrmIdentity](#obtaincrmidentity).
Request JSON:
```json
{
"activity": "AssignCrmIdentity",
"existingCrmIdentityId": 9943973,
"sessionId": 7418277
}
```
Odpověď activity:
```json
{
"activity": "AssignCrmIdentityResponse",
"created": false,
"crmIdentityId": 9943973,
"sessionId": 7417841,
"language": "en",
"source": "Default"
}
```
{% hint style="success" %}
*Jestliže v odpovědi na activitu ObtainCrmIdentity dostanete záznamy s určitou shodou, použijete v requestu hodnotu parametru "crmIdentityID". Pokud žádné shody nejsou nalezeny, jako hodnotu parametru "crmIdentityId" použijete "null".*
{% endhint %}
{% hint style="info" %}
*V odpovědi activity si můžete všimnout parametru "created", který nabývá hodnot "true" při vytváření nového záznamu a hodnoty "false" při napárování na existující záznam v Adresáři Kontaktů.*
{% endhint %}
### Attachment
Odesílá soubor do chatu (soubor není uložen v Souborech, ale nachází se např. na lokálním disku) .
Request JSON:
```json
{
"activity": "Attachment",
"file": , (file URL loaded by a guest)
"sessionId": 7418277
}
```
### ShareFile
Odešle soubor do chatu. Lze provést dvěma způsoby:
#### ShareFile (name)
Kombinace GetMediaObjects, což slouží k získání seznamu všech souborů uložených v Souborech (name + id). V druhém kroku použijete v rámci aktivity ShareFile *name* konkrétního souboru.
**Příklad:** Request JSON s použitím *name*:
```json
{
"sessionId": ,
"activity": "ShareFile",
"name":
}
```
#### ShareFile (URL)
Volání aktivity ShareFile s URL souboru hostovaného mimo mluvii.
**Příklad:** Request JSON s použitím *url*:
```json
{
"sessionId": ,
"activity": "ShareFile",
"url":
}
```
Odpověď aktivity:
{
"activity": "ShareFileResponse",
"isSuccess": <boolean>,
"errorMessage": <string>,
"fileSource": "<string>",
"sessionId": <integer>,
"language": <string>,
"source": <string>
}
{% hint style="info" %}
*Pokud chcete zasílat do chatu URL na Youtube video, použijte typ "message" a URL vkládejte do "textu".*
{% endhint %}
**Přehled povolených souborů pro daný kanál**
Na úrovni společnosti se dají omezit povolené soubory - tato tabulka z ní vychází a upřesňuje, které soubory jsou pro který kanál funkční. Například poslání a přehrání mp3 souboru funguje pro WhatsApp sezení, ale nikoliv pro Facebook.
| File type | WebChat | Facebook Messenger | WhatsApp | Apple Messages for Business | VKontakte |
|---|
| WAV | ✔ | ✘ | ✘ | ✔ | ✔ |
| MP3 | ✔ | ✘ | ✔ | ✔ | ✔ |
| MP4 | ✔ | ✘ | ✔ | ✔ | ✔ |
| JPG | ✔ | ✔ | ✔ | ✔ | ✔ |
| PNG | ✔ | ✔ | ✔ | ✔ | ✔ |
| GIF | ✔ | ✔ | ✔ | ✔ | ✔ |
| PDF | ✔ | ✔ | ✔ | ✔ | ✔ |
| TXT | ✔ | ✔ | ✔ | ✔ | ✔ |
### RequestLocation
Chatbot si vyžádá lokaci klienta skrze internetový prohlížeč a je schopen získat lokaci z desktop i mobilního zařízení.
Request JSON:
```json
{
"activity": "RequestLocation",
"sessionId":
}
```
Odpověď aktivity:
{
"activity": "GuestLocation",
"sessionId": <integer>
}
### Adaptive cards
API podporuje formátování zpráv podle standardu .
Příklad použití adaptive card carousel:
```json
{
"sessionId": ,
"type": "message",
"timestamp": "2020-06-12T12:13:39.7593384+02:00",
"attachmentLayout": "carousel",
"attachments": [
{
"contentType": "application/vnd.microsoft.card.hero",
"content": {
"title": "Street #1",
"subtitle": "1. Street Foo 254 Czechia",
"images": [
{
"url": "https://dev.virtualearth.net/REST/V1/Imagery/Map/Road?form=BTCTRL&mapArea=49.7463607788086,13.1083498001099,49.7932815551758,13.1951398849487&mapSize=500,280&pp=49.7616882324219,13.1491804122925;1;1&dpi=1&logo=always&key=ApBn8xoItlENbFx-rr1kzt_JakWdFTH24taCasYxQCgit15NtDeYrztO4chDtrg5"
}
],
"buttons": [
{
"type": "imBack",
"title": "Street Foo 254",
"value": 1
}
]
}
},
{
"contentType": "application/vnd.microsoft.card.hero",
"content": {
"title": "Street #2",
"subtitle": "1. Ulice, Plzeň, Czechia",
"images": [
{
"url": "https://dev.virtualearth.net/REST/V1/Imagery/Map/Road?form=BTCTRL&mapArea=49.7463607788086,13.1083498001099,49.7932815551758,13.1951398849487&mapSize=500,280&pp=49.7616882324219,13.1491804122925;1;1&dpi=1&logo=always&key=ApBn8xoItlENbFx-rr1kzt_JakWdFTH24taCasYxQCgit15NtDeYrztO4chDtrg5"
}
],
"buttons": [
{
"type": "imBack",
"title": "Ulice, Plzeň, Czechia",
"value": 1
}
]
}
},
{
"contentType": "application/vnd.microsoft.card.hero",
"content": {
"title": "Street #2 again",
"subtitle": "1. Ulice, Plzeň, Czechia",
"images": [
{
"url": "https://dev.virtualearth.net/REST/V1/Imagery/Map/Road?form=BTCTRL&mapArea=49.7463607788086,13.1083498001099,49.7932815551758,13.1951398849487&mapSize=500,280&pp=49.7616882324219,13.1491804122925;1;1&dpi=1&logo=always&key=ApBn8xoItlENbFx-rr1kzt_JakWdFTH24taCasYxQCgit15NtDeYrztO4chDtrg5"
}
],
"buttons": [
{
"type": "imBack",
"title": "Ulice, Plzeň, Czechia",
"value": 1
}
]
}
}
]
}
```
### Buttons
Tlačítka lze poslat pomocí [adaptive cards](https://adaptivecards.io/explorer).
Request JSON:
```json
{
"type": "message",
"timestamp": "2020-09-09T10:03:53.4976861+02:00",
"attachments": [
{
"contentType": "application/vnd.microsoft.card.hero",
"content": {
"title": "Test buttons",
"buttons": [
{
"type": "imBack",
"title": "Title of first button",
"value": "Value of first button"
},
{
"type": "imBack",
"title": "Title of second button",
"value": "Value of second button"
}
]
}
}
]
}
```
Odpověď na vybrané tlačítko (Button 2) je pak aktivita typu *Text* v následujícím formátu:
```json
{
"activity": "Text",
"timestamp": "2020-12-04T16:12:57.172",
"text": "Button 2",
"sessionId": 13,
"language": "cs",
"source": "Facebook"
}
```
## Eventy
### Příchozí zpráva
Jakmile klient odešle textovou zprávu do chatu, v Callback URL se zobrazí následující aktivita:
```
{
"sessionId": 1,
"activity": "Text",
"text": "Hello world"
}
```
### Příchozí soubor
Pokud klient nahraje soubor pomocí kancelářské sponky ve vstupním poli chatu, přijde botovi Aktivita v následujícím formátu.
```
{
"activity": "GuestFileUpload",
"fileUrl": , (file URL loaded by a guest)
}
```
---
# 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/napojeni-chatbotu/podporovane-aktivity.md?ask=
```
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.