Difference between revisions of "ATC/Current/SDK/api.session.getData"
From Genesys Documentation
m (Text replacement - "\|Platforms?=([^\|]*)PureEngage([\|]*)" to "|Platform=$1GenesysEngage-onpremises$2") |
m (Text replacement - "Genesys Cloud" to "Genesys Cloud CX") |
||
| (6 intermediate revisions by 2 users not shown) | |||
| Line 6: | Line 6: | ||
|Dimension=api.session | |Dimension=api.session | ||
|ComingSoon=No | |ComingSoon=No | ||
| − | |Platform=GenesysEngage- | + | |Platform=PureConnect, GenesysCloud, GenesysEngage-cloud |
| − | |||
|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 | ||
| − | + | |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 | ||
| − | |||
| − | |||
|Status=No | |Status=No | ||
}}{{Section | }}{{Section | ||
| Line 22: | Line 21: | ||
|anchor=Signature | |anchor=Signature | ||
|alignment=Vertical | |alignment=Vertical | ||
| − | |||
| − | |||
|structuredtext=<syntaxhighlight lang="javascript"> | |structuredtext=<syntaxhighlight lang="javascript"> | ||
ac('api.session.getData', (err, sessionInfo) => { | ac('api.session.getData', (err, sessionInfo) => { | ||
| Line 34: | Line 31: | ||
}); | }); | ||
</syntaxhighlight><br /> | </syntaxhighlight><br /> | ||
| − | |||
| − | |||
|Status=No | |Status=No | ||
}}{{Section | }}{{Section | ||
| Line 41: | Line 36: | ||
|anchor=Example | |anchor=Example | ||
|alignment=Vertical | |alignment=Vertical | ||
| − | + | |structuredtext=The following is an example of an object that api.session.getData returns:<syntaxhighlight lang="javascript"> | |
| − | |||
| − | |structuredtext=The following is an example of an object that | ||
{ | { | ||
id: <uuid> | id: <uuid> | ||
| Line 50: | Line 43: | ||
} | } | ||
</syntaxhighlight><br /> | </syntaxhighlight><br /> | ||
| − | |||
| − | |||
|Status=No | |Status=No | ||
}}{{Section | }}{{Section | ||
| Line 57: | Line 48: | ||
|anchor=Callback | |anchor=Callback | ||
|alignment=Vertical | |alignment=Vertical | ||
| − | |||
| − | |||
|structuredtext=The callback takes err as the first parameter. | |structuredtext=The callback takes err as the first parameter. | ||
| − | |||
| − | |||
|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.
Contents
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.
Comments or questions about this documentation? Contact us for support!