Listar registros de llamadas

GETList Call Registers

{ocular-api-domain}/api/ocular/admin/call-registers?timeZone=America/Santiago&sessionId=3223&start=2023-11-01&end=2023-11-30&widgetId=1&callTypeId=1

AUTHORIZATION Bearer Token#

Token

<token>

Headers#

X-Requested-With

XMLHttpRequest

Parámetros#

timeZone

America/Santiago
(String - requerido) Necesario para filtrar los registros segun su zona horaria ("America/Santiago").

sessionId

3223
(Integer - opcional) Para filtrar registros de llamadas por estados: (Perdida: 2, Contestada: 3, Cancelada: 4, Salio de la fila: 6, Angendada: 8, Abandono: 9, Sin disponibilidad: 10, Fuera de horario: 11, Cita cancelada: 12, Cita caducada: 13, Bloqueado: 14, Link creado: 16, Ip bloqueada: 17, Finalizada: 18, Desconexion forzada: 19).

start

2023-11-01
(Date - opcional) para filtrar los registros de llamadas en rangos de fechas: 2023-10-01 (fecha de inicio).

end

2023-11-30
(Date - opcional) para filtrar los registros de llamadas en rangos de fechas: 2023-12-01 (fecha de fin).

widgetId

1
(Integer - opcional) para filtrar los registros de llamadas por id de widget.

callTypeId

1
(Integer - opcional) para filtrar los registros de llamadas por tipos ejemplos (Directa: 1, Agendada: 2).

page

3
(Integer - opcional) Si no se coloca retorna los últimos 50 registros.

Example Request#

curl

curl --location -g '{{ocular-api-domain}}/api/ocular/admin/call-registers?timeZone=America%2FSantiago&sessionId=3223&start=2023-11-01&end=2023-11-30&widgetId=1&callTypeId=1' \
--header 'X-Requested-With: XMLHttpRequest'

Respuesta de ejemplo#

respuesta de llamada

{
  "sessionId": 994492,
  "agent": "Paul Núñez paul25gnm@gmail.com",
  "department": "Información",
  "stateName": "Finalizada",
  "widgetName": "Principal",
  "widgetMs": 140,
  "calificationWidget": "stable",
  "calificationCammer": "stable",
  "cammerMs": 131.08,
  "originUrl": "ocularsolution.com/",
  "duration": "00:00:14",
  "finished": "Agente",
  "date": "2024-06-18 16:44:23",
  "tags": null,
  "cancelled": "-",
  "calification": 10,
  "callType": "Directa",
  "transferred": "-",
  "comment": null,
  "customer": {
    "Teléfono": "+56988391319",
    "Nombre completo": "Paul Nuñez",
    "Correo electrónico": "paul25gnm@gmail.com"
  },
  "subscriberIp": "186.105.130.49",
  "attentionTime": "00:00:14",
  "ringingTime": "00:00:04",
  "queueTime": "00:00:15"
}

Diccionario#

SessionId

Este campo es un identificador único para cada sesión.

Agent

Indica el nombre del agente que atendió la llamada.

Department

Indica el departamento en el que se generó la llamada.

StateName

Indica el estado la de atención. Link a estados de llamadas (https://docs.ocularsolution.com/docs/guides/call-states).

WidgetName

Indica el nombre del widget que se utilizó para la llamada.

WidgetMs

Indica la calidad de la llamada realizada por el cliente expresado en milisegundos(ms)

CalificationWidget

Indica la calificación de la calidad de la conexión del cliente de acuerdo a un rango en (ms).

CalificationCammer

Indica la calificación de la calidad de la conexión del cammer de acuerdo a un rango en (ms).

CammerMs

Indica la calidad de la llamada realizada por el cammer expresado en milisegundos(ms)

OriginUrl

Indica la URL desde la que se originó la llamada.

Duration

Indica la duración total de la llamada, incluyendo el tiempo de espera, el tiempo con el widget y el tiempo con el agente.

Finished

Indica quien finalizó la llamada. Valores posibles (Agente || Cliente).

Date

Indica la fecha en que se realizó la llamada.