APIs integracion
Sumario
1 Webservice CreateClicktoCall
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 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/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
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 |
| 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 CreateClicktoCustomer
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/ClicktoCustomer/CreateClicktoCustomer
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://172.25.128.248:8180//ClicktoCustomer/CreateClicktoCustomer?date=2015-11-11 10:12:15&idLista=11&idCampana=23&nombre=pruebaTelecor&valFijo_1=0658841177&valMovil_1=0658841177&op3=TECI&op4=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:
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 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
