Manual API SP 2021

API
Manual Vozitel
para el uso de API’s
¿Qué es una API?
API es la abreviatura del término en inglés Application Programming Interfaces (Interfaces de
Programación de Aplicaciones) y se trata de un conjunto de especificaciones que permite a las
aplicaciones comunicarse o interactuar entre ellas.
Básicamente a través de una API conseguimos que varias aplicaciones puedan interconectarse de
diferentes formas para conseguir el correcto funcionamiento del software que el usuario esté
utilizando en ese momento.
Desde Vozitel ponemos a tu disposición varias API RESTFUL con las que podrás:
o permite consultar/modificar/eliminar datos de un contacto,
o recopilar información sobre encuestas,
o subir y descargar ficheros,
o obtener información sobre citas y tareas,
o eliminar/modificar/consultar expedientes...
entre muchas otras cosas.
VOZITEL también ofrece, como alternativa para otros protocolos de intercambio de datos, la
posibilidad de mantener sus sistemas conectados a través de nuestra API SOAP. Si necesitas este
tipo de API ponte en contacto con nuestro equipo de soporte en soporte@vozitel.es.
Manual API
API RESTFUL
Este tipo de API se ejecutan sobre https:// . Si quieres utilizar este tipo de API con Vozitel deberás
seguir los siguientes pasos:
AUTENTICACIÓN
Para la autenticación, se debe usar OAuth 2.0 y enviar el token en cada request que se haga al API.
También hay que tener en cuenta que todas las peticiones se realizarán sobre el puerto 8080.
El servidor OAuth que proporciona los tokens será el mismo que el del API pero se accede con una
ruta
diferente:
o Servidor OAuth: https://{servidor}.vozitel.com/oauth
o Servidor API: https://{servidor}.vozitel.com/api
Para obtener el token se debe realizar mediante el tipo de autenticación "client credentials" y en la
petición se debe proporcionar los siguientes parámetros:
o client_id = vzt_oauth_t3cnologic
o client_secret = vzt_oauth
o scope = presence
La petición se debe realizar al endpoint: https://{servidor}/oauth/token.
A continuación un ejemplo de petición:

curl –k -u vzt_oauth_t3cnologic:vzt_oauth
https://program.vozitel.com/oauth/token -d 'grant_type=client_credentials&scope=api'
La respuesta que proporciona el anterior comando es:

{
access_token: "ef7e5a63686fbcd2aac23e8578cdd42f38e15ca6"
expires_in: 3600
token_type: "Bearer"
scope: "api"
}
Hay que tener en cuenta el tiempo de expiración del token. Para actualizar el token es necesario
hacer un refresh para que nos actualice el token de acceso.
SERVIDOR
Cada aplicación o agente trabajará siempre contra un mismo servidor. Cuando se proporcionen las
credenciales a un agente para conectar una aplicación se le deben proporcionar obligatoriamente
estos tres datos:
o Usuario: es client_id en terminología OAuth (no tiene porqué ser el mismo usuario de acceso a
VOZITEL).
o Password: es el client_secret en terminología OAuth.
o Servidor: es el servidor sobre el que se tienen que hacer todas las peticiones.
Todas las peticiones tienen que hacerse con HTTPS

Manual API
HASH DE SEGURIDAD
Todas las entidades que se muetra a través del API y que son modificables posteriormente
proporcionan un hash de seguridad que se deba tener en cuenta cuando se vaya a realizar cualquier
modificación posterior a la entidad. Este hash se muestra de la siguiente forma:
sec_hash": "4061733c9cbf817d9afdca66baa30955”
Si se realiza una modificación con PUT de la misma entidad, se deberá incluir el mismo hash, de lo
contrario se indicará un error 409 ("Conflict: se han modificado los datos mientras se visualizaban").
PARÁMETROS DE CABECERA
Una vez obtenido el token de autenticación, es necesario introducir en todas las peticiones los
parámetros de cabecera que detallamos a continuación:
Authorization Bearer 8c3dd449fb63e15242f307a3c93113bf5ef4e424
Content-Type application/json
Accept application/json
TIPOS DE DATOS
En este apartado se definirán los tipos de los datos introducidos en el cuerpo de la respuesta:
TIPO DE DATO DESCRIPCIÓN
VARCHAR Almacena una cadena de longitud variable. La cadena podrá contener desde 0 a
sec_hash": "4061733c9cbf817d9afdca66baa30955”
255 caracteres
INT Número entero con o sin signo
TINYINT Es un número entero con o sin signo. Con signo el rango de valores válidos va desde
-128 a 127. Sin signo, el rango de valores es de 0 a 255
DECIMAL Número en coma flotante desempaquetado. El número se almacena como una
cadena
DATE Tipo fecha, almacena una fecha. El rango de valores va desde el 1 de enero del 1001
al 31 de diciembre de 9999. El formato de almacenamiento es de año-mes-día
TIMESTAMP Combinación de fecha y hora. El rango va desde el 1 de enero de 1970 al año 2037
El formato de almacenamiento depende del tamaño del campo
CHAR Almacena una cadena de longitud fija
CÓDIGOS DE RESPUESTA
CÓDIGOS DE RESPUESTA
En este apartado describiremos los posibles códigos de respuesta que obtendremos con cada petición.
TIPO DE DATO DESCRIPCIÓN
200 OK
204 Respuesta satisfactoria pero sin contenido.
400 Error de validación.
404 Error no encontrado.
409 Error conflicto al leer una entidad.
413 Error respuesta demasiado grande.
500 Error exception.
Manual API
API Buscar
MÉTODO URL DESCRIPCIÓN
GET /api/buscar/ Almacena una cadena de longitud variable. La cadena podrá contener desde 0 a
255 caracteres.
o donde: especifica dónde se va a realizar la búsqueda y admite los siguientes valores:
expedientes, contactos y proyectos.
o buscar: es opcional y es el texto a buscar.
o proyecto: es opcional y centra la búsqueda en el proyecto indicado (id).
o expediente: es opcional y centra la búsqueda en el expediente indicado (id). Solo sirve para los
contacto.
o referencia: es opcional y sirve para buscar por referencia del cliente en el expediente o en el
contacto.
o telefono: es opcional y sirve para buscar por un número de teléfono.
o direccion: es opcional y sirve para buscar por una dirección.
o contacto: es opcional y sirve para buscar un contacto de un expediente.
o agente: es opcional y sirve para buscar por agente.
o latitud: es opcional pero si se especifica también se tiene que especificar la longitud. Sirva para
realizar la búsqueda de contactos cuya dirección está más cerca de la latitud y longitud
especificada.
o longitud: es opcional pero si se especifica también se tiene que especificar la latitud. Sirve para
realizar la búsqueda de contactos cuya dirección está más cerca de la latitud y longitud
especificada.
o radio: opcional. Si se especifica (en metros), buscará sólo las posiciones que estén dentro del
racio especificado.
GET /api/buscar?donde=expedientes&id=8098578
Respuesta
"id": "8098578",
"agente": "1296",
"titulo": "PRUEBAS",
"proyecto": {
"id": "452",
"titulo": "PRUEBAS JESUS"
},
"referencia_cliente": "897"
}
Manual API
API Call
GET /api/call?desde=2019 Obtiene la lista de llamadas para un intervalo de fechas. Se puede filtrar
-01-16&hasta=2019-01 más la búsquedad añadiendo el teléfono de origen o destino y el
-16&telefono=910807796 y el expediente.
POST /api/call Realizar una llamada.
Parámetros posibles para añadir al realizar las búsquedas:
PARÁMETROS DESCRIPCIÓN
DESDE Obtiene la lista de llamadas desde una fecha definida. Este parámetro es obligatorio
HASTA Obtiene la lista de llamadas hasta la fecha definida. Este parámetro es obligatorio
EXPEDIENTE Obtiene la lista de llamadas para un determinado expediente. Este parámetro es opcional
TELEFONO Obtiene la lista de llamadas para un determinado teléfono. El teléfono puede ser el origen o
el destino de la llamada. Este parámetro es opcional
Ejemplos:
POST /api/call
Body
{
"to": "910807800",
"display":"910841500",
"extension": "107"
}
Respuesta:
{
"id": 1
}
GET /api/call?desde=2019-01-16&hasta=2019-01-16&telefono=910807800
Respuesta:
{
"id": "83128057",
"fecha": "2019-01-16 09:02:59",
Se trata de un ejemplo
"callid": "1547625779.890",
de respuesta que
"calleridnum": "910807800", mostraría todos los
... campos de la llamada
Manual API
API Chat
GET /api/chat/{id} Obtiene los detalles de un chat iniciado anteriormente.
POST /api/chat Crea una nueva sala de chat.
Parámetros de la petición:
PARÁMETROS TIPO/LOGITUD OBLIGATORIO COMENTARIOS
CLIENTE INT(11) NO Identificador del cliente

AGENTE INT(11) NO Identificador del agente
PARTE INT(11) NO Parte del texto
TEXTO VARCHAR(1000) SI Texto
FECHA TIMESTAMP NO Fecha
UPLOAD INT(11) NO
ID_SESION VARCHAR(100) NO Identificador de sesión
SYSTEM INT(11) NO
EXTERNAL_ID VARCHAR(50) NO
Ejemplos:
POST /api/chat
Body
{
"texto":"hola"
}
Respuesta:
{
"id": "33302",
"texto": "hola",
"fecha": "2017-09-28 17:47:39",
"upload": 0,
"sesion": "",
"agente": {
"id": "1296",
"nombre": "PRUEBAS JESUS",
"login": "pruebasjesus"
},
"parte": 0
}
Manual API
API Cita
GET /api/cita/{id} Obtiene los datos de una determinada cita.
GET /api/cita Obtiene todas las citas para hoy.
GET /api/cita?desde=2014-07-01 Obtiene la lista de citas desde 2014-07-01 hasta hoy.
GET /api/cita?desde=2014-07-01& Obtiene la lista de citas desde 2014-07-01 hasta el

hasta=2014-07-07 2014-07-07.
POST /api/cita Creación de una cita.
PUT /api/cita/{id} Modificación de una cita.
PARÁMETROS TIPO/LOGITUD OBLIG. COMENTARIOS

EXPEDIENTE INT(11) NO Identificador del expediente
CONTACTO INT(11) NO Identificador del contacto
DIRECCION INT(11) NO Identificador de la dirección
TIENE_INCIDENCIA INT(1) NO Indica si tiene incidencia
TITULO VARCHAR(200) NO Título de la cita
FECHA_ENTRADA TIMESTAMP NO Fecha de entrada de la cita
FECHA_SALIDA TIMESTAMP NO Fecha de salida de la cita
HORA_DESCANSO_INICIO TIME NO Hora inicio descanso
HORA_DESCANSO_FIN TIME NO Hora fin descanso
ESTADO INT(11) NO Estado en el que se encuentra la cita
FECHA_ENTRADA_REAL TIMESTAMP NO Fecha de entrada real de la cita
FECHA_SALIDA_REAL TIMESTAMP NO Fecha de salida real de la cita
FECHA_DESCANSO_INICIO_REAL TIMESTAMP NO Fecha inicio descanso real de la cita
FECHA_DESCANSO_FIN_REAL TIMESTAMP NO Fecha fin descanso real de la cita
EXCESO_TIEMPO INT(11) NO Exceso de tiempo
DESCRIPCION VARCHAR(200) NO Descripción de la cita
HORA_DESCANSO2_INICIO TIME NO Hora inicio descanso2
HORA_DESCANSO2_FIN TIME NO Hora fin descanso2
FECHA_DESCANSO2_INICIO_REAL TIMESTAMP NO Fecha inicio descanso2 real de la cita
FECHA_DESCANSO2_FIN_REAL TIMESTAMP NO Fecha fin descanso2 real de la cita
PUESTO_TRABAJO TINYINT(4) NO Indica si es un puesto de trabajo
PROYECTO INT(11) NO Proyecto al que pertenece el exped.
RETRASO_TIEMPO INT(11) NO Retraso de tiempo
ID_PUESTO_MAESTRO INTV NO Identificador del puesto maestro
AUTOREGISTRO TINYINT(4) NO Indica si esta activado el autoregistro
AUTOREGISTRO_TOLERANCIA INT(11) NO Tolerancia al autoregistro
GESTOR INT(11) NO Gestor de la cita
INCIDENCIA_PUNTUALIDAD INT(11) NO Indica incidencia de puntualidad
INCIDENCIA_TIEMPO_TRABAJADO INT(11) NO Indica incidencia de tiempo trabajado
REFERENCIA_CLIENTE VARCHAR(50) NO Referencia del cliente
GPS_PRESENCIA_START TIMESTAMP NO Coordenadas de inicio del GPS
GPS_PRESENCIA_END TIMESTAMP NO Coordenadas de fin del GPS
Manual API
DESDE Obtiene la lista de citas desde una fecha definida hasta hoy
HASTA Obtiene la lista de citas hasta la fecha definida
PENDIENTE Obtiene la lista de citas definidas por estado(pendiente="0" Tarea finalizada;
pendiente="1" Tarea pendiente)
FINALIZADA Obtiene la lista de citas definidas por estado(finalizada="0" Tarea no finalizada;
finalizada="1" Tarea finalizada).
Ejemplos:
POST /api/cita
Body
{
"titulo":"Prueba Jesus",
"estado":"263",
"expediente": {
"id":8098578
},
"contacto": {
"id":8427111
},
"direccion": {
"titulo":"C/ Norias 92 adicional, 28888 Majadahonda, MADRID"
},
"fecha_entrada":"2017-10-20 10:00:00",
"fecha_salida":"2017-10-20 12:00:00"
}
Respuesta:
{
"id": "637",
"titulo": "Prueba Jesus",
"descripcion": "",
"agente": "1296",
"puesto_trabajo": 0,
"expediente": {
"id": "8098578"
},
"proyecto": { La respuesta continua
"id": "452", en la siguiente página.

},
Manual API
La respuesta viene de
la página anterior.
"contacto": {
"id": "8427111",
"titulo": "contacto1",
"telefonos": {
"telefono1": "910807800"
},
"comentarios": "Cargo"
},
"direccion": {
"6582113": {
"_tabla": "DIRECCION"
},
"id": "6582113",
"titulo": "C/ Norias 92 adicional, 28888 Majadahonda, MADRID",
"pais": "",
"provincia": "",
"poblacion": "",
"departamento": "",
"tipo_via": "0",
"direccion": "",
"direccion_adicional": "",
"gps": {
"latitud": "0.0",
"longitud": "0.0",
"altura": "0.0"
},
"cod_autonomia": "",
"cod_provincia": "",
"cod_poblacion": "",
"cp": ""
},
"tiene_incidencia": 0,
"fecha_entrada": "2017-10-20 10:00:00",
"fecha_entrada_real": "0000-00-00 00:00:00",
"fecha_salida": "2017-10-20 12:00:00", La respuesta continua
"fecha_salida_real": "0000-00-00 00:00:00", en la siguiente página.
"hora_descanso_inicio": "00:00:00",
Manual API
"hora_descanso_fin": "00:00:00",
"fecha_descanso_inicio_real": "0000-00-00 00:00:00",
"fecha_descanso_fin_real": "0000-00-00 00:00:00",
"hora_descanso2_inicio": "00:00:00",
"hora_descanso2_fin": "00:00:00",
"fecha_descanso2_inicio_real": "0000-00-00 00:00:00",
"fecha_descanso2_fin_real": "0000-00-00 00:00:00",
"estado": {
"id": "263",
"titulo": "PENDIENTE",
"id_sistema": "-1"
},
"sec_hash": "7f44be9e185b067fb94918778620d595",
"gestion": {
"agente_id": "1296",
"agente_login": "pruebasjesus",
"agente_nombre": "PRUEBAS JESUS",
"gestor_id": 0,
"gestor_login": "",
"gestor_nombre": ""
}
PUT /api/cita/{id}
Body
{
"titulo":"Prueba Jesus2",
"estado":"263",
"fecha_entrada":"2017-10-20 10:00:00",
"fecha_salida":"2017-10-20 12:00:00",
"gps":{
"latitud":"40.47195470",
"longitud":"-3.8493690",
"altura":"0.0"
},
"sec_hash": "7f44be9e185b067fb94918778620d595"
}
Manual API
Es la respuesta del PUT,
viene de la pag. anterior.
Respuesta:
{
"id": "637",
"titulo": "Prueba Jesus2",
"descripcion": "",
"agente": "1296",
"puesto_trabajo": "0",
"expediente": {
"id": "8098578"
},
"proyecto": {
"id": "452",
},
"contacto": {
"id": "8427111",
"titulo": "contacto1",
"telefonos": {
"telefono1": "910807800"
},
"comentarios": "Cargo"
},
"direccion": {
"6582113": {
"_tabla": "DIRECCION"
},
"id": "6582113",
"titulo": "C/ Norias 92 adicional, 28888 Majadahonda, MADRID",
"pais": "",
"provincia": "",
"poblacion": "",
"departamento": "",
"tipo_via": "0",
"direccion": "",
"direccion_adicional": "", La respuesta continua
"gps": { en la siguiente página.
Manual API
La respuesta viene de la
página anterior.
"latitud": "0.0",
"longitud": "0.0",
"altura": "0.0"
},
"cod_autonomia": "",
"cod_provincia": "",
"cod_poblacion": "",
"cp": ""
},
"tiene_incidencia": "0",
"fecha_entrada": "2017-10-20 10:00:00",
"fecha_entrada_real": "0000-00-00 00:00:00",
"fecha_salida": "2017-10-20 12:00:00",
"fecha_salida_real": "0000-00-00 00:00:00",
"hora_descanso_inicio": "00:00:00",
"hora_descanso_fin": "00:00:00",
"fecha_descanso_inicio_real": "0000-00-00 00:00:00",
"fecha_descanso_fin_real": "0000-00-00 00:00:00",
"hora_descanso2_inicio": "00:00:00",
"hora_descanso2_fin": "00:00:00",
"fecha_descanso2_inicio_real": "0000-00-00 00:00:00",
"fecha_descanso2_fin_real": "0000-00-00 00:00:00",
"estado": {
"id": "263",
"titulo": "PENDIENTE",
"id_sistema": "-1"
},
"sec_hash": "c5d743e43c8f65a20d9e47c1a39e1d86",
"gestion": {
"agente_id": "1296",
"agente_login": "pruebasjesus",
"agente_nombre": "PRUEBAS JESUS",
"gestor_id": "0",
"gestor_login": "",
"gestor_nombre": ""
}
}
Manual API
API Configuración
GET /api/config Obtiene los parámetros de configuración del sistema
Ejemplos:
GET /api/config
Respuesta:
{
"api": {
"version_actual": 1,
"version_defecto": 1,
"version_actual_media_type": "application/vnd.api.v1+json",
"refresco_posicion_minutos": 2,
"version_app_store": 303,
"intervalo_envio_posiciones": 15,
"intervalo_envio_posiciones_proximidad": 5,
"servidor": "program.vozitel.com:8080"
},
"agente": {
"id": "539",
"nombre": "Jesus Cañizares",
"email": "jesus.canizares@vozitel.es",
"login": "VZT_JESUS",
"oauth_client_id": "VZT_JESUS",
"oauth_scope": "chat presence crm api call",
"aviso": "",
"estadisticas": {
"retrasos_acumulados": "04:55:48",
"faltas": "6"
}
},
"estados_citas": [ Se trata de un ejemplo
de respuesta que
mostraría todos los
... campos de la llamada.
Manual API
API Contacto
GET /api/contacto/{id} Obtener los datos del contacto
POST /api/contacto Creación de un contacto
PUT /api/contacto/{id} Modificación de un contacto
DELETE /api/contacto/{id} Modificación de un contacto
ATRIBUTO TIPO/LONGITUD OBLIG. COMENTARIOS

NOMBRE VARCHAR(150) SI Nombre del contacto
NIF VARCHAR(20) NO NIF del contacto
COMENTARIOS VARCHAR(500) NO Comentarios
CLIENTE INT(11) NO Cliente
AGENTE INT(11) NO Agente
OTROS VARCHAR(1000) NO Otras indicaciones
TIPO VARCHAR(50) NO Tipo
VALOR DECIMAL(12,2) NO Valor
ESTADO INT(11) NO Estado
PARTE_NOMBRE VARCHAR(50) NO Nombre
PARTE_APELLIDO1 VARCHAR(50) NO Apellido 1
PARTE_APELLIDO2 VARCHAR(50) NO Apellido 2
FECHA_NACIMIENTO DATE NO Fecha de nacimiento
SEXO CHAR(1) NO Sexo del contacto (H / M)
Ejemplos:
POST /api/contacto
Body
{
"nombre":"Prueba Jesus",
"expediente": 8098578
}
Respuesta:
{
"ID": "27371",
"NOMBRE": "Prueba Jesus",
"NIF": "", La respuesta continua
en la siguiente página.
Manual API
"REFERENCIA_CLIENTE": "",
"COMENTARIOS": "",
"CLIENTE": "1",
"AGENTE": "539",
"OTROS": "",
"MANUAL": 0,
"TIPO": "",
"VALOR": 0,
"ESTADO": 0,
"PARTE_NOMBRE": "",
"PARTE_APELLIDO1": "",
"FECHA_NACIMIENTO": "0000-00-00",
"SEXO": "",
"FECHA_MODIFICACION": "2017-09-28 12:21:46",
"CREADO": "2017-09-28 12:21:46",
"sec_hash": "4dc2702a82eb3a3907fb73a4991fe39d",
"EXPEDIENTE": "13369",
"PROYECTO": "15"
}
PUT /api/contacto/{id}
{
"id""nombre":"Prueba Jesus2",
"expediente":8098578
"sec_hash": "5be9c618765208d400e4b2243068dcce"
}
Respuesta:
{
"ID": "27371",
"NOMBRE": "Prueba Jesus2",
"NIF": "",
"REFERENCIA_CLIENTE": "", La respuesta continua
en la siguiente página.
Manual API
"COMENTARIOS": "",
"CLIENTE": "1",
"AGENTE": "539",
"OTROS": "",
"MANUAL": 0,
"TIPO": "",
"VALOR": 0,
"ESTADO": 0,
"PARTE_NOMBRE": "",
"FECHA_NACIMIENTO": "0000-00-00",
"SEXO": "",
"CREADO": "2017-09-28 12:21:46",
"sec_hash": "4dc2702a82eb3a3907fb73a4991fe39d",
"PROYECTO": "15"
}
Si necesitamos obtener información de la dirección, email, cuenta bancaria o redes sociales del
contacto , es necesario revisar la siguiente documentación:
1.- Dirección
2.- E-Mail
3.- Red Social
4.- Cuenta Bancaria
Manual API
API Cuenta Bancaria Contacto
GET /api/contactocuentabancaria/{idCuenta} Obteniene los datos de la cuenta bancaria para

un determinado identificador.
GET /api/contactocuentabancaria?contacto Obteniene los datos de la cuenta bancaria para

={idContacto} un determinado identificador del contacto.
POST /api/contactocuentabancaria Crea una cuenta bancaria para un contacto.
PUT /api/contactocuentabancaria/{idCuenta} Modifica una cuenta bancaria de un contacto.
DELETE /api/contactocuentabancaria/{idCuenta} Borrado de una cuenta bancaria de un contacto.

TITULO VARCHAR(200) NO Título
CUENTA VARCHAR(500) NO Número de cuenta
TIPO_CUENTA CHAR(1) NO Tipo de cuenta
TIPO_FORMA_CONTACTO INT(11) NO Tipo forma contacto
EMISOR VARCHAR(100) NO Emisor
CADUCA_MES CHAR(2) NO Mes de caducidad
CADUCA_ANO CHAR(4) NO Año de caducidad
ORDEN INT(11) NO Orden en que se inserta el elemento
(disponible en la inserción y en la
modificación de la entidad)
Ejemplos:
POST /api/co ntactocuentabancaria

Body
{
"titulo": "cuenta",
"cuenta": "44",
"contacto": 27369
}
Respuesta:
{
"ID": "10",
"CLIENTE": "1",
La respuesta continua
"TITULO": "cuenta", en la siguiente página
Manual API
"TIPO_CUENTA": "",
"TIPO_FORMA_CONTACTO": 0,
"EMISOR": "",
"CADUCA_MES": "",
"CADUCA_ANO": "",
"sec_hash": "fdf85652d33eaf36aae239cadfa9ec50"
}
PUT /api/contactocuentabancaria/{id}
Body
{
"cuenta_bancaria": "433",
"TITULO": "cuenta",
"sec_hash": "0aa23c346963fac50322f9ecd89de1f1"
}
Respuesta:
{
"ID": "10",
"CLIENTE": "1",
"TITULO": "cuenta",
"CUENTA": "443",
"TIPO_CUENTA": "",
"EMISOR": "",
"CADUCA_MES": "",
"CADUCA_ANO": "",
"sec_hash": "fdf85652d33eaf36aae239cadfa9ec50"
}
Manual API
API Dirección Contacto
GET /api/contactodireccion/{idDirección} Obtiene la dirección de un ID de dirección.
GET /api/contactodireccion?contacto= Obtiene la dirección para un ID del contacto.

{idContacto}
POST /api/contactodireccion Crea de una dirección para un contacto.
PUT /api/contactodireccion/{idDirección} Modifica de una dirección de un contacto.
DELETE /api/contactodireccion/{idDirección} Borra de una dirección de un contacto.

PAIS CHAR(2) NO País
PROVINCIA VARCHAR(50) NO Provincia
DEPARTAMENTO VARCHAR(200) NO Departamento
COD_AUTONOMIA CHAR(10) NO Código autonomía
COD_PROVINCIA CHAR(10) NO Código provincia
COD_POBLACION CHAR(10) NO Código población
TIPO_VIA INT(11) NO Tipo vía
DIRECCION VARCHAR(200) NO Dirección
DIRECCION_ADICIONAL VARCHAR(200) NO Dirección adicional
TIPO_FORMA_CONTACTO INT(11) NO Tipo forma contado
CREADO TIMESTAMP NO Fecha creación
CP VARCHAR(10) NO Código postal
GPS_LATITUD DECIMAL(25,22) NO Latitud gps
GPS_LONGITUD DECIMAL(25,22) NO Longitud gps
GPS_ALTURA DECIMAL(14,6) NO Altura gps
GPS_INDEX DECIMAL(25,20) NO Índice gps
REFERENCIA_CLIENTE VARCHAR(50) NO Referencia cliente
TOLERANCIA_GPS INT(11) NO Tolerancia
GPS_PARCIAL TINYINT(4) NO GPS
(disponible en la inserción y en la modifi.)
Ejemplos:
POST /api/contactodireccion
Body
{
"direccion": "C/Norias 92, Majadahonda, Madrid, 28221",
"contacto": 26089,
"COD_PROVINCIA":28221,
"POBLACION": "Majadahonda"
}
Manual API
Es la respuesta del POST,
Respuesta:
{
"ID": "11954",
"CLIENTE": "1",
"TITULO": "",
"PAIS": "",
"PROVINCIA": "",
"DEPARTAMENTO": "",
"COD_AUTONOMIA": "",
"COD_PROVINCIA": "28221",
"COD_POBLACION": "",
"POBLACION": "Majadahonda",
"TIPO_VIA": 0,
"DIRECCION": "C/Norias 92, Majadahonda, Madrid, 28221",
"DIRECCION_ADICIONAL": "",
"CREADO": "2017-09-29 11:17:24",
"CP": "",
"GPS_LATITUD": 0,
"GPS_LONGITUD": 0,
"GPS_ALTURA": 0,
"GPS_INDEX": 0,
"TOLERANCIA_GPS": 0,
"GPS_PARCIAL": 0,
"sec_hash": "3e1a6ecc9a0870406d34965a50728627"
}
PUT /api/contactodireccion/{id}
Body
{
"numero": "910841500",
"sec_hash": "de3d03366904faf6e91fb8e67c2e23f7"
}
Manual API
Respuesta:
{
"ID": "11954",
"CLIENTE": "1",
"TITULO": "",
"PAIS": "",
"PROVINCIA": "",
"DEPARTAMENTO": "",
"COD_AUTONOMIA": "",
"COD_PROVINCIA": "28221",
"COD_POBLACION": "",
"POBLACION": "Majadahonda",
"TIPO_VIA": 0,
"DIRECCION": "C/Norias 92, Madrid",
"DIRECCION_ADICIONAL": "",
"CREADO": "2017-09-29 11:17:24",
"CP": "",
"GPS_LATITUD": 0,
"GPS_LONGITUD": 0,
"GPS_ALTURA": 0,
"GPS_INDEX": 0,
"TOLERANCIA_GPS": 0,
"GPS_PARCIAL": 0,
"sec_hash": "3e1a6ecc9a0870406d34965a50728627"
}
Manual API
API Pool
GET /api/pool/{id}?cookie=cookie001 Obtiene los detalles de un pool mediante un

identificador. Es necesario añadir la misma cookie que
se definió al crear el pool.
POST /api/pool Creación de un pool. Devuelve el identificador del

pool y el número de teléfono.
PUT /api/pool/{id}?cookie=cookie001 Se utiliza para cambiar la URL o los datos del lead
mediante un identificador. Es necesario añadir la misma
cookie que se definió al crear el pool.
DELETE /api/pool/{id}?cookie=cookie001 Se utiliza para anular la reserva del pool. Es necesario

añadir la misma cookie que se definió al crear el pool.
POOL INT(11) SI Identificador del pool

COOKIE VARCHAR(200) SI Cookie almacenada en el sitio web
URL VARCHAR(500) NO Enlace al que hace referencia
DATOS BLOB NO Array de datos adicionales del lead
CAMPANA VARCHAR(64) NO Identeficador de la campaña de marketing
asociada (64 caracteres)
FUENTE VARCHAR(64) NO Fuente de trafico
MEDIO VARCHAR(64) NO Categoría de la fuente de tráfico
Ejemplos:
POST /api/pool
Body
{
"pool": "210",
"cookie": "cookie001",
"campana": "Newsletter",
"fuente": "spring_newsletter",
"medio": "email",
"datos":{},
"url": "url001"
}
Manual API
Respuesta:
{
"id": "102",
"numero": "910807800"
}
PUT /api/pool/102
Body
{
"pool": "210",
"medio": "email",
"datos":{},
"url": "url001"
}
Respuesta:
{
"id": "102",
"numero": "910807800",
"url": "url002",
"medio": "email",
"datos": false,
"expira": "2018-10-01 11:17:20"
}
Manual API
API Token
POST /oauth/token Obtener el token de acceso. Es necesario autenticarse mediante Oauth
Ejemplos:
POST /oauth/token
Body
{
"grant_type":"client_credentials"
}
Respuesta:
"access_token": "5c5def54100bbb1851c9c0f2daab7a9637417c00",
"expires_in": 43200,
"token_type": "Bearer",
"scope": "chat presence crm api call"
Manual API
API Metadato
Este endpoint permite manipular los metadatos de todas las entidades. La diferentes entidades son
clasificadas mediantes ámbitos que permiten identificar la entidad que se quiere manipular.
Los ámbitos existentes son los siguientes:
ENTIDAD ÁMBITO SUBENTIDAD
EXPEDIENTE 0 (por defecto si no se especifica) N/A

CONTACTO
sec_hash": "4061733c9cbf817d9afdca66baa30955” El ID del contacto
1
OFERTA 2 El ID de la oferta
PRODUCTO 3 El ID del producto
LÍNEA 4 El ID de la línea
TAREA 5 El ID de la tarea
DOCUMENTO 6 El ID del documento
CITA 7 El ID de la cita
PUESTO DE TRABAJO 8 El ID del puesto de trabajo
GET /api/metadato/{id} Obtiene los datos de un metadato
GET /api/metadato?expediente=XXX Obtiene la lista de todos los metadatos del

expediente XXX para el ámbito "expediente". Por
defecto, ambito = 0
GET /api/metadato?expediente=XXX&ambito= Obtiene la lista metadatos del contacto YYY

1&subentidad=YYY (ambito = 1) del expediente XXX
POST /api/metadato Creación de un metadato
PUT /api/metadato/{id} Modificación de un metadato

EXPEDIENTE INT(11) SI Identificador del expediente
PROYECTO INT(11) NO Identificador del proyecto
METADATO INT(11) SI Identificador del metadato
SUBENTIDAD INT(11) NO Identificador de la subentidad
VALOR VARCHAR(100) SI Valor del metadato
Manual API
Ejemplos:
POST /api/metadato
Body
{
"EXPEDIENTE": 18866,
"AMBITO": 1,
"VALOR": 333,
"SUBENTIDAD": 18857,
"METADATO": "77"
}
Respuesta:
{
"ID": "731",
"CLIENTE": "1",
"PROYECTO": "15",
"METADATO": "77",
"VALOR": 333,
"SUBENTIDAD": 18857,
"sec_hash": "60f46e24449054cfeef493f5304cef3e"
}
GET /api/metadato?expediente=18866&subentidad=18857&ambito=1
Respuesta:
[
{
"ID": "731",
"CLIENTE": "1",
"PROYECTO": "15",
"METADATO": "77",
"VALOR": "333",
"SUBENTIDAD": "18857",
"sec_hash": "60f46e24449054cfeef493f5304cef3e"
}
]
Manual API
API Oportunidad Comercial
GET /api/oportunidadcomercial/{id} Obtener los datos de una oportunidad comercial
GET /api/oportunidadcomercial?expediente= Obtener las oportunidades comerciales de un

1234 determinado expediente
GET /api/oportunidadcomercial? Obtener las oportunidades comerciales para una

referencia=1234abc determinada referencia
GET /api/oportunidadcomercial?producto=21 Obtener las oportunidades comerciales para un

determinado identificador de producto
GET /api/oportunidadcomercial? Obtener las oportunidades comerciales con un

producto=prod_1 literal de producto. Es obligatorio definir el exped.
POST /api/oportunidadcomercial Creación de una oportunidad comercial
PUT /api/oportunidadcomercial/{id} Modificación de una oportunidad comercial
DELETE /api/oportunidadcomercial/{id} Borrado de una oportunidad comercia

TITULO VARCHAR(100) NO Título de la Op. Comercial

DESCRIPCION VARCHAR(5000) NO Descripción de la Op. Comerciall
PROYECTO INT(11) NO Proyecto al que pertenece el expediente
FECHA DATE NO Fecha de estimación
IMPORTE DECIMAL(14,4) NO Importe total
ESTADO INT(11) NO Estado de la Op. Comercial
PROBABILIDAD INT(11) NO Probabilidad
PRODUCTO INT(11) NO Identificador del producto
CREADA TIMESTAMP NO Fecha de creación de la Op. Comercial
DISTRIBUIDOR INT(11) NO Identificador del distribuidor
FECHA_INICIO DATE NO Fecha de inicio de la Op. Comercial
FECHA_FIN DATE NO Fecha de fin de la Op. Comercial
REFERENCIA_CLIENTE VARCHAR(50) NO La referencia del cliente
PROMOCION INT(11) NO Identificador de la promoción
CANTIDAD INT(11) NO Cantidad
IMPORTE_UNITARIO INT(11) NO Importe unitario
PRODUCTO_CONTRATADO DECIMAL(14,4) NO Identificar del producto contratado
FECHA_MODIFICACION TIMESTAMP NO Fecha de modificación de la Op. Comercial
AFINIDAD INT(11) NO Afinidad
TAREA INT(11) NO Identificador de la tarea vinculada

EXPEDIENTE Obtiene la lista de oportunidades comerciales que tiene un expediente específico
REFERENCIA Obtiene la lista de oportunidades comerciales que tienen una referencia
determinada en la oportunidad comercial
Manual API
Ejemplos:
POST /api/oportunidadcomercial
Body
{
"titulo": "PRUEBA JCD",
"descripcion": "PRUEBA JCD",
"agente": "539",
"expediente":37912,
"proyecto": "15",
"fecha": "2017-10-01",
"importe": "10.0000",
"estado": "4",
"probabilidad": "22",
"producto": "20",
"distribuidor": "1",
"contacto": "27358",
"fecha_inicio": "2017-10-02",
"fecha_fin": "2017-10-03",
"referencia_cliente": "22",
"promocion": "6",
"cantidad": "1",
"importe_unitario": "10.0000",
"tarea": "0"
}
Respuesta:
{
"t"id": "29",
"agente": "539",
"expediente": {
"id": 37912,
"titulo": "jcd2"
},
"proyecto": "15",
"fecha": "2017-10-01",
"importe": "10.0000",
"estado": "4",
"producto": "20",
en la siguiente página
Manual API
"fecha_inicio": "2017-10-02",
"fecha_fin": "2017-10-03",
"promocion": "6",
"cantidad": "1",
"tarea": "0",
"hash": "cb717624015f421f3cf91f0daa820eb4"
}
PUT /api/oportunidadcomercial/{id}
Body
{
"titulo": "PRUEBA JCD2",
"descripcion": "PRUEBA JCD2",
"agente": "539",
"expediente":37912,
"proyecto": "15",
"fecha": "2017-10-01",
"importe": "10.0000",
"estado": "4",
"producto": "20",
"fecha_inicio": "2017-10-02",
"fecha_fin": "2017-10-03",
"promocion": "6",
"cantidad": "1",
"tarea": "0",
"sec_hash": "cb717624015f421f3cf91f0daa820eb4"
}
Manual API
Respuesta:
{
"id": "29",
"agente": "539",
"expediente": {
"id": 37912,
"titulo": "jcd2"
},
"proyecto": "15",
"fecha": "2017-10-01",
"importe": "10.0000",
"estado": "4",
"producto": "20",
"fecha_inicio": "2017-10-02",
"fecha_fin": "2017-10-03",
"promocion": "6",
"cantidad": "1",
"tarea": "0",
"hash": "cb717624015f421f3cf91f0daa820eb4"
}
Manual API
API Producto Contratado
GET /api/productocontratado/{id} Obtener los datos de un producto contratado
GET /api/productocontratado? Obtener los productos contratados de un

expediente=1234 determinado expediente
GET /api/productocontratado? Obtener los productos contratados con una

referencia=1234abc determinada referencia
GET /api/productocontratado? Obtener los productos contratados para un

producto=prod_21 determinado identificador de producto
GET /api/productocontratado? Obtener los productos contratados con un

producto=prod_1 literal de producto espec. Es obligatorio definir un exped.
POST /api/productocontratado Creación de un producto contratado
PUT /api/productocontratado/{id} Modificación de un producto contratado
DELETE /api/productocontratado/{id} Borrado de un producto contratado
TITULO VARCHAR(100) NO Título de un Prod. Contratado

DESCRIPCION VARCHAR(5000) NO Descripción de un Prod. Contratado
CREACION TIMESTAMP NO Fecha de creación de un Prod. Contratado
INACTIVO INT(11) NO Estado del Prod. Contratado
PRECIO DECIMAL(14,4) NO Importe
CANTIDAD INT(11) NO Cantidad
IMPORTE_UNITARIO INT(11) NO Importe unitario
PRECIO_LIBRE INT(11) SI Precio libre
TAG INT(11) NO Etiqueta
FORMULA_EJECUTAR TINYINT(4) NO Fórmulas para ejecutar
REGLA_CREACION_TAREA INT(11) NO Regla de creación de tarea
CATEGORIA INT(11) NO Identificador de la categoría
AFINIDAD INT(11) NO Afinidad
SUBCATEGORIA INT(11) NO Identificador de la subcategoría
EXPEDIENTE Obtiene la lista de productos contratados que tiene un expediente específico.
REFERENCIA Obtiene la lista de productos contratados que tienen una referencia determinada de
producto contratado.
Manual API
Ejemplos:
POST /api/productocontratado
Body
{
"agente": "539",
"expediente":37912,
"proyecto": "15",
"fecha": "2017-10-01",
"importe": "10.0000",
"producto": "20",
"fecha_inicio": "2017-10-02",
"fecha_fin": "2017-10-03",
"promocion": "6",
"cantidad": "1",
"importe_unitario": "10.0000
}
Respuesta:
{
"id": "50",
"expediente": {
"id": 37912,
"titulo": "jcd2"
},
"proyecto": "15",
"fecha": "2017-10-01",
"importe": "10.0000",
"agente": {
"id": "539",
"nombre": "Jesus Cañizares" La respuesta continua
en la siguiente página
{
Manual API
},
"producto": {
"id": "20",
"nombre": "PRUEBA CONTEXTO PARSER"
},
"fecha_inicio": "2017-10-02",
"fecha_fin": "2017-10-03",
"promocion": "6",
"cantidad": "1",
"hash": "38650b3605ed841b8bb302d357f5a612"
}
PUT /api/productocontratado/{id}
Body
{
"agente": "539",
"expediente":37912,
"proyecto": "15",
"fecha": "2017-10-01",
"importe": "10.0000",
"estado": "4",
"producto": "20",
"fecha_inicio": "2017-10-02",
"fecha_fin": "2017-10-03",
"promocion": "6",
"cantidad": "1",
"tarea": "0",
"sec_hash": "cb717624015f421f3cf91f0daa820eb4"
}
Manual API
Respuesta:
{
"id": "50",
"expediente": {
"id": 37912,
"titulo": "jcd2"
},
"proyecto": "15",
"fecha": "2017-10-01",
"importe": "10.0000",
"agente": {
"id": "539",
"nombre": "Jesus Cañizares"
},
"producto": {
"id": "20",
"nombre": "PRUEBA CONTEXTO PARSER"
},
"fecha_inicio": "2017-10-02",
"fecha_fin": "2017-10-03",
"promocion": "6",
"cantidad": "1",
"hash": "5262ebe1f2f319f58fd60952e352c54c"
}
Manual API
API Tarea
GET /api/tarea/{id} Obtiene los datos de una determinada tarea
GET /api/tarea Obtiene todas las tareas para hoy
GET /api/tarea?desde=2014-07-01 Obtiene la lista de tareas desde el 2014-07-01 hasta hoy
GET /api/tarea?desde=2014-07-01 Obtiene la lista de tareas desde el 2014-07-01 hasta el

&hasta=2014-07-07 2014-07-07
GET /api/tarea?estado=1 Obtiene la lista de tareas que están cerradas(estado="0"

Tareas pendientes; estado="1" Tareas cerradas; las
estado="all" Todas tareas)
GET /api/tarea?expediente=10232034 Obtiene la lista de tareas de un determinado expediente
GET /api/tarea?subtareas=10232034 Obtiene el listado de subtareas vinculadas a esta tarea
GET /api/tarea?tipo=3 Obtiene la lista de tareas de un tipo específico de tarea
POST /api/tarea Creación de una tarea
PUT /api/tarea/{id} Modificación de una tarea
DELETE /api/tarea/{id} Borrado de una tarea que no tiene subtareas
DELETE /api/tarea/{id}?subtareas=true Borrado de una tarea que tiene subtareas. Se borran

también las subtareas

FECHA_CREACION TIMESTAMP NO Fecha de creación de la tarea
FECHA_RESOLUCION TIMESTAMP NO Fecha de resolución de la tarea
ESTADO TINYINT NO Estado de la tarea
TIPO INT(11) SI Tipo de tarea
DESCRIPCION LONGBLOB SI Descripción de la tarea
RESULTADO INT(11) NO Resultado de la tarea
TITULO VARCHAR(250) SI Título de la tarea
FECHA_EJECUCION TIMESTAMP SI Fecha de ejecución de la tarea
CREADOR INT(11) NO Creador de la tarea
ID_EMAIL INT(11) NO Identificador de email
PERSONALIZADO1 VARCHAR(50) NO Personalizado 1
PERSONALIZADO3 VARCHAR(50) NO Personalizado3
DOCUMENTO VARCHAR(200) NO Documento
ALERTAR TINYINT(1) NO Alerta
Manual API
D_TASK INT(11) NO Identificador de tarea
VINCULADA INT(11) NO Indica si la tarea esta vinculada
ID_SMS INT(11) NO Identificador del sms
ID_MENSAJE_SOCIAL INT(11) NO Identificador del mensaje social
ESFUERZO INT(11) NO Identificador de esfuerzo
TIPO_INTERNO TINYINT(4) NO Tipo interno
ID_INTERNO INT(11) NO Identificador interno
PLANTILLA INT(11) NO Plantilla
FECHA_CAMBIO_RESULTADO TIMESTAMP NO Fecha de cambio de resultado
ID_RELACION INT(11) NO Identifacor de relación
PADRE INT(11) NO Identificador del padre de la tarea
URGENTE TINYINT(4) NO Tarea urgente
DESDE Obtiene la lista de tareas desde una fecha definida hasta hoy
HASTA Obtiene la lista de tareas hasta la fecha definida
ESTADO Obtiene la lista de tareas definidas por estado(estado="0" Tareas pendientes;
estado="1" Tareas cerradas; estado="all" Todas las tareas)
EXPEDIENTE Obtiene la lista de tareas que tiene un expediente específico
TIPO Obtiene la lista de tareas de un tipo específico de tarea
SUBTAREAS Obtiene la lista de subtareas vinculadas a una tarea. Es necesario pasarle el id de la
tarea sobre la que queremos hacer la consulta de las subtareas
Si desea crear una tarea sin expediente, debe indicar el proyecto
Por defecto obtenemos las tareas pendientes, para obtener las tareas cerradas es necesario
pasar el estado a "1" y si no es necesario definir el estado se pasará el estado como "all"
Por defecto obtenemos las tareas del agente que consulta, para obtener todas
las tareas es necesario definir "agente = 0".
Ejemplos:
POST /api/tarea
Body
{
"titulo":"Prueba Jesus",
"descripcion":"prueba",
"expediente":{
"id":"8098578"
},
"estado":"0",
"tipo":{
"id":3611
},
"fecha_planificada":"2017-10-20 12:00:00"
"sec_hash": "d92080cd96dc6141ac42e06d8fdf6616"
}
Manual API
Respuesta:
{
"id": "6184233",
"titulo": "Prueba Jesus",
"fecha_creacion": "2017-09-28 17:39:47",
"fecha_resolucion": "2017-09-28 17:39:47",
"fecha_planificada": "2017-10-20 12:00:00",
"estado": "0",
"resultado": {
"id": 0,
"titulo": ""
},
"proyecto": {
"id": "452",
},
"tipo": {
"id": 3611,
"titulo": "TIPO TAREA CON PERSONALIZADOS"
},
"agente": {
"id": "1296",
"titulo": "PRUEBAS JESUS",
},
"autor": {
"id": "1296",
},
"expediente": {
"id": "8098578",
"titulo": "PRUEBAS"
},
"campos_personalizados": {
"1": "",
AP
},
"descripcion": "prueba",
}
Manual API
PUT /api/tarea/{id}
Body
{
"descripcion":"prueba",
"expediente":{
"id":"8098578"
},
"estado":"0",
"tipo":{
"id":3611
},
"fecha_planificada":"2017-10-20 12:00:00",
}
Respuesta:
{
"id": "6184233",
"titulo": "Prueba Jesus2",
"fecha_creacion": "2017-09-28 17:39:47",
"fecha_resolucion": "2017-09-28 17:39:47",
"fecha_planificada": "2017-10-20 12:00:00",
"estado": "0",
"resultado": {
"id": 0,
"titulo": ""
},
"proyecto": {
"id": "452",
},
"tipo": {
"id": 3611,
"titulo": "TIPO TAREA CON PERSONALIZADOS"
},
"agente": {
"id": "1296",
},
"autor": {
"id": "1296", Maryrainbowblythe
"login": "pruebasjesus" Termina igual que la
... respuesta del POST
Manual API
API Encuesta Ejecución
GET /api/encuestaejecucion/{idEncuesta} Obtiene los datos clave/valor para un determinado

identificador encuesta
GET /api/encuestaejecucion?proyecto=3 Obtiene la lista de encuestas para el proyecto 3
GET /api/encuestaejecucion?expediente=13468 Obtiene la lista de encuestas del expediente 13468
GET /api/encuestaejecucion?desde= Obtiene la lista de encuestas desde el 2018-04-01

2018-04-01&hasta=2018-04-07 hasta el 2018-04-0
DESDE Obtiene la lista de encuestas desde una fecha definida hasta hoy
HASTA Obtiene la lista de encuestas hasta la fecha definida
EXPEDIENTE Obtiene la lista de encuestas para un determinado expediente
PROYECTO Obtiene la lista de encuestas para un proyecto
Ejemplos:
GET /api/encuestaejecucion/132
Respuesta:
{
"EJECUCION": "132",
"TITULO_EXPEDIENTE": "JAVIER VEGA",
"ESTADO_TITULO": "sin nombre",
"VALORACION_TITULO": null,
"FECHA": "2018-01-09 12:12:28",
"ULTIMA_MODIFICACION": "2018-01-09 12:13:12",
"TITULO_ENCUESTA": "Pruebas Responsive ",
"PROYECTO": "PRUEBAS",
"TITULO_VALORACION": null,
"REFERENCIA_CLIENTE": "9762455",
"PERSONALIZADO1": "DDD",
"PERSONALIZADO2": "1", en la siguiente página
Manual API
Es la respuesta del GET,
"PERSONALIZADO3": "",
"PERSONALIZADO6": "2018-03-05",
"TIPO_EXPEDIENTE": "PRUEBAS_MASIVO",
"CONTACTO": null,
"USUARIO": "VZT_JESUS",
"ESTADO_EXPEDIENTE": "sin nombre",
"VALORACION_EXPEDIENTE": null,
"VINCULADA": "0",
"¿como te llamas?": "María",
"cUANTOS AÑOS TIENES?": "ENTRE O Y 10",
"COMENTARIOS": "---",
"QUE DIA ES HOY?": "2018-01-10",
"¿que hora es hoy?": "12:15:00",
"¿que dia y hora es hoy?": "2018-01-10 12:15:00",
"Pregunta1": "lll",
"MATRIZ": "FILA: Respuesta2"
Manual API
API Documento
GET /api/documento/{id}?contenido=true Obtener los datos de un documento. Por defecto
no se descarga el contenido de un documento. Si
desea descargar el contenido, especifique el
parámetro contenido con el valor "true"
GET /api/documento?expediente=XXX Obtiene todos los documentos del exped. XXX
GET /api/documento?tarea=XXX Obtiene todos los documentos de la tarea XXX
GET /api/documento?expediente=XXX& Obtiene todos los documentos asociados al

desde=2018-07-01&hasta=2018-07-15 expediente XXX en un rango de fechas definido
POST /api/documento Creación de un documento. Para cargar el

documento primero tiene que crear el documento
con POST y posteriormente subir el contenido
con PUT
PUT /api/documento/{id}?contenido=true& Modificación de un documento. Si especifica el

fichero=nombre_fichero.ext parámetro contenido=true, se subirá el
documento al sistema. En este caso es obligado
indicar el nombre del fichero para poder
establecer los parámetros MIME adecuados.
Cuando se sube el contenido no hace falta
indicar el HASH de seguridad.
DELETE /api/documento/{id} Borrado de un documento
TITULO VARCHAR(100) NO Título del documento

NOMBRE_FICHERO VARCHAR(100) NO Nombre del fichero subido. Sirve para
descargarlo con el mismo nombre y
poder asociar el tipo de contenido MIME
TIPO VARCHAR(50) NO Tipo de documento
EXPEDIENTE INT(11) SI Expediente al que pertenece
IDUNICO VARCHAR(100) NO ID exclusivo que asigna el sistema para
poder hacer descargas por URL
CREADO FECHA HORA NO Fecha y hora en la que se ha creado
CATEGORIA INT(11) NO Categorización del docuento
DESCRIPCION VARCHAR(5000) NO Descripción detallada del documento
ARCHIVADO VARCHAR(100) NO Literal que describe la ubicación de la
archivación del documento
TAMANO INT(11) NO Tamaño del documento. Se calcula
automáticamente cuando se sube.
TAREA INT(11) NO ID de la tarea con la que está vinculado
el documento
Manual API
DESDE Obtiene los documentos de un expediente desde una fecha definida

HASTA Obtiene los documentos de un expediente hasta la fecha definida
EXPEDIENTE Obtiene los documentos para un determinado expediente
TAREA Obtiene los documentos de un expediente para un tarea específica
Ejemplos:
POST /api/documento
Body
{
"TITULO": "DOCUMENTO DESDE API"
}
Respuesta:
{
"ID": "27",
"NOMBRE_FICHERO": "",
"TIPO": "",
"CLIENTE": "1",
"TITULO": "DOCUMENTO DESDE API",
"IDUNICO": "5a2a751654032",
"PROYECTO": "5",
"CREADO": "2017-12-08 12:18:46",
"CATEGORIA": 0,
"DESCRIPCION": "",
"ARCHIVADO": "",
"TAMANO": 0,
"sec_hash": "fcdbc4bcaab17ddc9ae3aab99f73e5b6"
}
PUT /api/documento/{id}
Body
{
"TITULO": "NUEVO TITULO DESDE EL API",
"sec_hash": "fcdbc4bcaab17ddc9ae3aab99f73e5b6"
}
Manual API
Respuesta:
{
"ID": "27",
"NOMBRE_FICHERO": "",
"TIPO": "",
"CLIENTE": "1",
"TITULO": "NUEVO TITULO DESDE EL API",
"IDUNICO": "5a2a751654032",
"PROYECTO": "5",
"CREADO": "2017-12-08 12:18:46",
"CATEGORIA": "0",
"DESCRIPCION": "",
"ARCHIVADO": "",
"TAMANO": "0",
"sec_hash": "4d08d388976114edb4783889f30ccfa9"
}
CARGA Y DESCARGA DE DOCUMENTOS

Para la carga de un documento, primero debe crear la entidad con POST y una vez obtenido el ID del
documento, debe realizar la subida con PUT. No olvide especificar el content-type adecuado (por
ejemplo application/octet-stream para contenido binario). Ejemplo:
PUT /api/documento/26?contenido=true&fichero=prueba2.pdf y el contenido del fichero debe ir

en el body del request en binario.
Para la descarga, utilizar como en el siguiente ejemplo:
GET /api/documento/26?contenido=true.
Manual API
API Dowload
GET /api/download/{id} Descargar el fichero
Ejemplos:
GET /api/download/5
Respuesta:
{
Devuelve el fichero
}
Manual API
API Email Contacto
GET /api/contactoemail/{idEmail} Obtiene el email de un determinado
identificador de email
GET /api/contactoemail?contacto= Obtiene el email de un determinado

{idContacto} identificador del contacto
POST /api/contactoemail Creación de un email para un contacto
PUT /api/contactoemail/{idEmail} Modificación de un email de un contacto
DELETE /api/contactoemail/{idEmail} Borrado de un email de un contacto

EMAIL VARCHAR(200) NO Email
ERRONEO TINYINT(1) NO Email erróneo
ADMINISTRATIVO TINYINT(1) NO Administrativo
SISTEMA TINYINT(1) NO Sistema
(para la inserción y la modificación)
Ejemplos:
POST /api/contactoemail
Body
{
"email": "jesus.canizares@vozitel.es",
"contacto": 27369
}
Respuesta
{
"ID": "2927",
"CLIENTE": "1",
"TITULO": "",
"EMAIL": "jesus.canizares@vozitel.es",
"ERRONEO": 0,
"ADMINISTRATIVO": 0,
"SISTEMA": 0,
"sec_hash": "cc3098bd0bc8fe4f54815f85f05354aa"
}
Manual API
PUT /api/contactoemail/{id}
Body
{
"email": "jesus.canizares@null.es",
"sec_hash": "cc3098bd0bc8fe4f54815f85f05354aa"
}
Respuesta:
{
"ID": "2927",
"CLIENTE": "1",
"TITULO": "",
"EMAIL": "jesus.canizares@null.es",
"TIPO_FORMA_CONTACTO": "0",
"ERRONEO": "0",
"ADMINISTRATIVO": "0",
"SISTEMA": "0",
"sec_hash": "2752bdc4b2a1637799d1f4ac497347c8"
}
Manual API
API Expediente
GET /api/expediente/{id} Obtener los datos de un expediente
POST /api/expediente Creación de un expediente
PUT /api/expediente/{id} Modificación de un expediente
DELETE /api/expediente/{id} Borrado de un expediente
AGENTE INT(11) NO El agente es la persona que se encargará

de gestionar el expediente
PROYECTO INT(11) SI Proyecto al que pertenece el expediente
ESTADO INT(11) NO El estado en que se encuentra el exped.
DEUDA_TOTAL DECIMAL(14,4) NO La deuda total del expediente
PAGOS_REALIZADOS DECIMAL(14,4) NO Pagos realizados hechos por el cliente
PAGOS_COMPROMETIDOS DECIMAL(14,4) NO Pagos comprometidos hechos por el cliente
REFERENCIA_CLIENTE VARCHAR(100) NO La referencia del cliente
COMENTARIOS VARCHAR(500) NO Comentarios
FECHA_EXPEDIENTE TIMESTAMP NO Fecha del expediente
FECHA_CARGA TIMESTAMP NO Fecha de cuando fue cargado el
expediente en el sistema
FECHA_CIERRE TIMESTAMP NO Fecha de cierre del expediente
VALORACION INT(11) NO Valoración del expediente
TITULO VARCHAR(100) SI El título del expediente
CERRADO TINYINT(1) NO Indica si ha sido cerrado el expediente
NIF VARCHAR(20) NO NIF del expediente
MARCADOR TINYINT(1) NO Indica si ha sido entregado al marcador
TIPO VARCHAR(100) NO Tipo del expediente
CONTACTO_PRINCIPAL INT(11) NO Contacto principal del expediente
EXPORTACION TIMESTAMP NO Si ha sido exportado el expediente
PERSONALIZADO1 VARCHAR(100) NO Campo personalizado1 del expediente
FECHA_ACTUALIZACION TIMESTAMP NO Cuando fue actualizado el expediente
CONTROL1 TINYINT(1) NO Indica si tiene marcado el check de control
1 del expediente
CONTROL2 TINYINT(1) NO Indica si tiene marcado el check de control
2 del expediente
INCIDENCIA TINYINT(1) NO Indica si tiene marcado el check de
incidencia del expediente
Manual API
ROBINSON TINYINT NO Indica si tiene marcado el check de Robinson
del expediente
DISTRIBUIDOR INT(11) NO Distribuidor
PENDIENTE DECIMAL(14,4) NO Tiempo pendiente
LLAMADAS INT(11) NO Número de llamadas realizadas al expediente
ENTREGAS_MARCADOR INT(11) NO Número de entregas realizadas al marcador
CONTESTADO TINYINT(1) NO
FECHA_CAMBIO_ESTADO TIMESTAMP NO Cuándo fue cambiado de estado por última vez
el expediente
CREADO TIMESTAMP NO Cuando fue creado el expediente
ESTADO_ANTERIOR INT(11) NO Estado anterior del expediente
PADRE INT(11) NO
FECHA_ULTIMA_LLAMADA TIMESTAMP NO Fecha última llamada
Ejemplos:
POST /api/expediente
Body
{
"titulo": "Expediente VOZITEL",
"proyecto": 15
}
Respuesta:
{
""ID": "37922",
"AGENTE": "539",
"CLIENTE": "1",
"PROYECTO": "15",
"ESTADO": 0,
"DEUDA_TOTAL": 0,
"PAGOS_REALIZADOS": 0,
"PAGOS_COMPROMETIDOS": 0,
"COMENTARIOS": "",
"FECHA_EXPEDIENTE": "0000-00-00 00:00:00",
"FECHA_CARGA": "0000-00-00 00:00:00",
"FECHA_CIERRE": "0000-00-00 00:00:00",
"VALORACION": 0,
"TITULO": "Expediente VOZITEL",
"CERRADO": 0,
"NIF": "",
"MARCADOR": 0,
"TIPO": "", La respuesta continua
"CONTACTO_PRINCIPAL": 0, en la siguiente página
Manual API
"EXPORTACION": "0000-00-00 00:00:00

"UPDATED": "0000-00-00 00:00:00",
"FECHA_ACTUALIZACION": "0000-00-00 00:00:00",
"CONTROL1": 0,
"CONTROL2": 0,
"INCIDENCIA": 0,
"ROBINSON": 0,
"DISTRIBUIDOR": 0,
"PENDIENTE": 0,
"LLAMADAS": 0,
"ENTREGAS_MARCADOR": 0,
"CONTESTADO": 0,
"FECHA_CAMBIO_ESTADO": "0000-00-00 00:00:00",
"CREADO": "2017-09-28 13:30:14",
"ESTADO_ANTERIOR": 0,
"PADRE": 0,
"FECHA_ULTIMA_LLAMADA": "0000-00-00 00:00:00",
"sec_hash": "241c185c4d9ad1593850ddf16fb63114"
}
PUT /api/expediente/{id}
Body
"nombre":"Expediente VOZITEL2",
"expediente":
}
Respuesta:
{
"ID": "37922",
"AGENTE": "539",
"CLIENTE": "1",
"PROYECTO": "15",
"ESTADO": 0,
Manual API
"DEUDA_TOTAL": 0,
"PAGOS_REALIZADOS": 0,
"PAGOS_COMPROMETIDOS": 0,
"COMENTARIOS": "",
"FECHA_EXPEDIENTE": "0000-00-00 00:00:00",
"FECHA_CARGA": "0000-00-00 00:00:00",
"FECHA_CIERRE": "0000-00-00 00:00:00",
"VALORACION": 0,
"TITULO": "Expediente VOZITEL2",
"CERRADO": 0,
"NIF": "",
"MARCADOR": 0,
"TIPO": "",
"CONTACTO_PRINCIPAL": 0,
"EXPORTACION": "0000-00-00 00:00:00",
"UPDATED": "0000-00-00 00:00:00",
"FECHA_ACTUALIZACION": "0000-00-00 00:00:00",
"CONTROL1": 0,
"CONTROL2": 0,
"INCIDENCIA": 0,
"ROBINSON": 0,
"DISTRIBUIDOR": 0,
"PENDIENTE": 0,
"LLAMADAS": 0,
"ENTREGAS_MARCADOR": 0,
"CONTESTADO": 0,
"FECHA_CAMBIO_ESTADO": "0000-00-00 00:00:00",
"CREADO": "2017-09-28 13:30:14",
"ESTADO_ANTERIOR": 0,
"PADRE": 0,
"FECHA_ULTIMA_LLAMADA": "0000-00-00 00:00:00",
}
Manual API
API Incidencia
GET /api/incidencia/{id} Obtener los datos de una incidencia
POST /api/incidencia Creación de una incidencia
PUT /api/incidencia/{id} Modificación de una incidencia
CLIENTE INT(11) NO El identificador del cliente
CITA_PLANIFICADA INT(11) SI Día y hora de la cita
FECHA_CREACION TIMESTAMP NO Fecha de creación de la cita
FECHA_CIERRE TIMESTAMP NO Fecha de cierre de la cita
TIPO_INCIDENCIA INT(11) SI Tipo de incidencia que ha tenido el Exped.
DESCRIPCION VARCHAR(1000) SI Descripción de la incidencia
AGENTE INT(11) NO Es la persona que atenderá la incidencia
EXPEDIENTE INT(11) NO Es la persona que tiene la incidencia
CERRADA TINYINT(1) NO Indica si ya ha sido cerrada la incidencia
UPLOAD INT(11) NO
que tiene la incidencia
TAREA INT(11) NO Tarea a realizar
Ejemplos:
POST /api/incidencia
Body
{
"cerrada": "0",
"cita": {
"id": "636",
"titulo": "Cita con Carrefour"
},
"descripcion": "ha petao",
"upload": 1,
"expediente": {
"id": "8098578",
"titulo": ""
},
"fecha_cierre": "2014-09-01 02:10:22",
"fecha_creacion": "2014-09-01 02:10:22",
"tipo": {
"id": "2",
"titulo": "INCIDENCIA GENERAL"
}
Manual API
Respuesta:
{
"id": "102",
"cerrada": "0",
"fecha_creacion": "2014-09-01 02:10:22",
"fecha_cierre": "2014-09-01 02:10:22",
"upload": "1",
"expediente": {
"id": "8098578",
"titulo": "PRUEBAS"
},
"cita": {
"id": "636",
"titulo": "pst1"
},
"tipo": {
"id": "2",
"titulo": "TIPO 1"
},
"sec_hash": "802239ff589b6272d60eb360eacb3755"
}
PUT /api/incidencia/636
Body
{
"cerrada": "0",
"cita": {
"id": "636",
"titulo": "Cita con Carrefour2"
},
"sec_hash": "802239ff589b6272d60eb360eacb3755",
"upload": 1,
"expediente": {
"id": "8098578",
"titulo": ""
},
"fecha_cierre": "2014-09-01 02:10:22",
"fecha_creacion": "2014-09-01 02:10:22",
"tipo": {
"id": "2",
"titulo": "INCIDENCIA GENERAL"
}
Manual API
Respuesta:
{
"id": "102",
"cerrada": "0",
"fecha_creacion": "2014-09-01 02:10:22",
"fecha_cierre": "2014-09-01 02:10:22",
"upload": "1",
"expediente": {
"id": "8098578",
"titulo": "PRUEBAS"
},
"cita": {
"id": "636",
"titulo": "pst1"
},
"tipo": {
"id": "2",
"titulo": "TIPO 1"
},
"sec_hash": "802239ff589b6272d60eb360eacb3755"
}
Manual API
API Línea
GET /api/linea/{id} Obtener los datos de un línea
GET /api/linea?expediente=XXX Obtiene todas las líneas del expediente XXX
POST /api/linea Creación de una línea
PUT /api/linea/{id} Modificación de una línea
DELETE /api/linea/{id} Borrado de una línea

TITULO VARCHAR(200) NO Título de la línea
IMPORTE DECIMAL(14,4) NO Importe de la línea
FECHA TIMESTAMP NO Fecha de la línea
ESTADO VARCHAR(50) NO Estado
REFERENCIA_CLIENTE VARCHAR(50) NO Referencia cliente
PENDIENTE DECIMAL(14,4) NO Pendiente pago
TIPO INT(11) NO Tipo
MANUAL INT(11) NO Manual
IMPORTADO TIMESTAMP NO Fecha de importación
DESCRIPCION VARCHAR(1000) NO Descripción
VENCIMIENTO DATE NO Vencimiento de la línea
COMPROBADA TINYINT(1) NO Comprobada
PLAZOS TINYINT(4) NO Plazos
QUITA DECIMAL(14,4) NO Quita
FECHA_MODIFICACION TIMESTAMP NO Fecha de modificación de la línea
CREADO TIMESTAMP NO Fecha de creación de la línea
AUTOR INT(11) NO Autor de la línea
Ejemplos:
POST /api/linea
Body
{
"expediente": 8098578
}
Manual API
Respuesta:
{
"ID": "169",
"TITULO": "",
"IMPORTE": 0,
"FECHA": "0000-00-00 00:00:00",
"ESTADO": "",
"PENDIENTE": 0,
"CLIENTE": "1",
"PROYECTO": 0,
"TIPO": 0,
"MANUAL": 0,
"IMPORTADO": "0000-00-00 00:00:00",
"DESCRIPCION": "",
"VENCIMIENTO": "0000-00-00",
"COMPROBADA": 0,
"PLAZOS": 0,
"QUITA": 0,
"CREADO": "2017-10-21 18:54:55",
"AUTOR": 0,
"sec_hash": "1f33ba3901418eb2444ce4f9bbca084d"
}
PUT /api/linea/{id}
Body
{
"expediente": "8098578",
}
Manual API
Body
{
"ID": "169",
"TITULO": "Prueba Jesus2",
"IMPORTE": 0,
"FECHA": "0000-00-00 00:00:00",
"ESTADO": "",
"PENDIENTE": 0,
"CLIENTE": "1",
"PROYECTO": 0,
"TIPO": 0,
"MANUAL": 0,
"IMPORTADO": "0000-00-00 00:00:00",
"DESCRIPCION": "",
"VENCIMIENTO": "0000-00-00",
"COMPROBADA": 0,
"PLAZOS": 0,
"QUITA": 0,
"CREADO": "2017-10-21 18:54:55",
"AUTOR": 0,
}
Manual API
API Posición
POST /api/posicion Registrar posicion GPS del usuario
AGENTE INT(11) NO Identificador agente del que se tiene que tomar
la posición
CITA INT(11) NO Cita planificada
DISPOSITIVO INT(11) NO Tipo de dispositivo
BATERIA INT(11) NO Porcentaje de batería del dispositivo
GPS_LATITUD DECIMAL(25,22) SI Recoge la coordenada de latitud del agente
GPS_LONGITUD DECIMAL(25,22) SI Recoge la coordenada de longitud del agente
GPS_ALTURA DECIMAL(14,6) SI Recoge la coordenada de altura del agente
TITULO VARCHAR(200) SI Título
GPS_INDEX DECIMAL(25,20) NO Índice del GPS
PING TINYINT(1) NO Ping
VERSION VARCHAR(15) NO Versión del dispositivo
Ejemplos:
POST /api/tarea
Body
{
""titulo":"2017-09-28 16:36:32",
"fecha":"2017-09-28 16:36:32",
"gps":{
"latitud":"40.47178840000000121790",
"longitud":"-3.84956589999999998497",
"altura":0
}
}
Manual API
Respuesta:
{
"id":"11022",
"titulo":"2017-09-28 16:36:32",
"dispositivo":"13",
"fecha":"2017-09-28 16:36:32",
"proyecto":{
"id":0,"titulo":""
},
"expediente":{
"id":0,"titulo":""
},
"gps":{
"latitud":"40.47178840000000121790",
"longitud":"-3.84956589999999998497",
"altura":0
}
}
Manual API
API Posición Múltiple
POST /api/posicionmultiple Registrar varias posiciones GPS del usuario

AGENTE INT(11) NO Agente del que se tiene que tomar la posición
CITA INT(11) NO Cita planificada
DISPOSITIVO INT(11) NO Tipo de dispositivo
BATERIA INT(11) NO Porcentaje de batería del dispositivo
GPS_LATITUD DECIMAL(25,22) SI Recoge la coordenada de latitud del agente
GPS_LONGITUD DECIMAL(25,22) SI Recoge la coordenada de longitud del agente
GPS_ALTURA DECIMAL(14,6) SI Recoge la coordenada de altura del agente
GPS_INDEX DECIMAL(25,20) NO Índice del GPS
PING TINYINT(1) NO Ping
VERSION VARCHAR(15) NO Versión del dispositivo
Ejemplos:
POST /api/posicionmultiple
Body
{
"titulo":"2017-09-28 16:36:32",
"posiciones":{
"gps":{
"fecha":"2017-09-28 16:36:32",
"latitud":"40.47178840000000121790",
"longitud":"-3.84956589999999998497",
"altura":0
}
}
Respuesta:
{
"id": 1,
"posiciones": 1
}
Manual API
API Puesto
PUT /api/puesto/{id} Modificación de un puesto de trabajo
DIRECCION INT(11) NO Identificador de la dirección
TIENE_INCIDENCIA INT(11) NO Indica que el puesto de trabajo tiene
incidencia
FECHA_ENTRADA TIMESTAMP NO Fecha de entrada
FECHA_SALIDA TIMESTAMP NO Fecha de salida
HORA_DESCANSO_INICIO TIME NO Hora de de inicio de descanso
HORA_DESCANSO_FIN TIME NO Hora de fin de descanso
ESTADO INT(11) NO Estado
FECHA_ENTRADA_REAL TIMESTAMP NO Fecha entrada real
FECHA_SALIDA_REAL TIMESTAMP NO Fecha salida real
FECHA_DESCANSO_INICIO_REAL TIMESTAMP NO Fecha de inicio descanso real
FECHA_DESCANSO_FIN_REAL TIMESTAMP NO Fecha de fin descanso real
EXCESO_TIEMPO INT(11) NO Exceso de tiempo en el puesto
HORA_DESCANSO2_INICIO TIME NO Hora de inicio descanso 2
HORA_DESCANSO2_FIN TIME NO Hora de fin descanso 2
FECHA_DESCANSO2_INICIO_REAL TIMESTAMP NO Fecha de inicio real descanso 2
FECHA_DESCANSO2_FIN_REAL TIMESTAMP NO Fecha de fin real descanso 2
PUESTO_TRABAJO TINYINT(4) NO Indica si es un puesto de trabajo
PROYECTO INT(11) NO Identificador de proyecto
RETRASO_TIEMPO INT(11) NO Retraso de tiempo
ID_PUESTO_MAESTRO INT(11) NO Identificador del puesto maestro
AUTOREGISTRO TINYINT(4) NO Autorregistro del puesto
AUTOREGISTRO_TOLERANCIA INT(11) NO Tolerancia al autorregistro
GESTOR INT(11) NO Gestor
INCIDENCIA_PUNTUALIDAD INT(11) NO Incidencia de puntualidad
INCIDENCIA_TIEMPO_TRABAJADO INT(11) NO Incidencia durante el tiempo trabajo
GPS_PRESENCIA_START TIMESTAMP NO Coordenadas GPS de inicio
GPS_PRESENCIA_END TIMESTAMP NO Coordenadas GPS de fin
Ejemplos:
PUT /puesto/636
Body
{
"registro": "entrada",
"gps": {
"latitud": 40.47173660,
"longitud": 0.01928
}
Manual API
Respuesta:
{
[{"id":"636",
"titulo":"pst1",
"descripcion":"",
"agente":"1296",
"puesto_trabajo":"1",
"expediente":{
"titulo":"PRUEBAS",
"id":"8098578"
},
"proyecto":{
"id":"452",
"titulo":"PRUEBAS JESUS"
},
"contacto":[],"direccion":
{
"id":"3205102",
"titulo":"",
"pais":"ES",
"provincia":"MADRID",
"poblacion":"Majadahonda",
"departamento":"",
"tipo_via":"58",
"direccion":"C\/ Norias 92","direccion_adicional":"adicional",
"gps":{
"latitud":"40.47195470","longitud":"-3.8493690","altura":"0.0"
},
"cod_autonomia":"",
"cod_provincia":"28",
"cod_poblacion":"","cp":"28888"
},
"tiene_incidencia":"0",
"fecha_entrada":"2017-09-28 16:45:00",
"fecha_entrada_real":"2017-09-28 16:59:54",
"fecha_salida":"2017-09-29 00:45:00",
"fecha_salida_real":"2017-09-28 17:00:40",
"hora_descanso_inicio":"00:00:00",
"hora_descanso_fin":"00:00:00",
"fecha_descanso_inicio_real":"0000-00-00 00:00:00",
"fecha_descanso_fin_real":"0000-00-00 00:00:00",
"hora_descanso2_inicio":"00:00:00",
"hora_descanso2_fin":"00:00:00",
"fecha_descanso2_inicio_real":"0000-00-00 00:00:00",
"fecha_descanso2_fin_real":"0000-00-00 00:00:00",
"estado":{
"id":"266","titulo":"FINALIZADA","id_sistema":"-4"
},
"sec_hash":"d72c64bf90569c01f936e8d8cefed42e",
"gestion":{
"agente_id":"1296",
"agente_login":"pruebasjesus",
"agente_nombre":"PRUEBAS JESUS",
"gestor_id":"0",
"gestor_login":"",
"gestor_nombre":""
}}]
}
Manual API
API Red Social Contacto
GET /api/contactoredsocial/{idRedSocial} Obtiene los datos de una red social para un

determinado identificador
GET /api/contactoredsocial?contacto= Obtiene los datos de una red social para un

{idContacto} identificador del contacto
POST /api/contactoredsocial Creación de una red social para un contacto
PUT /api/contactoredsocial/{idRedSocial} Modificación de una red social de un contacto
DELETE /api/contactoredsocial/{idRedSocial} Borrado de una red social de un contacto

USUARIO_RED_SOCIAL VARCHAR(200) NO Usuario de la red social
TIPO_RED_SOCIAL VARCHAR(30) NO Tipo de red social
(disponible en la inserción y en la
modificación de la entidad)
Ejemplos:
POST //api/contactoredsocial
Body
{
"tipo_red_social": "Twitter", /* Twitter, Facebook, LinkedIn,
Google+, YouTube, Zendesk, Skype */
"titulo": "jcanizares",
"usuario_red_social": "jcanizares@twitter.es",
"contacto": 27369
}
Respuesta:
{
"ID": "26",
"CLIENTE": "1", en la siguiente página
""TITULO": "jcanizares",
Manual API
"USUARIO_RED_SOCIAL": "jcanizares@twitter.es",
"TIPO_RED_SOCIAL": "Twitter",
"sec_hash": "119dce6540277c3b3c3a2239ad54a14a"
}
PUT /api/contactoredsocial/{id}
Body
{
"tipo_red_social": "Twitter", /* Twitter, Facebook, LinkedIn,
Google+, YouTube, Zendesk, Skype */
"titulo": "jcanizares23",
"usuario_red_social": "jcanizares@twitter.es",
"sec_hash": "119dce6540277c3b3c3a2239ad54a14a"
}
Respuesta:
{
"ID": "27",
"CLIENTE": "1",
"TITULO": "jcanizares23",
"USUARIO_RED_SOCIAL": "jcanizares@twitter.es",
"TIPO_RED_SOCIAL": "Twitter",
"sec_hash": "e1ec21dde07310182d1cbec91169db8d"
}
Manual API
API Registro
GET /api/registro/{idDispositivo} Obtener los datos de registro de un dispositivo
POST /api/registro Registro de un dispositivo

MARCA VARCHAR(50) SI Marca del dispositivo
SISTEMA_OPERATIVO VARCHAR(50) SI Sistema operativo del dispositivo
SISTEMA_VERSION VARCHAR(10) SI Versión del dispositivo
MODELO VARCHAR(20) SI Modelo del dispositivo
TIPO VARCHAR(50) SI Tipo de dispositivo
IMEI VARCHAR(100) NO IMEI del dispositivo
BATERIA TINYINT(4) NO Porcentaje de bateria
FECHA_CONEXION TIMESTAMP NO Fecha de conexión
DESACTIVADO TINYINT(1) NO Estado en que se encuentra el dispositivo
NUMERO_SERIE VARCHAR(100) SI Número de serie del dispositivo
APPKEY VARCHAR(500) NO APPKEY asociada al dispositivo
Ejemplos:
POST /api/tarea
Body
{
id: "2"
numero_serie: "jdsluuiddj87489348"
titulo: "lge"
descripcion: "JESUS"
fecha_conexion: "2014-09-03 22:51:48"
marca: "IPHONE"
modelo: "5S"
sistema_operativo: "IOS"
sistema_version: "6.0"
fecha: “2014-09-08 00:00:00”
tipo: "t"
imei: "7743434884748454445345"
bateria: "55"
}
Manual API
Respuesa:
{
"id": "47",
"numero_serie": "359531060955623",
"titulo": "lge",
"descripcion": "JESUS",
"fecha_conexion": "2017-09-28 15:42:48",
"marca": "lge",
"modelo": "LG_H220",
"sistema_operativo": "Android",
"sistema_version": "4.4.2",
"tipo": "telefono",
"imei": "",
"bateria": "100",
"appkey": ""
}
Manual API
API Remote Log
POST /api/remotelog Enviar log al servidor
Ejemplos:
POST /api/remotelog
Body
{
"version" : "3.0.1",
"fecha" :"2017-10-21 10:00:00",
"user" : "JESÚS",
"server" : "servidor",
"error" : "error prueba"
}
Respuesta:
{
"id": 1
}
Manual API
API Teléfono Contacto
GET /api/contactotelefono/{idTelefono} Obtiene el teléfono de un determinado
identificador de teléfono
GET api/contactotelefono?contacto=idContacto Obtiene los teléfonos asociados a ese contacto
POST /api/contactotelefono Creación de un teléfono para un contacto
PUT /api/contactotelefono/{idTelefono} Modificación de un teléfono de un contacto
DELETE /api/contactotelefono/{idTelefono} Borrado de un teléfono de un contacto

PAIS CHAR(2) NO País del cliente
TIPO CHAR(1) NO Tipo
NUMERO VARCHAR(20) NO Número
DIRECCION_ASOCIADA INT(11) NO Dirección asociada
ERRONEO TINYINT(1) NO Teléfono erróneo
FAILED TINYINT(4) NO Teléfono fallido
USADO DATETIME NO Usado
ORDEN INT(11) NO Orden en que se inserta el elemento (para
la inserción y la modificación de la entidad)
Ejemplos:
POST /api/contactotelefono
Body
{
"numero": "910807800",
"contacto": 26089
}
Respuesta:
{
"ID": "15149",
"CLIENTE": "1",
"PAIS": "",
"TITULO": "",
"TIPO": "F",
"NUMERO": "910807800",
"DIRECCION_ASOCIADA": 0,
"ERRONEO": 0,
"FAILED": 0,
"USADO": "0000-00-00 00:00:00",
}
Manual API
PUT /api/contactotelefono/{id}
Body
{
"numero": "910841500",
}
Respuesta:
{
"ID": "15150",
"CLIENTE": "1",
"PAIS": "",
"TITULO": "",
"TIPO": "M",
"NUMERO": "910841500",
"TIPO_FORMA_CONTACTO": "0",
"DIRECCION_ASOCIADA": "0",
"ERRONEO": 0,
"FAILED": "0",
"USADO": "0000-00-00 00:00:00",
}
Manual API
API Ping
GET /api/ping Probar si el API está disponible
Ejemplos:
GET /api/ping
Respuesta:
{
"iso":"2014-08-25T19:54:13+02:00",
"unix":1408989253,
"local":"2014-08-25 19:54:13"
}
Manual API
API Upload
POST /api/ulpoad?fichero={nombre} Cargar un fichero
Ejemplos:
POST /oauth/ulpoad?fichero=manual.pdf
Body
{
"id": "2",
"fichero": "manual.pdf",
"fecha": "2017-09-04 23:03:43",
}
Respuesta:
{
"id": 1
}
Manual API
API LEAD
POST /api/lead Crear expedientes a través de proveedores externos de landing pages y que
usan las credenciales definidas en la campaña masiva.
En esta petición la atutenticación no se hace mediante OAuth como en el caso de las API’s anterio-
res sino que se autentica mediante el usuario y el password definido previamente en la campaña
masiva. Se debe utilizar el headerhttps://es.wikipedia.org/wiki/Autenticacion_de_acceso_basi-
Authorization de tipo Basic (ver Wikipedia)
IMPORTANTE: debe especificar la campaña a través del campo CAMPANA

AGENTE INT NO Identificador del agente.
COMENTARIOS VARCHAR(500) NO Comentarios del expediente.
CONTROL1 TINYINT NO
CONTROL2 TINYINT NO
DEUDA_TOTAL DECIMAL NO
DISTRIBUIDOR INT NO
ESTADO INT(11) NO
EMAIL/EMAIL1 VARCHAR(200) NO
EMAIL2 VARCHAR(200) NO
EMAIL3 VARCHAR(200) NO
FAX VARCHAR(20) NO
FECHA_EXPEDIENTE TIMESTAMP NO
FECHA_NACIMIENTO DATE NO
INCIDENCIA TINYINT NO
METADATO_XXXXX VARCHAR(100) NO XXXXX es la REFERENCIA_CLIENTE
del meta.
NIF VARCHAR(20) NO NIF del expediente.
NIF_CONTACTO VARCHAR(20) NO NIF del contacto.
NOMBRE_CONTACTO VARCHAR(100) NO Nombre completo del contacto.
OTROS VARCHAR(1000) NO
PAGOS_COMPROMETIDOS DECIMAL NO
PAGOS_REALIZADOS DECIMAL NO
PARTE_APELLIDO1 VARCHAR(50) NO
PARTE_APELLIDO2 VARCHAR(50) NO
PARTE_NOMBRE VARCHAR(50) NO
PENDIENTE DECIMAL NO
PERSONALIZADO1 VARCHAR(100) NO Para el PERSONALIZADO2/3/4/5 ó 6 sólo
hay que cambiar el número en el atributo.
REFERENCIA_CLIENTE VARCHAR(50) NO Referencia del cliente del expediente.
REFERENCIA_CONTACTO VARCHAR(50) NO Referencia del cliente del contacto.
ROBINSON TINYINT NO
SEXO CHAR(1) NO
TIPO VARCHAR(50) NO Tipo del expediente.
TELEFONO1 VARCHAR(20) NO
TIPO_CONTACTO VARCHAR(50) NO Tipo del contacto.
TITULO VARCHAR(100) NO Título del expediente.
VALOR_CONTACTO DECIMAL NO
VALORACION INT NO
Manual API
Parámetros de dirección:

DIRECCION VARCHAR(200) NO
DIRECCION_ADICIONAL VARCHAR(200) NO
CP VARCHAR(10) NO Código Postal.
PROVINCIA VARCHAR(50) NO
POBLACION VARCHAR(200) NO
Parámetros de dirección:

PLANIFICAR_LLAMADA TIMESTAMP NO Fecha en la que realizar la llamada
|MAÑANA|TARDE Formato AAA-MM-DD HH:MM:SS
ó bien las palabras MAÑANA ó
TARDE para llamar cualquier día
en horario de mañana ó tarde.
PLANIFICAR_LLAMADA_CAMPANA ENTERO NO Identificador de la campaña de
progresivo.
PLANIFICAR_LLAMADA_MANUAL ENTERO NO Establece si es una llamada
manual. Valor "1" ó "0".
Ejemplos:
POST /api/lead
Headers
Authorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==
Body
"CAMPANA": 5,
"TITULO": "Javier Vega",
"TIPO": "TIPO PRUEBA",
"TELEFONO1": "660992073",
Respuesta:
"valor": "37926",
"descripcion": "Expediente creado satisfactoriamente",
"error": 0
Manual API
Agradecimientos
Vozitel y su dirección corporativa agradece su atención y solicita que
los datos proporcionados en este dossier sean utilizados en
exclusiva, para los fines pactados y se garantice con ello la absoluta
confidencialidad de los mismos fuera de ese ámbito. Si necesita
cualquier otro dato por favor póngase en contacto con:
Maria de la Mata en Maria.delamata@vozitel.com

Beatriz Martínez en Beatriz.martinez@vozitel.com
Marcel Rodrigues Da Silva en Marcel.rodrigues@vozitel.com
¡Muchas
Gracias!
API RESTFUL y API LEAD 2019

Manual API SP 2021

Cargado por

Información del documento

Título original

Derechos de autor

Formatos disponibles

Compartir este documento

Compartir o incrustar documentos

Opciones para compartir

¿Le pareció útil este documento?

¿Este contenido es inapropiado?

Copyright:

Formatos disponibles

Manual API SP 2021

Cargado por

Copyright:

Formatos disponibles

API

La petición se debe realizar al endpoint: https://{servidor}/oauth/token.

A continuación un ejemplo de petición:

La respuesta que proporciona el anterior comando es:

Todas las peticiones tienen que hacerse con HTTPS

TIPO DE DATO DESCRIPCIÓN

TIPO DE DATO DESCRIPCIÓN

POST /api/call Realizar una llamada.

Parámetros posibles para añadir al realizar las búsquedas:

GET /api/chat/{id} Obtiene los detalles de un chat iniciado anteriormente.

POST /api/chat Crea una nueva sala de chat.

PARÁMETROS TIPO/LOGITUD OBLIGATORIO COMENTARIOS

CLIENTE INT(11) NO Identiﬁcador del cliente

GET /api/cita Obtiene todas las citas para hoy.

GET /api/cita?desde=2014-07-01 Obtiene la lista de citas desde 2014-07-01 hasta hoy.

GET /api/cita?desde=2014-07-01& Obtiene la lista de citas desde 2014-07-01 hasta el

POST /api/cita Creación de una cita.

PUT /api/cita/{id} Modiﬁcación de una cita.

CLIENTE INT(11) NO Identiﬁcador del cliente

"titulo": "PRUEBAS JESUS"

GET /api/conﬁg Obtiene los parámetros de conﬁguración del sistema

GET /api/contacto/{id} Obtener los datos del contacto

POST /api/contacto Creación de un contacto

PUT /api/contacto/{id} Modiﬁcación de un contacto

DELETE /api/contacto/{id} Modiﬁcación de un contacto

ATRIBUTO TIPO/LONGITUD OBLIG. COMENTARIOS

GET /api/contactocuentabancaria/{idCuenta} Obteniene los datos de la cuenta bancaria para

GET /api/contactocuentabancaria?contacto Obteniene los datos de la cuenta bancaria para

POST /api/contactocuentabancaria Crea una cuenta bancaria para un contacto.

PUT /api/contactocuentabancaria/{idCuenta} Modiﬁca una cuenta bancaria de un contacto.

DELETE /api/contactocuentabancaria/{idCuenta} Borrado de una cuenta bancaria de un contacto.

PARÁMETROS TIPO/LOGITUD OBLIG. COMENTARIOS

CLIENTE INT(11) NO Identiﬁcador del cliente

POST /api/co ntactocuentabancaria

GET /api/contactodireccion?contacto= Obtiene la dirección para un ID del contacto.

POST /api/contactodireccion Crea de una dirección para un contacto.

PUT /api/contactodireccion/{idDirección} Modiﬁca de una dirección de un contacto.

DELETE /api/contactodireccion/{idDirección} Borra de una dirección de un contacto.

PARÁMETROS TIPO/LOGITUD OBLIG. COMENTARIOS

GET /api/pool/{id}?cookie=cookie001 Obtiene los detalles de un pool mediante un

POST /api/pool Creación de un pool. Devuelve el identiﬁcador del

DELETE /api/pool/{id}?cookie=cookie001 Se utiliza para anular la reserva del pool. Es necesario

PARÁMETROS TIPO/LOGITUD OBLIG. COMENTARIOS

POOL INT(11) SI Identiﬁcador del pool

POST /oauth/token Obtener el token de acceso. Es necesario autenticarse mediante Oauth

Los ámbitos existentes son los siguientes:

ENTIDAD ÁMBITO SUBENTIDAD

EXPEDIENTE 0 (por defecto si no se especiﬁca) N/A

MÉTODO URL DESCRIPCIÓN

GET /api/metadato/{id} Obtiene los datos de un metadato

GET /api/metadato?expediente=XXX Obtiene la lista de todos los metadatos del

GET /api/metadato?expediente=XXX&ambito= Obtiene la lista metadatos del contacto YYY

POST /api/metadato Creación de un metadato

PUT /api/metadato/{id} Modiﬁcación de un metadato

PARÁMETROS TIPO/LOGITUD OBLIG. COMENTARIOS

CLIENTE INT(11) NO Identiﬁcador del cliente

GET /api/oportunidadcomercial?expediente= Obtener las oportunidades comerciales de un

GET /api/oportunidadcomercial? Obtener las oportunidades comerciales para una

GET /api/oportunidadcomercial?producto=21 Obtener las oportunidades comerciales para un

GET /api/oportunidadcomercial? Obtener las oportunidades comerciales con un

POST /api/oportunidadcomercial Creación de una oportunidad comercial

PUT /api/oportunidadcomercial/{id} Modiﬁcación de una oportunidad comercial

DELETE /api/oportunidadcomercial/{id} Borrado de una oportunidad comercia