On this page

Queue Resource

The Queue resource describes a call queue that contains individual calls, which are described by the queue's Member resources. Your account can have more than one call queue. Each queue can be retrieved by its sid directly using fetch. Alternately, you can read the list of Queues and filter by friendly_name or any other property you prefer.

Call queues are created when you add a call to a queue that doesn't exist and when you create one explicitly.

For information about enqueing calls, see Queueing Calls.

(warning)

Warning

Queues persist. To optimize fetch operations, inactive Queues should be deleted.

Queue Properties

Resource properties

date_updatedtype: string<date-time-rfc-2822>

Not PII

The date and time in GMT that this resource was last updated, specified in RFC 2822 format.

current_sizetype: integer

Not PII

The number of calls currently in the queue.

friendly_nametype: string

Not PII

A string that you assigned to describe this resource.

uritype: string

Not PII

The URI of this resource, relative to https://api.twilio.com.

account_sidtype: SID<AC>

Not PII

The SID of the Account that created this Queue resource.

average_wait_timetype: integer

Not PII

The average wait time in seconds of the members in this queue. This is calculated at the time of the request.

sidtype: SID<QU>

Not PII

The unique string that that we created to identify this Queue resource.

date_createdtype: string<date-time-rfc-2822>

Not PII

The date and time in GMT that this resource was created specified in RFC 2822 format.

max_sizetype: integer

Not PII

The maximum number of calls that can be in the queue. The default is 1000 and the maximum is 5000.

Create a Queue resource

POST https://api.twilio.com/2010-04-01/Accounts/{AccountSid}/Queues.json

Parameters

URI parameters

AccountSidtype: SID<AC>

Path ParameterNot PII

The SID of the Account that will create the resource.

Request body parameters

FriendlyNametype: stringRequired

Not PII

A descriptive string that you created to describe this resource. It can be up to 64 characters long.

MaxSizetype: integer

Not PII

The maximum number of calls allowed to be in the queue. The default is 1000. The maximum is 5000.

Create a Queue resource

Node.js

Python

Java

PHP

Ruby

twilio-cli

curl


_10// Download the helper library from https://www.twilio.com/docs/node/install
_10// Find your Account SID and Auth Token at twilio.com/console
_10// and set the environment variables. See http://twil.io/secure
_10const accountSid = process.env.TWILIO_ACCOUNT_SID;
_10const authToken = process.env.TWILIO_AUTH_TOKEN;
_10const client = require('twilio')(accountSid, authToken);
_10
_10client.queues.create({friendlyName: 'friendly_name'})
_10             .then(queue => console.log(queue.sid));

Output


_11{
_11  "account_sid": "ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_11  "average_wait_time": 0,
_11  "current_size": 0,
_11  "date_created": "Tue, 04 Aug 2015 18:39:09 +0000",
_11  "date_updated": "Tue, 04 Aug 2015 18:39:09 +0000",
_11  "friendly_name": "0.361280134646222",
_11  "max_size": 100,
_11  "sid": "QUXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_11  "uri": "/2010-04-01/Accounts/ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Queues/QUXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX.json"
_11}

Fetch a Queue resource

GET https://api.twilio.com/2010-04-01/Accounts/{AccountSid}/Queues/{Sid}.json

Parameters

URI parameters

AccountSidtype: SID<AC>

Path ParameterNot PII

The SID of the Account that created the Queue resource to fetch.

Sidtype: SID<QU>

Path ParameterNot PII

The Twilio-provided string that uniquely identifies the Queue resource to fetch

Fetch a Queue resource

Node.js

Python

Java

PHP

Ruby

twilio-cli

curl


_10// Download the helper library from https://www.twilio.com/docs/node/install
_10// Find your Account SID and Auth Token at twilio.com/console
_10// and set the environment variables. See http://twil.io/secure
_10const accountSid = process.env.TWILIO_ACCOUNT_SID;
_10const authToken = process.env.TWILIO_AUTH_TOKEN;
_10const client = require('twilio')(accountSid, authToken);
_10
_10client.queues('QUXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX')
_10      .fetch()
_10      .then(queue => console.log(queue.friendlyName));

Output


_11{
_11  "account_sid": "ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_11  "average_wait_time": 0,
_11  "current_size": 0,
_11  "date_created": "Tue, 04 Aug 2015 18:39:09 +0000",
_11  "date_updated": "Tue, 04 Aug 2015 18:39:09 +0000",
_11  "friendly_name": "0.361280134646222",
_11  "max_size": 100,
_11  "sid": "QUXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_11  "uri": "/2010-04-01/Accounts/ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Queues/QUXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX.json"
_11}

Read multiple Queue resources

GET https://api.twilio.com/2010-04-01/Accounts/{AccountSid}/Queues.json

Parameters

URI parameters

AccountSidtype: SID<AC>

Path ParameterNot PII

The SID of the Account that created the Queue resources to read.

PageSizetype: integer

Query ParameterNot PII

How many resources to return in each list page. The default is 50, and the maximum is 1000.

Pagetype: integer

Query ParameterNot PII

The page index. This value is simply for client state.

PageTokentype: string

Query ParameterNot PII

The page token. This is provided by the API.

Read multiple Queue resources

Node.js

Python

Java

PHP

Ruby

twilio-cli

curl


_10// Download the helper library from https://www.twilio.com/docs/node/install
_10// Find your Account SID and Auth Token at twilio.com/console
_10// and set the environment variables. See http://twil.io/secure
_10const accountSid = process.env.TWILIO_ACCOUNT_SID;
_10const authToken = process.env.TWILIO_AUTH_TOKEN;
_10const client = require('twilio')(accountSid, authToken);
_10
_10client.queues.list({limit: 20})
_10             .then(queues => queues.forEach(q => console.log(q.sid)));

Output


_26{
_26  "end": 0,
_26  "first_page_uri": "/2010-04-01/Accounts/ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Queues.json?PageSize=1&Page=0",
_26  "next_page_uri": "/2010-04-01/Accounts/ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Queues.json?PageSize=1&Page=1",
_26  "page": 0,
_26  "page_size": 1,
_26  "previous_page_uri": "/2010-04-01/Accounts/ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Queues.json?PageSize=1&Page=0",
_26  "queues": [
_26    {
_26      "account_sid": "ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_26      "average_wait_time": 0,
_26      "current_size": 0,
_26      "date_created": "Tue, 04 Aug 2015 18:39:09 +0000",
_26      "date_updated": "Tue, 04 Aug 2015 18:39:09 +0000",
_26      "friendly_name": "0.361280134646222",
_26      "max_size": 100,
_26      "sid": "QUXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_26      "uri": "/2010-04-01/Accounts/ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Queues/QUXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX.json",
_26      "subresource_uris": {
_26        "members": "/2010-04-01/Accounts/ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Queues/QUXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Members.json"
_26      }
_26    }
_26  ],
_26  "start": 0,
_26  "uri": "/2010-04-01/Accounts/ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Queues.json?PageSize=1&Page=0"
_26}

Update a Queue resource

POST https://api.twilio.com/2010-04-01/Accounts/{AccountSid}/Queues/{Sid}.json

Parameters

URI parameters

AccountSidtype: SID<AC>

Path ParameterNot PII

The SID of the Account that created the Queue resource to update.

Sidtype: SID<QU>

Path ParameterNot PII

The Twilio-provided string that uniquely identifies the Queue resource to update

Request body parameters

FriendlyNametype: string

Not PII

A descriptive string that you created to describe this resource. It can be up to 64 characters long.

MaxSizetype: integer

Not PII

The maximum number of calls allowed to be in the queue. The default is 1000. The maximum is 5000.

Update a Queue resource

Node.js

Python

Java

PHP

Ruby

twilio-cli

curl


_10// Download the helper library from https://www.twilio.com/docs/node/install
_10// Find your Account SID and Auth Token at twilio.com/console
_10// and set the environment variables. See http://twil.io/secure
_10const accountSid = process.env.TWILIO_ACCOUNT_SID;
_10const authToken = process.env.TWILIO_AUTH_TOKEN;
_10const client = require('twilio')(accountSid, authToken);
_10
_10client.queues('QUXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX')
_10      .update({friendlyName: 'friendly_name'})
_10      .then(queue => console.log(queue.friendlyName));

Output


_11{
_11  "account_sid": "ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_11  "average_wait_time": 0,
_11  "current_size": 0,
_11  "date_created": "Tue, 04 Aug 2015 18:39:09 +0000",
_11  "date_updated": "Tue, 04 Aug 2015 18:39:09 +0000",
_11  "friendly_name": "0.361280134646222",
_11  "max_size": 100,
_11  "sid": "QUXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_11  "uri": "/2010-04-01/Accounts/ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Queues/QUXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX.json"
_11}

Delete a Queue resource

DELETE https://api.twilio.com/2010-04-01/Accounts/{AccountSid}/Queues/{Sid}.json

Parameters

URI parameters

AccountSidtype: SID<AC>

Path ParameterNot PII

The SID of the Account that created the Queue resource to delete.

Sidtype: SID<QU>

Path ParameterNot PII

The Twilio-provided string that uniquely identifies the Queue resource to delete

Delete a Queue resource

Node.js

Python

Java

PHP

Ruby

twilio-cli

curl


_10// Download the helper library from https://www.twilio.com/docs/node/install
_10// Find your Account SID and Auth Token at twilio.com/console
_10// and set the environment variables. See http://twil.io/secure
_10const accountSid = process.env.TWILIO_ACCOUNT_SID;
_10const authToken = process.env.TWILIO_AUTH_TOKEN;
_10const client = require('twilio')(accountSid, authToken);
_10
_10client.queues('QUXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX').remove();