Contents

IS_Action_Mute

Definition

This action mutes the current call, or the call specified by the callid attribute, so that the other party cannot hear what the agent says. Invoking the IS_Action_Mute element mutes a call; invoking the IS_Action_Mute element again turns off the mute feature. The current or active call of the current campaign in the queue is assumed to be the target of this action, if the CallId attribute is not set.

Scripter will recognize click events from any HTML element whose name has an associated action documented in this API (e.g.: "IS_Action_CallComplete"). If the script needs to associate several buttons with the same action, then define the action using a meta element and call the click event on the meta element from the button(s).

Attributes

The IS_Action_Mute element has the following attributes:

[callid]

Optional. The callid to which this action applies (e.g. "89900001"). Dialer scripts use the current Dialer callid by default. A "debug mode" error is logged for non-Dialer scripts if the callid attribute is not specified.

[callback]

The callback property ensures that this action executes asynchronously in Interaction Connect. Starting with 2018 R3, all Interaction Scripter actions (IS_Actions) provide a callback property for use in Connect scripts only. In the example below, statements inside the highlighted callback function block execute only after the action completes. The callback will return an error if the action fails. See Writing custom scripts for Interaction Connect or Scripter .NET.

Here's how to use the .callback property in a script for Interaction Connect:

function IS_Action_Mute() {
  IS_Action_Mute.callback = function(error) {
    if (error) {
      console.error("IS_Action_Mute failed.");
    } else {
      console.log("IS_Action_Mute succeeded.");
    }
  }
}

Example 1

This is an example of a "Mute" button that allows the agent to mute a call so that the other party cannot hear the agent.

<body>
    <input type=button name="IS_Action_Mute" value="Mute">
</body>

Example 2

This is an example of a "Mute" button that invokes the "Mute" script function. The "mute" script function mutes a call so that the other party cannot hear the agent.;

<head>
    <meta name="IS_Action_Mute">
    <script language=javascript>
        function Mute() {
            IS_Action_Mute.click();
        }
    </script>
</head>

<body>
    <input type=button value="Mute" onclick="Mute();">
</body>

Example 3

This example shows how to mute the call specified by CallId.

<head>
    <meta name="IS_Action_Mute">
    <script language="javascript">
        function IS_MuteCall(p_page, p_CallId) {
            if (p_CallId != null) {
                IS_Action_Mute.callid = p_CallId;
            }
            IS_Action_Mute.click();
            if (p_page != null) location.href = p_page;
        }
    </script>
</head>

<body>
    <input type=button value="Mute Call" onclick="IS_MuteCall();">
</body>