Difference between revisions of "WID/Current/Developer/GWCCookies"

From Genesys Documentation
Jump to: navigation, search
(Published)
(Published)
Line 2: Line 2:
 
|Standalone=No
 
|Standalone=No
 
|DisplayName=Cookies
 
|DisplayName=Cookies
−
|Platform=PureEngage
 
 
|TocName=Cookies
 
|TocName=Cookies
 +
|Context=Genesys Widgets uses the following cookies to restore chat sessions, track the state of the UI, store a customer's decisions, and more. The customer's browser must enable cookies, or Genesys Widgets will not work properly.
 
|ComingSoon=No
 
|ComingSoon=No
−
|Context=Genesys Widgets uses the following cookies to restore chat sessions, track the state of the UI, store a customer's decisions, and more. The customer's browser must enable cookies, or Genesys Widgets will not work properly.
+
|Platform=PureEngage
 
|Section={{Section
 
|Section={{Section
−
|Standalone=No
+
|sectionHeading=App
−
|ComingSoon=No
 
 
|alignment=Vertical
 
|alignment=Vertical
 
|structuredtext=<br />
 
|structuredtext=<br />
 
{{{!}} class="wikitable"
 
{{{!}} class="wikitable"
−
{{!}}+
 
−
==App==
 
 
!Cookie Name
 
!Cookie Name
 
!Purpose
 
!Purpose
 
{{!}}-
 
{{!}}-
 
{{!}}_genesys.widgets.app.autoLoadList
 
{{!}}_genesys.widgets.app.autoLoadList
−
{{!}}Contains a list of active plugin names that are updated based on the usage of Widgets during the {{Link-SomewhereInThisVersion|manual=Developer|topic=GWCDeployment#Deployment_methods|display text=Lazy loading}} deployment method. This is to ensure that a Widget is auto-loaded during a page refresh or page navigation when there is an active session associated with it.
+
{{!}}Contains a list of active plugin names that are updated based on the usage of widgets during the {{Link-SomewhereInThisVersion|manual=Developer|topic=GWCDeployment#Deploying_Genesys_Widgets_.28Lazy-Loading.29|display text=lazy loading}} deployment method. This is to ensure that a widget is auto-loaded during a page refresh or page navigation when there is an active session associated with it.
−
{{!}}-
 
−
{{!}}
 
−
{{!}}
 
 
{{!}}}
 
{{!}}}
 
|Status=No
 
|Status=No
 
}}{{Section
 
}}{{Section
−
|Standalone=No
+
|sectionHeading=Console
−
|ComingSoon=No
 
 
|alignment=Vertical
 
|alignment=Vertical
 
|structuredtext=<br />
 
|structuredtext=<br />
 
{{{!}} class="wikitable"
 
{{{!}} class="wikitable"
−
{{!}}+
 
−
==Console==
 
 
!Cookie Name
 
!Cookie Name
 
!Purpose
 
!Purpose
 
{{!}}-
 
{{!}}-
 
{{!}}_genesys.widgets.console.session
 
{{!}}_genesys.widgets.console.session
−
{{!}}A cookie containing the active Console plugin open/close state.
+
{{!}}Contains the active Console plugin open/close state.
 
{{!}}-
 
{{!}}-
 
{{!}}_genesys.widgets.console.commandPlugin
 
{{!}}_genesys.widgets.console.commandPlugin
−
{{!}}A cookie containing the selected plugin name from the Commands section.
+
{{!}}Contains the selected plugin name from the Commands section.
 
{{!}}-
 
{{!}}-
 
{{!}}_genesys.widgets.console.command
 
{{!}}_genesys.widgets.console.command
−
{{!}}A cookie containing the selected command to run from the Commands section.
+
{{!}}Contains the selected command to run from the Commands section.
 
{{!}}-
 
{{!}}-
 
{{!}}_genesys.widgets.console.eventPlugin
 
{{!}}_genesys.widgets.console.eventPlugin
−
{{!}}A cookie containing the selected plugin from the Events section to listen for any events.
+
{{!}}Contains the selected plugin from the Events section to listen for events.
 
{{!}}-
 
{{!}}-
 
{{!}}_genesys.widgets.console.event
 
{{!}}_genesys.widgets.console.event
−
{{!}}A cookie containing the selected event type to listen against, from the Events section.
+
{{!}}Contains the selected event type to listen against, from the Events section.
 
{{!}}-
 
{{!}}-
 
{{!}}_genesys.widgets.console.optionsArea
 
{{!}}_genesys.widgets.console.optionsArea
−
{{!}}A cookie containing the command options to send when executing a command.
+
{{!}}Contains the command options to send when executing a command.
 
{{!}}-
 
{{!}}-
 
{{!}}_genesys.widgets.console.activeSubscriptions
 
{{!}}_genesys.widgets.console.activeSubscriptions
−
{{!}}A cookie containing the list of all active event subscriptions listening via Console plugin.
+
{{!}}Contains the list of all active event subscriptions listening via the Console plugin.
 
{{!}}-
 
{{!}}-
 
{{!}}_genesys.widgets.console.windowPosition
 
{{!}}_genesys.widgets.console.windowPosition
−
{{!}}A cookie containing the position of the Console plugin on the screen.
+
{{!}}Contains the position of the Console plugin on the screen.
 
{{!}}}
 
{{!}}}
 
|Status=No
 
|Status=No
 
}}{{Section
 
}}{{Section
−
|Standalone=No
+
|sectionHeading=WebChat
−
|ComingSoon=No
 
 
|alignment=Vertical
 
|alignment=Vertical
 
|structuredtext=<br />
 
|structuredtext=<br />
 
{{{!}} class="wikitable"
 
{{{!}} class="wikitable"
−
{{!}}+
 
−
==WebChat==
 
 
!Cookie Name
 
!Cookie Name
 
!Purpose
 
!Purpose
 
{{!}}-
 
{{!}}-
 
{{!}}_genesys.widgets.webchat.state.open
 
{{!}}_genesys.widgets.webchat.state.open
−
{{!}}A cookie containing the WebChat Widget open or close state for internal tracking purposes.
+
{{!}}Contains the WebChat Widget open or close state for internal tracking purposes.
 
{{!}}-
 
{{!}}-
 
{{!}}_genesys.widgets.webchat.state.keys
 
{{!}}_genesys.widgets.webchat.state.keys
−
{{!}}A session cookie that can contain some encrypted keys related to the current active chat session.
+
{{!}}Can contain encrypted keys related to the current active chat session.
 
{{!}}-
 
{{!}}-
 
{{!}}_genesys.widgets.webchat.state.ping
 
{{!}}_genesys.widgets.webchat.state.ping
−
{{!}}A session cookie containing the time at which the last successful request was made to the server.
+
{{!}}Contains the time at which the last successful request was made to the server.
 
{{!}}-
 
{{!}}-
 
{{!}}_genesys.widgets.webchat.metaData
 
{{!}}_genesys.widgets.webchat.metaData
−
{{!}}A session cookie containing all the {{Link-SomewhereInThisVersion|manual=SDK|topic=WebChat-combined#Metadata|display text=Metadata}} details related to the current active chat session.
+
{{!}}Contains all the {{Link-SomewhereInThisVersion|manual=SDK|topic=WebChat-combined#Metadata|display text=Metadata}} details related to the current active chat session.
 
{{!}}-
 
{{!}}-
 
{{!}}_genesys.widgets.webchat.state.index
 
{{!}}_genesys.widgets.webchat.state.index
−
{{!}}A session cookie containing the last unique Message ID for internal tracking purposes.
+
{{!}}Contains the last unique Message ID for internal tracking purposes.
 
{{!}}-
 
{{!}}-
 
{{!}}_genesys.widgets.webchat.state.filters
 
{{!}}_genesys.widgets.webchat.state.filters
−
{{!}}A session cookie containing any pre-filters that were added using WebChatService plugin commands {{Link-SomewhereInThisVersion|manual=SDK|topic=WebChatService-combined#addPrefilter|display text=addPrefilter}} or {{Link-SomewhereInThisVersion|manual=SDK|topic=WebChatService-combined#sendFilteredMessage|display text=sendFilteredMessage}}.
+
{{!}}Contains any prefilters that were added using WebChatService plugin commands {{Link-SomewhereInThisVersion|manual=SDK|topic=WebChatService-combined#addPrefilter|display text=addPrefilter}} or {{Link-SomewhereInThisVersion|manual=SDK|topic=WebChatService-combined#sendFilteredMessage|display text=sendFilteredMessage}}.
 
{{!}}-
 
{{!}}-
 
{{!}}_genesys.widgets.webchat.state.session
 
{{!}}_genesys.widgets.webchat.state.session
−
{{!}}A session cookie containing the unique Session ID related to the current active chat session. It is used to restore the active chat session during scenarios like page refresh or page navigation.
+
{{!}}Contains the unique Session ID related to the current active chat session. It is used to restore the active chat session during scenarios like page refresh or page navigation.
 
{{!}}-
 
{{!}}-
 
{{!}}_genesys.widgets.webchat.state.minimized
 
{{!}}_genesys.widgets.webchat.state.minimized
−
{{!}}A cookie containing the WebChat Widget minimized or maximized state for internal tracking purposes.
+
{{!}}Contains the WebChat Widget minimized or maximized state for internal tracking purposes.
 
{{!}}-
 
{{!}}-
 
{{!}}_genesys.widgets.webchat.autoInvite.disabled
 
{{!}}_genesys.widgets.webchat.autoInvite.disabled
−
{{!}}Contains a value whether to disable or enable the WebChat autoInvite feature. It is dynamically updated based on the user's response to the initial WebChat invite.
+
{{!}}Contains a value that disables or enables the WebChat autoInvite feature. It is dynamically updated based on the user's response to the initial WebChat invite.
 
{{!}}-
 
{{!}}-
 
{{!}}_genesys.widgets.webchat.state.unreadMessages
 
{{!}}_genesys.widgets.webchat.state.unreadMessages
−
{{!}}A session cookie that keeps track of the number of unread messages during an active chat session, when WebChat is minimized. It is cleared whenever the WebChat Widget is maximized by the user to read the new messages.
+
{{!}}Tracks the number of unread messages during an active chat session, when WebChat is minimized. It is cleared whenever the WebChat Widget is maximized by the user to read the new messages.
 
{{!}}-
 
{{!}}-
 
{{!}}_genesys.widgets.webchat.state.lastMessageCountRead
 
{{!}}_genesys.widgets.webchat.state.lastMessageCountRead
−
{{!}}A session cookie containing the number of messages that are read during an active chat session that calculates the number of unread messages when WebChat is minimized. It is automatically cleared whenever the WebChat Widget is maximized or closed/ended.
+
{{!}}Contains the number of messages that are read during an active chat session that calculates the number of unread messages when WebChat is minimized. It is automatically cleared whenever the WebChat Widget is maximized or closed/ended.
 
{{!}}-
 
{{!}}-
 
{{!}}_genesys.widgets.webchat.state.asyncUnreadMessageCount
 
{{!}}_genesys.widgets.webchat.state.asyncUnreadMessageCount
−
{{!}}A session cookie that keeps track of the number of unread messages related to an Async Chat, when WebChat is minimized. It is cleared whenever the WebChat Widget is maximized by the user to read the new messages.
+
{{!}}Keeps track of the number of unread messages related to an Async Chat, when WebChat is minimized. It is cleared whenever the WebChat Widget is maximized by the user to read the new messages.
 
{{!}}-
 
{{!}}-
 
{{!}}_genesys.widgets.webchat.state.pureengage-v3-rest.session
 
{{!}}_genesys.widgets.webchat.state.pureengage-v3-rest.session
−
{{!}}A session cookie applicable only when using PureEngage V3 API. It contains the Session ID related to the current active chat session. It is used to restore the active chat session during scenarios like page refresh or page navigation.
+
{{!}}Used only with PureEngage V3 API. It contains the Session ID related to the current active chat session. It is used to restore the active chat session during scenarios like page refresh or page navigation.
 
{{!}}-
 
{{!}}-
 
{{!}}_genesys.widgets.webchat.state.pureengage-v3-rest.keys
 
{{!}}_genesys.widgets.webchat.state.pureengage-v3-rest.keys
−
{{!}}A session cookie applicable only when using PureEngage V3 API, containing the encrypted keys related to the current active chat session.
+
{{!}}Used only with PureEngage V3 API, containing the encrypted keys related to the current active chat session.
 
{{!}}-
 
{{!}}-
 
{{!}}_genesys.widgets.webchat.state.pureengage-v3-rest.index
 
{{!}}_genesys.widgets.webchat.state.pureengage-v3-rest.index
−
{{!}}A session cookie applicable only when using PureEngage V3 API, containing the last unique message ID for internal tracking purposes.
+
{{!}}Used only with PureEngage V3 API, containing the last unique message ID for internal tracking purposes.
 
{{!}}-
 
{{!}}-
 
{{!}}_genesys.widgets.webchat.state.pureengage-v3-rest.open
 
{{!}}_genesys.widgets.webchat.state.pureengage-v3-rest.open
−
{{!}}A cookie applicable only when using PureEngage V3 API, containing the WebChat Widget open or close state for internal tracking purposes.
+
{{!}}Used only with PureEngage V3 API, containing the WebChat Widget open or close state for internal tracking purposes.
 
{{!}}-
 
{{!}}-
 
{{!}}_genesys.widgets.webchat.state.purecloud-v2-sockets.JWtoken
 
{{!}}_genesys.widgets.webchat.state.purecloud-v2-sockets.JWtoken
−
{{!}}A session cookie applicable only when using PureCloud V2 API, containing the JWT token related to the current active chat session.
+
{{!}}Used only with PureCloud V2 API, containing the JWT token related to the current active chat session.
 
{{!}}-
 
{{!}}-
 
{{!}}_genesys.widgets.webchat.state.purecloud-v2-sockets.ConversationID
 
{{!}}_genesys.widgets.webchat.state.purecloud-v2-sockets.ConversationID
−
{{!}}A session cookie applicable only when using PureCloud V2 API, containing the active conversation ID related to the current chat session.
+
{{!}}Used only with PureCloud V2 API, containing the active conversation ID related to the current chat session.
 
{{!}}-
 
{{!}}-
 
{{!}}_genesys.widgets.webchat.state.purecloud-v2-sockets.MemberID
 
{{!}}_genesys.widgets.webchat.state.purecloud-v2-sockets.MemberID
−
{{!}}A session cookie applicable only when using PureCloud V2 API, containing the user ID of the WebChat Widget related to the current active chat session.
+
{{!}}Used only with PureCloud V2 API, containing the user ID of the WebChat Widget related to the current active chat session.
 
{{!}}-
 
{{!}}-
 
{{!}}_genesys.widgets.webchat.state.purecloud-v2-sockets.WS_URL
 
{{!}}_genesys.widgets.webchat.state.purecloud-v2-sockets.WS_URL
−
{{!}}A session cookie applicable only when using PureCloud V2 API, containing the WebSocket event stream URI for listening to new incoming messages.
+
{{!}}Used only with PureCloud V2 API, containing the WebSocket event stream URI for listening to new incoming messages.
 
{{!}}-
 
{{!}}-
 
{{!}}_genesys.widgets.webchat.state.purecloud-v2-sockets.LastMsgId
 
{{!}}_genesys.widgets.webchat.state.purecloud-v2-sockets.LastMsgId
−
{{!}}A session cookie applicable only when using PureCloud V2 API, containing the last unique ID of the message sent in the WebChat Widget.
+
{{!}}Used only with PureCloud V2 API, containing the last unique ID of the message sent in the WebChat Widget.
 
{{!}}}
 
{{!}}}
 
|Status=No
 
|Status=No
 
}}
 
}}
 
}}
 
}}

Revision as of 19:55, February 26, 2020

This topic is part of the manual Widgets Developer's Guide for version Current of Widgets.

Genesys Widgets uses the following cookies to restore chat sessions, track the state of the UI, store a customer's decisions, and more. The customer's browser must enable cookies, or Genesys Widgets will not work properly.

Related documentation:

App


Cookie Name Purpose
_genesys.widgets.app.autoLoadList Contains a list of active plugin names that are updated based on the usage of widgets during the lazy loading deployment method. This is to ensure that a widget is auto-loaded during a page refresh or page navigation when there is an active session associated with it.

Console


Cookie Name Purpose
_genesys.widgets.console.session Contains the active Console plugin open/close state.
_genesys.widgets.console.commandPlugin Contains the selected plugin name from the Commands section.
_genesys.widgets.console.command Contains the selected command to run from the Commands section.
_genesys.widgets.console.eventPlugin Contains the selected plugin from the Events section to listen for events.
_genesys.widgets.console.event Contains the selected event type to listen against, from the Events section.
_genesys.widgets.console.optionsArea Contains the command options to send when executing a command.
_genesys.widgets.console.activeSubscriptions Contains the list of all active event subscriptions listening via the Console plugin.
_genesys.widgets.console.windowPosition Contains the position of the Console plugin on the screen.

WebChat


Cookie Name Purpose
_genesys.widgets.webchat.state.open Contains the WebChat Widget open or close state for internal tracking purposes.
_genesys.widgets.webchat.state.keys Can contain encrypted keys related to the current active chat session.
_genesys.widgets.webchat.state.ping Contains the time at which the last successful request was made to the server.
_genesys.widgets.webchat.metaData Contains all the Metadata details related to the current active chat session.
_genesys.widgets.webchat.state.index Contains the last unique Message ID for internal tracking purposes.
_genesys.widgets.webchat.state.filters Contains any prefilters that were added using WebChatService plugin commands addPrefilter or sendFilteredMessage.
_genesys.widgets.webchat.state.session Contains the unique Session ID related to the current active chat session. It is used to restore the active chat session during scenarios like page refresh or page navigation.
_genesys.widgets.webchat.state.minimized Contains the WebChat Widget minimized or maximized state for internal tracking purposes.
_genesys.widgets.webchat.autoInvite.disabled Contains a value that disables or enables the WebChat autoInvite feature. It is dynamically updated based on the user's response to the initial WebChat invite.
_genesys.widgets.webchat.state.unreadMessages Tracks the number of unread messages during an active chat session, when WebChat is minimized. It is cleared whenever the WebChat Widget is maximized by the user to read the new messages.
_genesys.widgets.webchat.state.lastMessageCountRead Contains the number of messages that are read during an active chat session that calculates the number of unread messages when WebChat is minimized. It is automatically cleared whenever the WebChat Widget is maximized or closed/ended.
_genesys.widgets.webchat.state.asyncUnreadMessageCount Keeps track of the number of unread messages related to an Async Chat, when WebChat is minimized. It is cleared whenever the WebChat Widget is maximized by the user to read the new messages.
_genesys.widgets.webchat.state.pureengage-v3-rest.session Used only with PureEngage V3 API. It contains the Session ID related to the current active chat session. It is used to restore the active chat session during scenarios like page refresh or page navigation.
_genesys.widgets.webchat.state.pureengage-v3-rest.keys Used only with PureEngage V3 API, containing the encrypted keys related to the current active chat session.
_genesys.widgets.webchat.state.pureengage-v3-rest.index Used only with PureEngage V3 API, containing the last unique message ID for internal tracking purposes.
_genesys.widgets.webchat.state.pureengage-v3-rest.open Used only with PureEngage V3 API, containing the WebChat Widget open or close state for internal tracking purposes.
_genesys.widgets.webchat.state.purecloud-v2-sockets.JWtoken Used only with PureCloud V2 API, containing the JWT token related to the current active chat session.
_genesys.widgets.webchat.state.purecloud-v2-sockets.ConversationID Used only with PureCloud V2 API, containing the active conversation ID related to the current chat session.
_genesys.widgets.webchat.state.purecloud-v2-sockets.MemberID Used only with PureCloud V2 API, containing the user ID of the WebChat Widget related to the current active chat session.
_genesys.widgets.webchat.state.purecloud-v2-sockets.WS_URL Used only with PureCloud V2 API, containing the WebSocket event stream URI for listening to new incoming messages.
_genesys.widgets.webchat.state.purecloud-v2-sockets.LastMsgId Used only with PureCloud V2 API, containing the last unique ID of the message sent in the WebChat Widget.
Retrieved from "https://all.docs.genesys.com/WID/Current/Developer/GWCCookies (2024-11-09 11:40:47)"
Comments or questions about this documentation? Contact us for support!