Nota
L'accés a aquesta pàgina requereix autorització. Podeu provar d'iniciar la sessió o de canviar els directoris.
L'accés a aquesta pàgina requereix autorització. Podeu provar de canviar els directoris.
El Microsoft CIFramework proporciona mètodes per utilitzar l'API de JavaScript per administrar el tauler de comunicació (giny), la notificació, la pestanya de l'aplicació, les sessions, els registres i els formularis a l'aplicació basada en models del Dynamics 365.
Important
- Les API només són compatibles amb els proveïdors de canals actius configurats a la vostra organització.
- S'ha d'invocar el controlador d'incidències CIFInitDone abans de cridar les altres API.
- El límit de temps d'espera de les API és de 100 segons. Si les API no s'executen en 100 segons, s'han de tornar a executar amb paràmetres o abast canviats.
API de gestió de panells de comunicació
El panell de comunicació és on tu, com a agent, interactues amb el client. Els ginys de socis creats amb el Channel Integration Framework 2.0 es carreguen en aquest plafó. El giny d'aquesta versió es mostra a l'esquerra del tauler de sessió i admet els modes acoblat, minimitzat i ocult.
Utilitzeu les API següents per gestionar l'estat del tauler de comunicació (giny).
| Mètodes | Descripció |
|---|---|
| setWidth | Defineix l'amplada del plafó per a totes les sessions. |
| getWidth | Obté l'amplada del plafó en píxels. |
| setMode | Defineix l'estat del plafó. |
| getMode | Defineix l'estat del plafó. |
API d'operacions CRUD
Utilitzeu les API següents per dur a terme operacions CRUD als registres d'entitat.
| Mètodes | Descripció |
|---|---|
| createRecord | Crea un registre d'entitat. |
| recuperarRegistre | Recupera un registre d'entitat. |
| updateRecord | Actualitza un registre d'entitat. |
| deleteRecord | Suprimeix un registre d'entitat. |
API d'administració de notificacions
Utilitzeu les API següents per mostrar o cancel·lar notificacions sobre les converses entrants.
| Mètodes | Descripció |
|---|---|
| notifyEvent | Mostra una notificació que es pot utilitzar per informar l'agent sobre una conversa entrant. |
| cancel·larEsdeveniment | Amaga o cancel·la una notificació basada en el testimoni de cancel·lació, tal com s'especifica al notifyEvent mètode. |
API de gestió de pestanyes d'aplicació
Utilitzeu les API següents per crear i administrar l'estat d'una pestanya d'aplicació.
| Mètodes | Descripció |
|---|---|
| crearPestanya | Crea una pestanya en una sessió enfocada i retorna l'identificador únic de la pestanya creada. |
| getTabs | Retorna una matriu d'identificadors de pestanya associats amb el nom de la plantilla o les etiquetes de plantilla per a les pestanyes de la sessió en focus, si la sessió pertany al proveïdor del canal. |
| focusTab | Defineix el focus en una pestanya, si la sessió enfocada pertany al proveïdor del canal i si la pestanya pertany a la sessió en focus. |
| getFocusedTab | Retorna l'identificador de pestanya en una sessió enfocada, si la sessió pertany al proveïdor. |
| refreshTab | Actualitza la pestanya. |
| setTabTitle | Defineix el títol de la pestanya, si la sessió enfocada pertany al proveïdor del canal i si la pestanya pertany a la sessió en focus. |
| tancarPestanya | Tanca la pestanya especificada a la sessió actual. |
API de gestió de sessions
Utilitzeu les API següents per administrar sessions en un entorn de proveïdor de diverses sessions.
| Mètodes | Descripció |
|---|---|
| canCreateSession | Permet comprovar si es pot crear una nova sessió. |
| createSession | Crea una sessió basada en la plantilla de sessió definida com a part de la plantilla i retorna l'identificador únic de la sessió que s'ha creat. |
| getSession | Retorna un objecte que conté l'identificador únic de la sessió, el context i el valor del paràmetre, si la sessió pertany al proveïdor del isFocused canal. |
| getFocusedSession | Retorna l'identificador únic de la sessió que està enfocada, si pertany al proveïdor de canals, en cas contrari, retorna null. |
| getAllSessions | Retorna la matriu d'identificadors de sessió per a un proveïdor de canals. |
| setSessionTitle | Defineix el títol de la sessió, si la sessió pertany al proveïdor del canal. |
| requestFocusSession | Estableix el focus en la sessió l'identificador de sessió de la qual es passa com a paràmetre, si la sessió pertany al proveïdor del canal. |
API d'anàlisi de canals
Utilitzeu les API següents per fer un seguiment de l'anàlisi d'esdeveniments.
| Mètodes | Descripció |
|---|---|
| Esdeveniment de logAnalytics. | Invoqueu aquest mètode per registrar l'anàlisi d'esdeveniments personalitzats. |
API d'indicadors de sessió
Utilitzeu les API següents per indicar una infracció de l'indicador clau de rendiment (KPI) i per actualitzar el nombre d'activitats noves en una sessió concreta.
| Mètodes | Descripció |
|---|---|
| notificarKpiBreach | Aquest mètode s'utilitza per indicar un incompliment del KPI. Quan s'utilitza aquest mètode, apareix un cercle vermell a la imatge del contacte quan s'ha produït una infracció de KPI. |
| notificarNewActivity | Aquest mètode s'utilitza per actualitzar el nombre d'activitats noves en una sessió concreta. |
API de presència
Utilitzeu aquestes API per definir i recuperar la presència de l'agent omnicanal mitjançant programació. Podeu utilitzar aquests mètodes quan un agent combinat està treballant en una aplicació que no és de Microsoft amb omnicanal i voleu sincronitzar els estats de presència entre diferents aplicacions per assegurar-vos que la capacitat de l'agent s'utilitza de manera òptima.
| Mètodes | Descripció |
|---|---|
| setPresència | Permet establir la presència mitjançant programació per a l'agent a la sessió del client. |
| getPresence | Permet que la presència es retorni mitjançant programació per a l'agent a la sessió del client. |
Mètodes diversos
| Mètodes | Descripció |
|---|---|
| getEntityMetadades | Retorna les metadades de l'entitat per a l'entitat especificada. |
| setClickToAct | Defineix un valor booleà per habilitar o inhabilitar la comunicació de sortida (ClickToAct). |
| getClickToAct | Retorna un valor booleà per indicar si la comunicació de sortida (ClickToAct) està habilitada o no. |
| searchAndOpenRecords | El mètode cerca el registre des del giny de comunicació durant la comunicació entrant i obre el registre. |
| getEntorn | Obté l'aplicació i els detalls de la pàgina de la interfície unificada actuals. Els detalls inclouen l'identificador de l'aplicació (appid), pageType(pageType), l'identificador de registre (id), la geografia de l'organització (orgGeo) i el tipus de navegació de sessió (navigationType). |
| openForm | Obre un formulari d'entitat o un formulari de creació ràpida. |
| renderSearchPage | Permet cercar entre els registres d'un tipus d'entitat concret. Aquesta API obre la pàgina de l'entitat Interfície unificada amb el camp de cerca emplenat prèviament amb la cadena de cerca que es passa com a paràmetre. |
| addHandler | Afegeix el subscriptor als esdeveniments.
Nota Aquesta API es pot utilitzar tant al giny com a la pàgina de la interfície unificada. |
| removeHandler | Suprimeix el subscriptor dels esdeveniments.
Nota Aquesta API es pot utilitzar tant al giny com a la pàgina de la interfície unificada. |
| raiseEvent | Invoca el subscriptor associat per a l'esdeveniment.
Nota Si heu creat esdeveniments personalitzats mitjançant el mètode addHandler, podeu generar aquests esdeveniments passant el nom de l'esdeveniment com a paràmetre en aquest mètode. |
| updateContext | Aquest mètode us permet configurar el diccionari d'automatització. |
| actualitzacióConversa | Aquest mètode us permet actualitzar un registre de conversa. |
Informació relacionada
Novetats del Dynamics 365 Channel Integration Framework
Requisits del sistema per al Dynamics 365 Channel Integration Framework 2.0