Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 24 Next »

Inbound:

In order to be able to do lookups on inbound calls we make use of the Redis callback infrastructure which already exists. We will send a callback to your application which is of a similar type as the C2D notifications. This incoming call notification is compatible with the notification used by the Teleforge Dialler for call connections, thus only one unpacking function is required to handle both.

 

Redis Notification

Key

enigma:notifications:inbound

Type

List ("BLPOP" for FIFO)
//Notification Example
brpop enigma:notifications:inbound
 
// Payload prior to v3.0.0
{
	type   : "call"
	payload: {
		number      : <caller>,
		dial_number : <dial_number>,
		hold_time   : <hold_time>,
		call_ref    : <internal_call_ref>,
		contact_ref : <custom_call_ref>,
		campaign_ref: "inbound",
		ref         : <ext>
	}
}
 
// Payload from v3.0.0 upwards
{
	type   : "call"
	payload: {
		number      : <caller>,
		dial_number : <dial_number>,
		hold_time   : <hold_time>,
		call_ref    : <internal_call_ref>,
		contact_ref : <custom_call_ref>,
		call_dir	: "inbound",
		ref         : <ext>
	}
}
  • <caller> number which the call is coming from
  • <dial_number> the number that was dialed by the caller
  • <hold_time> how long the callee was on hold in the queue, seconds (from v2.6.0)
  • <internal_call_ref> Internal click2dial call reference
  • <custom_call_ref> [optional] callee supplied reference
  • <ext> agent extension number

WebRTC Invite

This has not been implemented yet.

Values:

<ext>The agent extension number
<internal_call_ref>

Internal click2dial call reference, this is used to disposition the call


The call_ref field will return a unique identifier for this specific call, it is set internally for inbound calls, but for click2dial outbound calls it is set according to the value passed upon creating the call. This field is used to control call, as well as uniquely identify multiple calls to the same callee. 

<custom_call_ref>

The contact_ref field may not always be populated, that depends if there is an IVR which allows inbound callees to type in a reference number or account number. If this is the case that will be filled in in the contact_ref field, otherwise the field will default to a null string ("").

  • No labels