Difference between revisions of "ATC/Current/SDK/api.session.getId"
From Genesys Documentation
DannaShirley (talk | contribs) (Published) |
m (Text replacement - "Genesys Cloud" to "Genesys Cloud CX") |
||
| (8 intermediate revisions by 3 users not shown) | |||
| Line 6: | Line 6: | ||
|Dimension=api.session | |Dimension=api.session | ||
|ComingSoon=No | |ComingSoon=No | ||
| − | |Platform= | + | |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 session ID. | |
| − | |||
| − | |structuredtext=api.session.getData returns an object that contains 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.getId', (err, IdInfo) => { | ac('api.session.getId', (err, IdInfo) => { | ||
| Line 34: | Line 31: | ||
}); | }); | ||
</syntaxhighlight><br /> | </syntaxhighlight><br /> | ||
| − | |||
| − | |||
|Status=No | |Status=No | ||
}}{{Section | }}{{Section | ||
| Line 41: | Line 36: | ||
|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 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.
Comments or questions about this documentation? Contact us for support!