Breadcrumbs

channelSession



Object Name

channelSession

Description

This object contains properties related to the session that has been established through a particular channel e.g. web, voice etc. Each customer conversing with an agent/bot will have their own channel session.



Parameter

Type

Description

Id  Required

String

Unique Id of the ChannelSession

participantType Required

String

Type of participant in the channel session. See

ParticipantType

for details.

channel Required

Channel

Specifies the channel for the particular session. See

Channel

for details.

customer optional

Customer

See customer for details.

customerSuggestions optional

List

Provides list of customer suggestions

channelData Required

ChannelData

Specifies the data for the channel. This data is unique to each channel. See

channelData

for details.

latestIntent optional

String

Intents are system events to inform the conversational bot to take action on the intent. The channelSession object will contain the latest intent for the session e.g. CHANNEL_SESSION_STARTED.

customerPresence undefined

Object


isActive optional

Bool

If the channelSession is still active, isActive will be TRUE else FALSE.

conversationId optional

UUID

This is the ID of the conversation to which this channel session belongs. 

state Required

ChannelSessionState

See

channelSessionState

for details.