System Entities List
Objective
List of Current System Entities
Applies To
- Vonage AI Studio
Procedure
| Name of system entity | Purpose | Use case |
|
@CONTACTS
|
This is a list of contact information, including name, email, phone number, etc.
In order to make an employee list, go to "Contacts" under Properties. For more information on Contacts, please click here.
|
If you want to route the call, you need to use this entity in the RECIPIENT_NAME parameter.
(If the call should be routed to a particular contact, please include the name of the contact in the value.
If it is a required parameter waiting to be filled, you may leave the value empty.)
|
|
@sys.any
|
This entity can be filled with any value. There is no limitation to the type of input that can be classified using this entity. |
You can use this entity when you do not mind what kind of answer the caller is giving and do not need it to be saved by the agent.
Keep in mind, that because this entity is not attached to a list such as numbers or dates, the agent will not be able to read out the input in the response. $INPUT cannot be read out correctly if you use @sys.any.
|
|
@sys.date
|
This entity includes weekdays, months, years as well as actual dates.
If the caller’s input is only a weekday without the actual date, the agent will calculate the date based on the current date.
|
“I want to schedule a meeting with James on Thursday.”
“My router stopped working on the 23rd of March, 2019.”
“The last time I spoke to Customer Service was yesterday.”
|
|
@sys.time
|
@sys.time includes hours, minutes and seconds. If the caller’s input will include the hour without AM or PM, the agent will not be able to understand whether it is meant to be AM or PM.
Keep in mind that the agent will assign a time for the following user input:
Morning - 6 am
Noon - 12 pm
Afternoon - 1 pm
Evening - 6 pm
|
“I would like to schedule for 12 pm.”
“I am available around noon.” (This will be 12 pm)
|
|
@sys.names
|
A list of names based on common names in English speaking countries.
If not being filled in the first prompt, the parameter will fill with any value, not just names. Some caller names might be very particular, so the agent will also accept those in the second prompt.
|
“My name is Betty.”
“I would like to be called John.”
|
|
@sys.number
|
This entity includes all numbers.
For phone numbers, it is recommended to use the @sys.phone-number entity. Be aware that the agent will read out the number as a whole and not as digits. Even if the caller gives the number in digits “5 - 0 - 0”, the agent will only be able to read it out as a whole number “Fivehundred”.
|
“I need to order two tickets.”
“I live in Saint Anne Boulevard 31.”
|
|
@sys.time-frame
|
Using this entity you can refer to a time frame. |
“I spent two hours at the supermarket.”
“I would like to rent a car for two days.”
|
|
@sys.phone-number
|
You can collect a phone number using this entity. This requires the user to provide their phone number including the country code. If missing, the agent will prompt the caller again. After two failed attempts it will go to the fallback intent. |
“My phone number is
+972583372627.”
|
|
@sys.web-url
|
This entity can collect a URL in the following format “www.weburl.com”. If the “www” or the “.com” is missing, the agent will prompt the caller again. After two failed attempts it will go to the fallback intent. | “My company’s website is www.companyexamplesite.com.” |
|
@sys.email
|
You can collect an email address from your caller. The “@” sign is mandatory. | “My email address is annie.maxton@gmail.com.” |
|
@sys.countries
|
A list of all countries in the world. | “I am from England.” |
|
@sys.industries
|
This entity includes a list of a few industries, such as insurance, telecommunications, healthcare, etc. | “I work in the insurance sector.” |
|
@sys.cities
|
A list of all main global cities. | “I am a resident of Berlin.” |
|
@sys.digits
|
The agent will be able to read out the number collected as digits. If the caller gave the input “Five Hundred”, the agent will read it out as digits “5 - 0 - 0”. | |
|
@sys.confirmation
|
If the agent prompts the caller a yes or no question, you can use this parameter to collect values such as yes, no, maybe, and related synonyms. |
“Do you regularly use your air conditioning unit?” - “Sure.”
“Did you ever experience trouble using the support chat on our website?” - “Not really.”
|
|
@sys.serial-number
|
This enables the agent to accept a mix of English letters and numbers | “My serial number is 08C2LFM887” |
|
@sys.states-US
|
A list of all US states. | |
|
@sys.cities-US
|
A list of all major US cities. |
Comments
0 comments
Article is closed for comments.