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

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

Trasfondo

Esta API funciona para las aplicaciones que requieran información completa, en formato de lista de las llamadas de ClickFono.
Este documento explica como ocupar dicha api, con sus parámetros y respuestas.

Uso del servicio

El servicio se trata de un procedimiento remoto que se invoca a través de HTTP, por método GET.
Éste recibe los parámetros opcionales popup_uuid y date. 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 día actual.
    – Formato YYYY-MM-DD
    – No requerido.

– popup_uuid: identificador único del popup. 
    – Por defecto nulo. 
    – No requerido.
Headerssecurity-token: string que representa el 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=2024-01-31&popup_uuid=14f1cc88-6ce8-11e9-b8f9-001d09ef4aa0' -H 'security-token: api_token_clickfono'

Respuestas

Status HTTP: 200 ✅
Listado de llamadas encontradas.

La respuesta es en formato JSON, acompañada de la información respecto al listado de llamadas consultadas.

Ejemplo de respuesta:

[
  {
    "uuid": "69ae2c909ea19b62e3ebcdeba6847575",
    "call_at": "2024-01-22T16:38:46-04:00",
    "popup_name": "Seguros de Hogar",
    "popup_uuid": "7b4becb2-3afc-11ec-a857-001d09ef4a24",
    "caller_number": "+56912345678",
    "call_number_company": "56987654321",
    "duration_company": 183,
    "duration_customer": "95",
    "status": "Conectada",
    "retry": 1,
    "enqueued": false,
    "additionals": {
      "Nombre": "María Villablanca",
      "Rut": "22.222.222-K",
      "Email": "mvilla@mail.com"
    }
  },
  {
    "uuid": "69kf12c909ea19b62e3ebcdeba6847575",
    "call_at": "2024-01-22T12:38:46-04:00",
    "popup_name": "Seguros Automotriz",
    "popup_uuid": "7b4becb2-2de2-11ec-a857-001d09ef4a24",
    "caller_number": "+56912345678",
    "call_number_company": "56987654321",
    "duration_company": 65,
    "duration_customer": "33",
    "status": "Conectada",
    "retry": 2,
    "enqueued": false,
    "additionals": {
      "Nombre": "Juan Perez",
      "Rut": "11.111.111-k"
    }
  }
]

Campos de respuesta:

  1. uuid: Identificador único de la llamada consultada.
  2. call_at: Fecha y hora de cuando se realizó la llamada.
  3. popup_name: Nombre del popup que se ocupó para generar la llamada.
  4. popup_uuid: Identificador único del popup.
  5. caller_number: Número de teléfono del cliente.
  6. call_number_company: Número de teléfono del agente que está asignado al popup.
  7. duration_company: Duración en segundos del lado del agente (empresa).
  8. duration_customer: Duración en segundos del lado del cliente.
  9. status: Estado de la llamada. Posibles valores:
    1. "En ejecución"
    2. "Conectada"
    3. "No Conectada"
    4. "Intentos terminados"
    5. "SPAM"
    6. "En cola"
    7. "Fuera de horario"
  10. retry: Número de intentos que ha tenido la llamada.
  11. enqueued: Indica si la llamada está en cola para se ejecutada (en caso de que el popup tenga reintentos configurados).
    1. true
    2. false
  12. additionals: Parámetros adicionales enviados en la solicitud de llamada.

Status HTTP: 204 ✅

No se encontraron llamadas, con los parámetros indicados.


Status HTTP: 401 ⛔
Erro en el parámetro security-token.
{"status": "Invalid Security Token"}

    • Related Articles

    • API información de llamada ClickFono

      Esta API funciona para las aplicaciones que requieran información completa de una llamada de ClickFono. Este documento explica como ocupar dicha api, con sus parámetros y respuestas. Uso del servicio El servicio se trata de un procedimiento que se ...

    • API descarga audio de llamado Clickfono

      Esta API funciona para las aplicaciones que requieran información completa de una llamada de ClickFono. Este documento explica como ocupar dicha api, con sus parámetros y respuestas. Uso del servicio El servicio se trata de un procedimiento remoto ...

    • Reporte gráfico y análisis

      El nuevo Dashboard de ClickFono es una versión de gráficos mejorada donde se podrá analizar todas las solicitudes. Adicional, obtener una información más clara y asertiva que permitirá tomar las mejores decisiones en las operaciones. Para ver este ...

    • Reglas de SPAM en FormCall – API

      Debido a que el flujo de las llamadas son separadas para FormCall y los Pop-Up ClickFono, también así son las reglas de spam: FormCall – API Hay dos filtros de spam para FormCall, cuando la llamada es encolada (call_session_validator.php) Las ...

    • Estados de las Llamadas FormCall

      API de estados para clientes de FormCall Trasfondo Para el uso de FormCall en aplicaciones que requieren, o se benefician, de feedback continuo sobre el estado de la llamada a los usuarios es necesario de un endpoint que pueda entregar el estado ...