Añadir funciones personalizadas a la aplicación Rainbow (custo-manifest)

language Este artículo ha sido traducido automáticamente. Véase la versión de referencia en inglés.

Este artículo permite añadir funciones personalizadas a las aplicaciones Rainbow mediante un conjunto de acciones configurables desde un archivo custo-manifest.json.

Las acciones disponibles son:

• Acciones que se activan automáticamente a raíz de eventos:
  • on-incoming-pbx-call-actions: para ejecutar una acción cuando se produce una llamada entrante
  • on-answering-incoming-pbx-call-actions: para ejecutar una acción cuando se contesta una llamada entrante
  • on-releasing-incoming-pbx-call-actions: para ejecutar una acción cuando finaliza una llamada entrante

En las llamadas entrantes, las acciones pueden lanzar un script, una aplicación o una página web con información sobre la llamada entrante.

• Las acciones se activan mediante el uso de botones:
  • on-incoming-pbx-call-button-actions: para ejecutar una acción pulsando un botón añadido en la ventana emergente de llamadas entrantes
  • on-call-log-list-actions: para ejecutar una acción pulsando un botón insertado en cada elemento del registro de llamadas
  • on-contact-list-actions: para ejecutar una acción pulsando un botón insertado en cada elemento de contactos
  • on-contact-detail-actions: para ejecutar una acción pulsando un botón insertado en el área detallada de contactos
  • on-communication-card-actions: para ejecutar una acción pulsando un menu insertado en la barra del gestor de llamadas.

Al pulsar los botones, las acciones pueden abrir ventanas emergentes con posibilidad de unirse a contactos o servicios por correo electrónico.

• Acciones con visualización automática de la información:
  • on-incoming-pbx-call-display-actions: para insertar información en la ventana emergente de llamada entrante.
  • on-contact-card-display-actions: para insertar información en la zona detallada de contactos.

Estas acciones se configuran a partir del archivo custo-manifest.json disponible en la aplicación Rainbow.

La configuración consiste en:

1. Exportar el archivo custo-manifest.j son en el ordenador
2. Editar y completar el archivo custo-manifest. json
3. Importar el custo-manifest.j son en la aplicación Rainbow

La configuración sólo se aplica a las aplicaciones Rainbow que se ejecutan en el ordenador.

La configuración debe realizarse para cada aplicación Rainbow.

Requisito previo

• La configuración del archivo custo-manifest. json requiere al menos una licencia Business, Enterprise o Attendant.

Visión general del archivo custo-manifest

El archivo custo-manifest consta de dos partes:

• La primera parte enumera todas las acciones disponibles, y proporciona para cada acción, una plantilla con los principales parámetros a completar.
  Ejemplo:
  
• La segunda parte proporciona una guía de ayuda que debe leerse para la configuración.

Una acción se define mediante los siguientes parámetros:

• "nombre": es un texto utilizado para identificar la acción o la etiqueta del botón para las acciones que utilizan botón
• Para las acciones que utilizan botón
  • "icono": es la ruta de acceso al icono del botón
  • "tooltip": es la ruta de acceso a la información sobre la herramienta que se muestra al pasar el ratón por encima del botón
• "comando": define la acción a ejecutar
• "url": es la ruta o URL de
  acceso a la aplicación
  local, página web o API REST
  Nota: La barra invertida debe ser doble en la ruta de acceso a la aplicación local (por ejemplo, C:\\MicroCRM\\MicroCRM.exe).
• "params": es una cadena con variables ${xx} que serán sustituidas por su valor en la ejecución de la acción
• "commandType" : especifica el tipo de acción.: especifica el tipo de acción:
  • "ninguno": lanza una aplicación local o una página web (si la url empieza por 'http' o 'https')
  • "rest": ejecuta una llamada a la API REST
  • "archivo" : recupera el contenido del archivo.: recupera el contenido del archivo a recuperar (principalmente para el ajuste del depurador)
• "responseType: define el tipo de contenido devuelto por la acción: "markdown", "json" o "adaptiveCard".

  Si se establece en "json", entonces:

  • "displayJsonField": define el campo cuyo valor es el contenido a mostrar
  • "firstNameJsonField": define el campo cuyo valor debe sustituir al nombre del llamante
  • "lastNameJsonField: define el campo cuyo valor debe sustituir al apellido de la persona que llama
  • "companyJsonField": define el campo cuyo valor debe sustituir al nombre de la empresa de la persona que llama

  Si se establece como "adaptiveCard", entonces:

  • "adaptiveCardTemplateJsonField": define la plantilla de la tarjeta adaptativa que se mostrará
  • "adaptiveCardContentJsonField" : define el contenido de la tarjeta adaptable que se mostrará.: define el contenido de la tarjeta adaptativa que se mostrará

Existen parámetros adicionales:

• "AnswerOnClick": cuando se establece en true, ejecuta la acción y responde a la llamada entrante al mismo tiempo (sólo para la acción on-incoming-pbx-call-button-actions )
• "filtrar": si se establece en "NoShortNumber", no activará el evento si el número de la persona que llama es un número corto
• "ActivarCambioLlamada": permite configurar el comportamiento al recibir una llamada transferida:
  • false: sólo las llamadas directas al usuario activarán el evento
  • verdadero: el evento se dispara para las llamadas directas al usuario y también para las llamadas que han sido transferidas a este usuario
  • sólo: sólo las llamadas transferidas al usuario desencadenan el evento

La plantilla de acción puede incluir las variables ${xx} configuradas en el campo "url", "params" y "bodyParameters" (para la API REST). Se sustituyen por su valor cuando se ejecuta la acción.

Exportación del archivo custo-manifest en el ordenador

1. Desde la interfaz de administración de Rainbow, haga clic en el avatar del panel izquierdo y, a continuación, en el menú Ajustes.
2. En el menu de la izquierda, seleccione Telefonía.
   Se abrirá la ventana Ajustes - Configuración de telefonía.
3. Despliegue la ventana hasta la sección PERSONALIZACIÓN.
4. Haga clic en Exportar archivo y utilice el navegador para exportar el archivo custo-manifest en el ordenador.
5. Haga clic en Cerrar para salir de la ventana de configuración de telefonía.

Configuración local del archivo custo-manifest

1. Abra el archivo custo-manifest con un editor de texto.
2. Configure los parámetros de las acciones a utilizar.
   Atención: no elimine el espacio entre las comillas dobles de los parámetros no utilizados ("name": " ", "url": " ", "params": " "), de lo contrario no se tendrá en cuenta el archivo importado.
3. Elimine los parámetros de todas las acciones no utilizadas.
4. Guarde el archivo custo-manifest.

Importación del archivo custo-manifest en la aplicación Rainbow

1. Desde la interfaz de administración de Rainbow, haga clic en el avatar del panel izquierdo y, a continuación, en el menú Ajustes.
2. En el menu de la izquierda, seleccione Telefonía.
   Se abrirá la ventana Ajustes - Configuración de telefonía.
3. Despliegue la ventana hasta la sección PERSONALIZACIÓN.
4. Haga clic en Importar archivo y utilice el navegador para seleccionar e importar el archivo de custo-manifiesto en la aplicación Rainbow.
5. Haga clic en Cerrar para salir de la ventana de configuración de telefonía.

Ejemplos de configuración

Ejecutar una aplicación o un script con parámetros

Ejemplo 1:

La acción on-incoming-pbx-call-actions ejecuta una aplicación (por ejemplo, MicroCrm) con un parámetro de 'params' (sin retorno).

"versión": "2",
"extension-points": {
"on-incoming-pbx-call-actions": [ { "name": "Ejecutar CRM", "comando": { "url": "C:\MyApp\CustoApp\MicroCRM.exe", "params": "-número ${caller.phoneNumber}" } ],

Ejemplo 2:

La acción on-incoming-pbx-call-actions ejecuta un script (*.bat) con parámetros de 'params' (sin retorno).

"version": "2",
"extension-points": {
"on-incoming-pbx-call-actions": [ { "nombre": "BatScript", "comando": {"url": "C:\MyApp\MyApp.bat", "params": "IN-COMING canNr:${localUser.canonicalNumber} userIntNr:$"{localUser.internalNumber} caller[Nr:${calle.phoneNumber} FN:${caller.firstName} LN:${caller.lastName} .... CorData:[${calle.correlatorData Hex:${calle.hexCorrelatorData]" }   
  } ],

Abrir una página web con parámetros

Ejemplo 1:

La acción on-incoming-pbx-call-actions abre una página web con parámetros de 'params' (sin retorno).

"version": "2",
"extension-points": {
"on-incoming-pbx-call-actions": [ { "nombre": "Páginas amarillas", "comando": { "url":"https://www.pagesjaunes.fr/annuaireinverse/recherche",
 "params": "quoiqui=${caller.phoneNumber}&proximite=0"
 }
 }
],

Ejemplo 2:

La acción on-incoming-pbx-call-actions abre una página web con parámetros directamente en URL (sin retorno).

"version": "2",
"extension-points": {
"on-incoming-pbx-call-actions": [ { "name": "ventana emergente de contacto", "comando": { "url":"http://localhost:3000/contactShow?phone=${caller.phoneNumber}",
 "params": " "
 }
 }
],

Ejecutar una llamada a la API REST con parámetros

Ejemplo 1:

Cuando se libera la llamada entrante, la acción on-releasing-incoming-pbx-call-actions crea un registro de llamadas END en REST utilizando el método GET y los parámetros de "params" (sin retorno).

"version": "2",
"extension-points": {
"on-releasing-incoming-pbx-call-actions": [ { "name": "GetRestApi", "command": {
 "commandType": "rest",
 "method": "GET", "url":"http://localhost:3000/IncidentManager/CreateCallLog",
 "params": "byEmail=${localUser.email}&CustomerContact=${caller.phonenumber}"
 }
 }
],

Ejemplo 2:

Cuando se libera la llamada entrante, la acción on-releasing-incoming-pbx-call-actions crea un registro de llamadas END en REST utilizando el método POST y los parámetros de "bodyParameters" (sin retorno).

"version": "2",
"extension-points": {
"on-releasing-incoming-pbx-call-actions": [
 {
 "nombre": "PostRestApi",
 "command": {
 "commandType": "rest",
 "method": "POST",
 "url":"http://localhost:3000/IncidentManager/EndCallLog",
 "params": " "
 },
 "bodyParameters": {
 "llamante": "${contact.phoneNumber}",
 "user": "${localUser.email}",
 }
],