Jump to: navigation, search

<media-type>.ringing-bell

Section: interaction-workspace
Default Value: Sounds\Ring.mp3|10|-1|primary
Valid Values: All special characters that are valid Windows file path, '|' separator and numeric values.
Changes Take Effect: At the next interaction.
Dependencies: application.secondary-audio-out-device

Specifies the path of the sound file that is played when interaction of type <media-type> is ringing. For example: "Sounds\Ring.mp3|10|-1|primary" The value has four components that are separated by the character '|':

  1. The file name and folder relative to the application folder. In some virtual desktop environments, MP3 and other sound file formats cannot be rendered by Direct Show filters. In this scenario, use Direct Show compatible formats such as .wav.
  2. The priority. The higher the integer the higher the priority.
  3. The duration:
    1. -1 means play and repeat until an explicit message stops it. For example, the established event stops the ringing sound.
    2. 0 means play the whole sound one time.
    3. An integer > 0 means a time, in milliseconds, to play and repeat the sound.
  4. Specify whether tones are played on the default audio device, a secondary audio device, or both. If no value is specified for this flag, the value |primary is used by default.

outbound.treatment-mode

Section: interaction-workspace
Default Value: none
Valid Values: Select one value from the following list: personal,campaign,none.
Changes Take Effect: Immediately.


Specifies the type of treatment to be applied for the outbound record after it is marked as processed.

  • none—The application never applies any treatment to mark processed requests.
  • campaign—The treatment RecordTreatCampaign is applied to the record when a mark processed action is executed.
  • personal—The treatment RecordTreatPersonal is applied to the record when a mark processed action is executed.

outbound.timed-preview-auto-dial

Section: interaction-workspace
Default Value: -1
Valid Values: -1, 0, or any positive integer.
Changes Take Effect: At the next interaction.
Introduced: 8.5.109.16

Specifies whether agents in Preview, Push preview, and Reschedule preview campaigns can manually dial a record (-1), have the call auto-dialed as soon as the record is accepted (0), or have the call auto-dialed after a specified number of seconds. This option can be overridden by a routing strategy, as described in Overriding Options by Using a Routing Strategy.

outbound.sound.campaign-updated

Section: interaction-workspace
Default Value:
Valid Values: All special characters that are valid Windows file path, '|' separator and numeric values.
Changes Take Effect: At the next interaction.
Related Options: application.secondary-audio-out-device, application.secondary-audio-out-device

Specifies the sound-configuration string when the campaign status is updated. For example: "Sounds\Ring.mp3|10|-1|primary" The value has four components that are separated by the character '|':

  1. The file name and folder relative to the application folder. In some virtual desktop environments, MP3 and other sound file formats cannot be rendered by Direct Show filters. In this scenario, use Direct Show compatible formats such as .wav.
  2. The priority. The higher the integer the higher the priority.
  3. The duration:
    1. -1 means plays and repeats until an explicit message stops it. For example, the established event stops the ringing sound.
    2. 0 means play the whole sound one time.
    3. An integer > 0 means a time, in milliseconds, to play and repeat the sound.
  4. Specify whether tones are played on the default audio device, a secondary audio device, or both. If no value is specified for this flag, the value |primary is used by default.

outbound.reschedule-inherit-parent-availability-interval

Section: interaction-workspace
Default Value: false
Valid Values: true, false
Changes Take Effect: When the application is started or restarted.


Specifies how Workspace populates the default values of the availability ("From" and "Till") interval for a new outbound record created when rescheduling to a new number.

  • false: the default values are retrieved from the "From" and "Till" Field object of the Configuration
  • true: the "From" and "Till" are inherited from the parent record.

outbound.record-information.header-foreground-color

Section: interaction-workspace
Default Value: #FFFFFFFF
Valid Values: The hexadecimal Alpha (from '00' for fully transparent color to 'FF' for regular plain color) followed by the RGB hexadecimal color code (3 values in the '00'-'FF' range).
Changes Take Effect: At the next interaction.


Specifies the color of the text of the Record Information view header of Outbound interactions. Example #FFFFFFFF for white color. This option can be overridden by a routing strategy, as described in Overriding Options by Using a Routing Strategy.

outbound.record-information.frame-color

Section: interaction-workspace
Default Value: #FF17849D
Valid Values: The hexadecimal Alpha (from '00' for fully transparent color to 'FF' for regular plain color) followed by the RGB hexadecimal color code (3 values in the '00'-'FF' range).
Changes Take Effect: At the next interaction.


Specifies the background color the Record Information view header of Outbound interactions. Examples: #FFFFBA00 for a Gold color, #FF6F7074 for a Silver color, #FFB8400B for a Bronze color. This option can be overridden by a routing strategy, as described in Overriding Options by Using a Routing Strategy.

outbound.push-preview.media-types

Section: interaction-workspace
Default Value: outboundpreview
Valid Values: A comma separated list of valid media-types.
Changes Take Effect: When the application is started or restarted.


The list of media types that are available for the agent to use for outbound push-preview interactions.

outbound.push-preview.auto-answer.timer

Section: interaction-workspace
Default Value: 0
Valid Values: Any integer greater than or equal to 0.
Changes Take Effect: At the next interaction.
Dependencies: outbound.push-preview.auto-answer
Introduced: 8.5.105.12

Specifies the time, in seconds, after which an incoming interaction is automatically answered if the value of outbound.push-preview.auto-answer is set to true. If the value 0 is specified, interactions are immediately auto-answered. If any positive integer value is specified, then an interaction notification is displayed to the agent and a timer counts down the seconds until the interactions is auto-answered. This option can be overridden by a routing strategy, as described in Overriding Options by Using a Routing Strategy.

outbound.push-preview.auto-answer.enable-reject

Section: interaction-workspace
Default Value: false
Valid Values: true, false
Changes Take Effect: At the next interaction.
Dependencies: outbound.push-preview.auto-answer, outbound.push-preview.auto-answer.timer
Introduced: 8.5.105.12

Specifies whether the Reject button is available in the interaction notification when the value of outbound.push-preview.auto-answer is set to true and the value of outbound.push-preview.auto-answer.timer is greater than 0. The privilege to reject interactions must be granted. This option can be overridden by a routing strategy, as described in This option can be overridden by a routing strategy, as described in Overriding Options by Using a Routing Strategy..

outbound.push-preview.auto-answer

Section: interaction-workspace
Default Value: false
Valid Values: true, false
Changes Take Effect: At the next interaction.


Specifies whether a push preview outbound interaction is automatically accepted when Interaction Server Invite event is received. This option can be overridden by a routing strategy, as described in Overriding Options by Using a Routing Strategy.

outbound.load-at-startup

Section: interaction-workspace
Default Value: false
Valid Values: true, false
Changes Take Effect: When the application is started or restarted.
Introduced: 8.5.109.16

When the value of this option is set to true, the description of all the Outbound Calling Lists visible to the logged in agent is loaded and cached at login time. When the value of this option is set to false, the description of the Outbound Calling Lists assigned to a specific Campaign is loaded on demand when the agent is notified by Outbound Server that he or she is engaged in this Outbound Campaign.

outbound.fields.float-separator-in-db

Section: interaction-workspace
Default Value:
Valid Values: A valid float separator. Typical float separators are: '.' (period), ',' (comma), and '\' (backslash).
Changes Take Effect: Immediately.


Specifies the separator that is used for floating point numbers in the database for outbound fields. This option should be used when the decimal symbol in the regional settings of the agent workstation is different from the one provided by the database.

outbound.complete-record-before-transfer

Section: interaction-workspace
Default Value: false
Valid Values: true, false
Changes Take Effect: At the next transfer attempt.
Introduced: 8.5.117.18

Specifies whether the processing of an Outbound record will be completed when the call is transferred or conferenced. If the value is set to false, the outbound record will be editable after the call is transferred or conferenced; Workspace attempts to update the record in OCS accordingly; however, the update operation can fail, depending on topology. If the target agent is part of the campaign, he or she can edit the record. This is the legacy behavior. If the value is set to true, the Outbound record will be marked as processed and the Outbound record fields will become read-only after the call is transferred or conferenced. Workspace updates and closes the record in OCS before validating the call transfer; the target agent receives a read-only record.

outbound.campaign-stale-timeout

Section: interaction-workspace
Default Value: 0
Valid Values: An integer value
Changes Take Effect: When the application is started or restarted.


Records remain editable for a specified period of time after a campaign is unloaded, to reflect the Outbound Contact Server (OCS) OCServer section stale_clean_timeout option. A value of 0 means that the outbound record becomes read-only when the campaign is unloaded. A positive value is the duration, in minutes, during which the outbound record remains editable. During this period, the agent sees the campaign as Active. The campaign is removed from the campaigns list after this period. A value of -1 means that the outbound record is always editable (however, this action may fail in the OCS).

outbound.call-result-values

Section: interaction-workspace
Default Value: Answered,AnsweringMachine,Busy,NoAnswer,WrongNumber
Valid Values: Select at least one item from the list.
Changes Take Effect: At the next interaction.


The list of call results that are available for the agent to use for outbound interaction. The call results are displayed in the order in which they appear in the list. Specify 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)
  • CancelRecord
  • 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)

outbound.call-result-is-mandatory

Section: interaction-workspace
Default Value: false
Valid Values: true, false
Changes Take Effect: Immediatly.


Specifies whether it is mandatory for agents to set a Call Result before Marking Done an Outbound interaction. This option can be overridden by a routing strategy, as described in Overriding Options by Using a Routing Strategy.

outbound.callback-types

Section: interaction-workspace
Default Value: personal,campaign
Valid Values: A comma separated list of callback types from the following list: personal, campaign
Changes Take Effect: At the next interaction.
Introduced: 8.5.115.17

Specifies whether an agent can select a personal callback or a campaign callback when rescheduling an Outbound campaign record, or whether all callbacks are either personal or campaign. This option can be overridden by a routing strategy, as described in Overriding Options by Using a Routing Strategy.

outbound-callback.ringing-bell

Section: interaction-workspace
Default Value: Sounds\Ring.mp3|10|-1|primary
Valid Values: All special characters that are valid Windows file path, '|' separator and numeric values.
Changes Take Effect: At the next interaction.
Related Options: application.secondary-audio-out-device

Specifies the sound-configuration string of a scheduled callback pushed to the agent as a preview. For example: "Sounds\Ring.mp3|10|-1|primary" The value has four components that are separated by the character '|':

  1. The file name and folder relative to the application folder. In some virtual desktop environments, MP3 and other sound file formats cannot be rendered by Direct Show filters. In this scenario, use Direct Show compatible formats such as .wav.
  2. The priority. The higher the integer the higher the priority.
  3. The duration:
    1. -1 means plays and repeats until an explicit message stops it. For example, the established event stops the ringing sound.
    2. 0 means play the whole sound one time.
    3. An integer > 0 means a time, in milliseconds, to play and repeat the sound.
  4. Specify whether tones are played on the default audio device, a secondary audio device, or both. If no value is specified for this flag, the value |primary is used by default.
This page was last edited on July 22, 2020, at 18:40.
blog comments powered by Disqus