Dynamic Variables

Overview

VoiceCreator.ai makes it easy to personalise an assistant’s messages and prompts using dynamic variables. These variables allow each call to be customised, enabling tailored interactions for your customers.

Dynamic variables can be included in prompts, messages, and other assistant properties using templates defined with double curly braces {{variableName}}. These variables are set dynamically when initiating a call and provide a powerful way to enhance user experience.

Example Usage

Imagine you want the assistant’s first message to greet a customer by name. You can set the first message to:

Hello, {{name}}!

When starting the call, provide the name variable via the API or SDK like this:

{
  "variableValues": {
    "name": "John"
  }
}

The assistant will greet the user with:
"Hello, John!"

Utilizing Dynamic Variables in Phone Calls

To use dynamic variables during phone calls, follow these steps:

1. Prepare Your Request

Construct a JSON payload with the following key-value pairs:

• assistantId: The ID of the assistant you’re calling.
• assistantOverrides: This object customises the assistant’s behaviour, including dynamic variables.
• variableValues: An object containing the dynamic variables you want to pass. For example:
  JSON

  {
    "name": "John"
  }

• customer: An object representing the call recipient, including their phone number in E.164 format.
• phoneNumberId: The ID of your registered phone number (found in your dashboard).

2. Send the Request

Dispatch the JSON payload to the /call/phone endpoint using your preferred method (e.g., HTTP POST).

Example JSON Payload:

{
  "assistantId": "your-assistant-id",
  "assistantOverrides": {
    "variableValues": {
      "name": "John"
    }
  },
  "customer": {
    "number": "+61412345678"
  },
  "phoneNumberId": "your-phone-id"
}

Note

Ensure that the {{variableName}} is included wherever you want the variable to appear in the assistant’s prompts or messages.

Default Variables

VoiceCreator.ai provides several default variables that are automatically populated based on the current (UTC) time and customer information. These do not require manual setup in variableValues.

Advanced Date and Time Usage

VoiceCreator.ai uses LiquidJS for handling dynamic variables, enabling you to format dates and times in specific time zones.

Example:

{{"now" | date: "%b %d, %Y, %I:%M %p", "Australia/Sydney"}}

This will return the current date and time in Sydney, formatted as:
Jan 1, 2024, 12:00 PM

Benefits of Dynamic Variables

Dynamic variables allow you to:

• Personalise every interaction based on customer details.
• Dynamically adjust prompts and messages for specific call contexts.
• Improve customer satisfaction with tailored, context-aware communication.

Conclusion

Dynamic variables in VoiceCreator.ai provide a robust way to enhance personalisation during calls. By combining variables with templates, you can create highly customised and effective voice interactions. Whether it’s greeting a customer by name or using advanced date formatting, dynamic variables ensure every interaction feels unique.