From Bright Pattern Documentation
| Line 18: | Line 18: | ||
| JavaScript method executed when API method request is completed | | JavaScript method executed when API method request is completed | ||
|} | |} | ||
| + | |||
== Response == | == Response == | ||
| Line 26: | Line 27: | ||
| '''Data Type''' | | '''Data Type''' | ||
| '''Description''' | | '''Description''' | ||
| + | | '''Example''' | ||
|- | |- | ||
| data.item.id | | data.item.id | ||
| string | | string | ||
| Interaction ID | | Interaction ID | ||
| + | | "121212121" | ||
|- | |- | ||
| data.global_id | | data.global_id | ||
| string | | string | ||
| Global interaction ID (GIID) | | Global interaction ID (GIID) | ||
| + | | "asd234asdf234df" | ||
|- | |- | ||
| data.phone_number | | data.phone_number | ||
| string | | string | ||
| Customer phone number | | Customer phone number | ||
| + | | "4151234567" | ||
|- | |- | ||
| data.service | | data.service | ||
| string | | string | ||
| Name of the service handling the interaction | | Name of the service handling the interaction | ||
| + | | "Inbound Voice" | ||
|- | |- | ||
| data.screenpop_data | | data.screenpop_data | ||
| string | | string | ||
| Information shown on screen-pop | | Information shown on screen-pop | ||
| + | | "Case: 123123" | ||
|} | |} | ||
Revision as of 23:57, 12 February 2019
<translate>
addInteractionRenderedHandler(callback)
Gets information about an active interaction.
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 contains 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>