Documentation Index
Fetch the complete documentation index at: https://docs.voxworks.ai/llms.txt
Use this file to discover all available pages before exploring further.
What is a Script?
A Script brings together all the components that make your voice assistant work:| Component | Purpose |
|---|---|
| Flow | The conversation logic with steps, conditions, and branching paths |
| Objectives | Goals the assistant should accomplish during the call |
| Guidelines | Rules for handling specific situations or topics |
| Knowledge Base | Reference documents the assistant can draw from |
| Voicemail Message | What to say when reaching voicemail on outbound calls |
| Settings | Configuration options like maximum call duration |
How Scripts Work
When a call starts, Voxworks loads your Script and uses it to guide the entire conversation. After the call ends, objectives are reviewed against the transcript:- Initialization — The Script is loaded with its components, main flow, sub-flows and voice settings
- Opening Message — The assistant speaks the first message of the main flow
- Conversation Flow — The assistant follows the flow’s steps, responding to user input and navigating conditions
- Objective Tracking — The assistant works toward completing the defined objectives
- Call Completion — The call ends when an end condition is reached or the user hangs up
Script Types
Scripts can be configured for different call types:- Inbound — Handles incoming calls to your phone numbers
- Outbound — Powers automated outbound calling campaigns
Creating a Script
To create an effective Script:- Define your objectives — What should the assistant accomplish?
- Build your flow — Map out the conversation steps and branching logic
- Add guidelines — Handle edge cases and specific topics
- Configure settings — Set call duration limits and other options
- Select a voice — Choose the voice that fits your brand
Next Steps
- Call Objectives — Define what your assistant should accomplish
- Guidelines — Handle specific situations with conditional rules
- Knowledge Base — Give your assistant reference information
- Settings — Configure call duration and other options