Feedback

  • Contents
 

IS_Action_ManualOutboundCall

Definition

This action will initiate a preview call against an existing contact to either a supplied phone number, or to a different phone number from the contact list of the supplied record.

Attributes

IS_Action_ManualOutboundCall accepts the following attributes:

i3identity

The I3_Identity of the record in the contact table. This value is exposed by the IS_Attr_I3_IDENTITY attribute.

campaignid

The unique Id of the campaign. This value is exposed by the IS_Attr_CampaignId attribute.

campaignname

The name of the campaign. This value is exposed by the IS_Attr_CampaignName attribute.

contactcolumnId

The Contact Column ID or CCID in the <ContactList>_CCD table. This value will be in the json string returned by the IS_Event_ContactDataLoaded event with the "CCID" property. Set this value to -1 if you wish to pass in a different phone number.

phonenumber

The phone number you wish to dial if you set the ContactColumnId to -1.

overridemask

This uses a bit mask to indicate which Scrub processes you wish to override during the manual outbound process. When you pass a number to the Manual Outbound Call Action, Dialer will then check number several ways to determine if it should be dialed. These checks include if the number is blocked by a Filter, or a Query Time Filter, if it is zone blocked, blocked because of skills, blocked for going over a daily limit, violating minimum spacing, blocked by a Do Not Call List, or blocked by campaign ownership. Each of these checks can be overridden by passing a series of flags that have been OR-ed together. The flag values are as follows:

var FLAG_Filter = 0x01;
var FLAG_QueryTimeFilter = 0x02;
var FLAG_ZoneBlocking = 0x04;
var FLAG_Skills = 0x08;
var FLAG_DailyLimit = 0x10;
var FLAG_MinimumSpacing = 0x20;
var FLAG_DNC = 0x40;
var FLAG_CampaignOwnership = 0x80;
	

For example, IS_Action_ManualOutboundCall.OverrideMask = FLAG_Filter | FLAG_Skills] would prevent Dialer from scrubbing your number against Filters and Skills, while allowing the remaining checks to be active. If you wish to simply override everything, you can pass a value of 255 or 0xFF. The IS_Event_ManualOutboundCallStatus predictive event will also return a parameter called BlockedFlag that will contain one of these bit masks. You can then have a persistent variable that accumulates these flags and then pass it back to IS_Action_ManualOutboundCall after each attempt to override previous blocks. For example:

overrideParameter = overrideParameter | args.BlockedFlag ;
IS_Action_ManualOutboundCall.OverrideMask = overrideParameter ;
[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_ManualOutboundCall() {
  IS_Action_ManualOutboundCall.callback = function(error) {
    if (error) {
      console.error("IS_Action_LogonAll failed.");
    } else {
      console.log("IS_Action_LogonAll succeeded.");
    }
  }
}

Example

See Example 1 in Sample Interaction Connect Scripts.