Skip to main content

List call records

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 Token​


Token
<token>

Headers​


X-Requested-With
XMLHttpRequest

Parameters​


timeZone

America/Santiago
(String - required) Needed to filter records according to their time zone ("America/Santiago").

sessionId

3223
(Integer - optional) Filters call records by state: (Missed: 2, Answered: 3, Cancelled: 4, Left the queue: 6, Scheduled: 8, Abandoned: 9, No availability: 10, Out of hours: 11, Appointment cancelled: 12, Appointment expired: 13, Blocked: 14, Link created: 16, IP blocked: 17, Finished: 18, Forced disconnection: 19).

start

2023-11-01
(Date - optional) Filters call records by date range: 2023-10-01 (start date).

end

2023-11-30
(Date - optional) Filters call records by date range: 2023-12-01 (end date).

widgetId

1
(Integer - optional) Filters call records by widget ID.

callTypeId

1
(Integer - optional) Filters call records by type, for example (Direct: 1, Scheduled: 2).

customer

John Smith
(string - optional) Filters call records by customer.

page

3
(Integer - optional) If omitted, the last 50 records are returned.

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'

Example response​

call response
{
"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"
}

Dictionary​


SessionId
This field is a unique identifier for each session.
Agent
Indicates the name of the agent who handled the call.
Department
Indicates the department in which the call was generated.
StateName
Indicates the state of the interaction. Link to call states (https://docs.ocularsolution.com/docs/guides/call-states).
WidgetName
Indicates the name of the widget used for the call.
WidgetMs
Indicates the quality of the call on the customer's side, expressed in milliseconds (ms)
CalificationWidget
Indicates the quality rating of the customer's connection according to a range in (ms).
CalificationCammer
Indicates the quality rating of the cammer's connection according to a range in (ms).
CammerMs
Indicates the quality of the call on the cammer's side, expressed in milliseconds (ms)
OriginUrl
Indicates the URL from which the call originated.
Duration
Indicates the total duration of the call, including queue time, time with the widget and time with the agent.
Finished
Indicates who ended the call. Possible values (Agent || Customer).
Date
Indicates the date on which the call took place.
Tags
Indicates the tags associated with the call.
Cancelled
Indicates who cancelled the call. Possible values (Agent || Customer).
Calification
Indicates the overall rating of the call.
CallType
Indicates the call type. Possible values (Direct || Scheduled).
Transferred
Indicates whether the call was transferred to another agent or department.
Comment
Indicates the comment the customer left about the call.
Customer
Indicates the name of the customer who made the call.
SubscriberIp
Indicates the IP address of the subscriber who made the call.