API información de llamada ClickFono

API información de llamada ClickFono


Para el uso de la API de ClickFono en aplicaciones que requieren, o se benefician, del uso de la información completa sobre la llamada mediante un webservice. 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.

Uso del servicio

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/{call_uuid}/info
MétodoGET​​​​
Parámetrosuuid: string representando el UUID que identifica la llamada.
HeadersSECURITY-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/cc97f690180049f8e0b7cb57bc4d856b/info' 
-H 'Security-Token: MI_TOKEN'

Respuestas

Status HTTP200
La llamada identificada por el UUID  fue encontrada

La respuesta es en formato JSON, acompañada  de la información respecto a la llamada consultada

Ejemplo de respuesta:

{
"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_id": 7427,
"popup_name": "Pruebas Clickfono",
"additionals": {
  "Nombre": "Juan Perez",
  "Rut": "11.111.111-1"
},
"caller_number": "+56987654321"
}

Campos de respuesta

  •  «status«: Estado de la llamada. Posibles valores:
    • «Conectada»
    • «No Conectada»
    • «Intentos terminados»
    • «SPAM»
    • «En cola»
    • «Fuera de horario»
    • «En ejecución»
    • «Por ejecutar»
  • «call_number_company«: Número de de la empresa tiene configurado en el agente donde se llamó.
  • «retry«: Intento a que corresponde cuando se realizó la consulta.
  • «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 se ejecutada (en caso de tener reintentos configurados).
  • «popup_id«: identificador numérico del Popup
  • «Popup_name«: Nombre del popup.
  • «additionals«: Parámetros adicionales enviados en la solicitud de llamada.
  • «caller_number«: Número teléfono del cliente a quién se llama.
Status HTTP401
El token utilizado no es válido
Status HTTP404
La llamada identificada por el UUID no fue encontrada

    • Related Articles

    • 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 ...
    • API descarga audio de llamado Clickfono

      Para el uso de la API de Clickfono en aplicaciones que requieren, o se benefician, del uso de la grabación de la llamada mediante un webservice es necesario de un endpoint que pueda entregar el audio (archivo) de llamada. Este documento explica el ...
    • 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 ...
    • ¿Cómo funciona una llamada en ClickFono?

      Funcionamiento de una llamada de ClickFono Una vez que el ejecutivo del call center ha contestado la llamada, ClickFono llama automáticamente al número que ingresó el cliente final en su solicitud, y cuando este contesta, ClickFono conecta la llamada ...
    • 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 ...