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.
Variable Types
There are two types of variables:
| Type | Description | When Available |
|---|
| Contact Variables | Data from your contact records | At call start |
| Live Variables | Data written by tools and functions during the call | After the tool/function executes |
Static Variables
Static variables are populated from the database at the start of each call.
| Name | Data Type | Data Table | Field |
|---|
| Contact - First Name | string | contacts | first_name |
| Contact - Email | string | contacts | email |
| Contact - Phone | string | contacts | phone_number |
| Contact - Company | string | contacts | company |
Dynamic Variables
Live variables are populated by tools and functions during the conversation.
Important: Live variables have no value until a tool or function writes to them. If you reference a live variable before it has been populated, it will be empty. Always ensure your flow executes the relevant tool or function step before referencing its output variables.
Calendar Variables
| Name | Data Type | Description |
|---|
| Calendar - Availability - Spoken | string | Available times in natural spoken format |
| Calendar - Availability - Raw | string | Available times in machine-readable format |
| Calendar - Availability Error - Spoken | string | Error message if availability check fails |
| Calendar - Booking Time - Spoken | string | Booked time in natural spoken format |
| Calendar - Booking Time - Written | string | Booked time in written format |
| Calendar - Booking Time - Raw | string | Booked time in machine-readable format |
| Calendar - Booking ID | string | Unique booking confirmation ID |
| Calendar - Booking Link | string | URL to view/modify the booking |
| Calendar - Booking Error - Spoken | string | Error message if booking fails |
| Calendar - Event ID | string | Calendar event identifier |
| Name | Data Type | Description |
|---|
| Contact - Email (Verified) | string | Email address after validation |
SMS Variables
| Name | Data Type | Description |
|---|
| SMS - Send Error - Spoken | string | Error message if SMS fails to send |
Using Variables in Scripts
To insert a variable into a script, type / to open a dropdown of available variables and select the one you need.
Variables are automatically substituted when the assistant speaks:
Script: "Hi [Contact - First Name], this is Sarah from Voxworks.
I'm calling about the inquiry from [Contact - Company]."
Spoken: "Hi John, this is Sarah from Voxworks.
I'm calling about the inquiry from Acme Corp."
Where Variables Work
Variables are automatically substituted in:
- Voice step scripts
- Condition next scripts
- Tool input mappings
- Function input mappings
- SMS message content
Variable Lifecycle
Call Starts
→ Contact variables populated from contact data
→ Live variables are empty
During Conversation
→ Tools and functions write to live variables
→ All variables available to all steps and flows
Sub-Flow Entered
→ Variables continue to be available
→ No need to pass variables between flows
Call Ends
→ Variables are no longer needed
Best Practices
- Use contact variables for personalisation — Address callers by name
- Check your data — Ensure contact records have the fields you reference
- Handle missing values — Use a function step to check if required data exists before referencing it, and route to different steps accordingly (e.g., check if email is on record before attempting to send a confirmation)
- Use live variables after they’re set — Only reference live variables after the tool/function that populates them has run
- Keep it natural — Don’t overuse variables; conversations should flow naturally
Examples
Personalised Greeting
Say: "Hi [Contact - First Name], this is Alex from Voxworks. Is now a good time to chat?"
Referencing Company
Say: "I'm following up on the enquiry from [Contact - Company] about our services."
After Calendar Booking
Say: "You're all set for [Calendar - Booking Time - Spoken]. I'll send you the details."
SMS Confirmation
Tool Input:
Message: "Hi [Contact - First Name], your appointment is confirmed for [Calendar - Booking Time - Written]."
Phone: "[Contact - Phone]"
Next Steps
