REST Client MethodsQueues

Update

View as Markdown

Use this endpoint for the Queues method to modify the properties of a single call queue.

Path parameters

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

Request

FriendlyNamestringRequiredformat: "^\w+$">=1 character
A unique name for the queue. Must contain only alphanumeric characters and underscores.
MaxSizeintegerOptional
The maximum number of calls that are allowed to wait in a queue. Must be a positive integer.

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.

Request examples

1const { RestClient } = require('@signalwire/compatibility-api')
2const client = RestClient('YourProjectID', 'YourAuthToken', { signalwireSpaceUrl: 'example.signalwire.com' })
3
4client.queues('QueueSid')
5      .update()
6      .then(queue => console.log(queue.friendlyName))
7      .done();

Request: update the size of a queue

Change the maximum size of a call queue to 200 queue members.

1const { RestClient } = require('@signalwire/compatibility-api')
2const client = RestClient('YourProjectID', 'YourAuthToken', { signalwireSpaceUrl: 'example.signalwire.com' })
3
4client.queues('QueueSid')
5      .update({ maxSize: 200 })
6      .then(queue => console.log(queue.friendlyName))
7      .done();