api.session.getData

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.