ai.params

Parameters for AI that can be passed in ai.params at the top level of the ai Method.

Parameters

Name	Type	Required?	Default	Description
acknowledge_interruptions	boolean or string	Optional		Instructs the agent to acknowledge crosstalk and confirm user input when the user speaks over the agent.
ai_volume	integer	Optional	0 (the natural volume of the AI)	Adjust the volume of the AI. Allowed values from -50-50.
attention_timeout	integer	Optional	10000 ms (10 seconds)	Amount of time, in ms, to wait before prompting the user to respond. Allowed values from 10,000-600,000. Set to 0 to disable.
background_file	string	Optional	600000 ms (10 minutes)	URL of audio file to play in the background while AI plays in foreground.
background_file_loops	integer	Optional	undefined (loops indefinitely)	Maximum number of times to loop playing the background file.
background_file_volume	string	Optional		Defines background_file volume within a range of -50 to +50.
barge_match_string	string	Optional		Takes a string, including a regular expression, defining barge behavior. For example, this param can direct the AI to stop when the word "hippopotomus" is input.
barge_min_words	string	Optional		Defines the number of words that must be input before triggering barge behavior, in a range of 1-99.
conscience	string	Optional		Sets the prompt which binds the agent to its purpose.
conversation_id	string	Optional		Used by check_for_input and save_conversation to identify an individual conversation.
debug_webhook_level	boolean	Optional		Enables debugging to the set URL. If a URL is set, this param defaults to 1.
debug_webhook_url	string	Optional		Each interaction between the AI and end user is posted in real time to the established URL.
direction	string	Optional	the natural direction of the call	Forces the direction of the call to the assistant. Valid values are inbound and outbound.
digit_terminators	string	Optional		DTMF digit, as a string, to signal the end of input (ex: "#")
digit_timeout	integer	Optional	3000 ms	Time, in ms, at the end of digit input to detect end of input. Allowed values from 250-10,000.
end_of_speech_timeout	integer	Optional	2000 ms (2 seconds)	Amount of silence, in ms, at the end of an utterance to detect end of speech. Allowed values from 250-10,000.
energy_level	number	Optional	52	Amount of energy necessary for bot to hear you (in dB). Allowed values from 0.0-100.0.
hold_music	string	Optional		A URL for the hold music to play, accepting WAV, mp3, and FreeSWITCH tone_stream.
hold_on_process	boolean	Optional		Enables hold music during SWAIG processing.
inactivity_timeout	integer	Optional	600000 ms (10 minutes)	Amount of time, in ms, to wait before exiting the app due to inactivity. Allowed values from 10,000-3,600,000.
input_poll_freq	string	Optional		Check for input function with check_for_input. Example use case: Feeding an inbound SMS to AI on a voice call, eg., for collecting an email address or other complex information.
interrupt_on_noise	boolean	Optional		When enabled, barges agent upon any sound interruption longer than 1 second.
interrupt_prompt	string	Optional		Provide a prompt for the agent to handle crosstalk.
languages_enabled	boolean	Optional		Allows multilingualism when true.
local_tz	string	Optional	GMT	The local timezone setting for the AI. Value should use IANA TZ ID
outbound_attention_timeout	string	Optional		Sets a time duration for the outbound call recipient to respond to the AI agent before timeout, in a range from 10000 to 600000.
save_conversation	boolean	Optional	false	Send a summary of the conversation after the call ends. This requires a post_url to be set in the ai parameters and the conversation_id defined below. This eliminates the need for a post_prompt in the ai parameters.
swaig_allow_settings	boolean	Optional		Allows tweaking any of the indicated settings, such as barge_match_string, using the returned SWML from the SWAIG function.
swaig_allow_swml	boolean	Optional		Allows your SWAIG to return SWML to be executed.
swaig_post_conversation	boolean	Optional		Post entire conversation to any SWAIG call.
transfer_summary	boolean	Optional		Pass a summary of a conversation from one AI agent to another. For example, transfer a call summary between support agents in two departments.
verbose_logs	boolean	Optional		Enable verbose logging.
wait_for_user	boolean	Optional	false	When false, AI agent will initialize dialogue after call is setup. When true, agent will wait for the user to speak first.