from v4.0.0 onwards

redis_port and redis_db settings are determined by your issued configuration - see the configuration document for more information

sample redis connection string

<server_url>:<redis_port>/<redis_db>
e.g. our-client.forge-cloud.com:6379/0

End of call notifications (CDR):

At the end of an inbound or outbound call, a callback is sent via Redis. This callback contains a Call Data Record for the call. To determine whether the notification is from an inbound call use the call_dir field of the payload.

Redis Notification

Key	^{enigma:notifications:cdr}
Type	List ("BLPOP" for FIFO)

//Notification Example
brpop enigma:notifications:cdr

// Payload from v3.0.0 upwards
{
	type: "cdr",
	payload: {
		extension	 : <ext>,
		number		 : <client_number>,
		dial_number	 : <dial_number>,
		call_ref	 : <internal_call_ref>,
		contact_ref	 : <custom_call_ref>,
		dialed_at	 : <dialed_at> ,
		end_reason	 : <disposition>,
		end_code	 : <ISDN_termination_code>,
		call_time	 : <call_time> ,
		hold_time	 : <hold_time>,
		call_dir	 : <call_dir>,
		recording_url: <recording_ref>,
		ref			 : "click-dial"
	}
}
 
// Payload prior to v3.0.0 
{
	type: "cdr",
	payload: {
		extension	 : <ext>,
		dial_number	 : <dial_number>,
		call_ref	 : <internal_call_ref>,
		contact_ref	 : <custom_call_ref>,
		dialed_at	 : <dialed_at> ,
		end_reason	 : <disposition>,
		end_code	 : <ISDN_termination_code>,
		call_time	 : <call_time> ,
		hold_time	 : <hold_time>,
		call_dir	 : <call_dir> ,
		recording_url: <recording_ref>,
		ref			 : <client_number>
	}
}

<ext> agent extension/number
<dial_number> The number of the PBX
<client_number> dialed number or the inbound callers number (field changed from v3.0.0)
<internal_call_ref> Internal call reference, also used to fetch the recording
<custom_call_ref> Custom call reference
<dialed_at> time the call was placed
<disposition> how the call ended
<ISDN_termination_code>
<call_time> duration of call in seconds (from v2.6.0)
<hold_time> (inbound) how long the callee was on hold in the queue (from v2.6.0)
<call_dir> whether this was inbound or outbound
<recording_ref> Unique Recording reference used to fetch the recording

WebRTC

No CDR's will be sent over SIP, the reasons for this include:

SIP headers can get lost
It encourages bad practices
When do we send them? It has to be just before hangup, which has its own problems.

Values:

<ext>	The agent extension or number (if the call is external; between 2 external parties)
<dial_number>	The number the PBX used as part of this call Outbound: the caller ID that was shown to the callee Inbound: the (DID) number that was dialed by the caller
<internal_call_ref>	Current (inline with Dialer spec) Unique Internal identifier for this specific call, this is used to download recordings. Pre v2.4.0 Inbound: set internally Outbound: set according to the value passed upon creating the call
<custom_call_ref>	Your custom identifier for the caller/callee or matter. It should remain the same between multiple calls for the same callee and should be used to link CDR data to a specific person. Outbound/External: This reference can be set upon creating a C2D call via the API Inbound: the value is either an empty string or can be set by the caller via an IVR if that feature is enabled. Default: if no contact_ref is specified one is generated, although it serves no real purpose
<disposition>	Dispositions: how the call ended
<ISDN_termination_code>	The ISDN termination code
<client_number>	The clients number (as opposed to the agent) Inbound: callers number (can be empty if the callers number is set to private) Outbound: dialed number