API información de llamada ClickFono

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 invoca a través de HTTP, por método GET.

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

URLhttps://clickandtalk.medularis.com/calls/{uuid}/info
MétodoGET
Parámetrosuuid: string que representa el identificador único la llamada.
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/cc97f690180049f8e0b7cb57bc4d856b/info' -H 'security-token: api_token_clickfono'

Respuestas

Status HTTP: 200 ✅
La llamada con el uuid indicado fue encontrada
La respuesta es un JSON, acompañada de la información respecto a la llamada consultada

Ejemplo de respuesta:

{
  "uuid": "69ae2c909ea19b62e3ebcdeba6847575",
  "call_at": "2024-01-22T16: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: 401 ⛔
Erro en el parámetro security-token.
{"status": "Invalid Security Token"}
Status HTTP: 404 ⛔
La llamada con el uuid indicado no fue encontrada
{"status": "Not found"}

    • Related Articles

    • 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 ...

    • 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 ...

    • Glosario de Términos

      Términos básicos utilizados. Término Definición Llamada Exitosa Llamada con duración cliente igual o mayor a 25 segundos. Personalización de Pop-up «Al presionar el botón de acción para solicitar el llamado instantáneo, al usuario se le pide su ...

    • 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 ...

    • Integración con HubSpot

      Configuración ClickFono puede integrarse fácilmente con tu CRM de HubSpot, sólo debes hacer los siguientes pasos: 1.- Ingresar a la Plataforma ClickFono con privilegios de Administrador 2.- Hacer click en la opción Funciones Avanzadas del módulo de ...