From Bright Pattern Documentation
<translate>
Call Recordings Control
Call Recordings Control is used for controlling call recordings and getting the status of call recordings. The types of requests are described as follows, and the response types are applicable to all the requests that include a callback.
Requests
Mute Call Recordings
Mutes the call recording.
Syntax
window.bpspat.api.muteCallRecordings()
Parameters
| Parameter | Type | Description |
| empty | N/A | There is no response when API method request is completed |
Unmute Call Recordings
Unmutes the call recording.
Syntax
window.bpspat.api.unmuteCallRecordings()
Parameters
| Parameter | Type | Description |
| empty | N/A | There is no response when API method request is completed |
Get Call Recording Status (Callback)
Gets call recording status information.
Syntax
window.bpspat.api.getCallRecordingStatus(callback)
callback = function(data) {
}
Parameters
| Parameter | Type | Description |
| callback | function | JavaScript method executed when API method request is completed |
Start Call Recording (Callback)
Starts the call recording and gets confirmation that recording is on.
Syntax
window.bpspat.api.startCallRecording(callback)
callback = function(data) {
}
Parameters
| Parameter | Type | Description |
| callback | function | JavaScript method executed when API method request is completed |
Stop Call Recording (Callback)
Stops the call recording and gets confirmation that recording is off.
Syntax
window.bpspat.api.stopCallRecording(callback)
callback = function(data) {
}
Parameters
| Parameter | Type | Description |
| callback | function | JavaScript method executed when API method request is completed |
Mute Call Recording (Callback)
Mutes the call recording and gets confirmation that recording is on mute.
Syntax
window.bpspat.api.muteCallRecording(callback)
callback = function(data) {
}
Parameters
| Parameter | Type | Description |
| callback | function | JavaScript method executed when API method request is completed |
Unmute Call Recording (Callback)
Unmutes the call recording and gets confirmation that recording is not on mute.
Syntax
window.bpspat.api.unmuteCallRecording(callback)
callback = function(data) {
}
Parameters
| Parameter | Type | Description |
| callback | function | JavaScript method executed when API method request is completed |
Response
The response object contains 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>