API información de listado de llamados y filtrado por parámetros de Clickfono


Trasfondo

Para el uso de la API de Clickfono en aplicaciones que requieren, o se benefician, del uso de la información completa sobre listado de llamadas mediante un webservice utilizando parámetros de filtrado. Para esto es necesario de un endpoint que pueda entregar dicha informado.

Este documento explica el dicho endpoint, con sus parámetros y salidas esperables.

Invocación

El servicio se trata de un procedimiento remoto que se invoca a través de HTTP, por método GET.

Éste recibe como parámetro el UUID que identifica la llamada al ser pedida a través de la API de llamados de Clickfono. La interfaz sería la siguiente:

URLhttps://clickandtalk.medularis.com/calls/list
MétodoGET
Parámetros– date: string para filtro de fecha de las llamadas.
– Por defecto dia actual. 
– Formato YYYY-MM-DD
– No requerido.

– Popup_uuid:
– UUID del popup. 
– Por defecto nulo. 
– No requerido.
Headers security-token : API Token Clickfono

Nota: Si quiere conocer como  es el proceso de la generación de security_token


Un ejemplo de invocación desde consola, es la siguiente:

curl 'https://clickandtalk.medularis.com/calls/list?date=2019-04-02&popup_uuid=14f1cc88-6ce8-11e9-b8f9-001d09ef4aa0' -H 'security-token: MI_TOKEN'

Respuestas

Status HTTP: 200
Entrega información de llamadas en listado por filtros o no aplicados.
La respuesta es en formato JSON, acompañada  de la información respecto a las llamadas consultadas.

Ejemplo de respuesta

[
{
"uuid" :  "a93460bbf8402e15b9b0afddc05d5e8d",
    "status": "Conectada",
    "call_number_company": "56223456789",
    "retry": "3",
    "duration_company": "117",
    "duration_customer": "95",
    "call_at": "2019/04/02 10:05:03 -0300",
    "enqueued": false,
    "popup_uuid": "14f1cc88-6ce8-11e9-b8f9-001d09ef4aa0" ,
    "popup_name": "Pruebas Clickfono",
    "additionals": {
"Nombre": "Juan Perez",
      "Rut": "11.111.111-1"
     },
"caller_number": "+56987654321"
},  {
"uuid" :  "d45d347218b49a967a283c7bab360e5b",
"status": "No Conectada",
    "call_number_company": "56223456769",
    "retry": "3",
    "duration_company": "100",
    "duration_customer": "80",
    "call_at": "2019/04/02 11:05:03 -0300",
    "enqueued": false,
    "popup_uuid": "14f1cc88-6ce8-11e9-b8f9-001d09ef4aa0" ,
    "popup_name": "Pruebas Clickfono",
    "additionals": {
"Nombre": "Jorge Tapia",
      "Rut": "11.111.111-1"
},
    "caller_number": "+56987654321"
}

}
]

Campos de respuesta:

«uuid»string que representa el ID único de identificación de la llamada.
«status»

– «Conectada»
– «No Conectada»
– «Intentos terminados»
– «SPAM»
– «En cola»
– «Fuera de horario»
– «En ejecución»
– «Por ejecutar»
Estado de la llamada.

Posibles Valores
«call_number_company»Número de teléfono del agente, configurado en el popup.
«retry»Intento en el que se ejecutó la llamada.
«duration_company»Duración en segundos del lado de la empresa.
«duration_customer»Duración en segundos del lado del cliente.
«call_at»Fecha y hora cuando se realizó la llamada.
«enqueued»Si está en cola para ser ejecutada (en caso de tener reintentos configurados).
«popup_uuid»Identificador único del popup.
«popup_name»Nombre del popup.
«additionals»Parámetros adicionales enviados en la solicitud de llamada.
«caller_number»Número de teléfono de quien solicita la llamada.

Status HTTP: 204
No hay llamadas encontradas.

Status HTTP: 401
El token utilizado no es válido

Status HTTP: 404
La llamada identificada por el UUID no fue encontrada