Nuta
Dostęp do tej strony wymaga autoryzacji. Możesz spróbować się zalogować lub zmienić katalog.
Dostęp do tej strony wymaga autoryzacji. Możesz spróbować zmienić katalogi.
Microsoft CIFramework udostępnia metody korzystania z interfejsu API JavaScript do zarządzania panelem komunikacji (widżetem), powiadomieniem, zakładką aplikacji, sesjami, rekordami i formularzami w aplikacji opartej na modelu Dynamics 365.
Ważne
- Interfejsy API są obsługiwane tylko przez aktywnych dostawców kanałów skonfigurowanych w organizacji.
- Procedura obsługi zdarzeń CIFInitDone musi zostać wywołana przed wywołaniem innych interfejsów API.
- Limit czasu dla interfejsów API wynosi 100 sekund. Jeśli interfejsy API nie zostaną uruchomione w ciągu 100 sekund, należy je uruchomić ponownie ze zmienionymi parametrami lub zakresem.
Interfejsy API do zarządzania panelami komunikacyjnymi
Panel komunikacyjny to miejsce, w którym Ty jako agent wchodzisz w interakcję z klientem. Widżety partnerów utworzone przy użyciu Channel Integration Framework 2.0 są ładowane w tym panelu. Widżet w tej wersji jest wyświetlany po lewej stronie panelu sesji i obsługuje tryby zadokowany, zminimalizowany i ukryty.
Użyj następujących interfejsów API, aby zarządzać stanem panelu komunikacyjnego (widżetu).
| Methods | Description |
|---|---|
| setWidth (Szerokość) | Ustawia szerokość panelu dla wszystkich sesji. |
| getWidth (Szerokość Pojazdu) | Pobiera szerokość panelu w pikselach. |
| setMode (Tryb zestawu) | Ustawia stan panelu. |
| getMode (tryb getMode) | Ustawia stan panelu. |
Interfejsy API operacji CRUD
Użyj następujących interfejsów API, aby wykonywać operacje CRUD na rekordach encji.
| Methods | Description |
|---|---|
| createRecord (utwórzRekord) | Tworzy rekord encji. |
| Rekord pobierania | Pobiera rekord encji. |
| Rekord updateRecord (Rekord aktualizacji | Aktualizuje rekord encji. |
| deleteRecord (Rekord usuń) | Usuwa rekord encji. |
Interfejsy API zarządzania powiadomieniami
Użyj następujących interfejsów API, aby wyświetlić lub anulować powiadomienia o przychodzących konwersacjach.
| Methods | Description |
|---|---|
| notifyEvent (powiadomienie) | Wyświetla powiadomienie, które może być używane do informowania agenta o przychodzącej rozmowie. |
| cancelEvent (anulowaćZdarzenie) | Ukrywa lub anuluje powiadomienie na podstawie tokenu anulowania, zgodnie z opisem notifyEvent w metodzie. |
Interfejsy API zarządzania kartami aplikacji
Użyj następujących interfejsów API, aby utworzyć stan karty aplikacji i zarządzać nim.
| Methods | Description |
|---|---|
| createTab (utwórz) | Tworzy kartę w sesji z fokusem i zwraca unikatowy identyfikator utworzonej karty. |
| getTabs (Zakładki GetTabs) | Zwraca tablicę identyfikatorów kart powiązanych z nazwą szablonu lub tagami szablonu dla kart w sesji, na której aktywna jest aktywność, jeśli sesja należy do dostawcy kanału. |
| fokusTab | Ustawia fokus na karcie, jeśli aktywna sesja należy do dostawcy kanału i czy karta należy do sesji, na której aktywny jest fokus. |
| getFocusedTab (Zakładka Skoncentrowany) | Zwraca identyfikator karty w sesji z fokusem, jeśli sesja należy do dostawcy. |
| refreshTab (odświeżaćTab) | Odświeża kartę. |
| setTabTitle (Tytuł zakładki) | Ustawia tytuł karty, jeśli aktywna sesja należy do dostawcy kanału i czy karta należy do sesji, na której aktywny jest tytuł. |
| closeTab | Zamyka określoną kartę w bieżącej sesji. |
Interfejsy API zarządzania sesjami
Następujące interfejsy API służą do zarządzania sesjami w środowisku dostawcy z wieloma sesjami.
| Methods | Description |
|---|---|
| canCreateSession | Umożliwia sprawdzenie, czy można utworzyć nową sesję. |
| createSession (UtwórzSesja) | Tworzy sesję na podstawie szablonu sesji zdefiniowanego jako część szablonu i zwraca unikatowy identyfikator utworzonej sesji. |
| getSession (sesja get) | Zwraca obiekt zawierający unikatowy identyfikator sesji, kontekst i wartość parametru isFocused , jeśli sesja należy do dostawcy kanału. |
| getFocusedSession (sesja skupienia) | Zwraca unikatowy identyfikator sesji, która jest aktywna, jeśli należy do dostawcy kanału, w przeciwnym razie zwraca wartość null. |
| getAllSessions (Sesje getAll) | Zwraca tablicę identyfikatorów sesji dla dostawcy kanału. |
| setSessionTitle (Tytuł sesji) | Ustawia tytuł sesji, jeśli sesja należy do dostawcy kanału. |
| requestFocusSession (sesja żądania) | Ustawia fokus na sesji, której identyfikator sesji jest przekazywany jako parametr, jeśli sesja należy do dostawcy kanału. |
Interfejsy API analizy kanałów
Użyj następujących interfejsów API, aby śledzić analizę zdarzeń.
| Methods | Description |
|---|---|
| logAnalyticsEvent (zdarzenie logAnalytics) | Wywołaj tę metodę, aby zalogować się do analizy dla zdarzeń niestandardowych. |
Interfejsy API wskaźnika sesji
Poniższe interfejsy API służą do wskazywania naruszenia kluczowych wskaźników wydajności (KPI) i aktualizowania liczby nowych działań w danej sesji.
| Methods | Description |
|---|---|
| notify KpiBreach (powiadomienieKpiBreach | Ta metoda służy do wskazywania naruszenia wskaźnika KPI. Gdy ta metoda jest używana, na obrazie wyświetlanym kontaktu pojawia się czerwone kółko, gdy wystąpiło naruszenie wskaźnika KPI. |
| notifyNewActivity (powiadomienie) | Ta metoda służy do aktualizowania liczby nowych działań w danej sesji. |
Interfejsy API obecności
Użyj tych interfejsów API, aby programowo ustawić i pobrać obecność agenta obsługi wielokanałowej. Tych metod można używać, gdy agent mieszany pracuje nad aplikacją inną niż Microsoft z obsługą wielokanałową i chcesz zsynchronizować stany obecności między różnymi aplikacjami, aby zapewnić optymalne wykorzystanie pojemności agenta.
| Methods | Description |
|---|---|
| setPresence (Obecność zestawu) | Umożliwia programowe ustawienie obecności dla agenta w sesji klienta. |
| getPresence (Obecność Danych) | Umożliwia programowe zwracanie informacji o obecności dla agenta w sesji klienta. |
Różne metody
| Methods | Description |
|---|---|
| getEntityMetadata | Zwraca metadane jednostki dla określonej jednostki. |
| setClickToAct | Ustawia wartość logiczną w celu włączenia lub wyłączenia komunikacji wychodzącej (ClickToAct). |
| getClickToAct | Zwraca wartość logiczną wskazującą, czy komunikacja wychodząca (ClickToAct) jest włączona, czy nie. |
| searchAndOpenRecords (szukajAndOpenRecords) | Metoda wyszukuje rekord z widgetu komunikacji podczas komunikacji przychodzącej i otwiera rekord. |
| getEnvironment (Środowisko GetEnvironment) | Pobiera bieżące szczegóły aplikacji i strony ujednoliconego interfejsu. Szczegóły obejmują identyfikator aplikacji (appid), pageType (pageType), identyfikator rekordu (id), geografię organizacji (orgGeo) i typ nawigacji sesji (navigationType). |
| Otwarty formularz | Otwiera formularz encji lub formularz szybkiego tworzenia. |
| renderSearchPage (strona renderowania) | Umożliwia wyszukiwanie między rekordami określonego typu encji. Ten interfejs API otwiera stronę encji Ujednolicony interfejs z polem wyszukiwania wstępnie wypełnionym ciągiem wyszukiwania, który jest przekazywany jako parametr. |
| addHandler (Dodatek Obsługi) | Dodaje subskrybenta do wydarzeń.
Uwaga / Notatka Ten interfejs API może być używany zarówno na widżecie, jak i na stronie ujednoliconego interfejsu. |
| removeHandler (usuń program obsługi | Usuwa subskrybenta ze zdarzeń.
Uwaga / Notatka Ten interfejs API może być używany zarówno na widżecie, jak i na stronie ujednoliconego interfejsu. |
| raiseEvent (Zdarzenie podbicia) | Wywołuje skojarzonego subskrybenta zdarzenia.
Uwaga / Notatka Jeśli zdarzenia niestandardowe zostały utworzone przy użyciu metody addHandler, możesz zgłosić te zdarzenia, przekazując nazwę zdarzenia jako parametr w tej metodzie. |
| updateContext (Kontekst aktualizacji) | Ta metoda pozwala na ustawienie słownika automatyzacji. |
| updateRozmowa | Ta metoda umożliwia zaktualizowanie rekordu konwersacji. |
Informacje pokrewne
Co nowego w Dynamics 365 Channel Integration Framework
Wymagania systemowe dla Dynamics 365 Channel Integration Framework 2.0