X
wolkvox cuenta con múltiples APIs que permiten realizar integraciones con aplicaciones o procesos externos como CRM, ERP y Business Inteligence. Usando links seguros HTTPS que consta de varias funciones y parámetros que se reciben vía GET.
API

CREACIÓN DEL TOKEN

Para crear el token se debe ingresar al Manager wolkvox en la parte de Configuración. Luego nos vamos para integraciones y creamos el token, colocando un nombre y presionando el botón add token y copiamos el token y lo usamos en nuestros links de integración.

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.

API Agentes


Inicie el aplicativo de Agent wolkvox, debes verificar que en el Manager wolkvox este activo el puerto 80


Marcar

marcar


Marque desde su aplicación interna sin complejos desarrollos.
Eje: http://localhost:80/apiagentbox?action=dial&phone=945109000&id_customer=98629699.





Colgar

colgar

Cuelgue las llamadas desde su aplicativo empresarial.
Eje: http://localhost:80/apiagentbox?action=haup

Codificar

codificar

Codificar una sola vez, el sueño de muchos agentes.
Eje: http://localhost:80/apiagentbox?action=codd&cod=GOOD&cod2=BAD&comm=Esto es una prueba de comentarios a la llamada.





Re-programar llamada Predictivo

Re-programar llamada desde la aplicación empresarial, deja que wolkvox se encargue del resto.
Eje: http://localhost:80/apiagentbox?action=rcal&date=20161211223030&dial=932184598&t



Colgar - Codificar - Ready

combo_codificar

Combo, Colgar, codificar y nuevamente en ready.
Eje: http://localhost:80/apiagentbox?action=chur&cod=GOOD&cod2=BAD&comm=Combo con papa y gaseosa agrandada





Visible - Invisible botones Agentbox

Botones

Mostrar y ocultar botones agentbox.
Eje: http://localhost:80/apiagentbox?action=vibu&butto=haup&visib=no.



Ready

Estar de nuevo disponible desde la aplicación del agente, ganando segundos!
Eje: http://localhost:80/apiagentbox?action=redy

Logout

Desloguear desde su CRM es ahora posible!
Eje: http://localhost:80/apiagentbox?action=logu

Mute

mute

Mute desde el CRM.
Eje: http://localhost:80/apiagentbox?action=mute

Hold

Hold desde una página web.
Eje: http://localhost:80/apiagentbox?action=hold

Agentbox invisible

agentbox

Los más puristas programadores usan esta función para que el agente solo interactúe con su herramienta web.
Eje: http://localhost:80/apiagentbox?action=invi

Agentbox Visible

botones2

Algunas funciones se deben realizar directamente en el agent wolkvox!
Eje: http://localhost:80/apiagentbox?action=visi

Realizar llamada auxiliar

Se cae la llamada, o el cliente te pide que le marques a otro teléfono, pero no quieres perder la relación de esa llamada con el predictivo.
Eje: http://localhost:80/apiagentbox?action=diax&phone=945109000


ACW

acw

Entrando en estado ACW desde la aplicación web.
Eje: http://localhost:80/apiagentbox?action=acw

Presionar teclado DTMF

DTMF

Poder enviar tonos DTMF durante una llamada para navegar un IVR externo o interno.
Eje: http://localhost:80/apiagentbox?action=keyp&key=1


Transferencia

Transferir

Realizar transferencia a un IVR, agente o número externo.
Eje: http://localhost:80/apiagentbox?action=tran&phone=945109000


Marcar con ID Y Nombre

Botones3

Marque desde su aplicación adjuntando id y nombre del cliente a la llamada para futuras transferencias.
Eje: http://localhost:80/apiagentbox?action=dia2&phone=945109000&id_customer=98629699&name=Jorge Mario Vargas




API de Reportes wolkvox

Link: https://{ip_ipdialbox}/ipdialbox/api_reports.php

Parámetros básicos

Token: Es el id que identifica cada operación dentro de wolkvox, solicite al grupo de soporte de wolkvox el token para la operación que quiera integrar por medio de este link de integración.
report: indica el reporte que se va a generar.
date_ini: Fecha inicio del reporte.
date_end: Fecha fin del reporte.

1. Reporte agent_events:

Este reporte trae evento por evento cada uno de los tiempos de agente del aplicativo agent wolkvox, este reporte también llamado reporte de sucesos sirve para alimentar sistemas de nómina y sistema de productividad.

Ejemplo: https://{ip_ipdialbox}/ipdialbox/api_reports.php?token={token}&report=agent_events&date_ini=20160707000000&date_end=20160707235959

2. Reportes tiempo real.

Este reporte trae información en tiempo real de la operación.

Ejemplo: https://{ip_ipdialbox}/ipdialbox/api_reports.php?token={token}&report=real_time

Variables de regreso: En este caso, el sistema regresa un reporte en cadena json

3. Reportes de login - logout.

Este reporte trae información del tiempo de logueo de los asesores.

Ejemplo: https://{ip_ipdialbox}/ipdialbox/api_reports.php?token={token}&report=login_time&date_ini=20160707000000&date_end=20160707235959

Variables de regreso: En este caso, el sistema regresa un reporte en cadena json

4. Reporte de llamadas.

Este reporte trae información en las llamadas.

Ejemplo: https://{ip_ipdialbox}/ipdialbox/api_reports.php?token={token}&report=zoom_calls&date_ini=20160707000000&date_end=20160707235959

Variables de regreso: En este caso, el sistema regresa un reporte en cadena json

5. Reporte de CDR de llamadas

Este reporte trae información histórica de llamadas inbound y outbound.

Ejemplo: https://{ip_ipdialbox}/ipdialbox/api_reports.php?token={token}&report=cbps_cdr&date_ini=20160707000000&date_end=20160707235959

Variables de regreso: En este caso, el sistema regresa un reporte en cadena json así:

6. Reporte tiempos de agente por hora (status time)<


Ejemplo: https://{ip_ipdialbox}/ipdialbox/api_reports.php?token={token}&report=cbps_satustime&date_ini=20180724000000&date_end=20180724235959

Variables de regreso: En este caso, el sistema regresa un reporte en cadena json

7. Reporte encuesta al final de la llamada

Ejemplo: https://{ip_ipdialbox}/ipdialbox/api_reports.php?token={token}&report=cbps_survey&date_ini=20180724000000&date_end=20180724235959

Variables de regreso: En este caso, el sistema regresa un reporte en cadena json

8. Reporte detalle de agente (agents_detail).

Este reporte trae información detallada de agente, estado por estado, este reporte es de gran magnitud al traer un registro por cada evento de cada agente del contact center, con este reporte se puede construir cualquier estadística de agente que se desee, ideal para construir un ETL con niveles de agregación variados y armar vistas de BI sorprendentes.
Ejemplo: https://{ip_ipdialbox}/ipdialbox/api_reports.php?token={token}&report=agents_detail&date_ini=20180724000000&date_end=20180724235959

Variables de regreso: En este caso, el sistema regresa un reporte en cadena json

9. Reporte detalle de skill (skill_detail).


El reporte detallado de skill trae el resultado llamada por llamada de las llamadas entrantes a un skill permitiendo medir nivel de servicio y volúmenes de entrada en el skill. Este reporte es ideal para construir un ETL con niveles de agregación variados y armar vistas de BI sorprendentes de volúmenes de skill y niveles de servicio. Ejemplo: https://{ip_ipdialbox}/ipdialbox/api_reports.php?token={token}&report=skill_detail&date_ini=20180724000000&date_end=20180724235959

Variables de regreso: En este caso, el sistema regresa un reporte en cadena json

10. Reporte detalle de IVR (ivr_detail).


El reporte detallado de IVR regresa llamada a llamada que es procesada por el IVR. Ejemplo: https://{ip_ipdialbox}/ipdialbox/api_reports.php?token={token}&report=ivr_detail&date_ini= 20180724000000&date_end=20180724235959

Variables de regreso: En este caso, el sistema regresa un reporte en cadena json

11. Reporte detalle de calidad (quality_detail).


El reporte detallado de la calificación realizada por el analista de calidad Ejemplo: https://{ip_ipdialbox}/ipdialbox/api_reports.php?token={token}&report=quality_detail&date_i ni=20180724000000&date_end=20180724235959

Variables de regreso: En este caso, el sistema regresa un reporte en cadena json

12. Reporte detalle de espera inteligente (iw_detail)


El reporte detallado del módulo de espera inteligente
Ejemplo: https://{ip_ipdialbox}/ipdialbox/api_reports.php?token={token}&report=iw_detail&date_ini=2 0180724000000&date_end=20180724235959

Variables de regreso: En este caso, el sistema regresa un reporte en cadena json

13. Reporte de chats


Ejemplo: http://{ip ipdialbox}/ipdialbox/api_reports.php?token= {token}&report=chats&date_ini=20190501000000&date_end=20190531235959

Variables de regreso: En este caso, el sistema regresa un reporte en cadena json

14. Reporte de conversaciones


Ejemplo: http://{ip ipdialbox}/ipdialbox/api_reports.php?token={token}&report=chats_conversations&date_ini=20190529000000&date_end=20190531235959

Variables de regreso: En este caso, el sistema regresa un reporte en cadena json

15. Reporte de SMS (mensajes de texto)


Ejemplo: http://{ip_ipdialbox}/ipdialbox/api_reports.php?token= {token}&report=cdr_sms&date_ini=20190830000000&date_end=20190831235959

Variables de regreso: En este caso, el sistema regresa un reporte en cadena json

16. Reporte en tiempo real de skill por api (real_time_skill)


Entrega la información de los skill en tiempo real del día actual.

Ejemplo: http://{ip_server}/ipdialbox/api_reports.php?token={token}&report=real_time_skill

Variables de regreso: En este caso, el sistema regresa un reporte en cadena json

17. Reporte chatbots


Este reporte trae la información de lo que el chatbot habló con los clientes en un rango de fechas.

Ejemplo: http://{ip_ipdialbox}/ipdialbox/api_reports.php?token={token}&report=chats_bots&date_ini=20200401000000&date_end=20200430000000

Variables de regreso: En este caso, el sistema regresa un reporte en cadena json

18. Reporte API Hold Mute.


Este reporte trae la información de cuanto tiempo estuvo cada agente en hold y en mute durante las llamadas realizadas en el tiempo seleccionado.

Ejemplo: http://{ip_ipdialbox}/ipdialbox/api_reports.php?token={token}&date_ini=20200501000000&date_end=20200511235959&report=hold_mute_detail

Variables de regreso: En este caso, el sistema regresa un reporte en cadena json

19. Reporte API cdr_unconnected_calls.


Este reporte nos indica las llamadas manuales que realizan los agentes donde no hubo contestacion por parte del cliente, con el codigo de maquina correspondiente.

Url: http://{ip}/ipdialbox/api_reports.php?token={token}&date_ini=20200501000000&date_end=20200609235959&report=cdr_unconnected_calls

20. API reporte de latencia.


Usa esta api para obtener un reporte de la latencia de la red de internet en la operación

Url: http://{ip_ipdialbox}/ipdialbox/api_configuration.php?token={token_id}&function=latency_json&id={nombre_de_la_operacion}

API Campaña

Link: https://{ip_ipdialbox}/ipdialbox/api_campaing.php

Parámetros básicos

Token: Es el id que identifica cada operación dentro de wolkvox, solicite al grupo de soporte de wolkvox el token para la operación que quiera integrar por medio de este link de integración.
report: indica el reporte que se va a generar.
date_ini: Fecha inicio del reporte.
date_end: Fecha fin del reporte.

1. Creación de campañas

Para crear campañas en wolkvox 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 tomará como referencia para desviar las llamadas a 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 funcionará 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 opt1, opt2, opt3 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:

    Si el sistema 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 wolkvox 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.
  • opt1, opt2, opt3, 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&opt1=marzo_10&opt2=3&opt3=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:

    array('insert_array' => "{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 2019 hasta las 10pm del 7 de marzo del 2019 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=2019030508000000&date_end=2019030722000000

    Respuesta:

    El sistema regresa la base de datos 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 sólo una fracción de las llamadas realizadas, muchas operaciones de contact center 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_date={recall_date}&recall_tele={recall_tele}&id={id}

    Ejemplo:

    https://{ip_ipdialbox}/ipdialbox/api_campaing.php?token={token}&action=recall&recall_date=20190415000000&recall_tele=9320784512&id=98456789


    8. Borrar registro.

    Con esta función puedes borrar un registro del predictivo, esto es útil cuando estás 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


    9. Inicio y pausa de campaña

  • Start, inicia campaña predictiva.
  • https://{ip_ipdialbox}/ipdialbox/api_campaing.php?token={token}&action=start&campaing={id_campaing}

  • Stop, detiene campaña predictiva.
  • https://{ip_ipdialbox}/ipdialbox/api_campaing.php?token={token}&action=stop&campaing={id_campaing}


    10. API para envío de mensajes e imágenes por WhatsApp

    La API para envío de mensajes e imágenes por WhatsApp, permite una mayor agilidad en la comunicación con los clientes a través de este canal, facilitando la integración desde aplicaciones externas, como el CRM, con las líneas configuradas en wolkvox y poder así realizar la gestión de los mensajes o respuestas por chatbots o agentes.

    Recomendación: Sólo admite 6.000 mensajes diarios.

    Conoce en el siguiente enlace las políticas de WhatsApp para el manejo de información a través de este canal de atención: Whatspp.com

    Para configurar esta API se debe insertar el siguiente enlace en la aplicación externa:

    https://{ip-server}/ipdialbox/api_campaing.php?token={token}&action=send_wp&wp_id={id-wp}&wp_phone={phone}&wp_mess={mensaje}&url_atach={url_de_la_imagen_publica}

  • Para obtener el token se deben seguir los pasos descritos en el siguiente enlace Token
  • Para obtener el id-wp se debe ingresar a menú - configuración y en omnicanal - WhatsApp se selecciona la línea a integrar y el número existente debajo de la palabra configuración es el id-wp, en este caso sería el 1.
  • Nota: Esta API aplica solamente para WhatsApp Móvil no aplica para Business.

    Configuracion de WhatsApp

    Esta API permite enviar un mensaje al WhatsApp de un cliente cada 20 seg. El resultado del procedimiento se puede evidenciar así:

    Configuracion de WhatsApp

    Ok cuando el envío es exitoso y Error cuando hay que esperar los 20 segundos para enviar un nuevo mensaje.


    11. API para envío directo de SMS

    API para envío directo de SMS, sin necesidad de utilizar el módulo de campañas, permite una mayor agilidad en la automatización de tareas, ya que facilita la integración de la plataforma wolkvox con aplicaciones externas como el CRM.

  • Para configurar esta API se debe ejecutar el siguiente enlace en la aplicación externa:
  • https:// {ip-server}/ipdialbox/api_campaing.php?token={token}&action=send_sms&sms_phone={phone}&sms_msn={mensaje}

  • Para obtener el token se deben seguir los pasos descritos en el siguiente enlace Token
  • Nota:

    El uso de esta API tiene una limitante basada en las restricciones del token.

    Ejemplo:

    https://{ip-server}/ipdialbox/api_campaing.php?token={token}&action=send_sms&sms_phone=9508263614&sms_msn=hola


    12. API CAMPAING DELETE ALL

    Con esta función se pueden borrar todos los registros en una campaña de manera masiva.

  • Para configurar esta API se debe ejecutar el siguiente enlace en la aplicación externa:
  • https://{ip}/ipdialbox/api_campaing.php?token={token}&action=delete_all&campaing={id_campaing}&type_campaing={predictive or preview}

    Ejemplo:

    https://{ip-server}/ipdialbox/api_campaing.php?token={token}=delete_all&campaing=9108&type_campaing=predictive

    API Configuración

    Link: https://{ip_ipdialbox}/ipdialbox/api_configuration.php

    Parámetros básicos

    Token: Es el id que identifica cada operación dentro de wolkvox, solicite al grupo de soporte de wolkvox el token para la operación que quiera integrar por medio de este link de integración.
    Function: indica la función que sea va a ejecutar.

    1. Crear agente (create_agent)

    Esta función permite crear un agente en la plataforma wolkvox, regresa el usuario del agente y la contraseña para realizar el logueo.

    Variables a enviar:

  • Name: este parámetro es obligatorio, indica el nombre del agente en la plataforma.
  • Identification: parámetro opcional que indica el número de identificación en el país.
  • SSO: parámetro opcional donde se envía el usuario de red, para que tener la función single sign on.
  • Ejemplo:

    https://{ip_ipdialbox}/ipdialbox/api_configuration.php?token={token}&function=create_agent&name=PRUEBA AGENTE DESDE API&identification=API-123456789&sso=api.user01

    Variables de regreso: El sistema regresa el resultado de usuario y password en una cadena json asi:

    {"result":"OK","user":"1379","password":"18A8MQ", "message":"agent successfully created"}


    2. Desactivar agente (deactivate_user) y Activar agente (activate_user)

    Esta función permite desactivar un agente en el configuration, de esta manera el agente no podrá loguearse en el agentbox.

    Variables a enviar

    id_agent: ID del agente.

    Ejemplo:

    https://{ip_ipdialbox}/ipdialbox/api_configuration.php?token={token}&function=deactivate_user&id_agent=1289

    Variables de regreso: El sistema regresa el resultado de usuario y password en un json así

    {"result":"OK","message":"agent successfully deactivated"}

  • Activar agente (activa e_user): Esta función permite activar un agente en el configuration.
  • Variables a enviar

    id_agent: ID del agente.

    Ejemplo:

    https://{ip_ipdialbox}/ipdialbox/api_configuration.php?token={token}&function= activate_user&id_agent=1289

    Variables de regreso: El sistema regresa el resultado de usuario y password en una cadena json así

    {"result":"OK","message":"successful agent activation"}


    3. Subir archivo vía ftp (ftp_file_upload)

    Esta función permite transferir una grabación desde el servidor de telefonía al FTP del cliente.

    Variables a enviar:

  • id_callh3:ID de la llamada que se quiere transferir.
  • ftp_server: servidor FTP del cliente.
  • ftp_user:usuarios FTP del cliente.
  • ftp_pass:password FTP del cliente.
  • remote_path:ruta dentro del FTP del cliente donde se colocará el archivo, si se envía vacío se coloca en la raíz.
  • Ejemplo:

    https://{ip_ipdialbox}/ipdialbox/api_configuration.php?token={token}&function=ftp_file_upload&id_call=2848.2851.1532100356.226&ftp_server=ftp.microsyslabs.com&ftp_user=user_cliente&ftp_pass=pass_cliente&remote_path=folder_audios/

    Variables de regreso: el sistema regresa el resultado de usuario y password en una cadena json así

    {"result":"OK","message":"successfully uploaded"}


    4. Ingresar un DNC inbound o outbound (single_dnc)

    Esta función permite ingresar un numero DNC, inbound o outbond a la base de datos.

    Variables por enviar:

  • Phone: teléfono que queremos que sea bloqueado.
  • Type: en esta variable se indica si el teléfono a bloquear es inbound o outbound.
  • Ejemplo:

    https://{ip_ipdialbox}/ipdialbox/api_configuration.php?token={token}&function=single_dnc&phone=93218112345&type=outbound

    Variables de regreso: El sistema regresa el resultado en una cadena json

    {"result":"OK","message":"DNC ok!"}


    5. Ingresar DNC de manera masiva (massive_mounting_dnc)

    Esta función permite ingresar de manera masiva números DNC.

    Variables por enviar

  • Type: en esta variable si indica si el teléfono a bloquear es inbound o outbound.
  • massive_dnc: variable que se envía como POST, cada número DNC debe ir separado por el carácter enter.
  • Ejemplo:

    https://{ip_ipdialbox}/ipdialbox/api_configuration.php?token={token}&function=massive_mounting_dnc&type=outbound

    variables post

  • massive_dnc
  • 932112345
  • 945109000
  • 543214578
  • variables de regreso: el sistema regresa el resultado en una cadena json.

    {"result":"OK","message":"DNC ok!"}


    6. Borrar todos los DNC (delete_dnc)

    Borra todos los DNC del módulo.

    Ejemplo:

    https://{ip_ipdialbox}/ipdialbox/api_configuration.php?token={token}&function=delete_dnc

    Variables de regreso: El sistema regresa el resultado en una cadena json

    {"result":"OK","message":"Delete DNC ok!"}


    7. Elimina un DNC (single_delete_dnc)

    Esta función permite eliminar un numero DNC de la base de datos.

    Variables por enviar:

  • phone: teléfono que queremos que sea bloqueado.
  • Ejemplo:

    https://{ip_ipdialbox}/ipdialbox/api_configuration.php?token={token}&function=single_delete_dnc&phone=93218112345

    Variables de regreso:El sistema regresa el resultado en un json

    {"result":"OK","message":" Delete Single DNC ok!"}


    8. Monitoreo servers dedicados

    Esta api solo funciona en servidores dedicados, tiene el límite de consultas propias de la api.

    Ejemplo:

    http://{ip_server}/ipdialbox/api_configuration.php?function=info_server&token={token}

    El sistema regresa el resultado en un json:

    {"cpu_avg_10s":"16","cpu_max_10s":"28","cpu_min_10s":"9","ram":"14","calls":"55","connected_agents":"95"}

    Variables de regreso

  • cpu_avg_10s: cpu promedio de los ultimos 10seg
  • cpu_max_10s: cpu maxima de los ultimos 10seg
  • cpu_min_10s: cpu minima de los ultimos 10seg
  • ram: Ram utilizada actualmente.
  • calls: llamadas conectadas en el servidor.
  • connected_agents: Agentes conectados al servidor.
  • API Encuestas

    Link: https://{ip_ipdialbox}/ipdialbox/api_ reports.php

    Parámetros básicos

    Token: Es el id que identifica cada operación dentro de wolkvox, solicite al grupo de soporte de wolkvox el token para la operación que quiera integrar por medio de este link de integración.
    report: indica el reporte que se va a generar.
    date_ini: fecha inicio del reporte.
    date_end: fecha fin del reporte.

    1. Reporte encuesta al final de la llamada.

    Este reporte trae información acumulada hora a hora de los estados de cada agente de la operación.

    Ejemplo:

    https://{ip_ipdialbox}/ipdialbox/api_reports.php?token={token}&report= cbps_survey&date_ini=20180724000000&date_end=20180724235959


    2. Reporte detalle de agente (agents_detail).

    Este reporte trae información detallada de agente, estado por estado, este reporte es de gran magnitud al traer un registro por cada evento de cada agente del contact center, con este reporte se puede construir cualquier estadística de agente que se desee, ideal para construir un ETL con niveles de agregación variados y armar vistas de BI sorprendentes.

    Ejemplo:

    https://{ip_ipdialbox}/ipdialbox/api_reports.php?token={token}&report=agents_detail &date_ini=20180724000000&date_end=20180724235959


    3. Reporte detalle de agente (skill_detail).

    El reporte detallado de skill trae el resultado llamada por llamada de las llamadas entrantes a un skill, Este reporte permite medir nivel de servicio y volúmenes de entrada en el skill. Este reporte es ideal para construir un ETL con niveles de agregación variados y armar vistas de BI sorprendentes de volúmenes de skill y niveles de servicio.

    Ejemplo:

    https://{ip_ipdialbox}/ipdialbox/api_reports.php?token={token}&report=skill_detail&date_ini= 20180724000000&date_end=20180724235959


    4. Reporte detalle de agente (ivr_detail).

    El reporte detallado de IVR regresa llamada a llamada que es procesada por el IVR.

    Ejemplo:

    https://{ip_ipdialbox}/ipdialbox/api_reports.php?token={token}&report=ivr_detail&date_ini= 20180724000000&date_end=20180724235959


    5. Reporte detalle de agente (quality_detail).

    El reporte detallado de la calificación realizada por el analista de calidad.

    Ejemplo:

    https://{ip_ipdialbox}/ipdialbox/api_reports.php?token={token}&report=quality_detail&date_i ni=20180724000000&date_end=20180724235959

    API Whatsapp

    1. API PARA ENVÍO DE MENSAJES E IMÁGENES POR WHATSAPP

    La API para envío de mensajes e imágenes por WhatsApp, permite una mayor agilidad en la comunicación con los clientes a través de este canal, facilitando la integración desde aplicaciones externas, como el CRM, con las líneas configuradas en wolkvox y poder así realizar la gestión de los mensajes o respuestas por chatbots o agentes.

    Recomendación: Sólo admite 6.000 mensajes diarios.

    Conoce en el siguiente enlace las políticas de WhatsApp para el manejo de información a través de este canal de atención: Whatsapp.com

    Para configurar esta API se debe insertar el siguiente enlace en la aplicación externa:

    https://{ip-server}/ipdialbox/api_campaing.php?token={token}&action=send_wp&wp_id={id-wp}&wp_phone={phone}&wp_mess={mensaje}&url_atach={url_de_la_imagen_publica}

  • Para obtener el token se deben seguir los pasos descritos en el siguiente enlace Token
  • Para obtener el id-wp se debe ingresar a menú - configuración y en omnicanal - WhatsApp se selecciona la línea a integrar y el número existente debajo de la palabra configuración es el id-wp, en este caso sería el 1.
  • Nota: Esta API aplica solamente para WhatsApp Móvil no aplica para Business.

    Configuracion de WhatsApp

    Esta API permite enviar un mensaje al WhatsApp de un cliente cada 20 seg. El resultado del procedimiento se puede evidenciar así:

    Configuracion de WhatsApp

    Ok cuando el envío es exitoso y Error cuando hay que esperar los 20 segundos para enviar un nuevo mensaje.


    2. API WHATSAPP OFICIAL PARA ENVÍO DE PLANTILLAS.

    Para configurar esta API se debe insertar el siguiente enlace en la aplicación externa:

    http://{server}/ipdialbox/api_campaing.php?token={token}&wp_id={wp-id}&wp_phone={phone}&wp_template={wp-te}&wp_vars={var1;var2;varn}&action=send_wp_official