API Telefonía
- Daniel Olivera (Unlicensed)
- uContact dev
- Santiago Viglione
Aquí podremos encontrar toda la información relevante a las acciones de telefonía que pueden ser realizadas a través de nuestra API.
Recordar que para poder usar la API se necesita:
Autenticarse y obtener un token para la sesión.
Usar el token en el Header Authorization.
Finalizar sesión.
Contenido
Llamadas
Aquí veremos las siguientes acciones disponibles:
Realizar llamadas
https://dominio.ucontactcloud.com/Integra/resources/Agents/AgentCall
Método: POST
content-type:application/x-www-form-urlencoded; charset=UTF-8
Parámetros: callerid (Número con que va a salir la llamada)
agent (Nombre del agente que genera la llamda)
phone (Número de teléfono del agente)
tech (Usualmente SIP)
context (Contexto del agente configurado en uContact)
outqueue (Nombre de la campaña que se computara la llamada)
destination (Número destino)
Resultado: TEXTO (Guid de la llamada generado)
0 Error
Es una llamada en 2 pasos se llama al agente y cuando Atiende o Auto-atiende se genera la llamada final.
Realizar llamada vía proxy
<script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/porthole/1.0.0/porthole.js"></script>
<script type="text/javascript">
function Call () {
var windowProxy;
windowProxy.addEventListener(onResponse);
windowProxy = new Porthole.WindowProxy(window.location.protocol + window.location.hostname);
windowProxy.post({'action': 'call', 'campaign' : '<CAMPAIGN>', 'callerid' : '<CALLERID>', 'destination' : '<NUMBER>'});
}
function onResponse(messageEvent) {
response = messageEvent.data.guid; //retorna id único de llamada
}
</script>
Realizar llamada pasando Datos al Workflow
https://dominio.ucontactcloud.com/Integra/resources/Agents/AgentCallwithData
Método: POST
content-type:application/x-www-form-urlencoded; charset=UTF-8
Parámetros: callerid (Número con que va a salir la llamada)
agent (Nombre del agente que genera la llamda)
phone (Número de teléfono del agente)
tech (Usualmente SIP)
context (Contexto del agente configurado en uContact)
outqueue (Nombre de la campaña que se computara la llamada)
destination (Número destino)
data (datos para enviar al workflow, habitualmente un JSON que se puede pasar a variables con la actividad JSON dentro del flujo)
form (Nombre de Form o URL para Popup)
Resultado: TEXTO (Guid de la llamda generado)
0 Error
Es una llamada en 2 pasos se llama al agente y cuando Atiende o Auto-atiende se genera la llamada final.
Realizar llamada directamente desde el teléfono
Esta función permite realizar llamadas, pero se diferencia de la anterior porque utiliza el teléfono ya inicializado del portal.
La única manera de realizarlo es vía proxy, dado que la comunicación es directamente con el portal de uContact.
Cortar llamada
Cortar llamada vía Proxy
Tipificar llamadas
Respuestas del WS
Blacklist
Objeto de blacklist
Agregar número a Blacklist
Agregar varios números a Blacklist
Eliminar numero de Blacklist
Eliminar varios numeros de Blacklist
Grabaciones
Obtener grabaciones de llamada
Objeto Json
Respuesta
Convertir grabaciones
Marcar grabación (Tag)
Vía Proxy
Marcadores
Acciones disponibles
CTI
Este JSON es encontrado en el LocalStorage y encriptado, tiene la información de la llamada que fue atendida y la información del registro del marcador, si corresponde para Respool.
Dialer: Campaña, Num principal, status (siempre 1), data (parámetros y valores que pasan al Workflow), alternatives (separados por :), retries (reintentos que va haciendo ese número), contact (ID contacto), dialebase, prioridad, agentphone.
Estos datos hay que convertirlos al objetoRespool que se muestra más abajo.
¿Qué podemos realizar con Objeto Respool?
Cambiar teléfono principal por alternativos y reordenar a gusto.
Cambiar cantidad de reintentos para ese número (ejemplo: si pongo un alternativo como principal poner el 0).
Cambiar prioridades.
Agregar datos para el workflow o cambiarlos.
agentphone, si es progressive asignar a otro agente.
Vía Proxy
Definir en su página
Respool llamada
Objeto Json
Via Proxy
Agendar llamada
Objeto Json
Via Proxy
Tareas Marcadores
Ejemplos para cada modo:
Agregar marcador con prioridad 1
Crear llamada manual en el momento
Agregar llamada al marcador
Agendar llamada para marcador
Borrar Contacto del Dialer
Borrar Agenda del Marcador
Parámetros: campaña, el número, fecha desde y fecha hasta (formato YYYY-MM-DD hh:mm:ss) para poder borrar por fecha.
Subir Bases
La API nos da la posibilidad de subir las listas de marcadores con parámetros o con timezone para que sea utilizada la más adecuada a sus necesidades.
Subir base de llamadas
Formato del archivo
Subir base de llamadas con zona horaria
Formato del archivo
Información de Campañas
También puede obtener la información de las campañas de voz.
Resumen de campañas
Para ver resumido el estado de las campañas del sistema, existe el siguiente método:
Respuesta
Estado de Campañas
En cambio si queremos obtener toda la información de las campañas del sistema, podemos usar este otro método:
Respuesta
Para obtener la información de los agentes junto con las estadísticas de la campaña, para una campaña en específico, existe el siguiente método. Es la misma ruta que el anterior, pero se le especifica el nombre por parámetro.
Además de devolver el objeto con información de la campaña, también se devuelve el objeto de cada agente perteneciente a ella.
Respuesta
Códigos de estado de los agentes
Colección de postman con algunas de las llamadas.
