Objetivo

El objetivo de este documento es mostrar cómo pueden realizarse integraciones desde aplicaciones externas o procesos al módulo de campañas de wolkvox.

Tecnología:

La tecnología usada es un link seguro https que consta de varias funciones y parámetros que se reciben via get.

Creación del token en el configurationbox

Para crear el token se debe ingresar al configurationbox en la parte de settings.

Luego nos vamos para Integration y creamos el token, colocando un nombre y presionando el botón add token.

Luego copiamos el token y lo usamos en nuestros links de integración.


1. Creación de campañas:

Para crear campañas en el ipdialbox de manera remota se deben enviar los siguientes parámetros:

Action: se debe enviar el valor create_campaing

name_camp: Se envía el nombre de la campaña.

desc_camp: Se debe enviar la descripción de la campaña.

hora_ini: Hora de inicio permitida de la campaña, el valor son 4 dígitos numéricos. Ejemplo: 0700, Este ejemplo indica que desde las 7am se puede iniciar la campaña.

hora_fin: Hora fin hasta que la campaña correrá, valor en dígitos numéricos. Ejemplo:2000, indica que la campaña correrá hasta las 8pm.

queue_camp: es la cola que la campaña tomara como referencia para tomar los agentes.

Preview: Se debe enviar “yes” o “no”, si se envía “yes” quiere decir que la campaña es preview y si se envía “no” la campaña funcionara en modo predictivo/progresivo.

Adicionalmente se debe enviar los títulos de los campos opcionales de la lista, estos se envían usando los parámetros opt01, opt02, opt03 hasta opt12.

Ejemplo:

En este ejemplo crearemos una campaña en preview con el nombre “pruebas_20150815”, que funcione las 24 horas del día, donde los agentes estén logueados en la cola 4010 y que la campaña tenga tres campos opcionales.

https://{ip_ipdialbox}/ipdialbox/api_campaing.php?token= token}&action=create_campaing&preview=yes&name_camp=prue bas_20150815&desc_camp=pruebas_20150815&hora_ini=0000&hora_fin=235959&queue_camp=4010&opt1=fecha_cumpl e&opt2=numero_de_hijos&opt3=cupo

Variables de regreso:

El sistema si logra ingresar la campaña exitosamente, retorna el id de la campaña creada y el valor ok.

2. Inserción de registros en la campaña:

Para insertar registros en una campaña en el ipdialbox de manera remota se deben enviar los siguientes parámetros.

Action: se debe enviar el valor insert.

type_campaing: se debe enviar preview o predictive según la campaña que queramos correr.

Campaing: se envía el id de la campaña.

Name: Nombre del cliente.

lastname: Apellido del cliente.

type_id: tipo de identificación del cliente.

id: id del cliente.

Age: edad del cliente.

Sex: sexo del cliente.

Country: país del cliente.

Department: departamento del cliente.

City: ciudad del cliente.

Zone: zona del cliente.

Address: dirección del cliente.

opt01, opt02, opt03, opt12: Información de los campos

opcionales. tel01, tel02, tel03, …. , Tel10: teléfonos de los clientes.

Email: email del cliente (aplica solo para campañas predictivas).

Recall: fecha de la re-llamada (solo aplica para predictivo), el formato de este campo es yyyymmddhhmmss-telefono

Agent: agente al que se le va a asignar el registro, en caso de que lo queramos rotativo colocamos el valor acd (este campo solo aplica para campañas preview)

Ejemplo:

En este ejemplo ingresaremos un registro de un cliente en una campaña preview y se lo asignaremos al agente 1243, el id de la campaña es el 87.

https://{ip_ipdialbox}/ipdialbox/api_campaing.php?token={token}&action=insert&type_campaing=preview&campaing=87&na me=adriana&lastname=ortiz&type_id=cc&id=43667554&age=28&sex=Femenino&country=colombia&department=antioquia &city=medellin&opt01=marzo_10&opt02=3&opt03=5000000&agent=1243&tel01=93218148745

3. Inserción de registros en la campaña de manera masiva:

Para insertar registros en una campaña de manera masiva se deben enviar los parámetros básicos en get y el contenido del archivo en post de la siguiente manera.

En get se envían los siguientes parámetros.

Action: se debe enviar el valor insert_array

type_campaing: se debe enviar preview o predictive según la campaña que queramos correr.

Campaing: se envía el id de la campaña.

https://{ip_ipdialbox}/ipdialbox/api_campaing.php?token={token}&action=insert_array&type _campaing=preview&campaing=87

Como Post se debe enviar el contenido a cargar en formato texto con final de línea para identificar cada registro, y como separador entre campos usaremos el carácter |, los campos varían según el estándar del momento para preview o predictivo.

Ejemplo Predictivo:

{nombre_cliente}|{ apellido_cliente}|{ tipo_doc}|{ id_cliente}|{ edad}|{ sexo}|{ pais}|{ departamento}|{ ciudad}|{ zona}|{ direccion}|{ opt1}|{ opt2}|{ opt3}|{ opt4}|{ opt5}|{ opt6}|{ opt7}|{ opt8}|{ opt9}|{ opt10}|{ opt11}|{ opt12}|{ tel1}|{ tel2}|{ tel3}|{ tel4}|{ tel5}|{ tel6}|{ tel7}|{ tel8}|{ tel9}|{ tel10}|{ tel_extra}|{ email}|{recall}|\r\n

4. Solicitar detalle de la campaña

Con frecuencia es necesario saber el estado de los registros de una campaña para almacenarlos en un sistema de bi, o crm.

Para obtener esta información se debe invocar el web service de la siguiente manera.

Action: se debe enviar el valor “detail” o “detail_json”

type_campaing: se debe enviar preview o predictive según la campaña que queramos consultar. campaing: se envía el id de la campaña.

date_ini :Se debe enviar la fecha inicio en formato yyyymmddhhmmss

date_end: Se debe enviar la fecha fin en formato yyyymmddhhmmss

Ejemplo:

En este ejemplo consultaremos la información entre las 8am del 5 marzo del 2016 hasta las 10pm del 7 de marzo del 2016 para el id de la campaña es el 87.

https://{ip_ipdialbox}/ipdialbox/api_campaing.php?token={token}&action=detail_json&type_campaing=preview&campaing=87 &date_ini=2016030508000000&date_end=2016030722000000

Respuesta:

El sistema regresa la bd en formato json

5. Codificar registro desde aplicación externa.

En ocasiones es necesario codificar registros del predictivo desde una aplicación externa para evitar que el marcador predictivo llame al cliente, esto ocurre por ejemplo cuando se contacta al cliente por un canal diferente al call center, o cuando se llama al cliente por medio de una llamada manual y es necesario avisarle al predictivo que el cliente fue contactado.

Action: se debe enviar.

typify cod_rslt1: se debe enviar el código de actividad1

cod_rslt2: se debe enviar el código de actividad2

Id: se debe enviar el número único del cliente.

comment

Comentarios de la tipificación.

Link

https://{ip_ipdialbox}/ipdialbox/api_campaing.php?token={token}&action=typify&cod_rslt1= {codigo1}&cod_rslt2={codigo2}&id={idcliente}&comment={comment}

Ejemplo:

https://{ip_ipdialbox}/ipdialbox/api_campaing.php?token={token}&action=typify&cod_rslt1= VENTA&cod_rslt2=TCMASTER&id=43627866&comment=venta exitosa mastercard

6. Solicitar detalle llamada a llamada realizada por el predictivo.

El predictivo wolkvox puede llegar a realizar miles de llamadas, y en ocasiones lo que pasa a asesor es solo una fracción de las llamadas realizadas, muchas operaciones de contact requieren tener el detalle de cada llamada que realiza el predictivo para determinar que teléfonos están bueno o malos o en cuales definitivamente no contestan.

Action: se debe enviar full_detail

date_ini: se debe enviar la fecha inicial, en formato yyyymmddhhmmss

date_end: se debe enviar la fecha inicial, en formato yyyymmddhhmmss

Nota:

El formato que regresa los resultados es el siguiente, el fin de línea es el carácter enter.

REG|id_campaing|nombre_cliente|apellido_cliente|tipo_doc|id_cliente|resultado_maquina| telefono|fecha|

Link

https://{ip_ipdialbox}/ipdialbox/api_campaing.php?token={token}&action=full_detail&date_i ni={date_ini}&date_end={date_end}

Ejemplo:

https://{ip_ipdialbox}/ipdialbox/api_campaing.php?token={token}&action=full_detail&date_ini=20180415000000&date_end=20180415235959


7. Reprogramar llamada.

Con esta función puedes reprogramar un registro del predictivo desde una aplicación

externa.

Action: Se debe enviar recall

recall_date: Se debe enviar la fecha cuando queremos hacer la llamada, en formato yyyymmddhhmmss

recall_tele: Se debe enviar el teléfono a donde quieres que el sistema marque.

id: Enviar el ID del cliente.

Link

https://{ip_ipdialbox}/ipdialbox/api_campaing.php?token={token}&action=recall&recall_dat

e={recall_date}&recall_tele={recall_tele}&id={id}

Ejemplo:

https://{ip_ipdialbox}/ipdialbox/api_campaing.php?token={token}&action=recall&recall_dat

e=20190415000000&recall_tele=9320784512&id=98456789


8. Borrar registro.


Con esta función puedes borrar un registro del predictivo, esto es útil cuando estas

haciendo por ejemplo una campaña y el cliente nos contacta por otro canal.

Action: Se debe enviar delete_id

id: Enviar el ID del cliente.

Link

https://{ip_ipdialbox}/ipdialbox/api_campaing.php?token={token}&action=delete_id&id={id}

Ejemplo:

https://{ip_ipdialbox}/ipdialbox/api_campaing.php?token={token}&action=delete_id&id=98456789