Communication

Xelion Object
↪ Entity
↪ Communication

Subclasses

User Chat, Message, Video Conference, SMS Message, Email Message, Call Log

A communication event: a phone call, email, chat message or SMS message.

Fields

Name Type Notes

Name	Type		Notes
subject	`String`		The subject of the communication.
date	`datetime`	notNull	The date and time of the event.
contents	`Comment`		The contents of the communication.
durationSec	`Integer`	notNull	The communication duration in seconds. The value if this attribute is only set for object of type CallLog.
status	`Communication Status`		The status of the event. Some statuses are listed in {@link CommunicationStatus}
incoming	`Boolean`	notNull	If true then this communication is received by the owner of this object. If false the the owner is the creator of this communication. This is marked as true when the users queries a list of communication items.
displayed	`Boolean`	notNull	If true then this object is displayed by the owner of this object. This is true when the user has seen the full commincation object.
displayedUser	`String`		if communication is displayed the name of the user who has seen the communication is set in some cases for example a chat to a group that is displayed to 1 user this can be used to determine which user has seen the incoming communication.
flagged	`Boolean`	notNull	If true then this object is flagged, i.e. marked as important. Flagged communication will also be set on the todo/flagged list
forwarded	`Boolean`	notNull	If true then this communicaton is created from a forwarded message
processed	`Boolean`	notNull	If true then this communicaton is processed / archived
recordingStatus	`Recording Status`		If true then this object has no recording. If false, there could be a recording available.
hasAttachment	`Boolean`	notNull	True if the communication has one or more attachments.
hasInlineAttachment	`Boolean`	notNull	True if the communication has one or more attachments that preferably are shown in the body .
hasMessageReference	`Boolean`	notNull	True if the communication has one or more references to internal objects (contact, communication, appointment, …).
associatedAddressable	`Addressable`		The associated addressable. This attribute is set by messages in a group chat.
contentSummary	`String`		Content summary.
contentSummaryIsComplete	`Boolean`	notNull	Content summary is complete.
participants	`[Addressee]`		The participants in the communication.
attachments	`[Attachment]`		the message attachments
messageReferences	`[Entity]`		the message references (contact, communication, appointment, …)
voicemail	`Boolean`	notNull	is there a voicemail attached to this communication object
voicemailIsHeard	`Boolean`	notNull	is the attached voicemail heard
voicemailDuration	`Integer`		the voicemail duration in seconds
callId	`String`	CallLog	The unique call id
id	`String`	CallLog	The id of the call
callFlowId	`String`	CallLog	The call flow id. This id is kept when the call is transfered.
phone	`String`	CallLog	the phone who took the call
isConferenceCall	`Boolean`	CallLog	is this call a conference call
callAnswerTime	`String`	CallLog	answer time of a call
callAnswerTimeSec	`Integer`	CallLog	answer time of a call in seconds
callEndTime	`String`	CallLog	end time of a call
onHoldDuration	`Integer`	CallLog	the duration in seconds in which the call was in the on-hold state
trunk	`String`	CallLog	trunk that is used in this call
phoneLine	`Phone Line`		the phone line that is matched with this communication
wrapUpTime	`Integer`	CallLog	wrap up time in seconds
userProfile	`User Profile`		the user profile who took the communication
chatSessionType	`Chat Session Type`		if communication is a chat, the chat session type is given
whatsAppTemplateCategory	`String`		if WhatsApp template is sended, the category is filled here
original	`Communication`		the original communication object, this value is filled in when the communication is a reply of another communication
originalFromName	`String`		The name of the from addressable of the original communication
originalFromAddressable	`Addressable`		The addressable of the from addressable of the original communication
deliveredToReceiver	`datetime`		The date time when the communication is delivered to the receiver. This can be used to check if outgoing chats are delivered.
readByReceiver	`datetime`		The date time when the communication is read by the receiver. This can be used to check if outgoing chats are read.
transferredFrom	`Communication`		Communication (CallLog) object where the call is transferred from The transferred from line information is also included here
transferredFromName	`String`		The name of the caller where the call is transferred from
transferredFromAddressable	`Addressable`		The addressable of the caller where the call is transferred from
transferredFromReason	`Transfer Reason`		Reason why call is transferred
transferredTo	`Communication`		Communication (CallLog) object where the call is transferred to The transferred to line information is also included here
transferredToName	`String`		The name of the caller where the call is transferred to
transferredToAddressable	`Addressable`		The addressable of the caller where the call is transferred to
transferredToReason	`Transfer Reason`		Reason why call is transferred
chatSession	`Chat Session`		The chat session associated with this communication object
afterCallType	`String`		The after call type of the call
packetsLogs	`[Packets Log]`		Call’s RTP statistics, such as packets count and jitter.
callbackPhoneNumber	`String`		The phone number the caller has asked to be called on, when the caller was waiting in a call queue.
transcription	`Transcription`		Transcription
userReportedBadAudio	`Boolean`		The user marked the audio quality as 'bad'.
userReportedOnewayAudio	`Boolean`		The user has reported one-way audio.
userReportedUnstableConnection	`Boolean`		The user has reported an unstable connection.
userAudioQualityRating	`Integer`		User’s rating of the audio quality from 1 to 5.
userAudioQualityReview	`String`		User’s general comments on audio quality
logAttachments	`[Attachment]`		Logs of the call. For example: the call logging from the business rule server log or the app logging. These logs are not shared with other communication-objects of the same call.

subject

String

The subject of the communication.

date

datetime

notNull

The date and time of the event.

contents

Comment

The contents of the communication.

durationSec

Integer

notNull

The communication duration in seconds. The value if this attribute is only set for object of type CallLog.

status

Communication Status

The status of the event. Some statuses are listed in {@link CommunicationStatus}

incoming

Boolean

notNull

If true then this communication is received by the owner of this object. If false the the owner is the creator of this communication. This is marked as true when the users queries a list of communication items.

displayed

Boolean

notNull

If true then this object is displayed by the owner of this object.
This is true when the user has seen the full commincation object.

displayedUser

String

if communication is displayed the name of the user who has seen the communication is set in some cases
for example a chat to a group that is displayed to 1 user
this can be used to determine which user has seen the incoming communication.

flagged

Boolean

notNull

If true then this object is flagged, i.e. marked as important.
Flagged communication will also be set on the todo/flagged list

forwarded

Boolean

notNull

If true then this communicaton is created from a forwarded message

processed

Boolean

notNull

If true then this communicaton is processed / archived

recordingStatus

Recording Status

If true then this object has no recording. If false, there could be a recording available.

hasAttachment

Boolean

notNull

True if the communication has one or more attachments.

hasInlineAttachment

Boolean

notNull

True if the communication has one or more attachments that preferably are shown in the body .

hasMessageReference

Boolean

notNull

True if the communication has one or more references to internal objects (contact, communication, appointment, …).

associatedAddressable

Addressable

The associated addressable. This attribute is set by messages in a group chat.

contentSummary

String

Content summary.

contentSummaryIsComplete

Boolean

notNull

Content summary is complete.

participants

[Addressee]

The participants in the communication.

attachments

[Attachment]

the message attachments

messageReferences

[Entity]

the message references (contact, communication, appointment, …)

voicemail

Boolean

notNull

is there a voicemail attached to this communication object

voicemailIsHeard

Boolean

notNull

is the attached voicemail heard

voicemailDuration

Integer

the voicemail duration in seconds

callId

String

CallLog

The unique call id

String

CallLog

The id of the call

callFlowId

String

CallLog

The call flow id. This id is kept when the call is transfered.

phone

String

CallLog

the phone who took the call

isConferenceCall

Boolean

CallLog

is this call a conference call

callAnswerTime

String

CallLog

answer time of a call

callAnswerTimeSec

Integer

CallLog

answer time of a call in seconds

callEndTime

String

CallLog

end time of a call

onHoldDuration

Integer

CallLog

the duration in seconds in which the call was in the on-hold state

trunk

String

CallLog

trunk that is used in this call

phoneLine

Phone Line

the phone line that is matched with this communication

wrapUpTime

Integer

CallLog

wrap up time in seconds

userProfile

User Profile

the user profile who took the communication

chatSessionType

Chat Session Type

if communication is a chat, the chat session type is given

whatsAppTemplateCategory

String

if WhatsApp template is sended, the category is filled here

original

Communication

the original communication object, this value is filled in when the communication is a reply of another communication

originalFromName

String

The name of the from addressable of the original communication

originalFromAddressable

Addressable

The addressable of the from addressable of the original communication

deliveredToReceiver

datetime

The date time when the communication is delivered to the receiver. This can be used to check if outgoing chats are delivered.

readByReceiver

datetime

The date time when the communication is read by the receiver. This can be used to check if outgoing chats are read.

transferredFrom

Communication

Communication (CallLog) object where the call is transferred from
The transferred from line information is also included here

transferredFromName

String

The name of the caller where the call is transferred from

transferredFromAddressable

Addressable

The addressable of the caller where the call is transferred from

transferredFromReason

Transfer Reason

Reason why call is transferred

transferredTo

Communication

Communication (CallLog) object where the call is transferred to
The transferred to line information is also included here

transferredToName

String

The name of the caller where the call is transferred to

transferredToAddressable

Addressable

The addressable of the caller where the call is transferred to

transferredToReason

Transfer Reason

Reason why call is transferred

chatSession

Chat Session

The chat session associated with this communication object

afterCallType

String

The after call type of the call

packetsLogs

[Packets Log]

Call’s RTP statistics, such as packets count and jitter.

callbackPhoneNumber

String

The phone number the caller has asked to be called on, when the caller was waiting in a call queue.

transcription

Transcription

Transcription

userReportedBadAudio

Boolean

The user marked the audio quality as 'bad'.

userReportedOnewayAudio

Boolean

The user has reported one-way audio.

userReportedUnstableConnection

Boolean

The user has reported an unstable connection.

userAudioQualityRating

Integer

User’s rating of the audio quality from 1 to 5.

userAudioQualityReview

String

User’s general comments on audio quality

logAttachments

[Attachment]

Logs of the call. For example: the call logging from the business rule server log or the app logging. These logs are not shared with other communication-objects of the same call.