From Bright Pattern Documentation
| Line 3: | Line 3: | ||
Gets information about an active interaction. | Gets information about an active interaction. | ||
| − | == Syntax == | + | == Request == |
| + | === Syntax === | ||
window.bpspat.api.addInteractionRenderedHandler(callback) | window.bpspat.api.addInteractionRenderedHandler(callback) | ||
callback = function(data) { | callback = function(data) { | ||
} | } | ||
| − | == Arguments == | + | === Arguments === |
{|border="1" style="border-collapse:collapse" cellpadding="5" | {|border="1" style="border-collapse:collapse" cellpadding="5" | ||
| '''Parameter''' | | '''Parameter''' | ||
| Line 21: | Line 22: | ||
== Response == | == Response == | ||
| − | The response object | + | The response object may contain the following fields. |
{|border="1" style="border-collapse:collapse" cellpadding="5" | {|border="1" style="border-collapse:collapse" cellpadding="5" | ||
Revision as of 00:02, 13 February 2019
<translate>
addInteractionRenderedHandler(callback)
Gets information about an active interaction.
Request
Syntax
window.bpspat.api.addInteractionRenderedHandler(callback)
callback = function(data) {
}
Arguments
| Parameter | Type | Description |
| callback | function | JavaScript method executed when API method request is completed |
Response
The response object may contain the following fields.
| Name | Data Type | Description | Example |
| data.item.id | string | Interaction ID | "121212121" |
| data.global_id | string | Global interaction ID (GIID) | "asd234asdf234df" |
| data.phone_number | string | Customer phone number | "4151234567" |
| data.service | string | Name of the service handling the interaction | "Inbound Voice" |
| data.screenpop_data | string | Information shown on screen-pop | "Case: 123123" |
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";
}
</translate>