SQ_GetQueues | Voximplant Voice AI

curl -X POST "https://api.voximplant.com/platform_api/SQ_GetQueues?application_id=1" \
     -H "Authorization: Bearer <token>"

{
  "result": [
    {
      "sq_queue_id": 1611,
      "sq_queue_name": "First test queue",
      "created": "2022-10-10 11:46:52",
      "modified": "2023-07-19 08:17:35",
      "call_max_waiting_time": 120,
      "call_max_waiting_time_in_seconds": 7200,
      "im_max_waiting_time": 120,
      "im_max_waiting_time_in_seconds": 7200,
      "call_max_queue_size": 1000,
      "im_max_queue_size": 1000,
      "agentcount": 2,
      "CALL": {
        "task_selection": "MAX_WAITING_TIME",
        "agent_selection": "MOST_QUALIFIED",
        "max_waiting_time": 120,
        "max_queue_size": 1000,
        "max_waiting_time_in_seconds": 7200
      },
      "IM": {
        "task_selection": "MAX_WAITING_TIME",
        "agent_selection": "MOST_QUALIFIED",
        "max_waiting_time": 120,
        "max_queue_size": 1000,
        "max_waiting_time_in_seconds": 7200
      },
      "call_agent_selection": "MOST_QUALIFIED",
      "priority": 1,
      "im_task_selection": "MAX_WAITING_TIME",
      "im_agent_selection": "MOST_QUALIFIED",
      "call_task_selection": "MAX_WAITING_TIME"
    },
    {
      "sq_queue_id": 7475,
      "sq_queue_name": "Fourth_queue",
      "description": "",
      "created": "2025-04-10 05:53:50",
      "modified": "2025-04-10 05:53:50",
      "call_max_waiting_time": 1,
      "call_max_waiting_time_in_seconds": 60,
      "im_max_waiting_time": 120,
      "im_max_waiting_time_in_seconds": 7200,
      "call_max_queue_size": 1000,
      "im_max_queue_size": 1000,
      "agentcount": 0,
      "CALL": {
        "task_selection": "MAX_WAITING_TIME",
        "agent_selection": "MOST_QUALIFIED",
        "max_waiting_time": 1,
        "max_queue_size": 1000,
        "max_waiting_time_in_seconds": 60
      },
      "IM": {
        "task_selection": "MAX_WAITING_TIME",
        "agent_selection": "MOST_QUALIFIED",
        "max_waiting_time": 120,
        "max_queue_size": 1000,
        "max_waiting_time_in_seconds": 7200
      },
      "call_agent_selection": "MOST_QUALIFIED",
      "priority": 1,
      "im_task_selection": "MAX_WAITING_TIME",
      "im_agent_selection": "MOST_QUALIFIED",
      "call_task_selection": "MAX_WAITING_TIME"
    },
    {
      "sq_queue_id": 1617,
      "sq_queue_name": "Third queue",
      "created": "2022-10-17 10:09:36",
      "modified": "2022-10-17 10:09:36",
      "call_max_waiting_time": 120,
      "call_max_waiting_time_in_seconds": 7200,
      "im_max_waiting_time": 120,
      "im_max_waiting_time_in_seconds": 7200,
      "call_max_queue_size": 1000,
      "im_max_queue_size": 1000,
      "agentcount": 0,
      "CALL": {
        "task_selection": "MAX_WAITING_TIME",
        "agent_selection": "MOST_QUALIFIED",
        "max_waiting_time": 120,
        "max_queue_size": 1000,
        "max_waiting_time_in_seconds": 7200
      },
      "IM": {
        "task_selection": "MAX_WAITING_TIME",
        "agent_selection": "MOST_QUALIFIED",
        "max_waiting_time": 120,
        "max_queue_size": 1000,
        "max_waiting_time_in_seconds": 7200
      },
      "call_agent_selection": "MOST_QUALIFIED",
      "priority": 1,
      "im_task_selection": "MAX_WAITING_TIME",
      "im_agent_selection": "MOST_QUALIFIED",
      "call_task_selection": "MAX_WAITING_TIME"
    }
  ],
  "total_count": 3,
  "count": 3
}

Gets the queue(s).

Example request: Get all the queues.

Authentication

AuthorizationBearer

Voximplant Management API uses signed JWT tokens generated from your service-account private key. Pass the token in the Authorization header as a Bearer value:

Authorization: Bearer $VOXIMPLANT_TOKEN

See Authorization for ready-to-copy snippets in bash, Python, Node.js and Go that turn your credentials.json into a token.

Voximplant Management API uses signed JWT tokens generated from your service-account private key. Pass the token in the `Authorization` header as a Bearer value: ``` Authorization: Bearer $VOXIMPLANT_TOKEN ``` See [Authorization](/api-reference/management-api/authorization) for ready-to-copy snippets in bash, Python, Node.js and Go that turn your `credentials.json` into a token.

Query parameters

application_idintegerRequired

Application ID to search by

application_namestringOptional

Application name to search by. Can be used instead of application_id

sq_queue_idlist of integersOptional

List of SmartQueue IDs separated by semicolons (;)

sq_queue_namelist of stringsOptional

List of SmartQueue names separated by semicolons (;). Can be used instead of sq_queue_id

sq_queue_name_templatestringOptional

Substring of the SmartQueue name to filter

user_idintegerOptional

ID of the user that is bound to the queue

user_namestringOptional

Name of the user that is bound to the queue. Can be used instead of user_id

excluded_user_idintegerOptional

ID of the user that is not bound to the queue

excluded_user_namestringOptional

Name of the user that is not bound to the queue. Can be used instead of excluded_user_id

countintegerOptionalDefaults to 20

Number of items to show in the output

offsetintegerOptionalDefaults to 0

Number of items to skip in the output

with_agentcountbooleanOptionalDefaults to false

Whether to include the number of agents bound to the queue

Response

Successful response

resultlist of objects

The found queue(s)

total_countinteger

countinteger