Skip to main content

Guía de integración del componente web

Para realizar la integración del componente web básicamente tenemos que hacer 4 cosas:

  1. Inclusión de las hojas de estilo y javascript necesarios
  2. Generación de un div vacío con id root
  3. Construcción del objeto de inicialización necesario
  4. Inicialización del componente

1.- Inclusión de las hojas de estilo y javascript necesarios

 Incluir en la/s página/s donde se desee visualizar el componente los siguientes elementos:

Una vez incluidas las hojas de estilo y los javascript, debemos añadir un div vacio con nombre root. En este div es donde vamos a "incrustar el componente"

<body>
  <!--....-->
	<div id="root"></div>
  <!--....-->
</body>

 Con esto tenemos todo lo que necesitamos, ahora falta cómo instanciamos el componente. Antes de poder instanciarlo tenemos que crear un objeto donde completamos los datos que vamos a pasar al componente para su configuración. Las elementos soportados en el objeto de instanciación son:

// // cliente/alumno
country:"ES",//En ISO2 cual es el país del cliente/alumno
course_id: 24879, // Cual es el id del curso/producto al que hacemos referencia el la conversación
assessor_first_name: // quemandael/losmensaje
assessor_last_name:"de Los Montes", // // minimizadoono true,//Trueofalse,
Elemento
Ejemplo
Explicación
phone:phone "+34659463720",34659463120" Teléfono al que queremos mandar el/los mensajes
source:
source"webcomponent", Esto es un literal que luego se va a poder usar para filtrar los mensajes, por ejemplo Portal_Tutor,EMPRESA1, ERPACADEMICO
client_name:EMPRESA2. "FernandoEste Macho", // Nombre del cliente/alumno
client_lastname: "Macho", // Apellidos del cliente/alumno
client_email: "fernando.macho@unir.net", // Cuáldato es elfacilitado mailpor delUBM
client_name "María de las Mercedes", Nombre del asesor/tutorcliente
client_lastname "Pérez" Apellidos del asesorcliente
client_email

"mdlasm@email.com"

Mail del cliente
country"ES"Páis del cliente en ISO2
course_id12311Código de producto al que mandahace el/losreferencia mensajeel mensaje/conversación
assessor_email:
assessor_first_name"fernando.macho@gmail.Juanito"Nombre del agente que usa el componente
assessor_last_name"Rámirez"Apellido del agente que usa el componente
assessor_email"jr@mail.com",
 Email del asesor que manda el/los mensaje
minimzed: true, // True o false, dependiendo si queremosusa el componente
minimizedtrue¿El componente debe cargar minimizado?
show_userlist:
show_userlist true ¿Debemos dependiendo si queremos que desplieguemostrar la lista de conversacionesconversaciones?




Elemento
 Ejemplo
 Tipo
 Requerido
 Comentario
phone
 "+34xxxxxxxxx" string
 no Formato internacional
source
 "SOURCE"
 string
 si
 Facilitado por UBM
client_name
 "Raimundo"
 string
 si
 Nombre del cliente
client_lastname
 "Lucas Rodriguez"
 string
 si
 Apellidos del cliente
client_email
 "...@..."
 string
 no
 Email del cliente
country "ES"
 string
 no
 País del cliente. Muy util para la validación del teléfono
course_id "249"
 string
 no

Producto sobre el que muestra interés el cliente
assessor_first_name "Ana"
 string
 si

Nombre del empleado que usa el componente
assessor_last_name "Lucas martín"
 string
 si

Apellidos del empleado que usa el componente
assessor_email "...@mycompany.com"
 string
 si

Email del empleado que usa el componente
minimized true
 bool
 no

Si el componente debe arrancar minimizado, por defecto es false
show_userlist true
 bool
 no

Si mostramos la lista de conversaciones en el componente, por defecto es false

Un ejemplo de la construcción del objeto sería:

var var2init = {
				phone: "+34659463720", 					// Teléfono al que queremos mandar el/los mensajes (opcional)
				source: "MI_SOURCE", 					// Este dato es facilitado por UBM en el momento de la configuración de la plataforma
				client_name: "Raimundo", 				// Nombre del cliente
				client_lastname: "Lucas Rodríguez", 	// Apellidos del cliente
				client_email: "...@...", 				// Email del cliente (opcional, pero muy recomendado)
				country: "ES", 							// En ISO2 cual es el país del cliente, si se usa phone es muy recomendado para una validación del teléfono más correcta
				course_id: "249", 						// Cual es el id del producto sobre el que muestra interés el cliente
				assessor_first_name: "Ana", 			// Nombre del empleado que usa el componente
				assessor_last_name: "Lucas Martín", 	// Apellidos del empleado que usa el componente
				assessor_email: "...@mycompany.com", 	// Email del asesor/tutorasesor que manda el/los mensaje
				minimzed: true, 						// True o false, dependiendo si queremos el componente minimizado o no
				show_userlist: true,					// True o false, dependiendo si queremos que despliegue la lista de conversaciones
               };

Una vez que tenemos construido el objeto de instanción basta con que iniciemos el componente:

<script>
	initChat(var2init);
</script>

Otro ejemplo: para instanciar el componente y ver todas las conversaciones de un asesor:

var var2init = {
				assessor_first_name: "Ana", 			// Nombre del empleado que usa el componente
				assessor_last_name: "Lucas Martín", 	// Apellidos del empleado que usa el componente
				assessor_email: "...@mycompany.com", 	// Email del asesor/tutorasesor que manda el/los mensaje
				minimzed: true, 						// True o false, dependiendo si queremos el componente minimizado o no
				show_userlist: true,					// True o false, dependiendo si queremos que despliegue la lista de conversaciones
               };

Lo que vais a ver cuando se instancia el objeto chat es, si minimized es false y show_userlist es true: 

image.png

Si minimized es false y show_userlist es false:

image.png

Si minimized es true:

image.png

 

Back to top