Notification events are returned to subscribers in the form of JSON objects, which conform to the following structure:
| Field | Type | Description |
|---|
id | string | Unique id of the notification event |
time | number | Time at which the event was emitted, in ms past epoch (01/01/70 00:00:00 UTC) |
ver | string | The event format version (currently “1.0”) |
type | string | The event type (see below for possible values) |
payload | object | The event type-specific payload |
The following are valid values of the type field:
| Event Type | Description |
|---|
| slowToRespondAgentOpened | Slow to Respond notification opened |
| slowToRespondAgentClosed | Slow to Respond notification closed |
| silenceHighOpened | Extended Silence notification opened |
| silenceHighClosed | Extended Silence notification closed |
| speakingRateLowAgentOpened | Speaking Slowly notification opened |
| speakingRateLowAgentClosed | Speaking Slowly notification closed |
| empathyCueOpened | Empathy Cue notification opened |
| empathyCueClosed | Empathy Cue notification closed |
| lowEnergyAgentOpened | Energy Cue notification opened |
| lowEnergyAgentClosed | Energy Cue notification closed |
| continuousSpeakingAgentOpened | Continuous Speaking notification opened |
| continuousSpeakingAgentClosed | Continuous Speaking notification closed |
| extendedOverlapOpened | Extended Overlap notification opened |
| extendedOverlapClosed | Extended Overlap notification closed |
| speakingRateHighAgentOpened | Speaking Quickly notification opened |
| speakingRateHighAgentClosed | Speaking Quickly notification closed |
| positiveInteractionOpened | Positive Interaction notification opened |
| positiveInteractionClosed | Positive Interaction notification closed |
| Event Type | Description |
|---|
| cxScoreUpdated | Experience Score updated |
| Event Type | Description |
|---|
| topicKeywordEvent | The utterance of keyword(s) associated with a specified topic was detected |
| topicKeywordAbsentEvent | Keyword(s) associated with a specified topic were expected to be spoken but were not detected |
The structure of the payload field of the notification event JSON object varies depending on the type of the event.
| Field | Type | Description |
|---|
callId | string | The ID of the call during which this notification occurred |
username | string | The Cogito username of the user associated with the call |
bTime | number | The time in ms, relative to the start of the call, at which the behavior leading to the notification began |
nTime | number | The time in ms, relative to the start of the call, at which the notification is to be presented to the user |
idx | number | The sequence number of this event within the call. This number is unique within the same event type and call |
| Field | Type | Description |
|---|
callId | string | The ID of the call during which this notification occurred |
username | string | The Cogito username of the user associated with the call |
bTime | number | The time in ms, relative to the start of the call, at which the behavior leading to the notification ended |
nTime | number | The time in ms, relative to the start of the call, at which the notification is to no longer be presented to the user |
bDur | number | The duration in ms of the behavior that led to the notification |
nDur | number | The duration in ms, during which the notification is to be presented to the user |
idx | number | The sequence number of this event within the call. This number is unique within the same event type and call |
| Field | Type | Description |
|---|
callId | string | The ID of the call during which this notification occurred |
username | string | The Cogito username of the user associated with the call |
score | number | The call score |
| Field | Type | Description |
|---|
callId | string | The ID of the call during which this notification occurred |
username | string | The Cogito username of the user associated with the call |
displayDuration | number | The number of milliseconds for which this topic notification should be displayed |
utteranceBegin | number | The start time in milliseconds of the utterance in which this topic was detected, relative to the beginning of the call |
utteranceEnd | number | The end time in milliseconds of the utterance in which this topic was detected, relative to the beginning of the call |
speaker | string | The speaker of the utterance, either "Agent" or "Subject" |
topic | string | The id of the topic that was detected |
idx | number | The sequence number of this event within the call. This number is unique within the same event type and call |
| Field | Type | Description |
|---|
callId | string | The ID of the call during which this notification occurred |
username | string | The Cogito username of the user associated with the call |
displayDuration | number | The number of milliseconds for which this topic notification should be displayed |
absenceDuration | number | The amount of time in milliseconds from the beginning of the call, after which the notification is fired if the topic was not mentioned |
utteranceEnd | number | The end time of the utterance after which the notification was fired, relative to the beginning of the call |
topic | string | The id of the topic that was detected as absent |
idx | number | The sequence number of this event within the call. This number is unique within the same event type and call |
{"id":"adbce960-4d47-4d42-8fd5-52f70d867412", "time":1603158961452,"ver":"1.0",
"type":"lowEnergyAgentOpened","payload":{"callId":"TestCall-12a86f31-a569-4873-a121-b5137aca721d","username":"testAgent","bTime":21648,"nTime":35912,"idx":0}}
{"id":"0774112b-0f21-4d67-9664-0ae14b6921de","time":1603158972424,"ver":"1.0",
"type":"lowEnergyAgentClosed","payload":{"callId":"TestCall-12a86f31-a569-4873-a121-b5137aca721d","username":"testAgent","bTime":35912,"nTime":46800,"bDur":14264,"nDur":10888,"idx":0}}
{"id":"3bbeae95-fc01-4bd8-a912-6231967ba073","time":1603246877552,"ver":"1.0","type":"cxScoreUpdated","payload":{"callId":"TestCall-1a1b5fce-6267-4e61-a002-0bc692fe7ded","username":"testAgent","score":7.41417}}
{"id":"703c30a7-919c-4062-a0a0-2fd3d3be8e90","time":1685625647644,"ver":"1.0","type":"topicKeywordEvent","payload":{"callId":"TestCall-12a86f31-a569-4873-a121-b5137aca721d","username":"testAgent","displayDuration":15000,"utteranceBegin":749673,"utteranceEnd":752730,"speaker":"Agent","topic":"Billing-Question","idx":0}}
{"id":"7c209fcb-87c0-411b-bd3a-da1947430d2b", "time": 1685624842381,"ver":"1.0",
"type":"topicKeywordAbsentEvent","payload":{"callId":"TestCall-12a86f31-a569-4873-a121-b5137aca721d","username":"testAgent","displayDuration":12000,"absenceDuration":30000,"utteranceEnd": 32010,"topic":"Explain-Resources","idx":0}
