Monitoring

Silently listen to, whisper to agents during, barge in on, or join active calls.

Listen Call

Enables a supervisor to silently listen to an active call without being heard by either party.

POST /api/values/listenCall

Parameters

Parameter	Type	Required	Description
action	string	✓	"listenCall"
agentextension	string	✓	The agent extension on the active call
pickupextension	string	✓	The supervisor extension that will listen

Example

curl -X POST "http://<ringq-fqdn>:8443/api/values/listenCall" \
  -H "Content-Type: application/json" \
  -H "X-API-Key: <API_KEY>" \
  -H "X-Secret-Key: <SECRET_KEY>" \
  -d '{
    "action": "listenCall",
    "agentextension": "101",
    "pickupextension": "200"
  }'

Response

{
  "status": "success",
  "agent": "1013",
  "manager": "1160",
  "agent_uuid": "d7ef880f-26c6-4e0b-8d13-0836a12222c2",
  "mode": "silent_listen"
}

---

Whisper Call

Enables a supervisor to speak privately to the agent during a live call without the customer hearing.

POST /api/values/whisperCall

Parameters

Parameter	Type	Required	Description
action	string	✓	"whisperCall"
agentextension	string	✓	The agent extension on the active call
pickupextension	string	✓	The supervisor extension that will whisper

Example

curl -X POST "http://<ringq-fqdn>:8443/api/values/whisperCall" \
  -H "Content-Type: application/json" \
  -H "X-API-Key: <API_KEY>" \
  -H "X-Secret-Key: <SECRET_KEY>" \
  -d '{
    "action": "whisperCall",
    "agentextension": "101",
    "pickupextension": "200"
  }'

Response

{
  "status": "success",
  "mode": "whisper",
  "agent": "1013",
  "manager": "1160",
  "agent_uuid": "dd03aef7-112a-4990-8cf2-39814cf950f1"
}

---

Barge-In Call

Allows a supervisor to join an ongoing call so all three parties can hear each other.

POST /api/values/bargeInCall

Parameters

Parameter	Type	Required	Description
action	string	✓	"bargeInCall"
agentextension	string	✓	The agent extension on the active call
pickupextension	string	✓	The supervisor extension that will barge in

Example

curl -X POST "http://<ringq-fqdn>:8443/api/values/bargeInCall" \
  -H "Content-Type: application/json" \
  -H "X-API-Key: <API_KEY>" \
  -H "X-Secret-Key: <SECRET_KEY>" \
  -d '{
    "action": "bargeInCall",
    "agentextension": "101",
    "pickupextension": "200"
  }'

Response

{
  "status": "success",
  "mode": "barge_in",
  "room": "bargein_0712bf12"
}

---

Join Call

Joins a specified extension to an active conference or call session in the RingQ PBX.

POST /api/values/joinCall

Parameters

Parameter	Type	Required	Description
action	string	✓	"joinCall"
agentextension	string	✓	The extension of the active call session
pickupextension	string	✓	The extension joining the call

Example

curl -X POST "http://<ringq-fqdn>:8443/api/values/joinCall" \
  -H "Content-Type: application/json" \
  -H "X-API-Key: <API_KEY>" \
  -H "X-Secret-Key: <SECRET_KEY>" \
  -d '{
    "action": "joinCall",
    "agentextension": "101",
    "pickupextension": "200"
  }'

Response

{
  "status": "success",
  "extension": "1033",
  "domain": "station.ind1.ringq.ai",
  "message": "Join Success"
}