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:

• URL https://clickandtalk.medularis.com/calls/{uuid}/info

• Método GET

• Parámetros uuid: string que representa el identificador único la llamada.

• Headers security-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

• uuid: Identificador único de la llamada consultada.

• call_at: Fecha y hora de cuando se realizó la llamada.

• popup_name: Nombre del popup que se ocupó para generar la llamada.

• popup_uuid: Identificador único del popup.

• caller_number: Número de teléfono del cliente.

• call_number_company: Número de teléfono del agente que está asignado al popup.

• duration_company: Duración en segundos del lado del agente (empresa).

• duration_customer: Duración en segundos del lado del cliente.

• status: Estado de la llamada. Posibles valores:

  • "En ejecución"

  • "Conectada"

  • "No Conectada"

  • "Intentos terminados"

  • "SPAM"

  • "En cola"

  • "Fuera de horario"

• retry: Número de intentos que ha tenido la llamada.

• enqueued: Indica si la llamada está en cola para se ejecutada (en caso de que el popup tenga reintentos configurados).

  • true

  • false

• additionals: Parámetros adicionales enviados en la solicitud de llamada.

Status HTTP: 401 ⛔

Error 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"}