Allows searching Queues by name.

To fetch queues whose name partially or totally match a given string (this will be case insensitive), fill in this query parameter with the string to search for.

Allows filtering by the Queue Id (only filtering by one id is allowed).
If the id and name parameters are both filled in, the id prevails because it is the first rule.

To fetch a given queue, fill this query parameter with the Queue id.

The order_by parameter allows you to sort the retrieved results. If not specified, the default sorting will be based on the most recent Queue update (updated_at). Sort by multiple fields is currently not supported.

Supported sort fields

• name - Sort by queue name

Examples

• order_by=name:desc - Retrieve results sorted by queue name in descending order.

Allows filtering by Prompt Id(s). Supports one or more values, separated by commas.

To fetch queues that use specific Prompt Id(s), provide the Prompt Id(s) in this query parameter.

A queue matches when a requested Prompt Id is configured as its transfer waiting music, its voice waiting experience music, or its voice waiting experience message. Default music and text-to-speech messages are never matched. The total in the response counts every matching queue.

Optional policy to use when evaluating the request.