Campaign Preview

Owned by Rijnhard Hessel
Last updated: Feb 18, 2016

Preview 

Available from v1.2.1

This is NOT preview dialing (where the next matter can be selected ahead of time).

It is an optimisation so that the integrators know which data to cache in the case of big databases.

Sends a list of all the callees that will be dialed in the next stint.  

A stint is roughly twice the number of active agents. 

Redis

Key

enigma:notifications:campaigns:<campaign_ref>

Type

PubSub

 //Notification Example
psubscribe enigma:notifications:campaigns:*
{
    type: "dial_preview",
    payload: {
        callees : <callees>[
			{number:<number>, contact_ref: <contact_ref>},
			{number:<number>, contact_ref: <contact_ref>},
			...
		],
        ref     : <campaign_ref>
    }
}
  • <callees> array of callees to be dialed next with the number to be tried
    • <number> to dial
    • <custom_call_ref> your custom call reference
  • <campaign_ref> campaign reference

Values:

<callees>

An array of callees where a single callee contains:

  • number: to dial
  • contact_ref: <custom_call_ref> your custom call reference
<custom_call_ref>
Your custom call reference specified for this callee (use this for your lookups)
<campaign_ref>Your Campaign reference

Example:

# get notifications for all campaigns
psubscribe enigma:notifications:campaigns:*

# get notifications for campaign 1234
subscribe enigma:notifications:campaigns:1234