From Bright Pattern Documentation
(Created page with "<translate> = startCallRecording(callback) = Starts the call recording and gets confirmation that recording is on. == Request == === Syntax === window.bpspat.api.startCallRe...") |
|||
| Line 2: | Line 2: | ||
= startCallRecording(callback) = | = startCallRecording(callback) = | ||
Starts the call recording and gets confirmation that recording is on. | Starts the call recording and gets confirmation that recording is on. | ||
| + | |||
| + | See the Embedded Agent Desktop Specification's [[Embedded-agent-desktop-sdk-specification/UseCases/getCallRecordingStatus | Use Cases]] section for ways to use this method. | ||
== Request == | == Request == | ||
Revision as of 23:41, 26 March 2019
<translate>
startCallRecording(callback)
Starts the call recording and gets confirmation that recording is on.
See the Embedded Agent Desktop Specification's Use Cases section for ways to use this method.
Request
Syntax
window.bpspat.api.startCallRecording(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 |
| data.item_id | string | interaction ID |
| data.recording | boolean | Whether a call is being recorded ("true") or not ("false") |
| data.muted | boolean | Whether the call recording is on mute ("true") or not ("false") |
Example
{
data.item_id = "12121212";
data.recording = true;
}
</translate>