Voicemail & Queue

Delete voicemail messages and manage agent login status in call queues.

Voicemail Delete

Deletes one or more voicemail messages from the specified extension’s mailbox. Omit filename to delete all messages.

POST /api/values/voicemailDelete

Parameters

Parameter	Type	Required	Description
action	string	✓	"voicemailDelete"
agentextension	string	✓	The extension whose voicemail to delete from
filename	string		Specific file to delete. Omit to delete all messages.

Example

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

Response

{
  "status": "success",
  "mode": "single",
  "extension": "1013",
  "deleted": ["msg_05c75ef9.wav"],
  "failed": []
}

---

Queue Login

Logs an agent into the specified queue so they can begin receiving calls.

POST /api/values/queueLogin

Parameters

Parameter	Type	Required	Description
action	string	✓	"queueLogin"
agentextension	string	✓	The agent extension to log in
queuename	string	✓	The name of the queue to log into

Example

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

Response

{
  "status": "success",
  "message": "Agent logged in successfully"
}

---

Queue Logout

Logs an agent out of the specified queue, stopping further call routing to that extension.

POST /api/values/queueLogout

Parameters

Parameter	Type	Required	Description
action	string	✓	"queueLogout"
agentextension	string	✓	The agent extension to log out
queuename	string	✓	The name of the queue to log out from

Example

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

Response

{
  "status": "success",
  "message": "Agent logged out successfully"
}