Whisper Monitor
Through this interface, an extension can monitor another extension’s call in Whisper mode. As a result, the monitor and the monitored extension can talk to each other, but the other party in the call can talk to the monitor.
Operations
- Extension A is idle, extension B is in a call (query extension list to get the extension status).
- Make extension A monitor extension B’s call in Whisper mode.
- If the operation is successful, extension A will auto answer and start monitoring the extension B’s conversation.
Note: Some IP phone models or softphones may not support auto answer. In this case, IP phones or softphones will ring first, and users need to pick up the call manually to start monitoring.
Conditions
- The monitor extension’s monitor mode should be Extensive or Whisper;
- The monitored extension should allow being monitored;
- The call monitor only happens to extensions registered on the same PBX.
Endpoint
POST /api/v0.0.1/extension/whisper?token={token}&type={type}
Request Parameters
Name | Importance | Type | Description |
whisperer | Required | Int | The monitor extension. |
whisperedext | Required | Int | The monitored extension |
Examples
Request Example
POST /api/v1.1.0/extension/whisper?token=813b621cfe8eecf445a2ce1f4a079ffe&type=json HTTP/1.1
Content-Type:application/json; charset=utf-8
Host: 172.16.6.150
{
"whisperer": "101",
"whisperedext": "106"
}
POST /api/v1.1.0/extension/whisper?token=813b621cfe8eecf445a2ce1f4a079ffe&type=xml HTTP/1.1
Content-Type:application/xml; charset=utf-8
Host: 172.16.6.150
<?xml version="1.0" encoding="UTF-8" ?>
<xml>
<whisperer>101</whisperer>
<whisperedext>106</whisperedext>
</xml>
Response Sample
HTTP/1.1 200 OK
Access-control-allow-origin: *
Access-control-allow-methods: GET, POST, OPTIONS, PUT, DELETE
{
"status": "Success"
}
HTTP/1.1 200 OK
Access-control-allow-origin: *
Access-control-allow-methods: GET, POST, OPTIONS, PUT, DELETE
<?xml version="1.0" encoding="UTF-8" ?>
<xml>
<status>Success</status>
</xml>