ViciDial/ViciDialSVN
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Updated HELP text for AMD status maps

Browse Source 
git-svn-id: svn://192.168.202.10@4006 3d104415-ff17-0410-8863-d5cf3c621b8a
This commit is contained in:
mattf
2026-07-24 12:14:13 +00:00
parent 97cb244710
commit b551029ea5
1 changed files with 3 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files
agc_2-X/trunk/www/vicidial/help_documentation.txt
+3 -3
View File
@@ -1,4 +1,4 @@
# version: 20260620163401 # version: 20260724081001
users-user User ID <QXZ>This field is where you put the users ID number, can be up to 20 digits in length, Must be at least 2 characters in length. We strongly recommend not reusing user accounts for different users, for reporting accuracy. To disable a user account, set the Active option to -N-.</QXZ> users-user User ID <QXZ>This field is where you put the users ID number, can be up to 20 digits in length, Must be at least 2 characters in length. We strongly recommend not reusing user accounts for different users, for reporting accuracy. To disable a user account, set the Active option to -N-.</QXZ>
users-pass Password <QXZ>This field is where you put the users password. Must be at least 2 characters in length, unless the User Password Minimum Length system setting is enabled, which will require a longer password. Only letters and numbers are allowed in user passwords. A medium strength user password will be at least 10 characters in length, and a strong user password will be at least 20 characters in length and have letters as well as at least one number. It is recommended that you use a longer password if possible, stringing together several unrelated words with no spaces, and a number somewhere in the string. The maximum size of a password is 100 characters.</QXZ> users-pass Password <QXZ>This field is where you put the users password. Must be at least 2 characters in length, unless the User Password Minimum Length system setting is enabled, which will require a longer password. Only letters and numbers are allowed in user passwords. A medium strength user password will be at least 10 characters in length, and a strong user password will be at least 20 characters in length and have letters as well as at least one number. It is recommended that you use a longer password if possible, stringing together several unrelated words with no spaces, and a number somewhere in the string. The maximum size of a password is 100 characters.</QXZ>
users-force_change_password Force Change Password <QXZ>If this option is set to Y then the user will be prompted to change their password the next time they log in to the administration webpage or the agent screen. Default is N.</QXZ> users-force_change_password Force Change Password <QXZ>If this option is set to Y then the user will be prompted to change their password the next time they log in to the administration webpage or the agent screen. Default is N.</QXZ>
@@ -204,7 +204,7 @@ campaigns-amd_type AMD Type <QXZ>This setting allows you to define the type of A
campaigns-amd_send_to_vmx AMD send to Action <QXZ>This option allows you to define whether a call is sent to the Answering Machine Message or CPD AMD Action when an answering machine is detected, or if it is hung up. If this is set to N, then the call will be hung up as soon as it is determined to be an answering machine. Default is N.</QXZ> campaigns-amd_send_to_vmx AMD send to Action <QXZ>This option allows you to define whether a call is sent to the Answering Machine Message or CPD AMD Action when an answering machine is detected, or if it is hung up. If this is set to N, then the call will be hung up as soon as it is determined to be an answering machine. Default is N.</QXZ>
campaigns-amd_agent_route_options AMD Agent Route Options <QXZ>If enabled and you are using Asterisk AMD, this setting will allow you to define the AMD statuses and responses for calls going through AMD that will be sent to agents, overriding the default which sends all HUMAN and NOTSURE status calls to agents. To see the AMD statuses and responses for the calls that have been logged on your system, go to the AMD Log Report on the Admin Utilities page. The PENDING option for this setting will allow you to click on this option to go to the Modify Settings Container page to edit the settings without making them active yet. Default is DISABLED. There is also a special option you can enable in this settings container, NOAUDIODATA-Hangup-ENABLED, which will enable the immediate hangup of calls that have no audio data when they reach the AMD routing script. There are also FAX-Hangup-ENABLED and FAS-Hangup-ENABLED options to perform immediate hangups for FAX and FAS detected calls. The Settings Container for these options allow for multiple lines of settings, with each line containing one AMD status-response pair each separated by a comma. For example:</QXZ><BR>HUMAN,HUMAN<BR>NOTSURE,TOOLONG<BR> campaigns-amd_agent_route_options AMD Agent Route Options <QXZ>If enabled and you are using Asterisk AMD, this setting will allow you to define the AMD statuses and responses for calls going through AMD that will be sent to agents, overriding the default which sends all HUMAN and NOTSURE status calls to agents. To see the AMD statuses and responses for the calls that have been logged on your system, go to the AMD Log Report on the Admin Utilities page. The PENDING option for this setting will allow you to click on this option to go to the Modify Settings Container page to edit the settings without making them active yet. Default is DISABLED. There is also a special option you can enable in this settings container, NOAUDIODATA-Hangup-ENABLED, which will enable the immediate hangup of calls that have no audio data when they reach the AMD routing script. There are also FAX-Hangup-ENABLED and FAS-Hangup-ENABLED options to perform immediate hangups for FAX and FAS detected calls. The Settings Container for these options allow for multiple lines of settings, with each line containing one AMD status-response pair each separated by a comma. For example:</QXZ><BR>HUMAN,HUMAN<BR>NOTSURE,TOOLONG<BR>
campaigns-amd_agent_display ViciAMD Agent Display <QXZ>If enabled, and you are using the ViciAMD AMD-Type, then this feature will show the AMDSTATUS, AMDCAUSE and the transcribed customer side of the beginning of the outbound phone call to the agent on the agent screen as soon as the call is routed to the agent. Default is DISABLED.</QXZ> campaigns-amd_agent_display ViciAMD Agent Display <QXZ>If enabled, and you are using the ViciAMD AMD-Type, then this feature will show the AMDSTATUS, AMDCAUSE and the transcribed customer side of the beginning of the outbound phone call to the agent on the agent screen as soon as the call is routed to the agent. Default is DISABLED.</QXZ>
campaigns-amd_status_map AMD Status Map <QXZ>If your campaign is using AMD, and this setting is set to a valid AMD_STATUS_MAP Settings Container, then the status used for AMD-flagged calls that do not go to an agent will use the statuses defined for each AMD-status and AMD-cause as defined in the selected settings container. You can also set a default status to be used for an AMD-status overall if you do not have an AMD-cause defined for that AMD-status. If this setting is not active, then the system will default to using the System Settings AMD Status Map, if one is set. Default is DISABLED. Here is an example of what the settings container should look like:<br>MACHINE,* => VAMMAC<br>MACHINE,MAXWORDS => VAMMAC<br>NOTSURE,* => VAMNS<br>NOTSURE,HANGUP => VAMNS<br>NOTSURE,LOWCONFIDENCE => VAMNS campaigns-amd_status_map AMD Status Map <QXZ>If your campaign is using AMD, and this setting is set to a valid AMD_STATUS_MAP Settings Container, then the status used for AMD-flagged calls that do not go to an agent will use the statuses defined for each AMD-status and AMD-cause as defined in the selected settings container. You can also set a default status to be used for an AMD-status overall if you do not have an AMD-cause defined for that AMD-status. The AMD Status Map will override the old AM and AL statuses of a message being played, unless you add -KEEP-AL-AM-STATUSES- to a line in the AMD status map. If this setting is not active, then the system will default to using the System Settings AMD Status Map, if one is set. Default is DISABLED. Here is an example of what the settings container should look like:<br>MACHINE,* => VAMMAC<br>MACHINE,MAXWORDS => VAMMAC<br>NOTSURE,* => VAMNS<br>NOTSURE,HANGUP => VAMNS<br>NOTSURE,LOWCONFIDENCE => VAMNS
</QXZ> </QXZ>
campaigns-cpd_amd_action CPD AMD Action <QXZ>If you are using the Sangoma ParaXip Call Progress Detection software then you will want to enable this setting either setting it to DISPO which will disposition the call as AA and hang it up if the call is being processed and has not been sent to an agent yet or MESSAGE which will send the call to the defined Answering Machine Message for this campaign. Default is DISABLED. Setting this to INGROUP will send an answering machine to an inbound group. Setting this to CALLMENU will send an answering machine to a Call Menu in the system.</QXZ> campaigns-cpd_amd_action CPD AMD Action <QXZ>If you are using the Sangoma ParaXip Call Progress Detection software then you will want to enable this setting either setting it to DISPO which will disposition the call as AA and hang it up if the call is being processed and has not been sent to an agent yet or MESSAGE which will send the call to the defined Answering Machine Message for this campaign. Default is DISABLED. Setting this to INGROUP will send an answering machine to an inbound group. Setting this to CALLMENU will send an answering machine to a Call Menu in the system.</QXZ>
campaigns-cpd_unknown_action CPD Unknown Action <QXZ>If you are using the Sangoma ParaXip Call Progress Detection software and you want to send calls that have an Unknown result to a destination other than an agent, then you will want to enable this setting either setting it to DISPO which will disposition the call as AA and hang it up if the call is being processed and has not been sent to an agent yet or MESSAGE which will send the call to the defined Answering Machine Message for this campaign. Default is DISABLED. Setting this to INGROUP will send an answering machine to an inbound group. Setting this to CALLMENU will send an answering machine to a Call Menu in the system.</QXZ> campaigns-cpd_unknown_action CPD Unknown Action <QXZ>If you are using the Sangoma ParaXip Call Progress Detection software and you want to send calls that have an Unknown result to a destination other than an agent, then you will want to enable this setting either setting it to DISPO which will disposition the call as AA and hang it up if the call is being processed and has not been sent to an agent yet or MESSAGE which will send the call to the defined Answering Machine Message for this campaign. Default is DISABLED. Setting this to INGROUP will send an answering machine to an inbound group. Setting this to CALLMENU will send an answering machine to a Call Menu in the system.</QXZ>
@@ -1191,7 +1191,7 @@ settings-manual_dial_phone_strip Manual Dial Phone Prefix Strip <QXZ>If not DISA
settings-agent_man_dial_filter Agent Manual Dialstring Filter <QXZ>This setting allows you to filter characters from the agent screen manual dial dialstrings before calls are placed. This works by using the following character combinations to denote what to filter out of the dialstring:<br>DO - Digits only, filter out everything that is not a digit<br>DPO - Digits and plus sign only, filter out everything that is not a digit or a plus sign<br>DLO - Digits and letters only, filter out everything that is not a digit or letter<br>DLPO - Digits and letters and plus sign only, filter out everything that is not a digit or letter or a plus sign<br>L1 - Remove leading 1, remove the digit 1 from the beginning of the dialstring<br>L0 - Remove leading 0, remove the digit 1 from the beginning of the dialstring<br>R10 - Only dial the right 10 characters from the dialstring<br>NOTE: You can use a combination of the above filters together, separated by dashes, for example: DO-L1 for Digits-only and remove leading 1. Default is blank for disabled.</QXZ> settings-agent_man_dial_filter Agent Manual Dialstring Filter <QXZ>This setting allows you to filter characters from the agent screen manual dial dialstrings before calls are placed. This works by using the following character combinations to denote what to filter out of the dialstring:<br>DO - Digits only, filter out everything that is not a digit<br>DPO - Digits and plus sign only, filter out everything that is not a digit or a plus sign<br>DLO - Digits and letters only, filter out everything that is not a digit or letter<br>DLPO - Digits and letters and plus sign only, filter out everything that is not a digit or letter or a plus sign<br>L1 - Remove leading 1, remove the digit 1 from the beginning of the dialstring<br>L0 - Remove leading 0, remove the digit 1 from the beginning of the dialstring<br>R10 - Only dial the right 10 characters from the dialstring<br>NOTE: You can use a combination of the above filters together, separated by dashes, for example: DO-L1 for Digits-only and remove leading 1. Default is blank for disabled.</QXZ>
settings-agent_3way_dial_filter Agent 3-Way Dialstring Filter <QXZ>This setting allows you to filter characters from the agent screen 3-way dial dialstrings before calls are placed. This works by using the following character combinations to denote what to filter out of the 3-way call dialstring:<br>DO - Digits only, filter out everything that is not a digit<br>DPO - Digits and plus sign only, filter out everything that is not a digit or a plus sign<br>DLO - Digits and letters only, filter out everything that is not a digit or letter<br>DLPO - Digits and letters and plus sign only, filter out everything that is not a digit or letter or a plus sign<br>L1 - Remove leading 1, remove the digit 1 from the beginning of the dialstring<br>L0 - Remove leading 0, remove the digit 1 from the beginning of the dialstring<br>R10 - Only dial the right 10 characters from the dialstring<br>NOTE: You can use a combination of the above filters together, separated by dashes, for example: DO-L1 for Digits-only and remove leading 1. Default is blank for disabled.</QXZ> settings-agent_3way_dial_filter Agent 3-Way Dialstring Filter <QXZ>This setting allows you to filter characters from the agent screen 3-way dial dialstrings before calls are placed. This works by using the following character combinations to denote what to filter out of the 3-way call dialstring:<br>DO - Digits only, filter out everything that is not a digit<br>DPO - Digits and plus sign only, filter out everything that is not a digit or a plus sign<br>DLO - Digits and letters only, filter out everything that is not a digit or letter<br>DLPO - Digits and letters and plus sign only, filter out everything that is not a digit or letter or a plus sign<br>L1 - Remove leading 1, remove the digit 1 from the beginning of the dialstring<br>L0 - Remove leading 0, remove the digit 1 from the beginning of the dialstring<br>R10 - Only dial the right 10 characters from the dialstring<br>NOTE: You can use a combination of the above filters together, separated by dashes, for example: DO-L1 for Digits-only and remove leading 1. Default is blank for disabled.</QXZ>
settings-xfer_min_container Transfer Talk Minimum Container <QXZ>If Allow Closers is enabled on a campaign, and one of the In-Groups that agents are sending calls to has its Transfer Talk Minimum features enabled, then this XFER_TALK_MIN_MESSAGE type container can be used to override the default message the agent receives when they attempt to transfer a call to an In-Group before it has reached its talk time minimum. This agent alert message can use the following variables: --A--group_id--B--, --A--group_name--B--, --A--talk_sec_minimum--B--. The default for this option is blank for disabled, and the default message the agent would receive is: <br><i>This transfer In-Group has a minimum talk-time threshold of X seconds. You cannot transfer to this In-Group until your talk time reaches that length.</i></QXZ> settings-xfer_min_container Transfer Talk Minimum Container <QXZ>If Allow Closers is enabled on a campaign, and one of the In-Groups that agents are sending calls to has its Transfer Talk Minimum features enabled, then this XFER_TALK_MIN_MESSAGE type container can be used to override the default message the agent receives when they attempt to transfer a call to an In-Group before it has reached its talk time minimum. This agent alert message can use the following variables: --A--group_id--B--, --A--group_name--B--, --A--talk_sec_minimum--B--. The default for this option is blank for disabled, and the default message the agent would receive is: <br><i>This transfer In-Group has a minimum talk-time threshold of X seconds. You cannot transfer to this In-Group until your talk time reaches that length.</i></QXZ>
settings-amd_status_map AMD Status Map <QXZ>If a campaign is using AMD, and this setting is set to a valid AMD_STATUS_MAP Settings Container and the campaign does not have its own AMD Status Map defined, then the status used for AMD-flagged calls that do not go to an agent will use the statuses defined for each AMD-status and AMD-cause as defined in the selected settings container. You can also set a default status to be used for an AMD-status overall if you do not have an AMD-cause defined for that AMD-status. If this container is not defined in the system or campaign, then the system will default to using AA, AM and AL as the AMD statuses. Default is DISABLED. Here is an example of what the settings container should look like:<br>MACHINE,* => VAMMAC<br>MACHINE,MAXWORDS => VAMMAC<br>NOTSURE,* => VAMNS<br>NOTSURE,HANGUP => VAMNS<br>NOTSURE,LOWCONFIDENCE => VAMNS settings-amd_status_map AMD Status Map <QXZ>If a campaign is using AMD, and this setting is set to a valid AMD_STATUS_MAP Settings Container and the campaign does not have its own AMD Status Map defined, then the status used for AMD-flagged calls that do not go to an agent will use the statuses defined for each AMD-status and AMD-cause as defined in the selected settings container. You can also set a default status to be used for an AMD-status overall if you do not have an AMD-cause defined for that AMD-status. If this container is not defined in the system or campaign, then the system will default to using AA, AM and AL as the AMD statuses. The AMD Status Map will override the old AM and AL statuses of a message being played, unless you add -KEEP-AL-AM-STATUSES- to a line in the AMD status map. Default is DISABLED. Here is an example of what the settings container should look like:<br>MACHINE,* => VAMMAC<br>MACHINE,MAXWORDS => VAMMAC<br>NOTSURE,* => VAMNS<br>NOTSURE,HANGUP => VAMNS<br>NOTSURE,LOWCONFIDENCE => VAMNS
settings-allow_custom_dialplan Allow Custom Dialplan Entries <QXZ>This option allows you to enter custom dialplan lines into Call Menus, Servers and System Settings. Default is 0 for inactive.</QXZ> settings-allow_custom_dialplan Allow Custom Dialplan Entries <QXZ>This option allows you to enter custom dialplan lines into Call Menus, Servers and System Settings. Default is 0 for inactive.</QXZ>
settings-pllb_grouping_limit PLLB Grouping Limit <QXZ>Phone Login Load Balancing Grouping Limit. If PLLB Grouping is set to CASCADING at the campaign level then this setting will determine the number of agents acceptable on each server across all campaigns. Default is 100.</QXZ> settings-pllb_grouping_limit PLLB Grouping Limit <QXZ>Phone Login Load Balancing Grouping Limit. If PLLB Grouping is set to CASCADING at the campaign level then this setting will determine the number of agents acceptable on each server across all campaigns. Default is 100.</QXZ>
settings-generate_cross_server_exten Generate Cross-Server Phone Extensions <QXZ>This option if set to 1 will generate dialplan entries for every phone on a multi-server system. Default is 0 for inactive.</QXZ> settings-generate_cross_server_exten Generate Cross-Server Phone Extensions <QXZ>This option if set to 1 will generate dialplan entries for every phone on a multi-server system. Default is 0 for inactive.</QXZ>