From Bright Pattern Documentation
| Line 30: | Line 30: | ||
| '''Data Type''' | | '''Data Type''' | ||
| '''Description''' | | '''Description''' | ||
| + | | '''Example''' | ||
|- | |- | ||
| − | | | + | | item_id |
| string | | string | ||
| − | | | + | | Interaction ID |
| + | | "AA9ED493-8EB5-4120-A631-0919856E8358" | ||
|- | |- | ||
| − | | | + | | call_id |
| + | | string | ||
| + | | Call identifier | ||
| + | | "7A741A68-7F75-458A-ADB0-842D0F3BA8C3/203" | ||
| + | |- | ||
| + | | command | ||
| + | | string | ||
| + | | The command used for the callback function | ||
| + | | "call_recording_status" | ||
| + | |- | ||
| + | | recording | ||
| boolean | | boolean | ||
| Whether a call is being recorded ("1") or not ("0") | | Whether a call is being recorded ("1") or not ("0") | ||
| + | | "1" | ||
|- | |- | ||
| − | | | + | | muted |
| boolean | | boolean | ||
| Whether the call recording is muted ("1") or not ("0") | | Whether the call recording is muted ("1") or not ("0") | ||
| + | | "0" | ||
|} | |} | ||
=== Example === | === Example === | ||
| − | {"item_id":"D3FA4B4F-244A-41E4-AE89-022BF2AA8D11","call_id":"7A741A68-7F75-458A-ADB0-842D0F3BA8C3/211","command":"call_recording_status","recording":"1","muted":"0"} | + | <syntaxhighlight lang="json"> |
| − | + | { | |
| + | "item_id": "D3FA4B4F-244A-41E4-AE89-022BF2AA8D11", | ||
| + | "call_id": "7A741A68-7F75-458A-ADB0-842D0F3BA8C3\/211", | ||
| + | "command": "call_recording_status", | ||
| + | "recording": "1", | ||
| + | "muted": "0" | ||
| + | } | ||
| + | </syntaxhighlight> | ||
Revision as of 21:51, 27 March 2019
<translate>
getCallRecordingStatus(callback)
Gets call recording status information.
See the Embedded Agent Desktop Specification's Use Cases section for ways to use this method.
Request
Syntax
window.bpspat.api.getCallRecordingStatus(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 |
| item_id | string | Interaction ID | "AA9ED493-8EB5-4120-A631-0919856E8358" |
| call_id | string | Call identifier | "7A741A68-7F75-458A-ADB0-842D0F3BA8C3/203" |
| command | string | The command used for the callback function | "call_recording_status" |
| recording | boolean | Whether a call is being recorded ("1") or not ("0") | "1" |
| muted | boolean | Whether the call recording is muted ("1") or not ("0") | "0" |
Example
{
"item_id": "D3FA4B4F-244A-41E4-AE89-022BF2AA8D11",
"call_id": "7A741A68-7F75-458A-ADB0-842D0F3BA8C3\/211",
"command": "call_recording_status",
"recording": "1",
"muted": "0"
}
</translate>