This glossary includes the most commonly used x-hoppers terms and features and their descriptions.
Created: November 2024
Permalink: https://x-hoppers.atlassian.net/wiki/x/DAD8B
Introduction
Voice Bots is a poweful tool that allows automated responses and routes customers' and your team’s queries via bot assistance. There are several Voice Bot integration types:
Generative AI let you create highly interactive and intelligent Voice Bots without any coding expertise. By providing specific instructions, the AI model generates dynamic, context-aware responses that enhance user engagement. You can also create easily incorporate custom functions to interact with third-party servers, allowing your bot to perform actions like fetching real-time data, updating records, or triggering external processes during a conversation. This option doesn’t require coding experience.
Webhooks and AWS SQS allow you to take full control over your voice bot sessions. These options are ideal if your voice bot requires custom handling of conversations; you can build a service to analyze events and generate responses.
Dialogflow CX is a versatile AI platform, which is great at handling natural language and managing conversations, even when they get a bit complicated. It is good for automating customer interactions, handling queries, and passing customers to agents when needed, especially in cases where you have clear predefined use cases of customer interactions, where the scenarios of communication with customers are generally the same.
OpenAI Assistant connects your Voice Bot to OpenAI’s language models, which lets to handle complex conversations and provide natural responses to user queries. With OpenAI’s advanced AI capabilities, your Voice Bot can understand context, manage dialogues, and deliver personalized interactions.
Use Cases
Voice Bots can be used in a variety of ways. Here are some examples:
Shop assistance: assisting in finding products, checking availability, or making recommendations based on their interests.
Order processing and tracking: helping to place orders and provide updates on delivery status.
Call centers: handling routine calls and reducing wait times, so that human agents can focus on more complex issues.
Customer service: answering common questions of the customers, providing account information, or helping with troubleshooting over the phone.
Language support: communicating with customers in multiple languages to address queries of a more diverse audience.
Collecting feedback: gathering customer reviews or feedback through voice interactions to improve services.
Voice Bot Creation
It is possible to create up to 100 Voice Bots per organization.
To create a Voice Bot, proceed with the following steps:
Navigate to WMS -> PBX -> Integrations -> Cloud integrations -> Voice Bots
Click Add New Voicebot:
Enter Voice Bot name
Enter First message (optional)
Select the integration type for processing events:
Generative AI
Webhook
AWS SQS
Dialogflow CX
OpenAI Assistant
Fill out the necessary fields depending on the selected integration type (see instructions below)
Add Tools:
Tools allow a Voice Bot to execute specific tasks during a call. By integrating tools, you can align your Voice Bots with your existing workflow. See the list of available tools below:Transfer: allows to transfer a call to an agent or route via Dialplan
Delegate: gives possibility to delegate user’s request to another Voice Bot
Hangup: allows the Voice Bot to end a call by himself it the call is considered finished
Wait: allows to analyze the the user’s response and wait for more input if the response was incomplete
Third-party Function: gives possibility to integrate Voice Bot with various API options
To add a tool:
Click Add Tool -> choose the necessary option:
Fill out the necessary details:
Configure Advanced Configuration:
Interruption Detection: if enabled, customers can interrupt the bot and the system will stop the playback of the voice bot's response. By default, the option is disabled.
Silence Timeout: set the timeout before a call is automatically ended due to inactivity and the action (hangup or transfer) that should be performed when the call ends.
In case you choose to transfer the call after the Voice Bot reaches the silence timeout, you need to specify:Context: the Dialplan procedure
Extension: extension to which the call should be transferred
Maximum Duration: the maximum duration of a call in seconds and action (hangup or transfer) that should be performed when the call ends.
Click Add to save your Voice Bot
Types of Voice Bots
Generative AI
When configuring Generative AI as the integration type, you need to create a clear and precise prompt with instructions for AI agents, which directly impacts Voice Bot performance and reliability. Prompt engineering is an iterative process, so based on user feedback, you can refine your prompts for even better Voice Bot efficiency.
You can divide your system prompts into the distinct sections, each focusing on a specific element of the AI agent's behavior. For example:
Identity: define who the AI agent is, outline its persona and role to set the context for interactions.
Style: establish guidelines for the agent's communication style, including tone, language, and formality.
Response Guidelines: specify preferences for the response format, including any limitations or requirements in terms of the response structure.
Task and Goals: indicate the objectives the agent should achieve and outline the steps it should follow.
Webhook
Specify the following fields, when configuring Webhook as the integration type:
Target: enter the URL that the Webhook will use to send POST requests with the event payload.
Secret: the secret ensures that only requests from Wildix system are accepted, preventing unauthorized access or potential security breaches. The secret key is included in the headers of each POST request sent by the Webhook. Your server should validate this key to ensure the request is legitimate before processing the event data
Important: The endpoint should be publicly accessible with a valid HTTPS certificate, accept HTTP POST requests with JSON payloads, respond with codes from 200 to 299 as quickly as possible, and handle multiple identical calls in case of retries due to network or server failures (up to 3 times).
AWS SQS
If you configure AWS SQS as integration type, you need to provide the following details to establish the connection with your AWS SQS queue:
Target: enter the URL of your SQS queue. This is where the events are sent, for example, https://sqs.amazonaws.com/11111/wildix-events-queue
Key: enter your AWS Access Key ID. It is used to sign the request that x-hoppers sends to AWS SQS.
Secret: enter your AWS Secret Access Key, which is paired with your AWS Key to sign the requests securely.
Dialogflow CX
If you configure Dialogflow CX as the integration type, you need to fill out the following fields to establish the connection between x-hoppers and your Dialogflow CX agent:
Private Key: click Upload and upload the private key file associated with your Google Cloud service account
Location: fill out the region where your Dialogflow CX agent is deployed (typically it is a region-specific identifier, for example, europe-west1, us-central1)
Language: indicate the language that your Dialogflow CX agent will use to understand and respond to user inputs. Make sure the language code matches the languages supported by your Dialogflow CX agent, e.g.:
en
for EnglishAgent ID: provide the unique identifier of your Dialogflow CX agent, links your Voice Bot to the specific Dialogflow CX agent that you’ve configured in Google Cloud.
OpenAI Assistant
If you configure OpenAI Assistant as integration type, you need to fill out the following fields to enable the connection between x-hoppers and OpenAI's API:
API Key: enter the unique identifier that allows to grant access to the OpenAI API, which lets to send requests and receive responses from the Assistant
Assistant ID: fill out the unique identifier of a specific OpenAI Assistant you created.
Manage Voice Bots
The Voice Bots that you have created are displayed in WMS -> PBX -> Integrations -> Cloud integrations -> Voice Bots section. You can see the Voice Bot name, Bot ID, and Integration type.
Edit a Voice Bot
To edit a Voice Bot, click on the Edit (pencil) icon:
Make the necessary changes and click Save:
Delete a Voice Bot
To delete a Voice Bot, click on the Delete icon:
On the screen that pops up, type the word “delete” and click Delete:
Dialplan Configuration
To set Voice Bot in a Dialplan:
Set a language which the Voice Bot will use: add Set application -> Language -> select the language
Note:
The following languages are supported: English (British), English (US), Spanish, French, Italian, Dutch, German, Arabic, Catalan, Danish, Swedish, Portuguese.
Arabic (ar), Swedish (se) are not present in the drop-down list, but you can enter them manually, for example:
Basque and Estonian languages are not supported.
Add the Voice Bot application and choose the necessary Voice Bot from the list:
Traces
In Traces section you can see a table with the following information: Session ID, Voice Bot name, Caller, Duration of the call, date and language. Clicking on a session in Traces, you can view events of the session.
Voice Bots API
You can find Voice Bots API here: https://docs.wildix.com/api-reference/rest/wim/voicebots/#/