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

From Genesys Documentation
Jump to: navigation, search
(Published)
 
m (Text replacement - "Genesys Cloud" to "Genesys Cloud CX")
 
(9 intermediate revisions by 3 users not shown)
Line 3: Line 3:
 
|DisplayName=api.session.getId
 
|DisplayName=api.session.getId
 
|TocName=api.session.getId
 
|TocName=api.session.getId
−
|Context=api.session.getId
+
|Context=Learn how to get the Id of a particular session.
 +
|Dimension=api.session
 
|ComingSoon=No
 
|ComingSoon=No
−
|Platform=PureEngage, PureConnect, PureCloud
+
|Platform=PureConnect, GenesysCloud, GenesysEngage-cloud
−
|Prereq=
 
 
|Section={{Section
 
|Section={{Section
 +
|alignment=Vertical
 +
|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
 +
}}{{Section
 
|sectionHeading=Description
 
|sectionHeading=Description
 
|anchor=Desc
 
|anchor=Desc
 
|alignment=Vertical
 
|alignment=Vertical
−
|Media=
+
|structuredtext=api.session.getData returns an object that contains session ID.
−
|image=
 
−
|structuredtext=api.session.getData returns an object that contains session information.
 
−
|structuredtextwide=
 
−
|FAQHeading=
 
 
|Status=No
 
|Status=No
 
}}{{Section
 
}}{{Section
Line 21: Line 21:
 
|anchor=Signature
 
|anchor=Signature
 
|alignment=Vertical
 
|alignment=Vertical
−
|Media=
 
−
|image=
 
 
|structuredtext=<syntaxhighlight lang="javascript">
 
|structuredtext=<syntaxhighlight lang="javascript">
 
ac('api.session.getId', (err, IdInfo) => {
 
ac('api.session.getId', (err, IdInfo) => {
Line 33: Line 31:
 
});
 
});
 
</syntaxhighlight><br />
 
</syntaxhighlight><br />
−
|structuredtextwide=
 
−
|FAQHeading=
 
−
|Status=No
 
−
}}{{Section
 
−
|sectionHeading=Example
 
−
|anchor=Example
 
−
|alignment=Vertical
 
−
|Media=
 
−
|image=
 
−
|structuredtext=The following is an example of an object that is returned by api.session.getData:<syntaxhighlight lang="javascript">
 
−
{
 
−
  id: <uuid>
 
−
  shortId: 12345
 
−
  customerCookieId: <uuid>
 
−
}
 
−
</syntaxhighlight><br />
 
−
|structuredtextwide=
 
−
|FAQHeading=
 
 
|Status=No
 
|Status=No
 
}}{{Section
 
}}{{Section
Line 56: Line 36:
 
|anchor=Callback
 
|anchor=Callback
 
|alignment=Vertical
 
|alignment=Vertical
−
|Media=
 
−
|image=
 
 
|structuredtext=The callback takes err as the first parameter.
 
|structuredtext=The callback takes err as the first parameter.
−
|structuredtextwide=
 
−
|FAQHeading=
 
 
|Status=No
 
|Status=No
 
}}
 
}}
 
}}
 
}}

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 get the Id of a particular 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 session ID.

Signature

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

Callback

The callback takes err as the first parameter.

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