GetQueues | Voximplant Voice AI

curl -X POST https://api.voximplant.com/platform_api/GetQueues \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{}'

{
  "result": [
    {
      "acd_queue_id": 101,
      "acd_queue_name": "sales_inbound",
      "application_id": 12,
      "acd_queue_priority": 0,
      "service_probability": 1,
      "auto_binding": true,
      "modified": "2024-06-10 09:45:00"
    },
    {
      "acd_queue_id": 102,
      "acd_queue_name": "customer_support",
      "application_id": 12,
      "acd_queue_priority": 1,
      "service_probability": 0.9,
      "auto_binding": true,
      "max_waiting_time": 10,
      "max_queue_size": 50,
      "average_service_time": 240,
      "modified": "2024-06-10 09:45:00"
    }
  ],
  "total_count": 17,
  "count": 2
}

Gets the ACD queues.

Allowed roles: Owner, Admin, Developer, Supervisor.

Example request: Get the two 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

acd_queue_idintegerOptional

The ACD queue ID to filter

acd_queue_namestringOptional

The ACD queue name part to filter

application_idintegerOptional

The application ID to filter

skill_idintegerOptional

The skill ID to filter

excluded_skill_idintegerOptional

The excluded skill ID to filter

with_skillsbooleanOptionalDefaults to false

Whether to get the bound skills

showing_skill_idintegerOptional

The skill to show in the 'skills' field output

countintegerOptionalDefaults to 20

The max returning record count

offsetintegerOptionalDefaults to 0

The first N records are skipped in the output

with_operatorcountbooleanOptionalDefaults to false

Whether to include the number of agents bound to the queue

Response

Successful response

resultlist of objects

total_countinteger

The total found queue count

countinteger

The returned queue count