Microsoft.CIFramework-Methoden (JavaScript API Referenz) für Dynamics 365-Kanalintegrationsframework 2.0

Artikel
02/07/2024

Microsoft CIFramework bietet Methoden zur Verwendung der JavaScript-API zum Verwalten des Kommunikationsbereichs (Widget), der Benachrichtigung, der Anwendungsregisterkarte, Sitzungen, Datensätze und Formulare in der modellgesteuerten Dynamics 365 App.

Wichtig

Die APIs werden nur von den aktiven Kanalanbietern unterstützt, die in Ihrer Organisation konfiguriert sind.
Der CIFInitDone-Ereignishandler muss vor dem Aufruf der anderen APIs aufgerufen werden.
Das Timeout-Limit für die APIs beträgt 100 Sekunden. Wenn die APIs nicht innerhalb von 100 Sekunden ausgeführt werden, müssen sie mit geänderten Parametern oder geändertem Umfang erneut ausgeführt werden.

Kommunikationsbereich für die APIs Verwaltung

Der Kommunikationsbereich ist der Ort, an dem Sie sich als Agent mit Kunden in Verbindung setzen. In diesem Bereich werden Partner-Widgets geladen, die mit Kanalintegdrationsframework 2.0 erstellt wurden. Das Widget in dieser Version wird links vom Sitzungsbereich angezeigt und unterstützt die Modi Angehefted, Minimiert und Ausgeblendet.

Verwenden Sie die folgenden APIs, um den Status des Kommunikationsbereichs (Widgets) zu verwalten.

Methoden	Beschreibung
setWidth	Legt die Bereichsbreite für alle Sitzungen fest.
getWidth	Ruft die Bereichsbreite in Pixel ab.
setMode	Legt den Bereichsstatus fest.
getMode	Legt den Bereichsstatus fest.

CRUD-Operationen APIs

Verwenden Sie die folgenden APIs, um CRUD-Vorgänge für Entitätsdatensätze durchzuführen.

Methoden	Beschreibung
createRecord	Erstellt einen Entitätsdatensatz.
retrieveRecord	Ruft einen Entitätsdatensatz ab.
updateRecord	Aktualisiert einen Entitätsdatensatz.
deleteRecord	Löscht einen Entitätsdatensatz.

APIs für das Benachrichtigungsmanagement

Verwenden Sie die folgenden APIs, um Benachrichtigungen über eingehende Unterhaltungen anzuzeigen oder abzubrechen.

Methoden	Beschreibung
notifyEvent	Zeigt eine Benachrichtigung an, mit der der Agent über ein eingehendes Gespräch informiert werden kann.
cancelEvent	Versteckt oder storniert eine Benachrichtigung basierend auf dem Abbruchtoken, wie in der `notifyEvent` -Methode angegeben.

APIs für die Verwaltung von Anwendungsregisterkarten

Verwenden Sie die folgenden APIs, um den Status der Anwedungsregisterkarte zu verwalten.

Methoden	Beschreibung
createTab	Erstellt eine Registerkarte in einer fokussierten Sitzung und gibt die eindeutige Kennung der erstellten Registerkarte zurück.
getTabs	Gibt ein Array von Registerkartenbezeichnern zurück, die mit Vorlagennamen oder Vorlagentags für Registerkarten in der Sitzung im Fokus verknüpft sind, wenn die Sitzung zum Kanalanbieter gehört.
focusTab	Legt den Fokus auf eine Registerkarte fest, wenn die fokussierte Sitzung zum Kanalanbieter gehört und wenn die Registerkarte zur fokussierten Sitzung gehört.
getFocusedTab	Gibt den Registerkarten-Bezeichner in einer fokussierten Sitzung zurück, wenn die Sitzung zum Anbieter gehört.
refreshTab	Registerkarte aktualisieren.
setTabTitle	Legt den Titel auf eine Registerkarte fest, wenn die fokussierte Sitzung zum Kanalanbieter gehört und wenn die Registerkarte zur fokussierten Sitzung gehört.
Tab schließen	Schließt die angegebene Registerkarte in der aktuellen Sitzung.

Sitzungsverwaltungs-APIs

Verwenden Sie die folgenden APIs, um Sitzungen in einer Multisession-Anbieterumgebung zu verwalten.

Methoden	Beschreibung
canCreateSession	Ermöglicht Ihnen zu überprüfen, ob eine neue Sitzung erstellt werden kann.
createSession	Erstellt eine Sitzung basierend auf der als Teil der Vorlage definierten Sitzungsvorlage und gibt den eindeutigen Bezeichner der erstellten Sitzung zurück.
getSession	Gibt ein Objekt zurück, das die eindeutige Kennung der Sitzung, den Kontext und den Wert des Parameters `isFocused` enthält, wenn die Sitzung zum Kanalanbieter gehört.
getFocusedSession	Gibt den eindeutigen Bezeichner der Sitzung zurück, die im Fokus steht, wenn sie zum Kanalanbieter gehört, andernfalls wird null zurückgegeben.
getAllSessions	Gibt das Array von Sitzungskennungen für einen Kanalanbieter zurück.
setSessionTitle	Legt den Sitzungstitel fest, wenn die Sitzung zum Kanalanbieter gehört.
requestFocusSession	Legt den Fokus auf die Sitzung, deren Sitzungskennung als Parameter übergeben wird, wenn die Sitzung zum Kanalanbieter gehört.

Kanalanalyse-APIs

Verwenden Sie die folgenden APIs, um Ereignisanalysen zu verfolgen.

Methoden	Beschreibung
logAnalyticsEvent	Rufen Sie diese Methode für die Protokollierung von benutzerdefinierten Ereignisse ab.

Sitzungsindikator-APIs

Verwenden Sie die folgenden APIs, um einen Verstoß gegen Key Performance Indicator (KPI) anzuzeigen und die Anzahl neuer Aktivitäten in einer bestimmten Sitzung zu aktualisieren.

Methoden	Beschreibung
notifyKpiBreach	Diese Methode wird verwendet, um einen KPI-Verstoß anzuzeigen. Wenn diese Methode verwendet wird, erscheint ein roter Kreis auf dem Anzeigebild des Kontakts, wenn ein KPI-Verstoß aufgetreten ist.
notifyNewActivity	Diese Methode wird verwendet, um die Anzahl neuer Aktivitäten in einer bestimmten Sitzung zu aktualisieren.

Präsenz-APIs

Verwenden Sie diese APIs, um die Omnichannel-Agentenpräsenz programmgesteuert festzulegen und abzurufen. Sie können diese Methoden verwenden, wenn ein gemischter Agent an einer Drittanbieteranwendung mit Omnichannel arbeitet und Sie die Anwesenheitsstatus zwischen verschiedenen Anwendungen synchronisieren möchten, um sicherzustellen, dass die Agentenkapazität optimal genutzt wird.

Methoden	Beschreibung
setPresence	Ermöglicht die programmgesteuerte Festlegung der Anwesenheit des Agenten in der Clientsitzung.
getPresence	Ermöglicht die programmgesteuerte Festlegung der Anwesenheit des Agenten in der Clientsitzung.

Verschiedene Methoden

Methoden	Beschreibung
getEntityMetadata	Gibt die Entitätsmetadaten für die angegebene Entität zurück.
setClickToAct	Legt einen Booleschen Wert fest, um ausgehende Kommunikation (ClickToAct) zu aktivieren oder zu deaktivieren.
getClickToAct	Gibt einen Booleschen Wert zurück, um anzugeben, ob die ausgehende Kommunikation (ClickToAct) aktiviert ist oder nicht.
searchAndOpenRecords	Das Verfahren sucht während des Nachrichteneingangs nach dem Datensatz aus dem Kommunikations-Widget und öffnet ihn.
getEnvironment	Ruft die aktuellen App- und Seiteninformationen der Einheitlichen Oberfläche ab. Zu den Details gehören Anwendungs-ID (appid), der PageType (pageType), die Datensatz-ID (id), Organisationsgeografie (orgGeo) und der Sitzungsnavigationstyp (navigationType).
openForm	Öffnet ein Entitätsformular oder ein Schnellerfassungsformular.
renderSearchPage	Ermöglicht die Suche in Datensätzen eines bestimmten Entitätstyps. Die API öffnet die Entitätsseite der einheitlichen Oberfläche mit vorab ausgefülltem Suchfeld und der Suchzeichenfolge, die als Parameter übergeben wird.
addHandler	Fügen Sie den Abonnenten den Ereignissen hinzu. Anmerkung Diese API kann sowohl auf dem Widget als auch auf der Einheitliche Oberfläche-Seite verwendet werden.
removeHandler	Entfernt den Abonnenten aus den Ereignissen. Anmerkung Diese API kann sowohl auf dem Widget als auch auf der Einheitliche Oberfläche-Seite verwendet werden.
raiseEvent	Ruft den zugehörigen Abonnenten für das Ereignis auf. Anmerkung Wenn Sie benutzerdefinierte Ereignisse mit der addHandler-Methode erstellt haben, können Sie diese Ereignisse auslösen, indem Sie den Ereignisnamen als Parameter in dieser Methode übergeben.
updateContext	Mit dieser Methode können Sie das Automatisierungswörterbuch einstellen.
updateConversation	Rufen Sie diese Methode auf, um einen Unterhaltungsdatensatz zu aktualisieren.

Siehe auch

Was ist neu in Dynamics 365 Kanalintegrationsframework
Systemanforderungen für Dynamics 365 Kanalintegrationsframework 2.0

Teilen über