From Bright Pattern Documentation
Jump to: navigation, search
• 5.19 • 5.3 • 5.8

<translate>

Call Flow

Call Flow consists of two methods that get information about an interaction that is active or completed.

Add Interaction Rendered Handler

Gets information about an active interaction.

Syntax

window.bpspat.api.addInteractionRenderedHandler(callback)
callback = function(data) {
} 

Parameters

Parameter Type Description
callback function JavaScript method executed when API method request is completed

Response

The response object contains the following fields.

Name Data Type Description
data.item.id string Interaction ID
data.global_id string Global interaction ID (GIID)
data.phone_number string Customer phone number
data.service string Name of the service handling the interaction
data.screenpop_data string Information shown on screen-pop

Example

{
	data.item_id: "123123123";
	data.global_id: "asd234asdf234df"
	data.phone_number: "55511122233"
	data.service: "Customer Support"
	data.screenpop_data: "Case: 123123"
	data.service: "Customer Support";
} 


Add Interaction Completed Handler

Gets information about a completed interaction.

Syntax

window.bpspat.api.addInteractionCompletedHandler(callback)
callback = function(data) {
}

Parameters

Parameter Type Description
callback function JavaScript method executed when API method request is completed

Response

The response object contains the following fields.

Name Data Type Description
data.item.id string Interaction ID
data.global_id string Global interaction ID (GIID)
data.phone_number string Customer phone number
data.service string Name of the service handling the interaction
data.screenpop_data string Information shown on screen-pop
data.disposition string Disposition of the interaction
data.notes string Any notes recorded by the agent for the interaction
data.recording_url string Recording URL (if any)

Example

{
	data.item_id: "123123123";
	data.global_id: "asd234asdf234df"
	data.phone_number: "55511122233"
	data.service: "Customer Support"
	data.screenpop_data: "Case: 123123"
	data.service: "Customer Support";

	data.disposition: "Case resolved";
	data.notes: "good guy";
	data.recording_url: "http://"
}


</translate>

< Previous | Next >