REST Client Methods

Queues

View as Markdown

Queue permits you to search and maintain individual call queues.

Properties

idstringRequiredformat: "uuid"
The unique identifier of the queue.
project_idstringRequiredformat: "uuid"
The project ID associated with this queue.
friendly_namestringRequired
The friendly name of the queue.
max_sizeintegerOptional
The maximum number of callers allowed in the queue.
current_sizeintegerOptional
The current number of callers in the queue.
average_wait_timeintegerOptional
The average wait time in seconds.
uristringOptional
The URL of this queue.
date_createddatetimeOptional
Timestamp when the queue was created.
date_updateddatetimeOptional
Timestamp when the queue was last updated.

Example object

The Queue Object
1{
2  "id": "string",
3  "project_id": "string",
4  "friendly_name": "string",
5  "max_size": 0,
6  "current_size": 0,
7  "average_wait_time": 0,
8  "uri": "string",
9  "date_created": "2023-01-01T00:00:00Z",
10  "date_updated": "2023-01-01T00:00:00Z"
11}