Kommentar
Åtkomst till den här sidan kräver auktorisering. Du kan prova att logga in eller ändra kataloger.
Åtkomst till den här sidan kräver auktorisering. Du kan prova att ändra kataloger.
Microsoft CIFramework tillhandahåller metoder för att använda JavaScript API för att hantera kommunikationspanelen (widget), meddelandet, programfliken, sessioner, poster och formulär i den modellbaserade Dynamics 365-appen.
Viktigt!
- API:erna stöds endast från de aktiva kanalproviders som konfigurerats i din organisation.
- Händelsehanteraren CIFInitDone måste anropas innan de andra API:erna anropas.
- Timeout-gränsen för API:erna är 100 sekunder. Om API:erna inte körs inom 100 sekunder måste de köras igen med ändrade parametrar eller omfång.
API:er för hantering av kommunikationspaneler
Kommunikationspanelen är den plats där du som agent interagerar med kunden. Partnerwidgetar som skapats med Channel Integration Framework 2.0 läses in i den här panelen. Widgeten i den här versionen visas till vänster om sessionspanelen och har stöd för dockat, minimerat och dolt läge.
Använd följande API:er för att hantera tillståndet för kommunikationspanelen (widget).
| Methods | Description |
|---|---|
| setWidth (setWidth) | Ställer in panelbredden för alla sessioner. |
| getWidth | Hämtar panelens bredd i pixlar. |
| setMode (setMode) | Ställer in panelens tillstånd. |
| getMode | Ställer in panelens tillstånd. |
API:er för CRUD-åtgärder
Använd följande API:er för att utföra CRUD-åtgärder på entitetsposter.
| Methods | Description |
|---|---|
| createRecord | Skapar en entitetspost. |
| retrieveRecord | Hämtar en entitetspost. |
| updateRecord | Uppdaterar en entitetspost. |
| ta bortSpela in | Tar bort en entitetspost. |
API:er för meddelandehantering
Använd följande API:er för att visa eller avbryta meddelanden om inkommande konversationer.
| Methods | Description |
|---|---|
| notifyEvent | Visar ett meddelande som kan användas för att informera handläggaren om en inkommande konversation. |
| cancelEvent | Döljer eller avbryter ett meddelande baserat på annulleringstoken, enligt vad notifyEvent som anges i metoden. |
API:er för programflikshantering
Använd följande API:er för att skapa och hantera tillståndet för en programflik.
| Methods | Description |
|---|---|
| skapaFlik | Skapar en flik i en fokuserad session och returnerar den unika identifieraren för den skapade fliken. |
| getTabs | Returnerar en array med flikidentifierare som är associerade med mallnamn eller malltaggar för flikar i den session som är i fokus, om sessionen tillhör kanalleverantören. |
| fokusFlik | Ställer in fokus på en flik, om den fokuserade sessionen tillhör kanalleverantören och om fliken tillhör sessionen i fokus. |
| getFocusedTab | Returnerar flikidentifieraren i en fokuserad session, om sessionen tillhör providern. |
| refreshTab (på engelska) | Uppdaterar fliken. |
| setTabTitle | Anger namnet på fliken, om den fokuserade sessionen tillhör kanalleverantören och om fliken tillhör sessionen i fokus. |
| closeTab (på engelska) | Stänger den angivna fliken i den aktuella sessionen. |
API:er för sessionshantering
Använd följande API:er för att hantera sessioner i en providermiljö med flera sessioner.
| Methods | Description |
|---|---|
| canCreateSession | Gör att du kan kontrollera om en ny session kan skapas. |
| createSession | Skapar en session baserat på den sessionsmall som definierats som en del av mallen och returnerar den unika identifieraren för den session som skapades. |
| getSession | Returnerar ett objekt som innehåller den unika identifieraren för sessionen, kontexten och parameterns värde isFocused , om sessionen tillhör kanalprovidern. |
| getFocusedSession | Returnerar den unika identifieraren för den session som är i fokus, om den tillhör kanalprovidern, annars returneras null. |
| getAllSessions | Returnerar matrisen med sessionsidentifierare för en kanalprovider. |
| setSessionTitle | Anger sessionens titel om sessionen tillhör kanalleverantören. |
| requestFocusSession | Ställer in fokus på den session vars sessionsidentifierare skickas som en parameter, om sessionen tillhör kanalleverantören. |
API:er för kanalanalys
Använd följande API:er för att spåra händelseanalys.
| Methods | Description |
|---|---|
| logAnalyticsEvent | Anropa den här metoden för att logga analys för anpassade händelser. |
API:er för sessionsindikator
Använd följande API:er för att ange ett KPI-brott (Key Performance Indicator) och för att uppdatera antalet nya aktiviteter i en viss session.
| Methods | Description |
|---|---|
| notifyKpiBreach | Denna metod används för att indikera ett KPI-intrång. När den här metoden används visas en röd cirkel på kontaktens visningsbild när ett KPI-intrång har inträffat. |
| notifyNewActivity | Den här metoden används för att uppdatera antalet nya aktiviteter i en viss session. |
Närvaro-API:er
Använd dessa API:er för att ställa in och hämta Flerkanal-handläggarens närvaro programmatiskt. Du kan använda dessa metoder när en blandad agent arbetar med ett program som inte kommer från Microsoft med flerkanal, och du vill synkronisera närvarotillstånden mellan olika program för att säkerställa att handläggarens kapacitet utnyttjas optimalt.
| Methods | Description |
|---|---|
| setPresence | Gör det möjligt att ställa in närvaro programmatiskt för agenten i klientsessionen. |
| getPresence | Gör det möjligt att returnera närvaro programmatiskt för handläggaren i klientsessionen. |
Diverse metoder
| Methods | Description |
|---|---|
| getEntityMetadata | Returnerar entitetsmetadata för den angivna entiteten. |
| setClickToAct | Anger ett booleskt värde för att aktivera eller inaktivera utgående kommunikation (ClickToAct). |
| getClickToAct | Returnerar ett booleskt värde för att ange om den utgående kommunikationen (ClickToAct) är aktiverad eller inte. |
| searchAndOpenRecords | Metoden söker efter posten från kommunikationswidgeten under den inkommande kommunikationen och öppnar posten. |
| getEnvironment | Hämtar den aktuella appen med enhetligt gränssnitt och sidinformation. Informationen omfattar program-ID(appid), pageType(pageType), post-ID(id), organisationsgeografi (orgGeo) och sessionsnavigeringstyp (navigationType). |
| openForm (öppna formulär) | Öppnar ett entitetsformulär eller ett snabbregistreringsformulär. |
| renderSearchPage (på engelska) | Gör att du kan söka bland posterna för en viss entitetstyp. Det här API:et öppnar entitetssidan för enhetligt gränssnitt med sökfältet förifyllt med söksträngen som skickas som en parameter. |
| addHandler | Lägger till prenumeranten i händelserna.
Anmärkning Det här API:et kan användas både på widgeten och på sidan för enhetligt gränssnitt. |
| removeHandler | Tar bort prenumeranten från händelserna.
Anmärkning Det här API:et kan användas både på widgeten och på sidan för enhetligt gränssnitt. |
| raiseEvent (höja) | Anropar den associerade prenumeranten för händelsen.
Anmärkning Om du har skapat anpassade händelser med hjälp addHandler av metoden kan du skapa dessa händelser genom att skicka händelsenamnet som parameter i den här metoden. |
| updateContext | Med den här metoden kan du ställa in automatiseringsordlistan. |
| updateConversation | Med den här metoden kan du uppdatera en konversationspost. |
Relaterad information
Vad är nytt i Dynamics 365 Channel Integration Framework
Systemkrav för Dynamics 365 Channel Integration Framework 2.0