The Queues API is part of the Inbound Routing APIs. Use it to obtain a list of all queues you can access based on your user API key.
This legacy information is part of v1, v2, or v3, which will be supported only until March 31, 2027. To avoid disruption, migrate your integration to v4 before that date. For endpoint mappings, Bearer token authentication, and scoped API key guidance, see the Migrating to v4 article in the Developer's Guide.
Please refer to the detailed API endpoint specification: List queues
Get queues
This API lets you query inbound queues by sending a List queues request to your contact center.
Tip: You can use this API to retrieve object values needed for Get CDR.
Prerequisites
- The requesting user must be configured in your contact center.
- You must have at least one queue configured for your contact center.
Making requests
The queues API requires the Base URL (cluster_id) and the API key of a specific user. This tells Voiso which user is making the request. Voiso responds with the list of users the requesting user can access.
This API is used to request a list of queues. For example:
{
"method": "GET",
"url": "https://cluster1.contact_center_name.com/api/v2/cdr/queues",
"params": {
"key": "cc7c76b8987a27ab57...00ab6c3"
}
}
Response
The following table describes the elements of the response.
| Element | Description | Type | Notes |
|---|---|---|---|
| name | The name of the queue. | string | |
| id | The ID assigned to the queue when it was created. | number |
Response sample
[
{
"name": "Sales queue",
"id": 28982
}
]