From Bright Pattern Documentation
(Created page with "<translate> = Start Call Recording (Callback) = Starts the call recording and gets confirmation that recording is on. == Request == === Syntax === window.bpspat.api.startCal...") |
(Updated via BpDeleteTranslateTags script) |
||
| (One intermediate revision by one other user not shown) | |||
| Line 1: | Line 1: | ||
| − | + | ||
| − | = | + | = startCallRecording(callback) = |
Starts the call recording and gets confirmation that recording is on. | Starts the call recording and gets confirmation that recording is on. | ||
| Line 19: | 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 may contain the following fields. | |
| + | {|border="1" style="border-collapse:collapse" cellpadding="5" | ||
| + | | '''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; | ||
| + | } | ||
Latest revision as of 04:02, 29 May 2024
startCallRecording(callback)
Starts the call recording and gets confirmation that recording is on.
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;
}