From Bright Pattern Documentation
(Updated via BpDeleteTranslateTags script) |
|||
| (5 intermediate revisions by one other user not shown) | |||
| Line 1: | Line 1: | ||
| − | |||
| − | |||
| − | |||
| − | = | + | = addInteractionRenderedHandler(callback) = |
Gets information about an active interaction. | Gets information about an active interaction. | ||
| + | == Request == | ||
=== Syntax === | === Syntax === | ||
window.bpspat.api.addInteractionRenderedHandler(callback) | window.bpspat.api.addInteractionRenderedHandler(callback) | ||
| Line 21: | Line 19: | ||
| JavaScript method executed when API method request is completed | | JavaScript method executed when API method request is completed | ||
|} | |} | ||
| + | |||
== 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" | ||
| Line 29: | Line 28: | ||
| '''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" | ||
|} | |} | ||
| Line 59: | Line 64: | ||
data.screenpop_data: "Case: 123123" | data.screenpop_data: "Case: 123123" | ||
data.service: "Customer Support"; | data.service: "Customer Support"; | ||
| − | } | + | } |
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
Latest revision as of 04:02, 29 May 2024
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";
}