Jump to: navigation, search
Line 9: Line 9:
 
* Valid Values: Any available [[Outbound#outbound.call-result-values|call result value]].
 
* Valid Values: Any available [[Outbound#outbound.call-result-values|call result value]].
 
* Changes take effect: At the next interaction.
 
* Changes take effect: At the next interaction.
* Description: Specifies the call result to be selected by default for outbound records. The specified call result must be defined by the values that are specified for the <tt>outbound.call-result-values</tt> option. If set to an empty value, the current call result of the outbound record is selected, or unknown is selected if there is no current value.
+
* Description: Specifies the call result to be selected by default for outbound records. The specified call result must be defined by the values that are specified for the <tt>outbound.call-result-values</tt> option. If set to an empty value, the current call result of the outbound record is selected, or unknown is selected if there is no current value. Has a dependency on <tt>[[Outbound#privilege.outbound.can-use|privilege.outbound.can-use]]</tt>.
  
 
====outbound.call-result-values====
 
====outbound.call-result-values====
Line 15: Line 15:
 
*Valid Values: One or more items from the following list: <tt>Abandoned</tt> (Abandoned), <tt>AgentCallbackError</tt> (Agent Callback Error), <tt>AllTrunksBusy</tt> (All Trunks Busy), <tt>Answered</tt> (Answered), <tt>AnsweringMachine</tt> (Answering Machine), <tt>Busy</tt> (Busy), <tt>CallDropError</tt> (Call Drop Error), <tt>DialError</tt> (Dial Error), <tt>DoNotCall</tt> (Do Not Call), <tt>Dropped</tt> (Dropped), <tt>DroppedNoAnswer</tt> (Dropped No Answer), <tt>FaxDetected</tt> (Fax Detected), <tt>GeneralError</tt> (General Error), <tt>GroupCallbackError</tt> (Group Callback Error), <tt>NoAnswer</tt> (No Answer), <tt>NoDialTone</tt> (No Dial Tone), <tt>NoEstablished</tt> (No Established), <tt>NoFreePortError</tt> (No Free Port Error), <tt>NoProgress</tt> (No Progress), <tt>NoRingback</tt> (No Ringback), <tt>NuTone</tt> (Nu Tone), <tt>Ok</tt> (Ok), <tt>PagerDetected</tt> (Pager Detected), <tt>Silence</tt> (Silence), <tt>SitDetected</tt> (Sit Detected), <tt>SitInvalidNum</tt> (Sit Invalid Num), <tt>SitNoCircuit</tt> (Sit No Circuit), <tt>SitOperintercept</tt> (Sit Operintercept), <tt>SitReorder</tt> (Sit Reorder), <tt>SitUnknown</tt> (Sit Unknown), <tt>SitVacant</tt> (Sit Vacant), <tt>Stale</tt> (Stale), <tt>SwitchError</tt> (Switch Error), <tt>SystemError</tt> (System Error), <tt>TransferError</tt> (Transfer Error), <tt>Unknown</tt> (Unknown), <tt>WrongNumber</tt> (Wrong Number), <tt>WrongParty</tt> (Wrong Party)
 
*Valid Values: One or more items from the following list: <tt>Abandoned</tt> (Abandoned), <tt>AgentCallbackError</tt> (Agent Callback Error), <tt>AllTrunksBusy</tt> (All Trunks Busy), <tt>Answered</tt> (Answered), <tt>AnsweringMachine</tt> (Answering Machine), <tt>Busy</tt> (Busy), <tt>CallDropError</tt> (Call Drop Error), <tt>DialError</tt> (Dial Error), <tt>DoNotCall</tt> (Do Not Call), <tt>Dropped</tt> (Dropped), <tt>DroppedNoAnswer</tt> (Dropped No Answer), <tt>FaxDetected</tt> (Fax Detected), <tt>GeneralError</tt> (General Error), <tt>GroupCallbackError</tt> (Group Callback Error), <tt>NoAnswer</tt> (No Answer), <tt>NoDialTone</tt> (No Dial Tone), <tt>NoEstablished</tt> (No Established), <tt>NoFreePortError</tt> (No Free Port Error), <tt>NoProgress</tt> (No Progress), <tt>NoRingback</tt> (No Ringback), <tt>NuTone</tt> (Nu Tone), <tt>Ok</tt> (Ok), <tt>PagerDetected</tt> (Pager Detected), <tt>Silence</tt> (Silence), <tt>SitDetected</tt> (Sit Detected), <tt>SitInvalidNum</tt> (Sit Invalid Num), <tt>SitNoCircuit</tt> (Sit No Circuit), <tt>SitOperintercept</tt> (Sit Operintercept), <tt>SitReorder</tt> (Sit Reorder), <tt>SitUnknown</tt> (Sit Unknown), <tt>SitVacant</tt> (Sit Vacant), <tt>Stale</tt> (Stale), <tt>SwitchError</tt> (Switch Error), <tt>SystemError</tt> (System Error), <tt>TransferError</tt> (Transfer Error), <tt>Unknown</tt> (Unknown), <tt>WrongNumber</tt> (Wrong Number), <tt>WrongParty</tt> (Wrong Party)
 
*Changes take effect: At the next interaction.
 
*Changes take effect: At the next interaction.
*Description: Specifies the list of call results that are available for the agent to use for an outbound interaction. The call results are displayed in the order in which they appear in the list.
+
*Description: Specifies the list of call results that are available for the agent to use for an outbound interaction. The call results are displayed in the order in which they appear in the list. Has a dependency on <tt>[[Outbound#privilege.outbound.can-use|privilege.outbound.can-use]]</tt>.
  
 
====outbound-callback.ringing-bell====
 
====outbound-callback.ringing-bell====
Line 25: Line 25:
 
**<tt>0</tt> &mdash; play the whole sound once
 
**<tt>0</tt> &mdash; play the whole sound once
 
**an integer greater than <tt>0</tt> &mdash; the length of time, in milliseconds, to play and repeat the sound
 
**an integer greater than <tt>0</tt> &mdash; the length of time, in milliseconds, to play and repeat the sound
 
+
: Has a dependency on <tt>[[Outbound#privilege.outbound.can-use|privilege.outbound.can-use]]</tt>.
 
====outbound.preview.max-simultaneous-preview-record====
 
====outbound.preview.max-simultaneous-preview-record====
 
* Default Values: <tt>-1</tt>
 
* Default Values: <tt>-1</tt>
 
* Valid Values: An integer.  
 
* Valid Values: An integer.  
 
* Changes take effect: When the session is started or restarted.
 
* Changes take effect: When the session is started or restarted.
* Description: Specifies the maximum number of simultaneous Outbound Preview records an agent can view in the interaction window. A <tt>0</tt> or a negative value indicates no limit.
+
* Description: Specifies the maximum number of simultaneous Outbound Preview records an agent can view in the interaction window. A <tt>0</tt> or a negative value indicates no limit. Has a dependency on <tt>[[Outbound#privilege.outbound.can-use|privilege.outbound.can-use]]</tt>.
 
<!--
 
<!--
 
====outbound.preview.validation.http-response-timeout====
 
====outbound.preview.validation.http-response-timeout====
Line 36: Line 36:
 
* Valid Values: A positive integer.
 
* Valid Values: A positive integer.
 
* Changes take effect: When the session is started or restarted.
 
* Changes take effect: When the session is started or restarted.
* Description: Defines the maximum time, in seconds, that Workspace waits for a response from the pre-dial validation service (see [[Outbound#outbound.preview.validation.url|outbound.preview.validation.url]]).
+
* Description: Defines the maximum time, in seconds, that Workspace waits for a response from the pre-dial validation service (see [[Outbound#outbound.preview.validation.url|outbound.preview.validation.url]]). Has a dependency on <tt>[[Outbound#privilege.outbound.can-use|privilege.outbound.can-use]]</tt>.
  
 
====outbound.preview.validation.timeout-call-result====
 
====outbound.preview.validation.timeout-call-result====
Line 42: Line 42:
 
* Valid Values: The call result enumeration value (as defined in the "Call Result Types" table in the {{Repository|81ou_ref.pdf|f7675552-8d66-4283-81df-f22ede9e3825|Outbound Contact 8.1 Reference Manual}}.)
 
* Valid Values: The call result enumeration value (as defined in the "Call Result Types" table in the {{Repository|81ou_ref.pdf|f7675552-8d66-4283-81df-f22ede9e3825|Outbound Contact 8.1 Reference Manual}}.)
 
* Changes take effect: When the session is started or restarted.
 
* Changes take effect: When the session is started or restarted.
* Description: Specifies the call result value that is assigned to the dial attempt if pre-dial validation is turned on and Worksapce does not receive an HTTP response for the validation request within the specified timeout (defined in the [[Outbound#outbound.preview.validation.http-response-timeout|outbound.preview.validation.http-response-timeout]] option).
+
* Description: Specifies the call result value that is assigned to the dial attempt if pre-dial validation is turned on and Workspace does not receive an HTTP response for the validation request within the specified timeout (defined in the [[Outbound#outbound.preview.validation.http-response-timeout|outbound.preview.validation.http-response-timeout]] option). Has a dependency on <tt>[[Outbound#privilege.outbound.can-use|privilege.outbound.can-use]]</tt>.
  
 
====outbound.preview.validation.url====
 
====outbound.preview.validation.url====
Line 48: Line 48:
 
* Valid Values: The valid URL of a service that validates phone numbers.
 
* Valid Values: The valid URL of a service that validates phone numbers.
 
* Changes take effect: When the session is started or restarted.
 
* Changes take effect: When the session is started or restarted.
* Description: Specifies the URL of a pre-dial validation service for the Preview campaign.-->
+
* Description: Specifies the URL of a pre-dial validation service for the Preview campaign. Has a dependency on <tt>[[Outbound#privilege.outbound.can-use|privilege.outbound.can-use]]</tt>.-->
  
 
====privilege.outbound.can-cancel-record====
 
====privilege.outbound.can-cancel-record====
Line 54: Line 54:
 
* Valid Values: <tt>true</tt>, <tt>false</tt>
 
* Valid Values: <tt>true</tt>, <tt>false</tt>
 
* Changes take effect: When the session is started or restarted.
 
* Changes take effect: When the session is started or restarted.
* Description: Allows an agent to cancel a preview record. If an agent cancels a preview record, it is not processed again during the current campaign.
+
* Description: Allows an agent to cancel a preview record. If an agent cancels a preview record, it is not processed again during the current campaign. Has a dependency on <tt>[[Outbound#privilege.outbound.can-use|privilege.outbound.can-use]]</tt>.
  
 
====privilege.outbound.can-dial-alternative-chained-record====
 
====privilege.outbound.can-dial-alternative-chained-record====
Line 60: Line 60:
 
* Valid Values: <tt>true</tt>, <tt>false</tt>
 
* Valid Values: <tt>true</tt>, <tt>false</tt>
 
* Changes take effect: When the session is started or restarted.
 
* Changes take effect: When the session is started or restarted.
* Description: Allows an agent to dial a number from the preview record chain that is different than the number selected by the system.
+
* Description: Allows an agent to dial a number from the preview record chain that is different than the number selected by the system. Has a dependency on <tt>[[Outbound#privilege.outbound.can-use|privilege.outbound.can-use]]</tt>.
  
 
====privilege.outbound.can-get-next-preview-record====
 
====privilege.outbound.can-get-next-preview-record====
Line 66: Line 66:
 
* Valid Values: <tt>true</tt>, <tt>false</tt>
 
* Valid Values: <tt>true</tt>, <tt>false</tt>
 
* Changes take effect: When the session is started or restarted.
 
* Changes take effect: When the session is started or restarted.
* Description: Allows an agent to request a new preview record while processing of the previous preview record terminates.
+
* Description: Allows an agent to request a new preview record while processing of the previous preview record terminates. Has a dependency on <tt>[[Outbound#privilege.outbound.can-use|privilege.outbound.can-use]]</tt>.
  
 
====privilege.outbound.can-mark-do-not-call====
 
====privilege.outbound.can-mark-do-not-call====
Line 72: Line 72:
 
* Valid Values: <tt>true</tt>, <tt>false</tt>
 
* Valid Values: <tt>true</tt>, <tt>false</tt>
 
* Changes take effect: When the session is started or restarted.
 
* Changes take effect: When the session is started or restarted.
* Description: Allows an agent to mark a contact as <tt>Do Not Call</tt>.
+
* Description: Allows an agent to mark a contact as <tt>Do Not Call</tt>. Has a dependency on <tt>[[Outbound#privilege.outbound.can-use|privilege.outbound.can-use]]</tt>.
  
 
====privilege.outbound.can-reject-record====
 
====privilege.outbound.can-reject-record====
Line 78: Line 78:
 
* Valid Values: <tt>true</tt>, <tt>false</tt>
 
* Valid Values: <tt>true</tt>, <tt>false</tt>
 
* Changes take effect: When the session is started or restarted.
 
* Changes take effect: When the session is started or restarted.
* Description: Allows an agent to decline a preview record. If an agent declines a preview record, it can be processed by another agent in the campaign.
+
* Description: Allows an agent to decline a preview record. If an agent declines a preview record, it can be processed by another agent in the campaign. Has a dependency on <tt>[[Outbound#privilege.outbound.can-use|privilege.outbound.can-use]]</tt>.
  
 
====privilege.outbound.can-reschedule====
 
====privilege.outbound.can-reschedule====
Line 84: Line 84:
 
* Valid Values: <tt>true</tt>, <tt>false</tt>
 
* Valid Values: <tt>true</tt>, <tt>false</tt>
 
* Changes take effect: When the session is started or restarted.
 
* Changes take effect: When the session is started or restarted.
* Description: Allows an agent to reschedule an outbound record for an active call. Use the [[Outbound#privilege.outbound.can-reschedule-before-call|privilege.outbound.can-reschedule-before-call]] privilege to allow rescheduling before the call is dialed.
+
* Description: Allows an agent to reschedule an outbound record for an active call. Use the [[Outbound#privilege.outbound.can-reschedule-before-call|privilege.outbound.can-reschedule-before-call]] privilege to allow rescheduling before the call is dialed. Has a dependency on <tt>[[Outbound#privilege.outbound.can-use|privilege.outbound.can-use]]</tt>.
  
 
====privilege.outbound.can-reschedule-before-call====
 
====privilege.outbound.can-reschedule-before-call====
Line 90: Line 90:
 
* Valid Values: <tt>true</tt>, <tt>false</tt>
 
* Valid Values: <tt>true</tt>, <tt>false</tt>
 
* Changes take effect: When the session is started or restarted.
 
* Changes take effect: When the session is started or restarted.
* Description: Allows an agent to reschedule an outbound record before calling the contact. Requires privilege [[Outbound#privilege.outbound.can-reschedule|privilege.outbound.can-reschedule]].
+
* Description: Allows an agent to reschedule an outbound record before calling the contact. Requires privilege [[Outbound#privilege.outbound.can-reschedule|privilege.outbound.can-reschedule]]. Has a dependency on <tt>[[Outbound#privilege.outbound.can-use|privilege.outbound.can-use]]</tt>.
  
 
====privilege.outbound.can-reschedule-on-new-number====
 
====privilege.outbound.can-reschedule-on-new-number====
Line 96: Line 96:
 
* Valid Values: <tt>true</tt>, <tt>false</tt>
 
* Valid Values: <tt>true</tt>, <tt>false</tt>
 
* Changes take effect: When the session is started or restarted.
 
* Changes take effect: When the session is started or restarted.
* Description: Allows an agent to reschedule an outbound record on a new number (which adds a new record to the chain). Requires privilege [[Outbound#privilege.outbound.can-reschedule|privilege.outbound.can-reschedule]].
+
* Description: Allows an agent to reschedule an outbound record on a new number (which adds a new record to the chain). Requires privilege [[Outbound#privilege.outbound.can-reschedule|privilege.outbound.can-reschedule]]. Has a dependency on <tt>[[Outbound#privilege.outbound.can-use|privilege.outbound.can-use]]</tt>.
  
 
====privilege.outbound.can-set-call-result====
 
====privilege.outbound.can-set-call-result====
Line 102: Line 102:
 
* Valid Values: <tt>true</tt>, <tt>false</tt>
 
* Valid Values: <tt>true</tt>, <tt>false</tt>
 
* Changes take effect: When the session is started or restarted.
 
* Changes take effect: When the session is started or restarted.
* Description: Allows an agent to set a call result to the outbound record.   
+
* Description: Allows an agent to set a call result to the outbound record.  Has a dependency on <tt>[[Outbound#privilege.outbound.can-use|privilege.outbound.can-use]]</tt>.
  
 
====privilege.outbound.can-use====
 
====privilege.outbound.can-use====
Line 110: Line 110:
 
* Description: Allows access to the Outbound Campaign functions
 
* Description: Allows access to the Outbound Campaign functions
  
 
+
====privilege.outbound.push-preview.can-use====
 +
* Default Value: <tt>false</tt>
 +
* Valid Values: <tt>true</tt>, <tt>false</tt>
 +
* Changes take effect: When the session is started or restarted.
 +
* Description: Allows access to the Outbound push preview Campaign functions.  Has a dependency on <tt>[[Outbound#privilege.outbound.can-use|privilege.outbound.can-use]]</tt>.
  
 
[[Category:V:HTCC:8.5.2DRAFT]]
 
[[Category:V:HTCC:8.5.2DRAFT]]

Revision as of 14:09, July 26, 2017

Outbound

This page displays the options and privileges associated with Outbound campaigns for Workspace Web Edition.

Important
In initial releases, some values depicted below will be hard coded.

outbound.call-result-automatically-selected

  • Default Value: ""
  • Valid Values: Any available call result value.
  • Changes take effect: At the next interaction.
  • Description: Specifies the call result to be selected by default for outbound records. The specified call result must be defined by the values that are specified for the outbound.call-result-values option. If set to an empty value, the current call result of the outbound record is selected, or unknown is selected if there is no current value. Has a dependency on privilege.outbound.can-use.

outbound.call-result-values

  • Default Value: Answered,NoAnswer,AnsweringMachine,Busy,WrongNumber
  • Valid Values: One or more items from the following list: Abandoned (Abandoned), AgentCallbackError (Agent Callback Error), AllTrunksBusy (All Trunks Busy), Answered (Answered), AnsweringMachine (Answering Machine), Busy (Busy), CallDropError (Call Drop Error), DialError (Dial Error), DoNotCall (Do Not Call), Dropped (Dropped), DroppedNoAnswer (Dropped No Answer), FaxDetected (Fax Detected), GeneralError (General Error), GroupCallbackError (Group Callback Error), NoAnswer (No Answer), NoDialTone (No Dial Tone), NoEstablished (No Established), NoFreePortError (No Free Port Error), NoProgress (No Progress), NoRingback (No Ringback), NuTone (Nu Tone), Ok (Ok), PagerDetected (Pager Detected), Silence (Silence), SitDetected (Sit Detected), SitInvalidNum (Sit Invalid Num), SitNoCircuit (Sit No Circuit), SitOperintercept (Sit Operintercept), SitReorder (Sit Reorder), SitUnknown (Sit Unknown), SitVacant (Sit Vacant), Stale (Stale), SwitchError (Switch Error), SystemError (System Error), TransferError (Transfer Error), Unknown (Unknown), WrongNumber (Wrong Number), WrongParty (Wrong Party)
  • Changes take effect: At the next interaction.
  • Description: Specifies the list of call results that are available for the agent to use for an outbound interaction. The call results are displayed in the order in which they appear in the list. Has a dependency on privilege.outbound.can-use.

outbound-callback.ringing-bell

  • Default Value:
  • Valid Values: All special characters that are valid in a URL file path, the '|' separator, and numeric values.
  • Changes take effect: When the session is started or restarted.
  • Description: Specifies the outbound callback ringing sound configuration string of a scheduled callback pushed to the agent as a preview. For example: 'BELL|7|0'. The value has three components that are separated by the pipe ('|') character. The first is the sound file name (the BELL, RING, CHORD or WARNING predefined aliases or an absolute URL to a MP3 file). The second is a priority — the higher the integer, the higher the priority. The last is the duration, which can have the following values:
    • -1 — play and repeat the sound until an explicit message, such as event established, causes it to stop.
    • 0 — play the whole sound once
    • an integer greater than 0 — the length of time, in milliseconds, to play and repeat the sound
Has a dependency on privilege.outbound.can-use.

outbound.preview.max-simultaneous-preview-record

  • Default Values: -1
  • Valid Values: An integer.
  • Changes take effect: When the session is started or restarted.
  • Description: Specifies the maximum number of simultaneous Outbound Preview records an agent can view in the interaction window. A 0 or a negative value indicates no limit. Has a dependency on privilege.outbound.can-use.

privilege.outbound.can-cancel-record

  • Default Value: true
  • Valid Values: true, false
  • Changes take effect: When the session is started or restarted.
  • Description: Allows an agent to cancel a preview record. If an agent cancels a preview record, it is not processed again during the current campaign. Has a dependency on privilege.outbound.can-use.

privilege.outbound.can-dial-alternative-chained-record

  • Default Value: true
  • Valid Values: true, false
  • Changes take effect: When the session is started or restarted.
  • Description: Allows an agent to dial a number from the preview record chain that is different than the number selected by the system. Has a dependency on privilege.outbound.can-use.

privilege.outbound.can-get-next-preview-record

  • Default Value: true
  • Valid Values: true, false
  • Changes take effect: When the session is started or restarted.
  • Description: Allows an agent to request a new preview record while processing of the previous preview record terminates. Has a dependency on privilege.outbound.can-use.

privilege.outbound.can-mark-do-not-call

  • Default Value: true
  • Valid Values: true, false
  • Changes take effect: When the session is started or restarted.
  • Description: Allows an agent to mark a contact as Do Not Call. Has a dependency on privilege.outbound.can-use.

privilege.outbound.can-reject-record

  • Default Value: true
  • Valid Values: true, false
  • Changes take effect: When the session is started or restarted.
  • Description: Allows an agent to decline a preview record. If an agent declines a preview record, it can be processed by another agent in the campaign. Has a dependency on privilege.outbound.can-use.

privilege.outbound.can-reschedule

privilege.outbound.can-reschedule-before-call

  • Default Value: true
  • Valid Values: true, false
  • Changes take effect: When the session is started or restarted.
  • Description: Allows an agent to reschedule an outbound record before calling the contact. Requires privilege privilege.outbound.can-reschedule. Has a dependency on privilege.outbound.can-use.

privilege.outbound.can-reschedule-on-new-number

  • Default Value: true
  • Valid Values: true, false
  • Changes take effect: When the session is started or restarted.
  • Description: Allows an agent to reschedule an outbound record on a new number (which adds a new record to the chain). Requires privilege privilege.outbound.can-reschedule. Has a dependency on privilege.outbound.can-use.

privilege.outbound.can-set-call-result

  • Default Value: true
  • Valid Values: true, false
  • Changes take effect: When the session is started or restarted.
  • Description: Allows an agent to set a call result to the outbound record. Has a dependency on privilege.outbound.can-use.

privilege.outbound.can-use

  • Default Value: false
  • Valid Values: true, false
  • Changes take effect: When the session is started or restarted.
  • Description: Allows access to the Outbound Campaign functions

privilege.outbound.push-preview.can-use

  • Default Value: false
  • Valid Values: true, false
  • Changes take effect: When the session is started or restarted.
  • Description: Allows access to the Outbound push preview Campaign functions. Has a dependency on privilege.outbound.can-use.
Comments or questions about this documentation? Contact us for support!