Barge-in Monitor

Estimated reading: 2 minutes 376 views

Through this interface, an extension can barge in another extension’s call. As a result, all the three parties can talk to each other.

Operations

Extension A is idle, extension B is in a call (query extension list to get the extension status);
Make extension A barge in extension B’s call;
If the operation is successful, extension A will auto answer and barge in 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 Barge-in;
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/barge?token={token}&type={type}

Request Parameters

Name	Importance	Type	Description
bargein	Required	Int	The monitor extension.
bargedext	Required	Int	The monitored extension.

Examples

Request Example

POST /api/v0.0.1/extension/barge?token=813b621cfe8eecf445a2ce1f4a079ffe&type=json HTTP/1.1

Content-Type:application/json; charset=utf-8

Host: 172.16.6.150

{

"bargein": "101",

"bargedext": "106"

}

POST /api/v0.0.1/extension/barge?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>

<bargein>101</bargein>

<bargedext>106</bargedext>

</xml>

Response Example

HTTP/1.1 200 OK

Access-control-allow-origin: *

Access-control-allow-methods: GET, POST, OPTIONS, PUT, DELETE

{

"status": "Success"

}