Configure the Genesys Digital Bot Connector integration
You can use your own third-party bot source in Architect message flows. Configure your bot source from the Genesys Cloud Integrations page. Then, use the Architect Call Digital Bot Connector action to integrate the messaging flow with any bot source for processing before it returns entities or slots, and intents to Architect. When you use this action, you provide a bot list. Architect uses this list to populate fields such as bot name, version, and intents, and then provides the information from the call to the customer’s bot for processing.
- Before you can obtain the Genesys Digital Bot Connector integration, you must contact Genesys Cloud Sales to update your subscription.
- Work with a software engineer to develop a translation layer. This layer allows third-party bots to communicate with Genesys Cloud APIs. For more information, see the Digital Bot Connector Customer API Specification in the Developer Center.
- You can add a maximum of five Digital Bot Connector integrations.
- For information about pricing, see Bring your own technology services model (per turn/minute rates).
- When agents start a live conversation with a customer, agents can see previous messaging conversations the customer had with the external bot that uses the Genesys Digital Bot Connector integration.
- You can obtain the range of IP addresses for Digital Bot Connector and add them to your allowlist. The process to obtain IP address range for both Digital Bot Connector and Bot Connector (legacy) is the same. For more information, see How can I obtain the IP address range for my region where Bot Connector protocol requests could originate from so that I can add it to my allowlist?.
To configure and activate the Genesys Digital Bot Connector integration, follow these steps:
- Click Admin.
- Under Integrations, click Integrations.
- Click Menu > IT and Integrations > Integrations.
- Click Integrations.
- Search for or navigate to the Genesys Digital Bot Connector tile.
- Click Install. The integration opens to the Details tab.
- (Optional) Change the integration name and add notes about the integration. Note: If you change the integration name, be sure to use unique names to differentiate the integrations and the associated actions in the Genesys Cloud applications that reference them.
- Click the Configuration tab.
- Under Properties, enter the following values:
Property name Value Enable Attachment of files Indicate whether the integration must support file transfers from the third-party bot to end users.
Click Default to reset this parameter.
Supported Content Profile Select the Genesys supported content profile for defining the file types that bots can send. It is applicable only when Enable Attachment of files is set to True.
Click Default to reset this parameter.
Bot Connector URI Enter the URI that Genesys uses to relay an utterance from a chat to the Digital Bot Connector bot.
For example,
https://mycustomserver:443/botconnector/
.Bot Provider Enter the name of the third-party bot provider for reference. This is an optional parameter which can help you get insights from reports. Enable Mutual TLS Indicate whether the integration must support Mutual Transport Layer Security (MTLS) or not.
Click Default to reset this parameter.
Mutual TLS Client Certificate Authority Select the MTLS signing authority of the client certificate used by the integration. It is applicable only when Enable Mutual TLS is set to True.
For more information about the trusted certificates for MTLS, see MTLS support for the Genesys Digital Bot Connector integration.
- Click the Credentials tab and add access credentials for the third-party bot. Note: These credentials allow you to provide an authorized token for bot access, and appear in the header of the REST call.
- Click Configure. The Configure Credentials dialog opens.
- Click Add Credential Field.
- In the Field Name and Value fields, enter the appropriate access token for the bot.
- Click OK.
- Activate the integration.
- Next to the bot connector integration, click the Status toggle to change it from Inactive to Active. A Change Status dialog box appears.
- Click Yes. The integration is now active.
- Repeat steps 3–11 to add up to four more digital bot connector integrations.
Validate the integration
When you make and save changes under the Configuration tab, validate your changes to ensure that you configured the integration correctly. To do so, complete the following steps:
- Set the Status switch to Inactive and click Yes.
- Set the Status switch to Active again and click Yes. If the configuration is correct and Genesys Cloud encounters no errors during the activation process, the integration status changes to Active.
When you activate a new integration or save an integration that is already active, the system validates the integration changes. If the validation fails, an error message indicating the cause of the error is shown. Regardless of whether an integration is active or not, these error messages along with the integration details are published to operational events.
- “Validation error: Invalid value for Bot Connector URI: Must follow <scheme>://<network location>/<path> (eg, https://mycustomserver:443/botconnector/)”
- “Validation error: Invalid value for Bot Connector URI: Integration has an invalid Bot Connector URI scheme. Must be https”