Record Start
CATEGORY: RINGQ API List
Description:
The Record Start API will perform the recordStart functionality when the call is ringing in one extension number.
Request URL:
http://<ringq FQDN>:8443/api/values/recordStart
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",
"extension": "1155",
"uuid": "4cc9c0f5-01cb-40a6-80ec-b7875e3596cf",
"file": "/var/lib/freeswitch/recordings/foleycochranco.ringq.ai/archive/2026/Feb/25/1155-4cc9c0f5-01cb-40a6-80ec-b7875e3596cf-20260225-100657.wav"
}