What is a template variable?
Template variables are a way to add personalization to your outbound messages that include information about the customer, the team member helping a customer or various activities currently going on with the customer that Numa knows about (e.g. payments, repair orders).
For example, you may have phone greetings that should automatically introduce the staff member, the name of the business, and your hours.
Hi, this is John. Thanks for calling John's Template Service! Our hours are M-F, 9am-5pm.
The template to do this would be:
Hi, this is {{ user.first_name }}. Thanks for calling {{ location.name }}! Our hours are {{ location.hours }}.
By using template variables, if you ever change your business hours, all of your phone greetings immediately update! Further, when you add or remove new team members, you don't need to rewrite a new script for each new person.
Where can you use template variables?
You may use template variables anywhere Numa is being told to automate communication with customers. Some common examples include;
Saved Replies
AI-based responses and suggestions
Voice scripts
When using a template variable, Numa will populate the message after you send it and before it communicates to the customer. Keep in mind that some template variables require the customer to be actively engaged in the related template variable capability. For example, if you attempt to send payment request variables to a customer who doesn't have an active payment request, Numa will either send blank messages to customers or cause the outbound message will fail to send.
Supported Variables
Location Information
Name | Business Nmae |
Source | The name of your business. Configured in your Location Details |
Variable | location.name |
Example Template | Thanks for contacting {{ location.name }}! |
Preview | Thanks for contacting John's Template Service! |
For voice calls, the user may set a pronunciation in their Location Details settings to help guide Numa on how to properly speak your business' name.
Name | Business Hours |
Source | The operating hours of your business. Configured in your Business Hours settings |
Variable | location.hours |
Example Template | We are open: {{ location.hours }} |
Preview | We are open: Mon - Fri: 8 am - 5 pm Sat - Sun: Closed |
Name | Open/Closed Status |
Source | The current open/closed status of the business. True, if the. business is open. Configured in your Business Hours settings |
Variable | location.is_open_now |
Example Template | {% if location.is_open_now %}We are open right now.{% else %}We are closed right now.{% endif %} |
Preview | We are open right now. |
Name | Business Address |
Source | The physical address for your business, if it has one. Configured in your Location Details |
Variable | location.address |
Example Template | You can stop by our office at {{location.address}} |
Preview | You can stop by our office at 1800 Pennsylvania Ave. Washington, DC 20006 |
Name | Business Phone Number |
Source | The primary phone number for contacting your business. Configured in your Location Details |
Variable | location.phone_number |
Example Template | We'd be happy to talk with you at any time. You may call us at {{ location.phone_number }} |
Preview | We'd be happy to talk with you at any time. You may call us at 555-867-5309 |
Links
Inside your business' Location Details settings, under the Links tab. You may store common website links that you might share with customers to forms, documents, or pages that are important for your business. Numa comes with a couple of common ones built-in but you may create your own.
Name | Business Website |
Source | The website for your business. Configured in your Location Details, Links tab |
Variable | links.website |
Example Template | For more information, you may visit our website at {{ location.website_url }} |
Preview | For more information, you may visit our website at https://www.numa.com |
Link Type | Variable | Usage |
Appointments | {{ links.appointments }} | For a link to your online appointment booking or scheduler |
Directions | {{ links.directions }} | A link to Google Maps or an online mapping service |
Online Ordering | {{ links.ordering }} | A link to your website for placing orders |
Custom Links
In addition to the built-in links, you may create your own. Under the Custom links section, press the Add button. When you provide a name for the link, Numa will automatically generate a new variable name that may be used in templates. For example, if you want to send a link to your current Sales webpage, you may name the link "Sales" and Numa will create a new variable {{ links.sales }}.
Customers
Name | Customer Full Name |
Source | The full name of the customer, as it appears in Numa. Keep in mind that you need to use fallbacks in cases where the customer's name is unknown. |
Variable | customer.full_name |
Example Template | Hi {{customer.full_name}}, we look forward to helping you out today. |
Preview | Hi John Smith! We look forward to helping you out today. |
Name | Customer First Name |
Source | The first name of the customer, as it appears in Numa. Keep in mind that you need to use fallbacks in cases where the customer's name is unknown. |
Variable | customer.first_name |
Example Template | Hi {{customer.first_name}}! We look forward to helping you out today. |
Preview | Hi John! We look forward to helping you out today. |
Repair Orders
For customers using integrations with their CRM, DMS, or other third-party service tracking system, Numa can provide information related to appointments and repair orders. If multiple repair orders are in the system, Numa will either use the one triggering automation or, when ambiguous, the most recently updated repair order.
Name | Service Advisor Name |
Source | The full name of the service advisor on the repair order, if linked to Numa. The name comes from the advisor's User settings in Numa. |
Variable | advisor.name |
Example Template | Welcome to {{ location.name }}. Your advisor today will be {{ advisor.name }}. Feel free to text us with any questions. |
Preview | Welcome to Jon's Template Service. Your advisor today will be John Smith Feel free to text us with any questions. |
Name | Service Advisor First Name |
Source | The first name of the service advisor on the repair order, if linked to Numa. The name comes from the advisor's User settings in Numa. |
Variable | advisor.first_name |
Example Template | Hi, this is {{advisor.first_name}}! I'll be helping you with your service today. Just text me if you have any questions! |
Preview | Hi, this is John! I'll be helping you with your service today. Just text me if you have any questions! |
Payments
When there's an active payment for a customer, templates may use context from the payment request. If multiple payments have been requested, the most recent payment will be used in templates.
Name | Payment Net Amount |
Source | The amount for a payment request, net of any refunds. |
Variable | payment.amount |
Example Template | Your total comes out to {{ payment.amount }}. |
Preview | Your total comes out to $15.24. |
Name | Payment URL |
Source | Numa generates a secure, mobile-optimized web link for each payment request. After payment is complete, the same URL may be used to obtain a receipt. |
Variable | payment.url |
Example Template | To complete your payment, you may do so from your mobile phone on this secure website: {{ payment.url }} |
Preview | To complete your payment, you may do so from your mobile phone on this secure website: https://p.numa.com/unique_id |
Name | Payment Requested Amount |
Source | The payment amount originally requested when sending a payment request. |
Variable | payment.requested_amount |
Example Template | Your total comes out to {{ payment.requested_amount }}. |
Preview | Your total comes out to $15.24. |
Name | Payment Refunded Amount |
Source | The amount of money refunded when you issue a full or partial refund for a prior payment request. |
Variable | payment.refunded_amount |
Example Template | We've refunded you {{payment.refunded_amount}}. Please allow 3-10 days for the funds to return to your account. |
Preview | We've refunded you $13.59. Please allow 3-10 days for the funds to return to your account. |
Conversations
Within an ongoing conversation, templates may use some values about the current conversation state.
Name | Conversation Outbound Number |
Source | Sends the phone number that the customer is currently communicating with. |
Variable | conversation.business_phone |
Example Template | You can always text us at {{ conversation.business_phone }}. Thanks! |
Preview | You can always text us at 555-867-5309. Thanks! |
Name | Conversation Inbound Number |
Source | Sends the phone number of the customer currently communicating with in the conversation. |
Variable | conversation.customer_phone |
Example Template | Is {{ conversation.customer_phone }} the best number to reach you at? |
Preview | Is 555-500-5001 the best number to reach you at? |
Name | Conversation Assigned Full Name |
Source | Sends the full name of the person who currently has the conversation assigned to them in the Numa inbox. |
Variable | conversation.assigned |
Example Template | Thanks for calling today. Feel free to ask for {{conversation.assigned}} if you need any help. |
Preview | Thanks for calling today. Feel free to ask for John Smith if you need any help. |
Name | Conversation Assigned First Name |
Source | Sends the full name of the person who currently has the conversation assigned to them in the Numa inbox. |
Variable | conversation.assigned_first_name |
Example Template | Thanks for calling today. Feel free to ask for {{conversation.assigned_first_name}} if you need any help. |
Preview | Thanks for calling today. Feel free to ask for John if you need any help. |
Team Members
Numa may set template variables based on your team members and who's helping a customer in a given phone call or conversation.
Name | User's Phone Number |
Source | A user's contact phone number as configured in their User settings. |
Variable | user.phone_number |
Example Template | I'd like to talk with you later today! Please give me a call at {{ user.phone_number }}. Thanks! |
Preview | I'd like to talk with you later today! Please give me a call at 555-867-5309. Thanks! |
Name | User's Email |
Source | A user's contact email address as configured in their User settings |
Variable | user.email |
Example Template | To submit your report, please email a copy to {{ user.email }} |
Preview | To submit your report, please email a copy to john.doe@numa.com |
Name | User's First Name |
Source | A user's first name as the profile setting in their User settings |
Variable | user.first_name |
Example Template | Hi, this is {{ user.first_name }}! How can I help? |
Preview | Hi, this is John! How can I help? |
Name | User's Full Name |
Source | A user's full name as the profile setting in their User settings |
Variable | user.full_name |
Example Template | Hi, this is {{ user.full_name }}! How can I help? |
Preview | Hi, this is John Smith! How can I help? |
For voice calls, the user may set a pronunciation in their user settings that helps Numa properly pronounce their name.
Pronouns
Getting the pronouns right can be tricky and often involves more advanced templating. Numa allows users to configure their preferred pronoun in the user profile with the options of he/him, she/her, and they/them.
Name | User's Pronoun |
Source | The pronoun set by your user in their User settings |
Variable | user.pronouns |
Example Template | John isn't available right now. {{ user.pronouns }} will get back to you as soon as possible. |
Preview | John isn't available right now. He will get back to you as soon as possible. |
Situation | Template Variable | He/Him | She/Her | They/Them |
Subjective | user.subjective | he | she | they |
Objective | user.objective | him | her | them |
Possessive | user.possessive | his | hers | theirs |
Example Template
Hi, you have reached the phone of {{user.full_name | default('the team', true)}} at {{location.name}}. I'm answering because {{user.subjective | default('the team', true) }} {{ user.is | default('is', true) }} currently busy assisting others.
Preview
Hi, you have reached the phone of John at Numa. I'm answering because he is currently busy assisting others.
Verbs
For some common verbs, Numa will automatically use the plural form in a template variable based on the user's pronouns:
Verb | Template Variable | Singular | Plural |
Be | user.is | is | are |
See | user.sees | sees | see |
Text | user.texts | texts | text |
Helpful Conditionals
Changing content based on business open/closed
A frequent need is to have the way Numa answers change based on your business' current open or closed status. You can use the location.is_open_now variable with the if/else statements to acheive this.
Example Template
{% if location.is_open_now %}We are open right now{% else %}We are closed right now{% endif %}
Template Considerations
Fallbacks
There are times when using a template variable that it's possible there isn't a value for the variable. For example, if referencing a customer by name, it's possible that the customer doesn't have a name set in your Numa system. In those cases, you'll want to use a fallback to insert into your template.
In this example, we want to send a message to a customer of an automotive service center that greets the customer using the current user's first name. It's possible that the user never set a first name so we need to have a fallback:
This is {{ user.first_name | default('an advisor', true) }} at the {{ location.name }} service center.
The default("text to fallback to", true) sets the fallback to be used in case a template variable is not set. The "text to fallback" is the text to be used. The "true" will use the text if the targeted variable is either missing or blank. Setting it to "false" will only use the fallback if the variable is missing.
Advanced Templating
If you're really wanting to geek out, Numa uses the Jinja2 templating language. You may read more details about how to use advanced templating techniques on the Jinja website. Some of Numa's built-in templates use if-endif conditional statements to generate dynamic messages.