Listen Monitor

Through this interface, an extension can monitor another extension's call in Listen mode.

Operations

  1. Extension A is idle, extension B is in a call (query extension list to get the extension status);
  2. Make extension A monitor extension B's call in Listen mode;
  3. 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 Listen;
  • The monitored extension should allow being monitored; and it can only be monitored by one extension at the same time;
  • The call monitor only happens to extensions registered on the same PBX.

Endpoint

POST /api/v1.1.0/extension/listen?token={token}

Request Parameters

Name Importance Type Description
listener Required Int The monitor extension.
listenedext Required Int The monitored extension.

Examples

Request Example
POST /api/v1.1.0/extension/listen?token=1e3b3ebb6a974cb42ed31de5413df52d HTTP/1.1
Content-Type:application/json; charset=utf-8
Host: api.yeastarcloud.com
{
    "listener": "1005",
    "listenedext": "1002"
}
Response Example
HTTP/1.1 200 OK
Access-control-allow-origin: *
Access-control-allow-methods: GET, POST, OPTIONS, PUT, DELETE
{
    "status": "Success"
}