get
https://{defaultHost}/api/v4/routing/queues/
Returns detailed information about a specific queue.
The Get queue endpoint returns details for a single inbound routing queue.
Requirements: Base URL, Authentication, Error codes
Scope: routing.queues.read
What this does
When you send a Get queue request with a queue ID, Voiso returns the queue details for that queue.
When to use it
- Display queue details in an admin or reporting tool
- Validate a queue ID returned by Get queues
- Retrieve queue configuration before requesting related resources, such as queue users or supervisors
Prerequisites
- The queue must exist in the contact center.
- You must have access to the queue.
Endpoint
GET /api/v4/routing/queues/{queue_id}
Path parameters
- queue_id
The unique identifier of the queue.
Examples
Minimal request
curl -X GET "https://{cluster_id}.voiso.com/api/v4/routing/queues/1" \
-H "Authorization: Bearer <contact_center_api_key>" \
-H "Content-Type: application/json"Response
If successful, the API returns a queue object.
{
"queue": {
"id": 1,
"name": "Technical Support",
"extension": "4000",
"strategy": "ring_all",
"music_on_hold": {
"type": "music_on_hold",
"name": "Morning coffee (Default)"
},
"in_queue_announcement": {
"interval": 60,
"voice_message": {
"type": "voice_message",
"name": "Instructions"
},
"announce_position": true,
"announce_wait_time": true
},
"failover_destination": {
"type": "voicemail",
"wait_time": 300,
"destination": {
"voicemail": {
"voice_message": {
"type": "voice_message",
"name": "Leave a message"
},
"report": {
"emails": [
"[email protected]"
]
}
}
}
},
"callback": {
"wait_time": 300,
"caller_id_group": {
"id": 1,
"name": "Default"
},
"offer_voice_message": {
"type": "voice_message",
"name": "Offer callback"
},
"confirmation_voice_message": {
"type": "voice_message",
"name": "Callback confirmed"
}
},
"post_call_rating": {
"notification_voice_message": {
"type": "voice_message",
"name": "Survey notification"
},
"instruction_voice_message": {
"type": "voice_message",
"name": "Survey instructions"
},
"complete_voice_message": {
"type": "voice_message",
"name": "Survey completed"
}
},
"channels": [
{
"channel": "whatsapp",
"priority": 1
}
],
"skills": [
{
"id": 1,
"name": "Sales"
}
]
}
}
Next steps
- Retrieve queue members: Get queue users
- Retrieve queue supervisors: Get queue supervisors
Troubleshooting
401 Unauthorized
What to check:
- You are sending
Authorization: Bearer <contact_center_api_key>. - Your Base URL includes the correct
{cluster_id}.
403 Forbidden
What to check:
- The API key is valid, but does not have access to this queue.
404 Not found
This usually means the queue ID does not exist, or you do not have access to it.
What to check:
- Confirm the queue ID using Get queues.
Example response:
{ "error": "Not found" }429 Too many requests
What to do:
- Reduce request frequency and retry with backoff.
Example response:
{ "error": "Too many requests" }