REST ClientCompatQueues

get

View as MarkdownOpen in Claude

Retrieve a single queue by SID.

Path parameters

AccountSidstringRequiredformat: "uuid"
The unique identifier for the account this Queue is associated with.
SidstringRequiredformat: "uuid"
The unique identifier for the queue.

Response

sidstringRequiredformat: "uuid"
The unique identifier for the queue.
account_sidstringRequiredformat: "uuid"
The unique identifier for the account this Queue is associated with.
friendly_namestringRequired
A description that distinguishes a queue.
max_sizeinteger or nullRequired
The maximum number of calls that are allowed to wait in a queue. Null if no limit is set.
current_sizeintegerRequired>=0
The number of calls currently waiting in the queue.
average_wait_timeintegerRequired>=0
The average wait time, in seconds, of callers in a queue.
date_createdstringRequired
The date and time, in RFC 2822 format, the Queue was created.
date_updatedstringRequired
The date and time, in RFC 2822 format, the Queue was updated.
api_versionstringRequired
The version of the SignalWire API.
uristringRequired
The URI of this resource, relative to the API base URL.

Response Example

Response
1{
2  "sid": "b3877c40-da60-4998-90ad-b792e98472qu",
3  "account_sid": "b3877c40-da60-4998-90ad-b792e98472af",
4  "friendly_name": "Queue1",
5  "max_size": 100,
6  "current_size": 0,
7  "average_wait_time": 0,
8  "date_created": "Wed, 26 Sep 2018 18:00:00 +0000",
9  "date_updated": "Thu, 27 Sep 2018 19:00:00 +0000",
10  "api_version": "2010-04-01",
11  "uri": "/api/laml/2010-04-01/Accounts/b3877c40-da60-4998-90ad-b792e98472af/Queues/b3877c40-da60-4998-90ad-b792e98472qu.json"
12}

Example

1import { RestClient } from "@signalwire/sdk";
2
3const client = new RestClient({
4  project: "your-project-id",
5  token: "your-api-token",
6  host: "your-space.signalwire.com"
7});
8
9const queue = await client.compat.queues.get("QU...");