From Bright Pattern Documentation
(Created page with "<translate> = Get Call Recording Status (Callback) = Gets call recording status information. == Request == === Syntax === window.bpspat.api.getCallRecordingStatus(callback)...") |
|||
Line 1: | Line 1: | ||
<translate> | <translate> | ||
− | = | + | = getCallRecordingStatus(callback) = |
Gets call recording status information. | Gets call recording status information. | ||
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 | false; | ||
+ | data.muted = true | false; | ||
+ | } | ||
+ | |||
Revision as of 23:30, 12 February 2019
<translate>
getCallRecordingStatus(callback)
Gets call recording status information.
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 |
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 | false; data.muted = true | false; }
</translate>