17 REST endpoints for call control, monitoring, recording, and queue management. Fill in your PBX credentials in the builder to generate ready-to-run curl commands.
Enables a supervisor to silently listen to an active call without being heard.
http://<ringq FQDN>:8443/api/values/listenCall| Parameter | Type | Description |
|---|---|---|
| action* | String | Specify the action to perform |
| agentextension* | String | Specify the agent extension number |
| pickupextension* | String | Specify the agent number who has to pick up the call |
| Status | Message | Reason |
|---|---|---|
| 400 | Agent 102 does not participate in call or call is in incorrect state | Given extension has no active calls |
| 400 | Currently no active calls in the pbx system | No active calls in RingQ right now |
| 400 | Check extension 101 — not registered or has active calls | Extension unregistered or busy |
| 400 | Pickup Extension 1001 is not a valid RingQ Extension | Pickup extension is invalid |
| 400 | Agent Extension 1002 is not a valid RingQ Extension | Agent extension not in RingQ |
| 400 | Pickup extension is mandatory, can't be null or empty | Missing pickup extension |
| 400 | Agent extension is mandatory, can't be null or empty | Missing agent extension |
| 401 | Unauthorized, does not have permission for Pickup Call | Pickup call not enabled in omni channel |
Global Config
Sample Response
{
"status": "success",
"agent": "1013",
"manager": "1160",
"mode": "silent_listen"
}