Setup a Cognigy.AI Endpoint for Handover¶
First, an Endpoint, for example a Webchat Endpoint, needs to be created in Cognigy.AI.
Once you have an Endpoint, go to the Endpoint Editor and scroll down to Handover Settings.
Set the Handover Platform to "Cognigy Live Agent".
You now have two options. By default, the pre-configured Live Agent Account, mapped to the Cognigy.AI Organization will be used for the handover. However, by deactivating the "Handover to pre-configured Live Agent account" toggle, you can also manually configure the Live Agent handover.
Handover to Pre-configured Live Agent¶
If the toggle "Handover to pre-configured Live Agent account" is activated, conversations will be transferred to the Live Agent Account mapped to the current Cognigy.AI Organization.
To use this feature you need to:
- setup Live Agent for your Organisation
- create an Inbox for the account created in the previous step.
Use Autoconfigure feature in your own Cognigy Installation
To use this feature these environment variables must be set in your Cognigy.AI installation:
FEATURE_USE_COGNIGY_LIVE_AGENT: true COGNIGY_LIVE_AGENT_API_BASE_URL_WITH_PROTOCOL: <https://sub-domain.domain.com> COGNIGY_LIVE_AGENT_PLATFORM_TOKEN: <app-platform-token>
Manually Configure Live Agent Handover¶
Enter the base URL. The base URL is your Live Agent installation URL, plus /api/v1.
See the example below from our Trial environment.
|Base URL||https://liveagent-trial.cognigy.ai/api/v1||*https://liveagent-trial.cognigy.ai* is the Live Agent URL|
Now you need the values to enter in the Account ID and API Key fields. You will need to login to Live Agent as the admin of the current Agent.
Navigate to the UI of Cognigy Live Agent, via the User Menu. Click on Live Agent in the User Menu and Live Agent will open up in a new tab.
Click to Sign In when prompted, using your credentials from Cognigy.AI.
Once logged into Live Agent, note down the following values: Account ID and Inbox ID. These values can be found on the Live Agent URL after logging in.
At the bottom left corner of your screen, click the profile icon displaying your initials. Then click on Profile Settings.
Scroll down and find the section labeled Access Token. Copy the value shown here. This is your API Key.
Return to the Endpoint Editor in Cognigy.AI, go back to Handover Settings in the Webchat Endpoint.
Enter the Account ID and API Key (Access Token) found in the previous steps and save your changes.
Next Steps - Setup your Flow for Handover¶
Now your Webchat Endpoint is setup! Next, you will need to setup your Flow for handover to Live Agent: