NewChatEvent
Notification Object
↪ NewChatEvent
Notification when a new message is received for the chat session.
Subscribing
Event is send every time a user is receiving a new chat
When the chat session is an external session only administrators can subscribe with the select chat session oid.
How to process
When this event is received, a new chat message is received. The new message should be processed and the participant should be warned or the open chat screen should be updaeted.
Fields
| Name | Type | Notes | |
|---|---|---|---|
sessionName |
|
the name of the chat session |
|
sessionOid |
|
the oid of the chat session |
|
chatOid |
|
the oid of the chat session |
|
date |
|
the date of the chat in UTC |
|
phoneLine |
the phone line of the chat notification |
||
clientId |
|
the client id identifies the client from which the chat is send from (smartphone / softphone / ..) |
|
creator |
the creator of the chat message |
||
addressable |
the addressable of the chat session |
||
reference |
the sended reference (attachment or object reference) |
||
contents |
|
the contents of the chat. Long chat message are truncated |
|
chatSessionType |
|
the chat session type (user, group, phoneLine, external, whatsApp) |
|
communicationOid |
|
the oid of the linked communication object |
|
forwarded |
|
is the chat a forward of another chat message |
|
silent |
|
if true, do not show a notification, only refresh the active communication screens |
|
incoming |
|
if true, the chat is incoming else it is outgoing |
|
chatHuntingPolicy |
if true, the chat agent hunting is enabled and the delivery is handled specially |