From Bright Pattern Documentation
< 5.3:Embedded-agent-desktop-api-specification | Methods
Revision as of 22:00, 27 March 2019 by imported>Tracy
<translate>
stopCallRecording(callback)
Stops the call recording and gets confirmation that recording is off.
See the Embedded Agent Desktop Specification's Use Cases section for ways to use this method.
Request
Syntax
window.bpspat.api.stopCallRecording(callback) callback = function(data) { }
Arguments
Parameter | Type | Description |
callback | function | JavaScript method executed when API method request is completed |
Response
Response Parameters
The response object may contain the following.
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") | "0" |
muted | boolean | Whether the call recording is muted ("1") or not ("0") | "0" |
Example Response
{
"item_id": "D3FA4B4F-244A-41E4-AE89-022BF2AA8D11",
"call_id": "7A741A68-7F75-458A-ADB0-842D0F3BA8C3\/211",
"command": "call_recording_status",
"recording": "0",
"muted": "0"
}
</translate>