APIs integracion

De VIVAitwiki
Ir a la navegaciónIr a la búsqueda
Producto: VIVAit Call

VIVAit Suite

1 Webservice ClicktoCall

Versión 1.0

1.1 Introducción

A través de este webservice, se podrán añadir contactos a las listas “llamame” del cliente. Estas listas serán gestionadas para la generación de campañas utilizadas en el marcador.

1.2 Invocación y parámetros

Para poder invocar a dicho webservice, se deberá hacer una petición http a la siguiente url:

http://xxx.xxx.xxx.xxx:xxxx/ClicktoCall/CreateClicktoCall

siendo xxx.xxx.xxx.xxx:xxxx la ip y el puerto donde haya sido desplegado el webservice

Se deberán pasar los parámetros a través de post.

Un ejemplo de invocación sería la siguiente

http://10.1.10.10:8180/ClicktoCall/CreateClicktoCall?idLista=11&nombre=pruebaWorldLine&msisdn=0658841177&lang=1

Los distintos parámetros que podemos indicar en dicha invocación son los siguientes:

Nombre Tipo Obligatorio Descripción
date String No Fecha en la que se realizará la llamada, si el parámetro no se indica, se fija fecha actual.El formato del string que se debe enviar es

yyyy-MM-dd HH:mm:ss

idLista Integer Si Identificador de la lísta “llamame” en la que el contacto será insertado
codCliente String No Código del cliente
nombre String Si Nombre del cliente
apellido1 String No Primer apellido del cliente
apellido2 String No Segundo apellido del cliente
empresa String No Empresa del cliente
direccion1 String No Campo de dirección del cliente
direccion2 String No Campo de dirección del cliente
cp String No Código postal del cliente
localidad String No Localidad del cliente
provincia String No Provincia del cliente
idpais Integer No Identificador del país, si no se indica, será España
email String No E-mail del cliente
msisdn String Si Número de teléfono del cliente
gender Integer No Indicador del género del cliente, si no se indica, sera masculino
lang Integer Sí Indicador del lenguaje a utilizar, si no se indica, será lenguaje español
treatment Integer No Indicador del tipo de tratamiento del cliente.
op1int Integer No Parámetro opcional 1
op2int Integer No Parámetro opcional 2
op3int Integer No Parámetro opcional 3
op4int Integer No Parámetro opcional 4
op1 String No Parámetro opcional 1
op2 String No Parámetro opcional 2
op3 String No Parámetro opcional 3
op4 String No Parámetro opcional 4

1.3 Resultado y códigos de error

Si el webservice se ejecuta correctamente enviará el código de respuesta 200.

Si el webservice no se ejecuta de forma correcta, puede devolver los siguientes códigos de error:

Error Código Descripción
SC_NOT_FOUND 404
SC_BAD_REQUEST 400 Not enough parameters
SC_CONFLICT 409 Internal process error
SC_INTERNAL_SERVER_ERROR 500 e.getMessage()

2 Webservice CargaContactos

Versión 1.0

2.1 Introducción

A través de este webservice, se podrán añadir contactos a cualquiera de las campañas que se tenga definidas.

2.2 Invocación y párametros

Para poder invocar a dicho webservice, se deberá hacer una petición http a la siguiente url:

http://xxx.xxx.xxx.xxx:xxxx/CargaContactos/CreateCargaContactos

siendo xxx.xxx.xxx.xxx:xxxx la ip y el puerto donde haya sido desplegado el webservice

Se deberán pasar los parámetros a través de post.

Un ejemplo de invocación sería la siguiente

http://localhost:8180/CargaContactos/CreateCargaContactos?date=2015-11-11%2010:12:15&idLista=11&idCampana=23&nombreCon=pruebaTelecor&valFijo_1=0658841177&valMovil_1=0658841177&cOpc3=TECI&cOpc4=3321347


Los distintos parámetros que podemos indicar en dicha invocación son los siguientes:

Nombre Descripción Obligatorio Tipo
date Fecha en la que se realizará la llamada, si el parámetro no se indica, se fija fecha actual. El formato del string que se debe enviar es yyyy-MM-dd HH:mm:ss No Date
obsoletos Si vale 1, marcar como obsoletos los contactos anteriores, el valor por defecto es 0 No Integer
diasCaducidad Número de días a partir de los cuales caducarán los contactos No Integer
idCampanna Identificador de la campaña en la que se insertará el contacto Si Integer
idLista Identificador de lista asociada a la campaña Si Integer
prioridad El valor es de 0 a 99. A mayor número menor prioridad (se le llamará más tarde) No Integer
tipoTarea Los posibles valores de la columna son:
  • A: Alta
  • M: Modificación
  • B: Baja

Por defecto el valor es A

No String
codCli Identificador del código del cliente No String
nombreCon Nombre del cliente No String
apellido1 Primer apellido No String
apellido2 Segundo apellido No String
empresa Empresa No String
direccion1 Dirección 1 No String
direccion1 Dirección 1 No String
direccion2 Dirección 2 No String
codPostal Código postal No String
localidad Localidad No String
provin Provincia No String
email Email No String
valFijo_1 Primer número fijo del contacto. Si Integer
valFijo_2 Segundo número fijo del contacto. No Integer
valFijo_3 Tercer número fijo del contacto. No Integer
valFijo_4 Cuarto número fijo del contacto. No Integer
valMovil_1 Primer número móvil del contacto. Si Integer
valMovil_2 Segundo número móvil del contacto. No Integer
valMovil_3 Tercer número móvil del contacto. No Integer
valMovil_4 Cuarto número móvil del contacto. No Integer
edad Edad. No Integer
nOpc1 Dato numérico opcional No Integer
nOpc2 Dato numérico opcional No Integer
nOpc3 Dato numérico opcional No Integer
nOpc4 Dato numérico opcional No Integer
nOpc5 Dato numérico opcional No Integer
nOpc6 Dato numérico opcional No Integer
nOpc7 Dato numérico opcional No Integer
nOpc8 Dato numérico opcional No Integer
cOpc1 Cadena opcional No String
cOpc2 Cadena opcional No String
cOpc3 Cadena opcional No String
cOpc4 Cadena opcional No String
cOpc5 Cadena opcional No String
cOpc6 Cadena opcional No String
cOpc7 Cadena opcional No String
cOpc8 Cadena opcional No String

2.3 Resultado y códigos de error

Si el webservice se ejecuta correctamente enviará el código de respuesta 200. Si el webservice no se ejecuta de forma correcta, puede devolver los siguientes códigos de error:

Error Código Descripción
SC_NOT_FOUND 404
SC_BAD_REQUEST 400 Not enough parameters
SC_FORBIDDEN 403 Client in Robinson List
SC_CONFLICT 409 Internal process error
SC_INTERNAL_SERVER_ERROR 500 Problems in SQL querys

e.getMessage()

2.4 Configuración del fichero web.xml

En este fichero, se deben fijar los valores de despliegue correctos de la aplicación. Este fichero se encuentra en la ruta de despliegue del WAR (/var/lib/tomcatx/webapps/CargaContactos/WEB-INF/web.xml) 

 <context-param>
   <description>Servidor BBDD</description>
   <param-name>bd_acd_servidor</param-name>
   <param-value>xxx.xxx.xxx.xxx</param-value>
 </context-param>
 <context-param>
   <description>BBDD</description>
   <param-name>bd_acd_bd</param-name>
   <param-value>xxxxxxx</param-value>
 </context-param>
 <context-param>
   <description>Usuario BBDD</description>
   <param-name>bd_acd_usuario</param-name>
   <param-value>xxxxxx</param-value>
 </context-param>
 <context-param>
   <description>Usa Clave</description>
   <param-name>bd_usa_clave</param-name>
   <param-value>0</param-value>
 </context-param>
 <context-param>
   <description>Clave BBDD</description>
   <param-name>bd_acd_clave</param-name>
   <param-value>xxxxxxxx</param-value>
 </context-param>
 <context-param>
   <description>Dias Caducidad</description>
   <param-name>caducidad</param-name>
   <param-value>30</param-value>
 </context-param>
Parámetro Descripción
bd_acd_servidor IP donde se encuentre ubicada la base de datos
bd_acd_bd Nombre de la base de datos a utilizar
bd_acd_usuario Usuario de la base de datos
bd_usa_clave Parámetro que indica si el password esta cifrado o no, por defecto el valor es 0 (No cifrado)
bd_acd_clave Clave para la conexión a base de datos.
caducidad Días de caducidad del contacto

3 Script Cargacontactos

Guía de uso de script CargaContactos

4 Webservice Chat

4.1 Introducción

A través de este interfaz se podrá utilizar el servicio de chat incluido dentro de la plataforma Vivait-Suite.
El interfaz de comunicación está basado en invocaciones a distintos webservices que deberán ser controlados desde la aplicación cliente.
Consta de 4 webservices que serán definidos con precisión en el siguiente apartado.

4.2 Invocación y parámetros

4.2.1 StartChat

Este webservice será utilizado para inicializar el canal de chat. Una vez inicializado el canal, se facilitarán los datos de la llamada, así como la sesión a utilizar.

4.2.1.1 Invocación

Para poder invocar a dicho webservice, se deberá hacer una petición http a la siguiente url:

http://xxx.xxx.xxx.xxx:xxxx/ChatWebService/startchat

siendo xxx.xxx.xxx.xxx:xxxx la ip y el puerto donde haya sido desplegado el webservice.

Se deberán pasar los parámetros a través de get.


Un ejemplo de invocación sería la siguiente:

http://172.25.128.248:8180/ChatWebService/startchat?service=chat1&name=minombre&origin=6177&destiny=60600

Los distintos parámetros que podemos indicar en dicha invocación son los siguientes:

Nombre Tipo Obligatorio Descripción
service String Si Servicio de chat a utilizar
name String Si Nombre del usuario que genera la petición de chat.
origin String Si Identificador del usuario que genera la petición de chat.
destiny String Si Identificador de la cola de destino del chat
4.2.1.2 Resultado y códigos de error

Si el webservice se ejecuta correctamente enviará el código de respuesta http SC_OK 200 acompañado de un JSON con los siguientes datos:

{"result":"OK",
"diag":"10002000091463068795",
 "session":"4D463E5289082EB500AC1D2D75221EDB",
 "comments":"Channel created"}

Si el webservice no se ejecuta de forma correcta, puede devolver los siguientes códigos de error:

Error Código Descripción
SC_NOT_FOUND 404
SC_BAD_REQUEST 400 Not enough parameters
SC_CONFLICT 409 Failed to create the channel
SC_INTERNAL_SERVER_ERROR 500 e.getMessage()

4.2.2 FinishChat

Este webservice será utilizado para finalizar el canal de chat.

4.2.2.1 Invocación

Para poder invocar a dicho webservice, se deberá hacer una petición http a la siguiente url:

http://xxx.xxx.xxx.xxx:xxxx/ChatWebService/finishchat

siendo xxx.xxx.xxx.xxx:xxxx la ip y el puerto donde haya sido desplegado el webservice

Se deberán pasar los parámetros a través de get.

Un ejemplo de invocación sería la siguiente:

http://172.25.128.248:8180/ChatWebService/finishchat?session=FBCDA34A0AFD3341D3150184C03467FC&ucid=10002000101463126744

Nombre Tipo Obligatorio Descripción
session String No Identificador de la sesión http asociada al chat
ucid String Si Identificador del chat
4.2.2.2 Resultado y códigos de error

Si el webservice se ejecuta correctamente enviará el código de respuesta http SC_OK 200 acompañado de un JSON con los siguientes datos:

{"result":"OK",
"comments":"Channel closed"}

Si el webservice no se ejecuta de forma correcta, puede devolver los siguientes códigos de error:

Error Código Descripción
SC_NOT_FOUND 404
SC_BAD_REQUEST Not enough parameters
SC_CONFLICT 409 Failed to create the channel
SessionID no valid
SC_INTERNAL_SERVER_ERROR 500 Failed updating database, rollback for the UCID

e.getMessage()

4.2.3 SendMessage

Este webservice será utilizado enviar un mensaje de chat.

4.2.3.1 Invocación

Para poder invocar a dicho webservice, se deberá hacer una petición http a la siguiente url:

http://xxx.xxx.xxx.xxx:xxxx/ChatWebService/sendmessage

siendo xxx.xxx.xxx.xxx:xxxx la ip y el puerto donde haya sido desplegado el webservice

Se deberán pasar los parámetros a través de get.

Un ejemplo de invocación sería la siguiente:

http://172.25.128.248:8180/ChatWebService/sendmessage?session=FBCDA34A0AFD3341D3150184C03467FC&ucid=10002000101463126744&idsender=6177&message=texto a insertar en el chat

Los distintos parámetros que podemos indicar en dicha invocación son los siguientes:

Nombre Tipo Obligatorio Descripción
session String Si Identificador de la sesión http asociada al chat
ucid String Si Identificador del chat
idsender String Si Identificar del usuario que genera el mensaje (cliente o agente)
message String Si Mensaje a enviar
4.2.3.2 Resultado y códigos de error

Si el webservice se ejecuta correctamente enviará el código de respuesta http SC_OK 200 acompañado de un JSON con los siguientes datos:


{"idMessage":"144524524",
"result":"OK",
"diag":"Up",
"comment":"Message correctly register"}

Si el webservice no se ejecuta de forma correcta, puede devolver los siguientes códigos de error:

Error Código Descripción
SC_NOT_FOUND 404
SC_BAD_REQUEST 400 Not enough parameters
SC_CONFLICT 409 Failed to record the message.SessionID no valid
SC_INTERNAL_SERVER_ERROR 500 Database error
SessionID is not valid
Not session avaible
e.getMessage()

4.2.4 ReceiveMessage

Este webservice será utilizado comprobar si hay mensajes pendientes de recibir en el chat. Este webservice tiene que ser invocado periódicamente para mostrar los mensajes recibidos

4.2.4.1 Invocación

Para poder invocar a dicho webservice, se deberá hacer una petición http a la siguiente url:

http://xxx.xxx.xxx.xxx:xxxx/ChatWebService/receivemessage

siendo xxx.xxx.xxx.xxx:xxxx la ip y el puerto donde haya sido desplegado el webservice

Se deberán pasar los parámetros a través de get.

Un ejemplo de invocación sería la siguiente:

http://172.25.128.248:8180/ChatWebService/receivemessage?session=FBCDA34A0AFD3341D3150184C03467FC&ucid=10002000101463126744&idsender=60600&idmessage=0

Los distintos parámetros que podemos indicar en dicha invocación son los siguientes:

Nombre Tipo Obligatorio Descripción
session String Si Identificador de la sesión http asociada al chat
ucid String Si Identificador del chat
idsender String Si Identificar el usuario que solicita la lectura del mensaje (cliente o agente)
idmessage String Si Identificador del último mensaje recibido
4.2.4.2 Resultado y códigos de error

Si el webservice se ejecuta correctamente enviará el código de respuesta http SC_OK 200 acompañado de un JSON con los siguientes datos (si hay algún mensaje pendiente, recibimos el mensaje, junto con su identificador, y el identificador del usuario que lo escribió):

{"message":"texto a insertar en el chat",
"idMessage":"144524524",
"result":"OK",
"diag":"Up",
"idUser":6177}

Si por el contrario, no existen mensajes pendientes de recibir, el JSON recibido tendrá el siguiente contenido (el identificador de mensajes estará a cero y el identificador de usuario será el mismo del usuario que ha realizado la petición de lectura): {"message":"NO MORE MESSAGES",
"idMessage":"0",
"result":"OK",
"diag":"Up",
"idUser":"60600"}

Si el webservice no se ejecuta de forma correcta, puede devolver los siguientes códigos de error:

Error Código Descripción
SC_NOT_FOUND 404
SC_BAD_REQUEST 400 Not enough parameters
SC_CONFLICT 409 Failed to record the message
SessionID no valid
SC_INTERNAL_SERVER_ERROR 500
Obtenido de «http://vivait-wiki.mdnova.local/wiki/vivait/index.php?title=APIs_integracion&oldid=4575»