Métodos de Microsoft.CIFramework (referencia de API de JavaScript) para Marco de integración de canal de Dynamics 365 2.0
Microsoft CIFramework proporciona métodos para utilizar la API de JavaScript para administrar el panel de comunicación (widget), la notificación, la pestaña de la aplicación, las sesiones, los registros y los formularios en la aplicación basada en modelos de Dynamics 365.
Importante
- Las API solo son compatibles con los proveedores de canales activos configurados en su organización.
- El controlador de eventos CIFInitDone debe invocarse antes de llamar a las otras API.
- El límite de tiempo de espera para las API es de 100 segundos. Si las API no se ejecutan en 100 segundos, se deben ejecutar nuevamente con parámetros o alcance modificados.
API de administración de panel de comunicación
El panel de comunicación es donde podrá interactuar con el cliente como agente. Los widgets de socios creados con Marco de integración de canal 2.0 se cargan en este panel. El widget en esta versión se muestra a la izquierda del panel de sesión y admite los modos Acoplado, Minimizado y Oculto.
Utilice las siguientes API para administrar el estado del panel de comunicación (widget).
| Métodos | Descripción |
|---|---|
| setWidth | Establece el ancho del panel para todas las sesiones. |
| getWidth | Obtiene el ancho del panel en píxeles. |
| setMode | Establece el estado del panel. |
| getMode | Establece el estado del panel. |
API de operaciones CRUD
Utilice las siguientes API para realizar operaciones CRUD en registros de entidades.
| Métodos | Descripción |
|---|---|
| createRecord | Crea un registro de entidad. |
| retrieveRecord | Recupera un registro de entidad. |
| updateRecord | Actualiza un registro de entidad. |
| deleteRecord | Elimina un registro de entidad. |
API de administración de notificación
Utilice las siguientes API para mostrar o cancelar notificaciones sobre conversaciones entrantes.
| Métodos | Descripción |
|---|---|
| notifyEvent | Muestra una notificación que se puede utilizar para informar al agente sobre una conversación entrante. |
| cancelEvent | Oculta o cancela una notificación según el símbolo (token) de cancelación, como se especifica en el método notifyEvent. |
API de administración de pestañas de aplicación
Utilice las siguientes API para crear y administrar el estado de una pestaña de aplicación.
| Métodos | Descripción |
|---|---|
| createTab | Crea una pestaña en una sesión enfocada y devuelve el identificador único de la pestaña creada. |
| getTabs | Devuelve una matriz de identificadores de pestañas asociados con el nombre de la plantilla o etiquetas de plantilla para las pestañas en la sesión enfocada, si la sesión pertenece al proveedor del canal. |
| focusTab | Establece el foco en una pestaña, si la sesión enfocada pertenece al proveedor del canal y si la pestaña pertenece a la sesión enfocada. |
| getFocusedTab | Devuelve el identificador de la pestaña enfocada en una sesión enfocada, si la sesión pertenece al proveedor. |
| refreshTab | Actualiza la pestaña. |
| setTabTitle | Establece el título de la pestaña, si la sesión enfocada pertenece al proveedor del canal y si la pestaña pertenece a la sesión enfocada. |
| closeTab | Cierra la pestaña especificada en la sesión actual. |
API de administración de sesión
Utilice las siguientes API para administrar sesiones en un entorno de proveedor multisesión.
| Métodos | Descripción |
|---|---|
| canCreateSession | Le permite comprobar si se puede crear una nueva sesión. |
| createSession | Crea una sesión basada en la plantilla de sesión definida como parte de la plantilla y devuelve el identificador único de la sesión que se creó. |
| getSession | Devuelve un objeto que contiene el identificador único de la sesión, el contexto y el valor del parámetro isFocused, si la sesión pertenece al proveedor del canal. |
| getFocusedSession | Devuelve el identificador único de la sesión que está enfocada, si pertenece al proveedor del canal; de lo contrario, devuelve nulo. |
| getAllSessions | Devuelve la matriz de identificadores de sesión de un proveedor de canal. |
| setSessionTitle | Establece el título de la sesión, si la sesión pertenece al proveedor del canal. |
| requestFocusSession | Establece el foco en la sesión cuyo identificador de sesión se pasa como parámetro, si la sesión pertenece al proveedor del canal. |
API de Análisis de canal
Utilice las siguientes API para realizar un seguimiento del análisis de eventos.
| Métodos | Descripción |
|---|---|
| logAnalyticsEvent | Invoque este método para registrar análisis para eventos personalizados. |
API de indicador de sesión
Utilice las siguientes API para indicar una infracción de indicador clave de rendimiento (KPI) y para actualizar la cantidad de nuevas actividades en una sesión particular.
| Métodos | Descripción |
|---|---|
| notifyKpiBreach | Este método se utiliza para indicar una infracción de KPI. Cuando se utiliza este método, aparece un círculo rojo en la imagen del contacto cuando se produce una infracción de KPI. |
| notifyNewActivity | Este método se utiliza para actualizar la cantidad de actividades nuevas en una sesión particular. |
API de presencia
Utilice estas API para configurar y recuperar la presencia del agente omnicanal mediante programación. Puede utilizar estos métodos cuando un agente combinado esté trabajando en una aplicación de terceros con omnicanal y desee sincronizar los estados de presencia entre diferentes aplicaciones para garantizar que la capacidad del agente se utilice de manera óptima.
| Métodos | Descripción |
|---|---|
| setPresence | Permite establecer la presencia mediante programación para el agente en la sesión del cliente. |
| getPresence | Permite devolver la presencia mediante programación para el agente en la sesión del cliente. |
Varios métodos
| Métodos | Descripción |
|---|---|
| getEntityMetadata | Devuelve los metadatos de la entidad especificada. |
| setClickToAct | Establece un valor booleano para habilitar o deshabilitar la comunicación saliente (ClickToAct). |
| getClickToAct | Devuelve un valor booleano para indicar si la comunicación saliente (ClickToAct) está habilitada o no. |
| searchAndOpenRecords | El método busca el registro en el widget de comunicación durante la comunicación entrante y abre el registro. |
| getEnvironment | Obtiene los detalles actuales de la aplicación de la Interfaz unificada y de la página. Los detalles incluyen ID de aplicación (appid), tipo de página (pageType), ID de registro (id), geografía de la organización (orgGeo) y tipo de navegación de sesión (navigationType). |
| openForm | Abre un formulario de entidad o un formulario de creación rápida. |
| renderSearchPage | Le permite buscar entre los registro de un tipo de entidad particular. Esta API abre la página de entidad de la Interfaz unificada con el campo de búsqueda en ella rellenado previamente con la cadena de búsqueda que se pasa como un parámetro. |
| addHandler | Agrega el suscriptor a los eventos.
Nota Esta API se puede utilizar tanto en el widget como en la página Interfaz unificada. |
| removeHandler | Quita el suscriptor de los eventos.
Nota Esta API se puede utilizar tanto en el widget como en la página Interfaz unificada. |
| raiseEvent | Invoca al suscriptor asociado al evento.
Nota Si ha creado eventos personalizados utilizando el método addHandler, puede generar esos eventos pasando el nombre del evento como parámetro en este método. |
| updateContext | Este método le permite configurar el diccionario de automatización. |
| updateConversation | Este método le permite actualizar un registro de conversación. |
Consulte también
Novedades de Marco de integración de canales de Dynamics 365
Requisitos del sistema para el marco de integración de canal de Dynamics 365 2.0