WID/Current/GCAPI/WebChatService - Revision history

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

2022-08-02T18:27:05Z

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

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

2021-11-09T21:27:59Z

Text replacement - "Genesys Cloud" to "Genesys Cloud CX"

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

2021-11-09T21:11:32Z

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

Chrissy.forrest@genesys.com: Published

2021-04-21T15:40:45Z

Published

Chrissy.forrest@genesys.com: Published

2021-02-03T20:56:02Z

Published

Show changes

@@ Line 512: / Line 512: @@
 ===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 3: / Line 3: @@
 |DisplayName=WebChatService
 |TocName=WebChatService
-|Context=Learn how to use Genesys chat services in Genesys Cloud.
+|Context=Learn how to use Genesys chat services in Genesys Cloud CX.
 |Dimension=WebChat
 |ComingSoon=No
@@ Line 9: / Line 9: @@
 |Section={{Section
 |alignment=Vertical
-|structuredtext={{BarbFeatureTemp|Feature=Web messaging}}If you are a Genesys Cloud 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. To use web messaging, you configure tracking through the [https://developer.genesys.cloud/api/webmessaging/messengersdk/ Messenger JavaScript SDK] instead of deploying a tracking snippet.
+|structuredtext={{BarbFeatureTemp|Feature=Web messaging}}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. To use web messaging, you configure tracking through the [https://developer.genesys.cloud/api/webmessaging/messengersdk/ Messenger JavaScript SDK] instead of deploying a tracking snippet.
 |Status=No
 }}{{Section
@@ Line 47: / Line 47: @@
 |anchor=config
 |alignment=Vertical
-|structuredtext=WebChat and WebChatService share the '''_genesys.widgets.webchat''' configuration namespace. WebChat contains the UI options and WebChatService contains the connection options.{{NoteFormat|Starting with version 9.0.008.04, WebChatService allows you to choose between the types of chat services available in Genesys via the transport section configuration options.|}}For Genesys Cloud, the '''transport.type''' property should always be set to <code>purecloud-v2-sockets</code>.
+|structuredtext=WebChat and WebChatService share the '''_genesys.widgets.webchat''' configuration namespace. WebChat contains the UI options and WebChatService contains the connection options.{{NoteFormat|Starting with version 9.0.008.04, WebChatService allows you to choose between the types of chat services available in Genesys via the transport section configuration options.|}}For Genesys Cloud CX, the '''transport.type''' property should always be set to <code>purecloud-v2-sockets</code>.
 ====Example====
-*Applicable to Genesys Cloud - [https://developer.genesys.cloud/api/digital/webchat/guestchat Guest Chat APIs]
+*Applicable to Genesys Cloud CX - [https://developer.genesys.cloud/api/digital/webchat/guestchat Guest Chat APIs]
 <source lang="javascript">
    window._genesys.widgets.webchat = {  transport: {
@@ Line 98: / Line 98: @@
 {{!}}transport.type
 {{!}}string
-{{!}}Always set to <code>purecloud-v2-sockets</code> for use with Genesys Cloud.
+{{!}}Always set to <code>purecloud-v2-sockets</code> for use with Genesys Cloud CX.
-For more details see [https://developer.genesys.cloud/api/digital/webchat/widget-version2 Widget - Version 2 in Genesys Cloud Developer Center].
+For more details see [https://developer.genesys.cloud/api/digital/webchat/widget-version2 Widget - Version 2 in Genesys Cloud CX Developer Center].
 {{!}}N/A
 {{!}}Yes
@@ Line 107: / Line 107: @@
 {{!}}transport.dataURL
 {{!}}string (URL)
-{{!}}The Genesys Cloud WebChatService URL for your region. A list of API URLs per region is available in the [https://developer.genesys.cloud/api/rest/index.html Platform API section].
+{{!}}The Genesys Cloud CX WebChatService URL for your region. A list of API URLs per region is available in the [https://developer.genesys.cloud/api/rest/index.html Platform API section].
-For more details see [https://developer.genesys.cloud/api/digital/webchat/widget-version2 Widget - Version 2 in Genesys Cloud Developer Center].
+For more details see [https://developer.genesys.cloud/api/digital/webchat/widget-version2 Widget - Version 2 in Genesys Cloud CX Developer Center].
 {{!}}N/A
 {{!}}Yes
@@ Line 115: / Line 115: @@
 {{!}}transport.deploymentKey
 {{!}}string
-{{!}}Genesys Cloud widget deployment key. Identifies the widget on your web page as the one you created in the previous task (Create a widget configuration object).
+{{!}}Genesys Cloud CX widget deployment key. Identifies the widget on your web page as the one you created in the previous task (Create a widget configuration object).
-For more details see [https://developer.genesys.cloud/api/digital/webchat/widget-version2 Widget - Version 2 in Genesys Cloud Developer Center].
+For more details see [https://developer.genesys.cloud/api/digital/webchat/widget-version2 Widget - Version 2 in Genesys Cloud CX Developer Center].
 {{!}}N/A
 {{!}}Yes
@@ Line 124: / Line 124: @@
 {{!}}transport.orgGuid<br />
 {{!}}string
-{{!}}Genesys Cloud organization ID; a unique GUID.
+{{!}}Genesys Cloud CX organization ID; a unique GUID.
-For more details see [https://developer.genesys.cloud/api/digital/webchat/widget-version2 Widget - Version 2 in Genesys Cloud Developer Center].
+For more details see [https://developer.genesys.cloud/api/digital/webchat/widget-version2 Widget - Version 2 in Genesys Cloud CX Developer Center].
 {{!}}N/A
 {{!}}Yes
@@ Line 156: / Line 156: @@
 {{!}}The queue name that receives chat messages. Example: ''Support''.
-For more details see [https://developer.genesys.cloud/api/digital/webchat/widget-version2 Widget - Version 2 in Genesys Cloud Developer Center].
+For more details see [https://developer.genesys.cloud/api/digital/webchat/widget-version2 Widget - Version 2 in Genesys Cloud CX Developer Center].
 {{!}}N/A
 {{!}}Yes
@@ Line 165: / Line 165: @@
 {{!}}Priority level from 0 (lowest) to 10 (highest).
-For more details see [https://developer.genesys.cloud/api/digital/webchat/widget-version2 Widget - Version 2 in Genesys Cloud Developer Center].
+For more details see [https://developer.genesys.cloud/api/digital/webchat/widget-version2 Widget - Version 2 in Genesys Cloud CX Developer Center].
 {{!}}N/A
 {{!}}No
@@ Line 174: / Line 174: @@
 {{!}}List of skills. Example: [''Computers'', ''Printers''].
-For more details see [https://developer.genesys.cloud/api/digital/webchat/widget-version2 Widget - Version 2 in Genesys Cloud Developer Center].
+For more details see [https://developer.genesys.cloud/api/digital/webchat/widget-version2 Widget - Version 2 in Genesys Cloud CX Developer Center].
 {{!}} colspan="1"{{!}}N/A
 {{!}} colspan="1"{{!}}No
@@ Line 183: / Line 183: @@
 {{!}}Requested agent language skill. Example: ''English - Written''.
-For more details see [https://developer.genesys.cloud/api/digital/webchat/widget-version2 Widget - Version 2 in Genesys Cloud Developer Center].
+For more details see [https://developer.genesys.cloud/api/digital/webchat/widget-version2 Widget - Version 2 in Genesys Cloud CX Developer Center].
 {{!}} colspan="1"{{!}}N/A
 {{!}} colspan="1"{{!}}No
@@ Line 192: / Line 192: @@
 {{!}}An object of key/value pairs of arbitrary custom data.
-For more details see [https://developer.genesys.cloud/api/digital/webchat/widget-version2 Widget - Version 2 in Genesys Cloud Developer Center].
+For more details see [https://developer.genesys.cloud/api/digital/webchat/widget-version2 Widget - Version 2 in Genesys Cloud CX Developer Center].
 {{!}} colspan="1"{{!}}N/A
 {{!}} colspan="1"{{!}}No

@@ Line 884: / Line 884: @@
 {{!}}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=GCAPI|topic=WebChatService|anchor=config|display text=configuration}}.
+{{!}}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=GCAPI|topic=WebChatService|anchor=config|display text=configuration}}.
 {{!}}(JWT string token)
 {{!}}9.0.008.04
@@ Line 1,158: / Line 1,158: @@
 {{!}}-
 {{!}}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=GCAPI|topic=WebChatService|anchor=config|display text=configuration}}.
+{{!}}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=GCAPI|topic=WebChatService|anchor=config|display text=configuration}}.
 {{!}}{participantId: (string), sessionId: {string), token: (string), transportId: (string)}
 {{!}}9.0.008.04

@@ Line 7: / Line 7: @@
 |ComingSoon=No
 |Platform=GenesysCloud
 |Section={{Section
 |alignment=Vertical
-|structuredtext={{BarbFeatureTemp|Feature=Web messaging}}If you are a Genesys Cloud 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. To use web messaging, you configure tracking through the [https://developer.mypurecloud.com/api/webmessaging/messengersdk/ Messenger JavaScript SDK] instead of deploying a tracking snippet.
+|structuredtext={{BarbFeatureTemp|Feature=Web messaging}}If you are a Genesys Cloud 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. To use web messaging, you configure tracking through the [https://developer.genesys.cloud/api/webmessaging/messengersdk/ Messenger JavaScript SDK] instead of deploying a tracking snippet.
 |Status=No
 }}{{Section
@@ Line 52: / Line 51: @@
 ====Example====
-*Applicable to Genesys Cloud - [https://developer.mypurecloud.com/api/webchat/guestchat.html Guest Chat APIs]
+*Applicable to Genesys Cloud - [https://developer.genesys.cloud/api/digital/webchat/guestchat Guest Chat APIs]
 <source lang="javascript">
    window._genesys.widgets.webchat = {  transport: {
@@ Line 101: / Line 100: @@
 {{!}}Always set to <code>purecloud-v2-sockets</code> for use with Genesys Cloud.
-For more details see [https://developer.mypurecloud.com/api/webchat/widget-version2.html#chat_configuration_variables Widget - Version 2 in Genesys Cloud Developer Center].
+For more details see [https://developer.genesys.cloud/api/digital/webchat/widget-version2 Widget - Version 2 in Genesys Cloud Developer Center].
 {{!}}N/A
 {{!}}Yes
@@ Line 108: / Line 107: @@
 {{!}}transport.dataURL
 {{!}}string (URL)
-{{!}}The Genesys Cloud WebChatService URL for your region. A list of API URLs per region is available in the [https://developer.mypurecloud.com/api/rest/index.html Platform API section].
+{{!}}The Genesys Cloud WebChatService URL for your region. A list of API URLs per region is available in the [https://developer.genesys.cloud/api/rest/index.html Platform API section].
-For more details see [https://developer.mypurecloud.com/api/webchat/widget-version2.html#chat_configuration_variables Widget - Version 2 in Genesys Cloud Developer Center].
+For more details see [https://developer.genesys.cloud/api/digital/webchat/widget-version2 Widget - Version 2 in Genesys Cloud Developer Center].
 {{!}}N/A
 {{!}}Yes
@@ Line 118: / Line 117: @@
 {{!}}Genesys Cloud widget deployment key. Identifies the widget on your web page as the one you created in the previous task (Create a widget configuration object).
-For more details see [https://developer.mypurecloud.com/api/webchat/widget-version2.html#chat_configuration_variables Widget - Version 2 in Genesys Cloud Developer Center].
+For more details see [https://developer.genesys.cloud/api/digital/webchat/widget-version2 Widget - Version 2 in Genesys Cloud Developer Center].
 {{!}}N/A
 {{!}}Yes
@@ Line 127: / Line 126: @@
 {{!}}Genesys Cloud organization ID; a unique GUID.
-For more details see [https://developer.mypurecloud.com/api/webchat/widget-version2.html#chat_configuration_variables Widget - Version 2 in Genesys Cloud Developer Center].
+For more details see [https://developer.genesys.cloud/api/digital/webchat/widget-version2 Widget - Version 2 in Genesys Cloud Developer Center].
 {{!}}N/A
 {{!}}Yes
@@ Line 157: / Line 156: @@
 {{!}}The queue name that receives chat messages. Example: ''Support''.
-For more details see [https://developer.mypurecloud.com/api/webchat/widget-version2.html#chat_configuration_variables Widget - Version 2 in Genesys Cloud Developer Center].
+For more details see [https://developer.genesys.cloud/api/digital/webchat/widget-version2 Widget - Version 2 in Genesys Cloud Developer Center].
 {{!}}N/A
 {{!}}Yes
@@ Line 166: / Line 165: @@
 {{!}}Priority level from 0 (lowest) to 10 (highest).
-For more details see [https://developer.mypurecloud.com/api/webchat/widget-version2.html#chat_configuration_variables Widget - Version 2 in Genesys Cloud Developer Center].
+For more details see [https://developer.genesys.cloud/api/digital/webchat/widget-version2 Widget - Version 2 in Genesys Cloud Developer Center].
 {{!}}N/A
 {{!}}No
@@ Line 175: / Line 174: @@
 {{!}}List of skills. Example: [''Computers'', ''Printers''].
-For more details see [https://developer.mypurecloud.com/api/webchat/widget-version2.html#chat_configuration_variables Widget - Version 2 in Genesys Cloud Developer Center].
+For more details see [https://developer.genesys.cloud/api/digital/webchat/widget-version2 Widget - Version 2 in Genesys Cloud Developer Center].
 {{!}} colspan="1"{{!}}N/A
 {{!}} colspan="1"{{!}}No
@@ Line 184: / Line 183: @@
 {{!}}Requested agent language skill. Example: ''English - Written''.
-For more details see [https://developer.mypurecloud.com/api/webchat/widget-version2.html#chat_configuration_variables Widget - Version 2 in Genesys Cloud Developer Center].
+For more details see [https://developer.genesys.cloud/api/digital/webchat/widget-version2 Widget - Version 2 in Genesys Cloud Developer Center].
 {{!}} colspan="1"{{!}}N/A
 {{!}} colspan="1"{{!}}No
@@ Line 193: / Line 192: @@
 {{!}}An object of key/value pairs of arbitrary custom data.
-For more details see [https://developer.mypurecloud.com/api/webchat/widget-version2.html#chat_configuration_variables Widget - Version 2 in Genesys Cloud Developer Center].
+For more details see [https://developer.genesys.cloud/api/digital/webchat/widget-version2 Widget - Version 2 in Genesys Cloud Developer Center].
 {{!}} colspan="1"{{!}}N/A
 {{!}} colspan="1"{{!}}No