From Bright Pattern Documentation
(Updated via BpDeleteTranslateTags script) |
|||
| (One intermediate revision by one other user not shown) | |||
| Line 1: | Line 1: | ||
| − | + | ||
= muteCallRecording(callback) = | = muteCallRecording(callback) = | ||
Mutes the call recording and gets confirmation that recording is on mute. | Mutes the call recording and gets confirmation that recording is on mute. | ||
| Line 23: | Line 23: | ||
== Response == | == Response == | ||
| − | The response object may contain the following | + | === Response Parameters === |
| + | The response object may contain the following. | ||
{|border="1" style="border-collapse:collapse" cellpadding="5" | {|border="1" style="border-collapse:collapse" cellpadding="5" | ||
| Line 29: | Line 30: | ||
| '''Data Type''' | | '''Data Type''' | ||
| '''Description''' | | '''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 | | string | ||
| − | | | + | | The command used for the callback function |
| + | | "call_recording_status" | ||
|- | |- | ||
| − | | | + | | recording |
| boolean | | boolean | ||
| − | | Whether a call is being recorded (" | + | | Whether a call is being recorded ("1") or not ("0") |
| + | | "1" | ||
|- | |- | ||
| − | | | + | | muted |
| boolean | | boolean | ||
| − | | Whether the call recording is | + | | Whether the call recording is muted ("1") or not ("0") |
| + | | "1" | ||
|} | |} | ||
| − | === Example === | + | === Example Response === |
| + | <syntaxhighlight lang="json"> | ||
{ | { | ||
| − | + | "item_id": "D3FA4B4F-244A-41E4-AE89-022BF2AA8D11", | |
| − | + | "call_id": "7A741A68-7F75-458A-ADB0-842D0F3BA8C3\/211", | |
| − | + | "command": "call_recording_status", | |
| + | "recording": "1", | ||
| + | "muted": "1" | ||
} | } | ||
| − | + | </syntaxhighlight> | |
| − | |||
| − | |||
| − | |||
| − | |||
| − | </ | ||
Latest revision as of 04:02, 29 May 2024
muteCallRecording(callback)
Mutes the call recording and gets confirmation that recording is on mute.
See the Embedded Agent Desktop Specification's Use Cases section for ways to use this method.
Request
Syntax
window.bpspat.api.muteCallRecording(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") | "1" |
| muted | boolean | Whether the call recording is muted ("1") or not ("0") | "1" |
Example Response
{
"item_id": "D3FA4B4F-244A-41E4-AE89-022BF2AA8D11",
"call_id": "7A741A68-7F75-458A-ADB0-842D0F3BA8C3\/211",
"command": "call_recording_status",
"recording": "1",
"muted": "1"
}