A session is a building block of a conversation.

Example Usage

import { Session } from "syllable-sdk/models/components";

let value: Session = {
  timestamp: new Date("2024-11-04T12:32:11.817Z"),
  channelManagerService: "hedy",
  channelManagerType: "web_chat_v1",
  source: "user@email.com",
};

Fields

FieldTypeRequiredDescriptionExample
timestampDateTRUETimestamp of the session
sessionIdstringFALSEInternal ID of the session, generated based on interaction details
conversationIdstringFALSEID of the conversation of which the session is a part
channelManagerServicestringFALSEName of the service used to facilitate the sessionhedy
channelManagerTypestringFALSEType of the service used to facilitate the sessionvoice_sip_v1
channelManagerSidstringFALSEChannel-manager-side ID of the session (different from session_id)
agentIdstringFALSEID of the agent with which the session occurred
agentNamestringFALSEName of the agent with which the session occurred
agentTypestringFALSEType of the agent with which the session occurred
agentTimezonestringFALSETimezone of the agent with which the session occurred
promptIdstringFALSEID of the prompt used by the agent with which the session occurred
promptNamestringFALSEName of the prompt used by the agent with which the session occurred
promptVersionstringFALSEVersion of the prompt used by the agent with which the session occurred
durationnumberFALSEDuration of the session in seconds
sessionLabelIdstringFALSEID of the label (listing the quality of the session and any issues that occurred) associated with the session
sourcestringFALSESource of the session (e.g., for an inbound session, the user’s phone number/username/email)+18042221111
targetstringFALSEThe name of the channel target associated with the agent at the time of the session (see ChannelTargetResponse.target)
isLegacybooleanFALSEWhether the session occurred on the legacy Syllable system
isTestbooleanFALSEWhether the session is a test session