Contents

IS_Action_Pickup

Definition

This action provides the ability to pick up the current call that is on the users' queue or answer a call specified by the callid attribute. Normally this action is called after a Hold action is performed. Calling this action takes the call off Hold. If the callid attribute is not set, the first active call in the queue is assumed to be the target of this action. If you call IS_Action_Pickup when there is no call, the routine terminates without generating an error.

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_Pickup element has the following attributes:

[callid]

Optional. The callid to which this action applies (e.g. "89900001"). CallId is optional. 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_Pickup() {
  IS_Action_Pickup.callback = function(error) {
    if (error) {
      console.error("IS_Action_Pickup failed.");
    } else {
      console.log("IS_Action_Pickup succeeded.");
    }
  }
}

Example 1

This is an example of a "Pickup" button that allows the agent to pick up a call.

<body>

    <input type=button name="IS_Action_Pickup" value="Pickup">
</body>

Example 2

This is an example of a "Pickup" button that invokes the "Pickup" script function. The "pickup" script function picks up a call.

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

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

Example 3

This example answers the call identified by callid.

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

<body>
    <input type=button value="Pickup Call" onclick="IS_PickUpCall();">
</body>