Poznámka:
Přístup k této stránce vyžaduje autorizaci. Můžete se zkusit přihlásit nebo změnit adresáře.
Přístup k této stránce vyžaduje autorizaci. Můžete zkusit změnit adresáře.
Microsoft CIFramework poskytuje metody pro použití rozhraní JavaScript API ke správě komunikačního panelu (widgetu), oznámení, karty aplikace, relací, záznamů a formulářů v modelem řízené aplikaci Dynamics 365.
Důležité
- Rozhraní API jsou podporována pouze aktivními poskytovateli kanálů nakonfigurovanými ve vaší organizaci.
- Obslužná rutina události CIFInitDone musí být vyvolána před voláním ostatních rozhraní API.
- Časový limit pro rozhraní API je 100 sekund. Pokud se rozhraní API nespustí do 100 sekund, je nutné je spustit znovu se změněnými parametry nebo rozsahem.
Rozhraní API pro správu komunikačních panelů
Komunikační panel je místo, kde jako agent komunikujete se zákazníkem. Do tohoto panelu se načítají widgety partnerů vytvořené pomocí rozhraní Channel Integration Framework 2.0. Widget v této verzi se zobrazuje vlevo od panelu relace a podporuje režimy Ukotvený, Minimalizovaný a Skrytý.
Ke správě stavu komunikačního panelu (widgetu) použijte následující rozhraní API.
| Methods | Description |
|---|---|
| nastavit šířku | Nastaví šířku panelu pro všechny relace. |
| Získat šířku | Získá šířku panelu v pixelech. |
| Režim nastavení | Slouží k nastavení stavu panelu. |
| Režim getMode | Slouží k nastavení stavu panelu. |
Rozhraní API operací CRUD
K provádění operací CRUD se záznamy entit použijte následující rozhraní API.
| Methods | Description |
|---|---|
| createRecord (vytvořit) záznam | Vytvoří záznam entity. |
| retrieveRecord | Načte záznam entity. |
| Záznam aktualizace | Aktualizuje záznam entity. |
| smazatZáznam | Odstraní záznam entity. |
Rozhraní API pro správu oznámení
Pomocí následujících rozhraní API můžete zobrazit nebo zrušit oznámení o příchozích konverzacích.
| Methods | Description |
|---|---|
| Událost notifyEvent | Zobrazí oznámení, které lze použít k informování agenta o příchozí konverzaci. |
| cancelEvent | Skryje nebo zruší oznámení na základě tokenu zrušení, jak je uvedeno v metodě notifyEvent . |
Rozhraní API pro správu karet aplikací
Pomocí následujících rozhraní API můžete vytvořit a spravovat stav karty aplikace.
| Methods | Description |
|---|---|
| VytvořitTab | Vytvoří kartu s cílem v relaci s cílem a vrátí jedinečný identifikátor vytvořené karty. |
| Získat karty | Vrátí pole identifikátorů karet spojených s názvem šablony nebo značkami šablony pro karty v aktivní relaci, pokud relace patří poskytovateli kanálu. |
| Záložka focusTab | Nastaví vstup na kartu v případě, že relace s cílem patří poskytovateli kanálu a zda karta patří vybrané relaci. |
| getFocusedTab | Vrátí identifikátor karty v prioritní relaci, pokud relace patří poskytovateli. |
| Karta RefreshTab | Obnoví kartu. |
| setTabTitle | Nastaví název karty, pokud vybraná relace patří poskytovateli kanálu a zda karta patří vybrané relaci. |
| zavřítKarta | Zavře určenou kartu v aktuální relaci. |
Rozhraní API pro správu relací
Ke správě relací v prostředí poskytovatele s více relacemi použijte následující rozhraní API.
| Methods | Description |
|---|---|
| canCreateSession | Umožňuje zkontrolovat, zda lze vytvořit novou relaci. |
| createSession | Vytvoří relaci založenou na šabloně relace definované jako součást šablony a vrátí jedinečný identifikátor relace, která byla vytvořena. |
| Získání relace | Vrací objekt obsahující jedinečný identifikátor relace, kontext a hodnotu parametru isFocused , pokud relace patří poskytovateli kanálu. |
| getFocusedSession | Vrátí jedinečný identifikátor vybrané relace, pokud patří poskytovateli kanálu, jinak vrátí hodnotu null. |
| getAllSessions | Vrátí pole identifikátorů relace pro poskytovatele kanálu. |
| setSessionTitle | Nastaví název relace, pokud relace patří poskytovateli kanálu. |
| requestFocusSession | Nastaví fokus na relaci, jejíž identifikátor relace je předán jako parametr, pokud relace patří poskytovateli kanálu. |
Rozhraní API pro analýzu kanálů
Ke sledování analýzy událostí použijte následující rozhraní API.
| Methods | Description |
|---|---|
| logAnalyticsEvent | Tuto metodu vyvolejte k protokolování Analytics pro vlastní události. |
Rozhraní API indikátoru relace
Pomocí následujících rozhraní API můžete označit porušení klíčových ukazatelů výkonu (KPI) a aktualizovat počet nových aktivit v konkrétní relaci.
| Methods | Description |
|---|---|
| notifyKpiBreach | Tato metoda se používá k označení porušení klíčového ukazatele výkonu. Při použití této metody se na obraze kontaktu zobrazí červený kruh, pokud dojde k porušení klíčového ukazatele výkonu. |
| notifyNewActivity | Tato metoda se používá k aktualizaci počtu nových aktivit v konkrétní relaci. |
Rozhraní API stavu
Pomocí těchto rozhraní API můžete programově nastavit a načíst přítomnost agenta Omnichannel. Tyto metody můžete použít, když smíšený agent pracuje na aplikaci jiného výrobce než Microsoft s omnikanálem a chcete synchronizovat stavy přítomnosti mezi různými aplikacemi, abyste zajistili optimální využití kapacity agenta.
| Methods | Description |
|---|---|
| setPresence | Umožňuje programové nastavení přítomnosti pro agenta v relaci klienta. |
| Přítomnost v systému získání | Umožňuje programově vrátit přítomnost agentovi v relaci klienta. |
Různé metody
| Methods | Description |
|---|---|
| Metadata getEntityMetadata | Vrátí metadata entity pro zadanou entitu. |
| setClickToAct | Nastaví logickou hodnotu pro povolení nebo zakázání odchozí komunikace (ClickToAct). |
| getClickToAct | Vrací logickou hodnotu, která označuje, zda je odchozí komunikace (ClickToAct) povolena nebo ne. |
| searchAndOpenRecords | Metoda vyhledá záznam z widgetu komunikace při příchozí komunikaci a záznam otevře. |
| getEnvironment | Získá aktuální aplikaci Sjednocené rozhraní a podrobnosti o stránce. Mezi tyto podrobnosti patří ID aplikace (appid), pageType (pageType), ID záznamu (id), geografie organizace (orgGeo) a typ navigace v relaci (navigationType). |
| Otevřený formulář | Otevře formulář entity nebo formulář pro rychlé vytvoření. |
| renderSearchPage | Umožňuje vyhledávat mezi záznamy konkrétního typu entity. Toto API otevře stránku entity v Sjednoceném rozhraní, kde je vyhledávací pole předem vyplněno vyhledávacím řetězcem, který je předán jako parametr. |
| addHandler | Přidá odběratele k událostem.
Poznámka: Toto rozhraní API lze použít jak na stránce widgetu, tak na stránce Sjednoceného rozhraní. |
| obslužná rutina removeHandler | Odebere odběratele z událostí.
Poznámka: Toto rozhraní API lze použít jak na stránce widgetu, tak na stránce Sjednoceného rozhraní. |
| raiseEvent | Vyvolá přidruženého odběratele pro událost.
Poznámka: Pokud jste vytvořili vlastní události pomocí metody addHandler, můžete tyto události vyvolat předáním názvu události jako parametru v této metodě. |
| Kontext aktualizace | Tato metoda umožňuje nastavit slovník automatizace. |
| updateConversation (AktualizaceKonverzace) | Tato metoda umožňuje aktualizovat záznam konverzace. |
Související informace
Co je nového v Dynamics 365 Channel Integration Framework
Systémové požadavky pro Dynamics 365 Channel Integration Framework 2.0