Recording List
CATEGORY: RINGQ API List
Description:
The Recording List API will perform the recordingList functionality when the call is ringing in one extension number.
Request URL:
http://<ringq FQDN>:8443/api/values/recordingList
Request Method:
POST
Request Parameters:
| Parameter Name (* Mandatory) | Data Type | Description |
|---|---|---|
| action* | String | Specify the action to perform |
| agentextension* | String | Specify the agent extension number |
| pickupextension* | String | Specify the agent number whom have to pickup the call |
Possible Errors:
| HTTP Status | Message | Reason |
|---|---|---|
| 400 | Agent 102 does not participate in call or call is in incorrect state | The given extension number is not having any calls |
| 400 | Currently no active calls in the pbx system | There is no call in the RingQ right now |
| 400 | Check the extension 101 is currently registered or not, and also does not have any active calls | The given extension is not registered or extension is in another call |
| 400 | Pickup Extension 1001 is not a valid RingQ Extension | Pickup Extension 1001 is not a valid RingQ Extension |
| 400 | Agent Extension 1002 is not a valid RingQ Extension | The agent extension is not in RingQ |
| 400 | Pickup extension is a mandatory one, it can't be null or empty | The pickup extension is mandatory |
| 400 | Agent extension is a mandatory one, it can't be null or empty | The agent extension is mandatory |
| 401 | Unauthorized, does not have permission for Pickup Call | Check whether the pickup call is enabled in omni channel |
Generate API
Sample Response
{
"status": "success",
"domain": "station.ind1.ringq.ai",
"extension": "1013",
"count": 15,
"recordings": [
{
"file": "1013-1155-02-25-26-09:41.mp3",
"date": "2026-Feb-25",
"time": "09:42:10",
"timestamp": 1772005330,
"size_kb": 219.69,
"path": "/var/lib/freeswitch/recordings/station.ind1.ringq.ai/archive/2026/Feb/25/1013-1155-02-25-26-09:41.mp3"
},
{
"file": "1158-1013-01-08-26-11:38.mp3",
"date": "2026-Jan-08",
"time": "11:38:59",
"timestamp": 1767865139,
"size_kb": 70.66,
"path": "/var/lib/freeswitch/recordings/station.ind1.ringq.ai/archive/2026/Jan/08/1158-1013-01-08-26-11:38.mp3"
}
]
}