Difference between revisions of "ATC/Current/SDK/api.session.getData"

From Genesys Documentation
Jump to: navigation, search
(Published)
m (Text replacement - "Genesys Cloud" to "Genesys Cloud CX")
 
(3 intermediate revisions by one other user not shown)
Line 8: Line 8:
 
|Platform=PureConnect, GenesysCloud, GenesysEngage-cloud
 
|Platform=PureConnect, GenesysCloud, GenesysEngage-cloud
 
|Section={{Section
 
|Section={{Section
−
|sectionHeading=About web messaging
 
−
|anchor=WebMessaging
 
 
|alignment=Vertical
 
|alignment=Vertical
−
|structuredtext={{BarbFeatureTemp|Feature=Web messaging}}This article only applies to customers using web chat. If you are a Genesys Cloud customer, we encourage you to use the new {{Link-AnywhereElse|product=ATC|version=Current|manual=AdminGuide|topic=About_web_messaging|display text=web messaging}} feature to replace web chat.
+
|structuredtext={{NoteFormat|1=This article only applies to customers using {{Link-AnywhereElse|product=ATC|version=Current|manual=AdminGuide|topic=About_web_chats|display text=web chat}}. If you are a Genesys Cloud CX customer, we encourage you to use the new {{Link-AnywhereElse|product=ATC|version=Current|manual=AdminGuide|topic=About_web_messaging|display text=web messaging}} feature to replace web chat.|2=}}<br />
 
|Status=No
 
|Status=No
 
}}{{Section
 
}}{{Section
Line 17: Line 15:
 
|anchor=Desc
 
|anchor=Desc
 
|alignment=Vertical
 
|alignment=Vertical
−
|structuredtext=api.session.getData returns an object that contains the session Id, short Id, and customer cookie Id.
+
|structuredtext=api.session.getData returns an object that contains the session ID, short ID, and customer cookie ID.
 
|Status=No
 
|Status=No
 
}}{{Section
 
}}{{Section
Line 38: Line 36:
 
|anchor=Example
 
|anchor=Example
 
|alignment=Vertical
 
|alignment=Vertical
−
|structuredtext=The following is an example of an object that is returned by api.session.getData:<syntaxhighlight lang="javascript">
+
|structuredtext=The following is an example of an object that api.session.getData returns:<syntaxhighlight lang="javascript">
 
{
 
{
 
   id: <uuid>
 
   id: <uuid>

Latest revision as of 21:28, November 9, 2021

This topic is part of the manual Journey JavaScript SDK for version Current of Genesys Predictive Engagement.

Learn how to obtain the data such as the short ID for a particular customer's session.

Important
This article only applies to customers using web chat. If you are a Genesys Cloud CX customer, we encourage you to use the new web messaging feature to replace web chat.

Description

api.session.getData returns an object that contains the session ID, short ID, and customer cookie ID.

Signature

ac('api.session.getData', (err, sessionInfo) => {
  if (err) {
    // handle error
    return;
  }
  
  return sessionInfo;
});

Example

The following is an example of an object that api.session.getData returns:
{
  id: <uuid>
  shortId: 12345
  customerCookieId: <uuid>
}

Callback

The callback takes err as the first parameter.

Retrieved from "https://all.docs.genesys.com/ATC/Current/SDK/api.session.getData (2025-06-23 12:55:58)"
Comments or questions about this documentation? Contact us for support!