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.

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.

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 un json asi:

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

Desactivar agente (deactivate_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 asi:

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

ü Activar agente (activate_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 un json asi:

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

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_call

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 un json asi:

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

Ingresar un dnc inbound o outbound (single_dnc)

Esta función permite ingresar un numero dnc, inbound o outbond a la bd.

Variables por enviar

Pone

Teléfono que queremos que sea bloqueado.

Type

En esta variable si 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 un json:

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

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 un json:

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

Borrar todos los DNC (delete_dnc)

Borrar 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 un json:

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