Settings
Name (Label) |
Type |
Req'd |
Single Setting Value |
Sub. Allowed |
Default |
Notes |
||||
inputmode (Input Mode) |
string enum |
Yes |
|
|
|
The type of
entry allowed for input during confirmation. Possible values are:
|
||||
noinput_timeout (Noinput Timeout) |
string |
Yes |
|
|
5s |
The maximum time allowed for silence or no keypress before a noinput event is thrown. Possible values are standard time designations including both a non-negative number and a time unit, for example, 3s (for seconds) or 3000ms (for milliseconds). Default = 5s. |
||||
record_max_noinput_count (Record Max NoInput Count) |
int ≥ 0 |
Yes |
|
|
3 |
The maximum number of noinput events allowed during input capture. 0 = infinite noinputs allowed. |
||||
confirm_max_noinput_count (Confirm Max NoInput Count) |
int ≥ 0 |
Yes |
|
|
3 |
The maximum number of noinput events allowed during confirmation. 0 = infinite noinputs allowed. |
||||
confirm_max_nomatch_count (Confirm Max NoMatch Count) |
int ≥ 0 |
Yes |
|
|
3 |
The maximum number of nomatch events allowed during confirmation. 0 = infinite nomatches allowed. |
||||
max_disconfirmed_count (Max Disconfirmed Count) |
int ≥ 0 |
Yes |
|
|
3 |
The maximum number of times a caller is allowed to reject a recording. 0 = infinite disconfirmations allowed.
|
||||
confirm_confidence_level (Confirm Confidence Level) |
decimal (0.0 – 1.0) |
Yes |
|
|
0.50 |
The confidence level threshold to use for the confirmation. |
||||
start_with_beep (Start With Beep) |
boolean |
Yes |
|
|
|
Whether or not to play a beep before recording begins. |
||||
terminate_on_dtmf (Terminate On DTMF) |
boolean |
Yes |
|
|
|
Whether or not the caller can end the recording by pressing a touchtone key. |
||||
keep_recording_on_hangup (Keep Recording On Hangup) |
boolean |
Yes |
|
|
|
Whether or not the recording is stored if the caller hung up while making the recording or during the confirmation menu. Default = false. |
||||
max_record_time (Max Record Time) |
string |
Yes |
|
|
180s |
The maximum time (in seconds) the recording is allowed to last. Possible values are standard time designations including a positive integer followed by s (for seconds), for example, 30s. Default = 180s. |
||||
final_silence (Final Silence) |
string |
Yes |
|
|
4s |
|
||||
replay (Replay) |
boolean |
Yes |
|
|
|
Adds an option to replay the confirm initial audio groups. |
||||
filename (Filename) |
string |
No |
|
|
None |
The filename of the recording (without extension). If left blank, an auto-generated filename will be used. |
||||
file_type (File Type) |
string enum |
Yes |
|
|
|
This
specifies the audio type of the file that will hold the recording. Possible
values are:
|
||||
mime_type (Mime Type) |
string |
Yes |
|
|
None |
This
specifies the MIME type of the file that will hold the recording, if file_type
is set to
|
||||
file_extension (File Extension) |
string |
No |
|
|
None |
This
specifies the file extension to use for the recorded file. A file extension
different from the file type can be used. For example, with a mime type of
|
||||
path (Path) |
string |
No |
|
|
None |
The path to the file that will hold the recording. Either the path, ftp host, or both must be specified. |
||||
ftp_host (FTP Host) |
string |
No |
|
|
None |
The domain name of the host to FTP the recording. Either the path, ftp host, or both must be specified. |
||||
Secure (Secure) |
boolean |
Yes |
|
|
|
Whether or not to enable Secure File Transfer protocol (SFTP). Default = false, indicates file transfer happens over FTP by default. |
||||
ftp_user (FTP User) |
string |
Yes |
|
|
None |
The user name to use while FTPing the recording, if ftp_host is set. |
||||
ftp_password (FTP Password) |
string |
Yes |
|
|
None |
The password to use while FTPing the recording, if ftp_host is set. |
||||
ftp_path (FTP Path) |
string |
No |
|
|
None |
The directory in which to FTP the recording, if ftp_host is set. |
||||
ftp_in_background (FTP In Background) |
boolean |
Yes |
|
|
|
Whether or not the FTP is to be performed in the background, if ftp_host is set. |
|