Package com.mypurecloud.sdk.v2.model
Class AnalyticsSession
java.lang.Object
com.mypurecloud.sdk.v2.model.AnalyticsSession
- All Implemented Interfaces:
Serializable
AnalyticsSession
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic enumThe email or SMS delivery statusstatic enumThe direction of the communicationstatic enumOpen Messaging engagement source typestatic enumThe session media typestatic enumGets or Sets requestedRoutingsstatic enumRouting rule typestatic enumComplete routing method -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionactiveSkillIds(List<String> activeSkillIds) ID(s) of Skill(s) that are active on the conversationacwSkipped(Boolean acwSkipped) Marker for an agent that skipped after call workaddressFrom(String addressFrom) The address that initiated an actionaddressOther(String addressOther) The email address for the participant on the other side of the email conversationaddressSelf(String addressSelf) The email address for the participant on this side of the email conversationThe address receiving an actionagentAssistantId(String agentAssistantId) Unique identifier of the active virtual agent assistantagentBullseyeRing(Integer agentBullseyeRing) Bullseye ring of the targeted agentagentGroups(List<AnalyticsAgentGroup> agentGroups) Conditional group routing agent groupsagentOwned(Boolean agentOwned) Flag indicating an agent-owned callbackAutomatic Number Identification (caller's number)assignerId(String assignerId) ID of the user that manually assigned a conversationauthenticated(Boolean authenticated) Flag that indicates that the identity of the customer has been asserted as verified by the provider.bargedParticipantId(String bargedParticipantId) The participantId being barged in on (if someone (e.g. an agent) is being barged in on, this would correspond to one of the other participantIds present in the conversation)Blind carbon copy email address(es)callbackNumbers(List<String> callbackNumbers) Callback phone number(s)callbackScheduledTime(Date callbackScheduledTime) Scheduled callback date/time.callbackUserName(String callbackUserName) The name of the user requesting a call backCarbon copy email address(es)Flag that indicates that the conversation has been cleared by the customercoachedParticipantId(String coachedParticipantId) The participantId being coached (if someone (e.g. an agent) is being coached, this would correspond to one of the other participantIds present in the conversation)cobrowseRole(String cobrowseRole) Describes side of the cobrowse (sharer or viewer)cobrowseRoomId(String cobrowseRoomId) A unique identifier for a Genesys Cloud cobrowse roomdeliveryPushed(Boolean deliveryPushed) Flag that indicates that the push delivery mechanism was useddeliveryStatus(AnalyticsSession.DeliveryStatusEnum deliveryStatus) The email or SMS delivery statusdeliveryStatusChangeDate(Date deliveryStatusChangeDate) Date and time of the most recent delivery status change.destinationAddresses(List<String> destinationAddresses) Destination address(es) of transfers or consultsdetectedSpeechEnd(Date detectedSpeechEnd) Absolute time when the speech ended.detectedSpeechStart(Date detectedSpeechStart) Absolute time when the speech started.direction(AnalyticsSession.DirectionEnum direction) The direction of the communicationdispositionAnalyzer(String dispositionAnalyzer) (Dialer) Analyzer (for example speech.person)dispositionName(String dispositionName) (Dialer) Result of the analysis (for example disposition.classification.callable.machine)Dialed number identification service (number dialed by the calling party)Unique identifier of the edge deviceeligibleAgentCounts(List<Integer> eligibleAgentCounts) Number of eligible agents for each predictive routing attemptengagementSource(AnalyticsSession.EngagementSourceEnum engagementSource) Open Messaging engagement source typebooleanextendedDeliveryStatus(String extendedDeliveryStatus) Extended delivery statusflow(AnalyticsFlow flow) IVR flow execution associated with this sessionflowInType(String flowInType) Type of flow in that occurred when entering ACD.flowOutType(String flowOutType) Type of flow out that occurred when emitting tFlowOut.getAni()getBcc()getCc()getDnis()getFlow()inthashCode()journeyActionId(String journeyActionId) Identifier of the journey action.journeyActionMapId(String journeyActionMapId) Identifier of the journey action map that triggered the action.journeyActionMapVersion(Integer journeyActionMapVersion) Version of the journey action map that triggered the action.journeyCustomerId(String journeyCustomerId) Primary identifier of the journey customer in the source where the activities originate from.journeyCustomerIdType(String journeyCustomerIdType) Type of primary identifier of the journey customer (e.g. cookie).journeyCustomerSessionId(String journeyCustomerSessionId) Unique identifier of the journey session.journeyCustomerSessionIdType(String journeyCustomerSessionIdType) Type or category of journey sessions (e.g. web, ticket, delivery, atm).mediaBridgeId(String mediaBridgeId) Media bridge ID for the conference session consistent across all participantsmediaCount(Integer mediaCount) Count of any media (images, files, etc) included in this sessionmediaEndpointStats(List<AnalyticsMediaEndpointStat> mediaEndpointStats) MediaEndpointStats associated with this sessionmediaType(AnalyticsSession.MediaTypeEnum mediaType) The session media typemessageType(String messageType) Message type for messaging services.metrics(List<AnalyticsSessionMetric> metrics) List of metrics for this sessionmonitoredParticipantId(String monitoredParticipantId) The participantId being monitored (if someone (e.g. an agent) is being monitored, this would correspond to one of the other participantIds present in the conversation)outboundCampaignId(String outboundCampaignId) (Dialer) Unique identifier of the outbound campaignoutboundContactId(String outboundContactId) (Dialer) Unique identifier of the contactoutboundContactListId(String outboundContactListId) (Dialer) Unique identifier of the contact list that this contact belongs toThis identifies pairs of related sessions on a conversation.proposedAgents(List<AnalyticsProposedAgent> proposedAgents) Proposed agentsprotocolCallId(String protocolCallId) The original voice protocol call ID, e.g. a SIP call IDThe source provider for the communication.Flag determining if an audio recording was started or notName, phone number, or email address of the remote party.remoteNameDisplayable(String remoteNameDisplayable) Unique identifier for the remote partyremovedSkillIds(List<String> removedSkillIds) ID(s) of Skill(s) that have been removed by bullseye routingrequestedRoutings(List<AnalyticsSession.RequestedRoutingsEnum> requestedRoutings) Routing type(s) for requested/attempted routing methods.Unique identifier for the roomroutingRing(Integer routingRing) Routing ring for bullseye or preferred agent routingroutingRule(String routingRule) Routing rule for preferred, conditional and predictive routing typeroutingRuleType(AnalyticsSession.RoutingRuleTypeEnum routingRuleType) Routing rule typescreenMonitoredUserId(String screenMonitoredUserId) The user ID for the participant who is being screen monitored.screenShareAddressSelf(String screenShareAddressSelf) Direct screen share addressscreenShareRoomId(String screenShareRoomId) A unique identifier for a Genesys Cloud screen share roomA unique identifier for a scriptsegments(List<AnalyticsConversationSegment> segments) List of segments for this sessionselectedAgentId(String selectedAgentId) Selected agent IDselectedAgentRank(Integer selectedAgentRank) Selected agent GPR ranksessionDnis(String sessionDnis) Dialed number for the current session; this can be different from dnis, e.g. if the call was transferredThe unique identifier of this sessionvoidsetActiveSkillIds(List<String> activeSkillIds) voidsetAcwSkipped(Boolean acwSkipped) voidsetAddressFrom(String addressFrom) voidsetAddressOther(String addressOther) voidsetAddressSelf(String addressSelf) voidsetAddressTo(String addressTo) voidsetAgentAssistantId(String agentAssistantId) voidsetAgentBullseyeRing(Integer agentBullseyeRing) voidsetAgentGroups(List<AnalyticsAgentGroup> agentGroups) voidsetAgentOwned(Boolean agentOwned) voidvoidsetAssignerId(String assignerId) voidsetAuthenticated(Boolean authenticated) voidsetBargedParticipantId(String bargedParticipantId) voidvoidsetCallbackNumbers(List<String> callbackNumbers) voidsetCallbackScheduledTime(Date callbackScheduledTime) voidsetCallbackUserName(String callbackUserName) voidvoidsetCleared(Boolean cleared) voidsetCoachedParticipantId(String coachedParticipantId) voidsetCobrowseRole(String cobrowseRole) voidsetCobrowseRoomId(String cobrowseRoomId) voidsetDeliveryPushed(Boolean deliveryPushed) voidsetDeliveryStatus(AnalyticsSession.DeliveryStatusEnum deliveryStatus) voidsetDeliveryStatusChangeDate(Date deliveryStatusChangeDate) voidsetDestinationAddresses(List<String> destinationAddresses) voidsetDetectedSpeechEnd(Date detectedSpeechEnd) voidsetDetectedSpeechStart(Date detectedSpeechStart) voidsetDirection(AnalyticsSession.DirectionEnum direction) voidsetDispositionAnalyzer(String dispositionAnalyzer) voidsetDispositionName(String dispositionName) voidvoidvoidsetEligibleAgentCounts(List<Integer> eligibleAgentCounts) voidsetEngagementSource(AnalyticsSession.EngagementSourceEnum engagementSource) voidsetExtendedDeliveryStatus(String extendedDeliveryStatus) voidsetFlow(AnalyticsFlow flow) voidsetFlowInType(String flowInType) voidsetFlowOutType(String flowOutType) voidsetJourneyActionId(String journeyActionId) voidsetJourneyActionMapId(String journeyActionMapId) voidsetJourneyActionMapVersion(Integer journeyActionMapVersion) voidsetJourneyCustomerId(String journeyCustomerId) voidsetJourneyCustomerIdType(String journeyCustomerIdType) voidsetJourneyCustomerSessionId(String journeyCustomerSessionId) voidsetJourneyCustomerSessionIdType(String journeyCustomerSessionIdType) voidsetMediaBridgeId(String mediaBridgeId) voidsetMediaCount(Integer mediaCount) voidsetMediaEndpointStats(List<AnalyticsMediaEndpointStat> mediaEndpointStats) voidsetMediaType(AnalyticsSession.MediaTypeEnum mediaType) voidsetMessageType(String messageType) voidsetMetrics(List<AnalyticsSessionMetric> metrics) voidsetMonitoredParticipantId(String monitoredParticipantId) voidsetOutboundCampaignId(String outboundCampaignId) voidsetOutboundContactId(String outboundContactId) voidsetOutboundContactListId(String outboundContactListId) voidvoidsetProposedAgents(List<AnalyticsProposedAgent> proposedAgents) voidsetProtocolCallId(String protocolCallId) voidsetProvider(String provider) voidsetRecording(Boolean recording) voidvoidsetRemoteNameDisplayable(String remoteNameDisplayable) voidsetRemovedSkillIds(List<String> removedSkillIds) voidsetRequestedRoutings(List<AnalyticsSession.RequestedRoutingsEnum> requestedRoutings) voidvoidsetRoutingRing(Integer routingRing) voidsetRoutingRule(String routingRule) voidsetRoutingRuleType(AnalyticsSession.RoutingRuleTypeEnum routingRuleType) voidsetScreenMonitoredUserId(String screenMonitoredUserId) voidsetScreenShareAddressSelf(String screenShareAddressSelf) voidsetScreenShareRoomId(String screenShareRoomId) voidsetScriptId(String scriptId) voidsetSegments(List<AnalyticsConversationSegment> segments) voidsetSelectedAgentId(String selectedAgentId) voidsetSelectedAgentRank(Integer selectedAgentRank) voidsetSessionDnis(String sessionDnis) voidsetSessionId(String sessionId) voidsetSharingScreen(Boolean sharingScreen) voidsetSkillExpressionId(String skillExpressionId) voidsetSkipEnabled(Boolean skipEnabled) voidsetSnippetRecording(Boolean snippetRecording) voidsetTimeoutSeconds(Integer timeoutSeconds) voidsetUsedRouting(AnalyticsSession.UsedRoutingEnum usedRouting) voidsetVideoAddressSelf(String videoAddressSelf) voidsetVideoRoomId(String videoRoomId) voidsetWaitingInteractionCounts(List<Integer> waitingInteractionCounts) sharingScreen(Boolean sharingScreen) Flag determining if screen share is started or not (true/false)skillExpressionId(String skillExpressionId) Unique identifier for the skill requested for an interactionskipEnabled(Boolean skipEnabled) (Dialer) Whether the agent can skip the dialer contactsnippetRecording(Boolean snippetRecording) Whether or not the conversation included a snippet being recorded.timeoutSeconds(Integer timeoutSeconds) The number of seconds before Genesys Cloud begins the call for a call back (0 disables automatic calling)toString()usedRouting(AnalyticsSession.UsedRoutingEnum usedRouting) Complete routing methodvideoAddressSelf(String videoAddressSelf) Direct Video addressvideoRoomId(String videoRoomId) A unique identifier for a Genesys Cloud video roomwaitingInteractionCounts(List<Integer> waitingInteractionCounts) Number of waiting interactions for each predictive routing attempt
-
Constructor Details
-
AnalyticsSession
public AnalyticsSession() -
AnalyticsSession
-
-
Method Details
-
activeSkillIds
ID(s) of Skill(s) that are active on the conversation -
getActiveSkillIds
-
setActiveSkillIds
-
acwSkipped
Marker for an agent that skipped after call work -
getAcwSkipped
-
setAcwSkipped
-
addressFrom
The address that initiated an action -
getAddressFrom
-
setAddressFrom
-
addressOther
The email address for the participant on the other side of the email conversation -
getAddressOther
-
setAddressOther
-
addressSelf
The email address for the participant on this side of the email conversation -
getAddressSelf
-
setAddressSelf
-
addressTo
The address receiving an action -
getAddressTo
-
setAddressTo
-
agentAssistantId
Unique identifier of the active virtual agent assistant -
getAgentAssistantId
-
setAgentAssistantId
-
agentBullseyeRing
Bullseye ring of the targeted agent -
getAgentBullseyeRing
-
setAgentBullseyeRing
-
agentOwned
Flag indicating an agent-owned callback -
getAgentOwned
-
setAgentOwned
-
ani
Automatic Number Identification (caller's number) -
getAni
-
setAni
-
assignerId
ID of the user that manually assigned a conversation -
getAssignerId
-
setAssignerId
-
authenticated
Flag that indicates that the identity of the customer has been asserted as verified by the provider. -
getAuthenticated
-
setAuthenticated
-
bargedParticipantId
The participantId being barged in on (if someone (e.g. an agent) is being barged in on, this would correspond to one of the other participantIds present in the conversation) -
getBargedParticipantId
-
setBargedParticipantId
-
bcc
Blind carbon copy email address(es) -
getBcc
-
setBcc
-
callbackNumbers
Callback phone number(s) -
getCallbackNumbers
-
setCallbackNumbers
-
callbackScheduledTime
Scheduled callback date/time. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z -
getCallbackScheduledTime
-
setCallbackScheduledTime
-
callbackUserName
The name of the user requesting a call back -
getCallbackUserName
-
setCallbackUserName
-
cc
Carbon copy email address(es) -
getCc
-
setCc
-
cleared
Flag that indicates that the conversation has been cleared by the customer -
getCleared
-
setCleared
-
coachedParticipantId
The participantId being coached (if someone (e.g. an agent) is being coached, this would correspond to one of the other participantIds present in the conversation) -
getCoachedParticipantId
-
setCoachedParticipantId
-
cobrowseRole
Describes side of the cobrowse (sharer or viewer) -
getCobrowseRole
-
setCobrowseRole
-
cobrowseRoomId
A unique identifier for a Genesys Cloud cobrowse room -
getCobrowseRoomId
-
setCobrowseRoomId
-
deliveryPushed
Flag that indicates that the push delivery mechanism was used -
getDeliveryPushed
-
setDeliveryPushed
-
deliveryStatus
The email or SMS delivery status -
getDeliveryStatus
-
setDeliveryStatus
-
deliveryStatusChangeDate
Date and time of the most recent delivery status change. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z -
getDeliveryStatusChangeDate
-
setDeliveryStatusChangeDate
-
destinationAddresses
Destination address(es) of transfers or consults -
getDestinationAddresses
-
setDestinationAddresses
-
detectedSpeechEnd
Absolute time when the speech ended. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z -
getDetectedSpeechEnd
-
setDetectedSpeechEnd
-
detectedSpeechStart
Absolute time when the speech started. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z -
getDetectedSpeechStart
-
setDetectedSpeechStart
-
direction
The direction of the communication -
getDirection
-
setDirection
-
dispositionAnalyzer
(Dialer) Analyzer (for example speech.person) -
getDispositionAnalyzer
-
setDispositionAnalyzer
-
dispositionName
(Dialer) Result of the analysis (for example disposition.classification.callable.machine) -
getDispositionName
-
setDispositionName
-
dnis
Dialed number identification service (number dialed by the calling party) -
getDnis
-
setDnis
-
edgeId
Unique identifier of the edge device -
getEdgeId
-
setEdgeId
-
eligibleAgentCounts
Number of eligible agents for each predictive routing attempt -
getEligibleAgentCounts
-
setEligibleAgentCounts
-
engagementSource
Open Messaging engagement source type -
getEngagementSource
-
setEngagementSource
-
extendedDeliveryStatus
Extended delivery status -
getExtendedDeliveryStatus
-
setExtendedDeliveryStatus
-
flowInType
Type of flow in that occurred when entering ACD. -
getFlowInType
-
setFlowInType
-
flowOutType
Type of flow out that occurred when emitting tFlowOut. -
getFlowOutType
-
setFlowOutType
-
journeyActionId
Identifier of the journey action. -
getJourneyActionId
-
setJourneyActionId
-
journeyActionMapId
Identifier of the journey action map that triggered the action. -
getJourneyActionMapId
-
setJourneyActionMapId
-
journeyActionMapVersion
Version of the journey action map that triggered the action. -
getJourneyActionMapVersion
-
setJourneyActionMapVersion
-
journeyCustomerId
Primary identifier of the journey customer in the source where the activities originate from. -
getJourneyCustomerId
-
setJourneyCustomerId
-
journeyCustomerIdType
Type of primary identifier of the journey customer (e.g. cookie). -
getJourneyCustomerIdType
-
setJourneyCustomerIdType
-
journeyCustomerSessionId
Unique identifier of the journey session. -
getJourneyCustomerSessionId
-
setJourneyCustomerSessionId
-
journeyCustomerSessionIdType
Type or category of journey sessions (e.g. web, ticket, delivery, atm). -
getJourneyCustomerSessionIdType
-
setJourneyCustomerSessionIdType
-
mediaBridgeId
Media bridge ID for the conference session consistent across all participants -
getMediaBridgeId
-
setMediaBridgeId
-
mediaCount
Count of any media (images, files, etc) included in this session -
getMediaCount
-
setMediaCount
-
mediaType
The session media type -
getMediaType
-
setMediaType
-
messageType
Message type for messaging services. E.g.: sms, facebook, twitter, line -
getMessageType
-
setMessageType
-
monitoredParticipantId
The participantId being monitored (if someone (e.g. an agent) is being monitored, this would correspond to one of the other participantIds present in the conversation) -
getMonitoredParticipantId
-
setMonitoredParticipantId
-
outboundCampaignId
(Dialer) Unique identifier of the outbound campaign -
getOutboundCampaignId
-
setOutboundCampaignId
-
outboundContactId
(Dialer) Unique identifier of the contact -
getOutboundContactId
-
setOutboundContactId
-
outboundContactListId
(Dialer) Unique identifier of the contact list that this contact belongs to -
getOutboundContactListId
-
setOutboundContactListId
-
peerId
This identifies pairs of related sessions on a conversation. E.g. an external session’s peerId will be the session that the call originally connected to, e.g. if an IVR was dialed, the IVR session, which will also have the external session’s ID as its peer. After that point, any transfers of that session to other internal components (acd, agent, etc.) will all spawn new sessions whose peerIds point back to that original external session. -
getPeerId
-
setPeerId
-
protocolCallId
The original voice protocol call ID, e.g. a SIP call ID -
getProtocolCallId
-
setProtocolCallId
-
provider
The source provider for the communication. -
getProvider
-
setProvider
-
recording
Flag determining if an audio recording was started or not -
getRecording
-
setRecording
-
remote
Name, phone number, or email address of the remote party. -
getRemote
-
setRemote
-
remoteNameDisplayable
Unique identifier for the remote party -
getRemoteNameDisplayable
-
setRemoteNameDisplayable
-
removedSkillIds
ID(s) of Skill(s) that have been removed by bullseye routing -
getRemovedSkillIds
-
setRemovedSkillIds
-
requestedRoutings
public AnalyticsSession requestedRoutings(List<AnalyticsSession.RequestedRoutingsEnum> requestedRoutings) Routing type(s) for requested/attempted routing methods. -
getRequestedRoutings
-
setRequestedRoutings
-
roomId
Unique identifier for the room -
getRoomId
-
setRoomId
-
routingRing
Routing ring for bullseye or preferred agent routing -
getRoutingRing
-
setRoutingRing
-
routingRule
Routing rule for preferred, conditional and predictive routing type -
getRoutingRule
-
setRoutingRule
-
routingRuleType
Routing rule type -
getRoutingRuleType
-
setRoutingRuleType
-
screenMonitoredUserId
The user ID for the participant who is being screen monitored. -
getScreenMonitoredUserId
-
setScreenMonitoredUserId
-
scriptId
A unique identifier for a script -
getScriptId
-
setScriptId
-
selectedAgentId
Selected agent ID -
getSelectedAgentId
-
setSelectedAgentId
-
selectedAgentRank
Selected agent GPR rank -
getSelectedAgentRank
-
setSelectedAgentRank
-
sessionDnis
Dialed number for the current session; this can be different from dnis, e.g. if the call was transferred -
getSessionDnis
-
setSessionDnis
-
sessionId
The unique identifier of this session -
getSessionId
-
setSessionId
-
sharingScreen
Flag determining if screen share is started or not (true/false) -
getSharingScreen
-
setSharingScreen
-
skillExpressionId
Unique identifier for the skill requested for an interaction -
getSkillExpressionId
-
setSkillExpressionId
-
skipEnabled
(Dialer) Whether the agent can skip the dialer contact -
getSkipEnabled
-
setSkipEnabled
-
snippetRecording
Whether or not the conversation included a snippet being recorded. -
getSnippetRecording
-
setSnippetRecording
-
timeoutSeconds
The number of seconds before Genesys Cloud begins the call for a call back (0 disables automatic calling) -
getTimeoutSeconds
-
setTimeoutSeconds
-
usedRouting
Complete routing method -
getUsedRouting
-
setUsedRouting
-
videoAddressSelf
Direct Video address -
getVideoAddressSelf
-
setVideoAddressSelf
-
videoRoomId
A unique identifier for a Genesys Cloud video room -
getVideoRoomId
-
setVideoRoomId
-
waitingInteractionCounts
Number of waiting interactions for each predictive routing attempt -
getWaitingInteractionCounts
-
setWaitingInteractionCounts
-
agentGroups
Conditional group routing agent groups -
getAgentGroups
-
setAgentGroups
-
proposedAgents
Proposed agents -
getProposedAgents
-
setProposedAgents
-
mediaEndpointStats
MediaEndpointStats associated with this session -
getMediaEndpointStats
-
setMediaEndpointStats
-
flow
IVR flow execution associated with this session -
getFlow
-
setFlow
-
metrics
List of metrics for this session -
getMetrics
-
setMetrics
-
segments
List of segments for this session -
getSegments
-
setSegments
-
equals
-
hashCode
public int hashCode() -
toString
-