WID/Current/SDK/WebChatService-combined - Revision history

WikiSysop at 06:30, October 6, 2023

2023-10-06T06:30:57Z

Xavier: Published

2023-10-06T06:22:40Z

Published

Mwest: Text replacement - "Agent Desktop" to "Agent Workspace"

2022-08-02T18:27:02Z

Text replacement - "Agent Desktop" to "Agent Workspace"

WikiSysop at 13:30, April 6, 2022

2022-04-06T13:30:35Z

Mgionet: Published

2022-03-25T12:47:15Z

Published

Monique.gionet@genesys.com: Published

2021-11-12T15:11:41Z

Published

Ed.jamer@genesys.com: Text replacement - "Genesys Engage" to "Genesys Multicloud CX"

2021-11-09T21:12:39Z

Text replacement - "Genesys Engage" to "Genesys Multicloud CX"

Chrissy.forrest@genesys.com: Published

2021-04-27T18:51:05Z

Published

Chrissy.forrest@genesys.com: Published

2021-03-25T20:04:09Z

Published

Chrissyforrest: Published

2020-10-29T17:11:27Z

Published

@@ Line 650: / Line 650: @@
 ===sendFilteredMessage===
-Sends a message along with a regular expression to match the message and hide it from the client. Useful for sending codes and tokens through the WebChat interface to the Agent Workspace.
+Sends a message along with a regular expression to match the message and hide it from the client. Useful for sending codes and tokens through the WebChat interface to the Agent Desktop.
 {{NoteFormat|Filters are now automatically stored and recalled on chat restore for the duration of the session.}}

@@ Line 38: / Line 38: @@
 WebChatService has many configuration options but no customization options. It is a plug-and-play plugin and works as is.
 |Status=No
 }}{{Section

@@ Line 644: / Line 644: @@
 ===sendFilteredMessage===
-Sends a message along with a regular expression to match the message and hide it from the client. Useful for sending codes and tokens through the WebChat interface to the Agent Desktop.
+Sends a message along with a regular expression to match the message and hide it from the client. Useful for sending codes and tokens through the WebChat interface to the Agent Workspace.
 {{NoteFormat|Filters are now automatically stored and recalled on chat restore for the duration of the session.}}

@@ Line 331: / Line 331: @@
 Initiates a new chat session with the chat server via GES or with the service configured under the transport section.
 ====Example====
 <source lang="javascript">
 oMyPlugin.command('WebChatService.startChat', {
@@ Line 342: / Line 366: @@
    	email: 'jon.smith@mail.com',
    	subject: 'product questions',
-  	userData: {}
+  },
+  userData: {}
 }).done(function(e){

@@ Line 336: / Line 336: @@
 oMyPlugin.command('WebChatService.startChat', {
-	nickname: 'Jonny',
+  form:{
-	firstname: 'Johnathan',
+  	nickname: 'Jonny',
-	lastname: 'Smith',
+  	firstname: 'Johnathan',
-	email: 'jon.smith@mail.com',
+  	lastname: 'Smith',
-	subject: 'product questions',
+  	email: 'jon.smith@mail.com',
-	userData: {}
+  	subject: 'product questions',
+  	userData: {}
 }).done(function(e){

@@ Line 1,280: / Line 1,280: @@
 '''[Introduced: 9.0.008.04]'''
-This applies only in Asynchronous mode to fetch older chat messages. It does not fetch all of the messages at once; rather a certain number of messages are fetched every time this command is called. Response data will be available in the {{Link-SomewhereInThisVersion|manual=SDK|topic=WebChatService-combined|anchor=events|display text=messageReceived}} event.
+This applies only in Asynchronous mode to fetch older chat messages. It does not fetch all of the messages at once; rather a certain number of messages are fetched every time this command is called. Response data will be available in the {{Link-SomewhereInThisVersion|manual=SDK|topic=WebChatService-combined|anchor=events|display text=messageReceived}} event. This internal command determines the last received message index and, based on this information, fetches older messages whenever it is called.
 ====Example====

@@ Line 234: / Line 234: @@
 {{!}}transport.endpoint
 {{!}}string
-{{!}}The endpoint for Genesys Engage v3 API.
+{{!}}The endpoint for Genesys Multicloud CX v3 API.
 {{!}}n/a
 {{!}}Yes
@@ Line 990: / Line 990: @@
 {{!}}sessionData
 {{!}}string
-{{!}}The session data that is needed to restore the WebChat in Async mode. It is a JWT token string value. Applicable only when using WebChat with Genesys Engage v3 API. For more information, see the “Genesys Engage v3” tab in the “Options” table in {{Link-SomewhereInThisVersion|manual=SDK|topic=WebChatService-combined|anchor=options|display text=configuration options}}.
+{{!}}The session data that is needed to restore the WebChat in Async mode. It is a JWT token string value. Applicable only when using WebChat with Genesys Multicloud CX v3 API. For more information, see the “Genesys Multicloud CX v3” tab in the “Options” table in {{Link-SomewhereInThisVersion|manual=SDK|topic=WebChatService-combined|anchor=options|display text=configuration options}}.
 {{!}}(JWT string token)
 {{!}}9.0.008.04
@@ Line 1,265: / Line 1,265: @@
 {{!}}-
 {{!}}resolved
-{{!}}Always, when using Chat via Genesys Engage v3 API. For more information, see the 'Genesys Engage v3' tab in the 'Options' table in {{Link-SomewhereInThisVersion|manual=SDK|topic=WebChatService-combined|anchor=options|display text=configuration options}}.
+{{!}}Always, when using Chat via Genesys Multicloud CX v3 API. For more information, see the 'Genesys Multicloud CX v3' tab in the 'Options' table in {{Link-SomewhereInThisVersion|manual=SDK|topic=WebChatService-combined|anchor=options|display text=configuration options}}.
 {{!}}{participantId: (string), sessionId: {string), token: (string), transportId: (string)}
 {{!}}9.0.008.04

@@ Line 267: / Line 267: @@
 {{!}}9.0.008.04
 {{!}}-
-{{!}}transport.async.setSessionData
+{{!}}transport.async.getSessionData
 {{!}}function
-{{!}}A function that you can define to retrieve updated session data from WebChatService plugin. This function is called back when starting a new Async chat session for the first time or when the sessionData changes over the course of an active chat session. This function takes the following arguments - sessionData (current active session data), Cookie (Widgets Internal cookie reference) and CookieOptions (a parameter that is needed when using Widgets Cookie). The purpose of this function is to provide you the active session data so that it can be stored somewhere safe and secure. Later this needs to be provided in the below setSessionData function to restore the chat session. Refer to the {{Link-SomewhereInThisVersion|manual=SDK|topic=WebChatService-combined|anchor=example|display text=example}} for usage.
+{{!}}A function that you can define to retrieve updated session data from the WebChatService plugin. This function is called back when starting a new Async chat session for the first time, or when the sessionData changes over the course of an active chat session. This function takes the following arguments: sessionData (current active session data), Cookie (Widgets Internal cookie reference), and CookieOptions (a parameter that is needed when using Widgets Cookie). The purpose of this function is to provide you with the active session data so that it can be stored somewhere safe and secure. Later this needs to be provided in the below '''setSessionData''' function to restore the chat session. Refer to the {{Link-SomewhereInThisVersion|manual=SDK|topic=WebChatService-combined|anchor=example|display text=example}} for usage.
 {{!}}none
 {{!}}Yes, when Async WebChat mode is enabled
 {{!}}9.0.008.04
 {{!}}-
-{{!}}transport.async.getSessionData
+{{!}}transport.async.setSessionData
 {{!}}function
-{{!}}A function that you can define to return the session data to WebChatService plugin. During initialization, WebChatService plugin will call this function to check if any session data is returned. If found, WebChatService tries to restore the chat session using this session data and open WebChat Widget. WebChatService will also pass the following arguments into this function - Open (WebChat current open state value), Cookie (Widgets Internal cookie reference) and CookieOptions (a parameter that will be needed when using Widgets Cookie). Refer to the {{Link-SomewhereInThisVersion|manual=SDK|topic=WebChatService-combined|anchor=example|display text=example}} for usage.
+{{!}}A function that you can define to return the session data to the WebChatService plugin. During initialization, the WebChatService plugin will call this function to check if any session data is returned. If found, WebChatService tries to restore the chat session using this session data and open the WebChat Widget. WebChatService will also pass the following arguments into this function: Open (WebChat current open state value), Cookie (Widgets Internal cookie reference), and CookieOptions (a parameter that isneeded when using Widgets Cookie). Refer to the {{Link-SomewhereInThisVersion|manual=SDK|topic=WebChatService-combined|anchor=example|display text=example}} for usage.
 {{!}}none
 {{!}}Yes, when Async WebChat mode is enabled

@@ Line 138: / Line 138: @@
 {{!}}apikey
 {{!}}string
-{{!}}Apigee Proxy secure token.
+{{!}}Apigee Proxy secure token.{{NoteFormat|This option is only supported in GMS REST mode.|}}
 {{!}}n/a
 {{!}}Yes, if using Apigee Proxy
@@ Line 180: / Line 180: @@
 {{!}}xhrFields
 {{!}}object
-{{!}}Allows you to set the properties for the AJAX xhrFields object (for example, {withCredentials: false}).
+{{!}}Allows you to set the properties for the AJAX xhrFields object (for example, {withCredentials: false}).{{NoteFormat|This option is only supported in GMS REST mode.|}}
 {{!}}{withCredentials: false}
 {{!}}n/a
@@ Line 1,405: / Line 1,405: @@
 {{!}}No preprocessor function provided. Type provided was '<DATATYPE>'.<br />
 {{!}}}
 <br />
 |Status=No
 }}{{Section

@@ Line 311: / Line 311: @@
 |Status=No
 }}{{Section
-|sectionHeading=API Commands
+|sectionHeading=API commands
 |anchor=commands
 |alignment=Vertical
@@ Line 615: / Line 615: @@
 {{!}}}
- {{AnchorDiv||sfm}}
+{{AnchorDiv|sfm}}
 ===sendFilteredMessage===
@@ Line 675: / Line 675: @@
 {{!}}}
-  {{AnchorDiv||ap}}
+  {{AnchorDiv|ap}}
 ===addPrefilter===
@@ Line 1,408: / Line 1,408: @@
 |Status=No
 }}{{Section
-|sectionHeading=API Events
+|sectionHeading=API events
 |anchor=events
 |alignment=Vertical
@@ Line 1,423: / Line 1,423: @@
 !Description
 !Data
-!Introduced/Updated
+!Introduced/updated
 {{!}}-
 {{!}}ready