Skip to content

Custom Voice Bot

In this section, we will explore the Custom Voice Bot feature of Buzzeasy. Custom Bots enable you to create an interface for your solution to interact directly with customers within the Buzzeasy system.

Integration interface

The communication between your bot and Buzzeasy goes through a WebSocket connection. Your bot will act as the WebSocket server and there will be a connection from Buzzeasy for each conversation and for each bot session within the conversation. You can find the WebSocket message definitions on the next page.

Setting up the Custom Voice Bot

You can configure Custom Voice Bots on the Portal under the Integration/Voice Bots section. The configuration requires the following fields:

  • Name: This is the name you want to give to your bot.
  • WebSocket Server URL: This is the URL of your bot server where Buzzeasy will send WebSocket requests.
  • API Key: This is a secret key generated by you. Buzzeasy will include this key in the x-api-key HTTP header when it makes WebSocket requests to your bot. You can validate this key on your bot server to ensure the request is from Buzzeasy.

Adding Custom Bot to your Workflow

Once you have set up a Custom Bot as described in the previous sections, the next step is to add it to a workflow. Here's how to do it:

Navigate to the workflow editor in the Buzzeasy portal. Add a new Custom Bot node to your workflow Inside the node, select the Custom Bot you created from the drop-down list. Save the workflow. Now, whenever this workflow is executed, Buzzeasy will assign conversations to your Custom Bot based on the workflow conditions.

Remember, you can add multiple Custom Bot nodes in a single workflow, and each node can be configured to use a different Custom Bot. This allows you to create complex workflows that use multiple bots to handle different parts of a conversation.