Recipient Monitoring#
Monitoring is a Callcenter Pro feature.
Permissions#
In order for a recipient to perform monitor actions they must have the "call_monitor" permission.
Modes#
- Eavesdrop
eavesdrop
- allows the monitor to listen to the recipient's call without sending any audio. - Whisper
whisper
- allows the monitor to speak only to the recipient while eavesdropping on the call. - Barge
barge
- allows the monitor to speak with both the caller and the recipient.
Notifications#
The monitoring recipient can choose to disable notifications for the target recipient, if disabled the target will not receive any indication that they are being monitored. The default is to send notification events.
API#
The monitor action will eavesdrop another recipient (if the current recipient has the permission enabled)
POST /v2/accounts/{ACCOUNT_ID}/qubicle_recipients/{RECIPIENT_ID}/
curl -v -X POST -H "X-Auth-Token: {AUTH_TOKEN}" -H "Content-Type: application/json" http://{SERVER}:8000/v2/accounts/{ACCOUNT_ID}/qubicle_recipients/{RECIPIENT_ID} -d '{"data":{"action":"monitor", "target": {TARGET_RECIPIENT_ID}, "mode": {MODE}}'
{
"data":{
"action":"monitor"
},
"status":"success",
"request_id":"{REQUEST_ID}",
"auth_token":"{AUTH_TOKEN}"
}