## Documentation Index

Fetch the complete documentation index at: [/llms.txt](https://docs.cognigy.com/llms.txt)

Use this file to discover all available pages before exploring further.

## Description

As of June 11, 2025, the Genesys Cloud Guest Chat handover is deprecated. This follows [Genesys ACD Web Chat v2 deprecation](https://help.mypurecloud.com/articles/deprecation-predictive-engagement-support-for-acd-web-chat-version-2/). If you’re a new user looking to connect to Genesys, create a new [Genesys Cloud Open Messaging](https://docs.cognigy.com/ai/escalate/handover-reference/genesys-cloud-open-messaging) handover.
For existing users, we strongly advise migrating to the [Genesys Cloud Open Messaging](https://docs.cognigy.com/ai/escalate/handover-reference/genesys-cloud-open-messaging) handover before the deprecation date.

The Genesys Cloud Guest Chat handover provider bridges Cognigy.AI and [Genesys](https://login.mypurecloud.com/), enabling end users to connect with human agents working in a contact center that uses Genesys Cloud Guest Chat. The Genesys Cloud Guest Chat handover provider is based on [Genesys Guest Chat APIs](https://developer.genesys.cloud/commdigital/digital/webchat/guestchat). These APIs contain functionality to create a new chat conversation, retrieve previous chat history, send messages, set the typing indicator, and leave the chat. Receiving messages, membership changes, and other real-time events are available via a WebSocket connection.

## Prerequisites

- Access to [Genesys Cloud](https://login.mypurecloud.com/).
- Created Endpoint [compatible with Genesys Cloud Guest Chat](https://docs.cognigy.com/ai/agents/deploy/endpoints/handover-settings#endpoints-compatible-with-handover-providers).

## Configuration on the Handover Provider Side

1. Create a Handover Provider

1. Go to **Deploy > Handover Providers**.
   2. Click **+ New Handover Provider** and select **Genesys Guest Chat** from the list.
   3. To fill in the required fields and complete your setup, read the [Genesys Cloud Handover Integration](https://support.cognigy.com/hc/en-us/articles/6229147435292) article in the Cognigy Help Center.

2. Configure Handover Settings

In [Handover to Human Agent](https://docs.cognigy.com/ai/agents/develop/node-reference/service/handover-to-agent) Node, configure the following settings:

- **Language** — specify a language for the conversation. For example, `english`, `spanish`, `german`.
- **Skills** — define skills for the conversation. For example, `escalation`.
- **Priority** — set the priority for the conversation. For example, `1`. If a priority is set, it triggers a flow in Genesys to prioritize or de-prioritize the conversation within the queue. Note that this functionality requires the appropriate flow to be set up in Genesys.
- **Display Agent Details** — display the human agent’s name and avatar from Genesys in the chat for the end user. The parameter is disabled by default.
- **Custom Attributes** — add custom attributes in the `Key: Value` format, which allows you to include additional information.

For example:

```
{
    "section": "section A",
    "region": "Europe"
}
```

## Additional Configuration

### Filter Transcript Messages

By default, Cognigy.AI sends the full conversation transcript as a single message once the handover to Genesys occurs. Additionally, you can filter out empty or unsupported messages to keep the transcript relevant and concise:

- **Filter unsupported messages** — if the system detects a message in an unsupported format, such as `UNSUPPORTED_STRUCTURE_DATA`, the system will exclude the message from the conversation transcript. To activate this feature, use the `FEATURE_FILTER_UNSUPPORTED_MESSAGES_HANDOVER_PROVIDER: "true"` feature flag.
- **Filter empty messages** — if a user sends a blank message with no text or content, the system will exclude the message from the conversation transcript. To activate this feature, use the `FEATURE_FILTER_EMPTY_MESSAGES_HANDOVER_PROVIDER: "true"` feature flag.

### Agent Copilot Workspace

Within Genesys integration, you can use the [Agent Copilot workspace](https://docs.cognigy.com/agent-copilot/overview) as an assistant for your human agents. By default, two versions of the application are provided:

#### Standalone

Agent Copilot will be available as a standalone application via the following link: `https://${AgentCopilotBaseUrl}/?userId=${userId}&sessionId=${sessionId}&URLToken=${URLToken}` Where:

- `AICopilotBaseUrl` — the base URL used to access the Agent Copilot workspace.
- `sessionId` — the Cognigy session ID. A session represents the interaction between the human agent and the Agent Copilot workspace.
- `userId` — the Cognigy user ID. It helps Agent Copilot associate the interaction with a specific user.
- `URLToken` — the Endpoint token from Cognigy.AI. The Endpoint must be linked to the Handover Flow. To find this token, go to the Endpoint that you created previously. In the **Endpoint URL** field, copy the token after `https://endpoint-trial.cognigy.ai/`. For example, in the URL `https://endpoint-trial.cognigy.ai/f38791ae20d4961acf0e97d9f377c4fe3df92894e1eff1c7a774a8ed089a4590`, the token is `f38791ae20d4961acf0e97d9f377c4fe3df92894e1eff1c7a774a8ed089a4590`. Only authorized users can access the Agent Copilot system through this URL.

Example URL:

```
https://ai-copilot-trial.cognigy.ai/?sessionId=session123&userId=user123&URLToken=a4d5c86c98f27730311591f28d194510e05ffed30ca148e3344970defd418e7d
```

#### Embedded

By default, you can use the embedded version of the Agent Copilot workspace, but it will overlap part of the screen with the conversation. To place the workspace to the right of the chat with the conversation, follow these steps:

1. Create a Script

To create a script, follow these steps:

1. In Cognigy.AI, go to Endpoint **Settings > Copilot**.
   2. Copy the Agent Copilot Embedding URL by clicking on it.
   3. In Genesys Cloud, open the **Admin** tab.
   4. Under **Contact Center**, click **Scripts**, then **Create**. Type a name for the script.
   5. Select the **Blank Script** template and click **+ Create**.
   6. On the script page, go to the **Add Components** tab.
   7. Under the **Components** section, select **Web Page**. In the **Web Page Source** field, enter the Agent Copilot Embedding URL that you copied before.
   8. In the **Layout** section, change the size of width and height by clicking the **Stretch** button.
   9. In the upper-right corner, go to the **Variables** tab.
   10. On the **Variables** tab, go to the **Basic Types** section and click **String**.
   11. Create a new variable:

1. In the **Name** field, enter `userId`.
       2. In the **Description** field, enter `Cognigy variable`.
       3. Enable the **Input** toggle and click **Apply**.
   12. In the upper-left corner of the script page, click **Script > Properties**.
   13. In the **Script Properties** section, activate the **Inbound** and **Message** features.
   14. In the upper-left corner of the script page, click **Script > Save**, then **Publish**.

2. Add the Script to the Inbound Message Flow

To add the Script to the Inbound Message Flow, follow these steps:

1. In the Genesys Cloud interface, go to **Orchestration > Architect**.
2. Click or hover over the  icon on the **Flows** tab and select **Inbound Message**.
3. From the flow list, select a flow that you created before.
4. To configure a flow, click **Edit**.
5. In the flow editor, ensure that the **Get Participant Data** action is added. If you haven’t done so already, refer to steps 9-11 in the Create an Inbound Message Flow section of the [Genesys Cloud Open Messaging](https://docs.cognigy.com/ai/escalate/handover-reference/genesys-cloud-open-messaging#3-create-an-inbound-message-flow) article.
6. Below the **Get Participant Data** action, place a [Set Screen Pop](https://help.mypurecloud.com/articles/set-screen-pop-action/) action. The **Set Screen Pop** action must be positioned above the **Transfer to ACD** action.
7. From the **Message Script** list of the **Set Screen Pop** action, select the script created before.
8. In the **Inputs** action, add `userId` in the **userId** field.
9. In the upper-left corner, click **Save**, then **Publish**.

## More Information

- [Genesys Cloud Open Messaging](https://docs.cognigy.com/ai/escalate/handover-reference/genesys-cloud-open-messaging)