Skip to content Skip to navigation Skip to topbar

Queues resource

On this reference page, you'll learn the properties, methods, and parameters for the Queues resource. See Related how-to documentation to learn the steps to use the info on this page.

A Queue resource describes a call queue that contains individual calls, which are described by the queue's Members subsresource. 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 enqueuing calls, see Queueing Calls.

(warning)

Warning

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

Queues properties

Property nameTypeRequiredPIIDescriptionChild properties

endinteger

Optional

firstPageUristring<uri>

Optional

nextPageUristring<uri>

Optional

pageinteger

Optional

pageSizeinteger

Optional

previousPageUristring<uri>

Optional

startinteger

Optional

uristring<uri>

Optional

queuesarray[object]

Optional

Show queues properties

Create a Queue

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

Path parameters

Property nameTypeRequiredPIIDescription

accountSidSID<AC>

required

The SID of the Account that will create the resource.

Pattern: ^AC[0-9a-fA-F]{32}$Min length: 34Max length: 34

Request body parameters

Encoding type:application/x-www-form-urlencoded

SchemaExample

Property nameTypeRequiredPIIDescriptionChild properties

friendlyNamestring

required

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

maxSizeinteger

Optional

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

Create a Queue

1// Download the helper library from https://www.twilio.com/docs/node/install
2const twilio = require("twilio"); // Or, for ESM: import twilio from "twilio";
3
4// Find your Account SID at twilio.com/console
5// Provision API Keys at twilio.com/console/runtime/api-keys
6// and set the environment variables. See http://twil.io/secure
7// For local testing, you can use your Account SID and Auth token
8const accountSid = process.env.TWILIO_ACCOUNT_SID;
9const apiKey = process.env.TWILIO_API_KEY;
10const apiSecret = process.env.TWILIO_API_SECRET;
11const client = twilio(apiKey, apiSecret, { accountSid: accountSid });
12
13async function createQueue() {
14  const queue = await client.queues.create({ friendlyName: "FriendlyName" });
15
16  console.log(queue.dateUpdated);
17}
18
19createQueue();

Response

1{
2  "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
3  "average_wait_time": 0,
4  "current_size": 0,
5  "date_created": "Tue, 04 Aug 2015 18:39:09 +0000",
6  "date_updated": "Tue, 04 Aug 2015 18:39:09 +0000",
7  "friendly_name": "FriendlyName",
8  "max_size": 100,
9  "sid": "QUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
10  "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Queues/QUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json"
11}

Retrieve a Queue

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

Path parameters

Property nameTypeRequiredPIIDescription

accountSidSID<AC>

required

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

Pattern: ^AC[0-9a-fA-F]{32}$Min length: 34Max length: 34

sidSID<QU>

required

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

Pattern: ^QU[0-9a-fA-F]{32}$Min length: 34Max length: 34

Retrieve a Queue

1// Download the helper library from https://www.twilio.com/docs/node/install
2const twilio = require("twilio"); // Or, for ESM: import twilio from "twilio";
3
4// Find your Account SID at twilio.com/console
5// Provision API Keys at twilio.com/console/runtime/api-keys
6// and set the environment variables. See http://twil.io/secure
7// For local testing, you can use your Account SID and Auth token
8const accountSid = process.env.TWILIO_ACCOUNT_SID;
9const apiKey = process.env.TWILIO_API_KEY;
10const apiSecret = process.env.TWILIO_API_SECRET;
11const client = twilio(apiKey, apiSecret, { accountSid: accountSid });
12
13async function fetchQueue() {
14  const queue = await client
15    .queues("QUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa")
16    .fetch();
17
18  console.log(queue.dateUpdated);
19}
20
21fetchQueue();

Response

1{
2  "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
3  "average_wait_time": 0,
4  "current_size": 0,
5  "date_created": "Tue, 04 Aug 2015 18:39:09 +0000",
6  "date_updated": "Tue, 04 Aug 2015 18:39:09 +0000",
7  "friendly_name": "0.361280134646222",
8  "max_size": 100,
9  "sid": "QUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
10  "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Queues/QUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json"
11}

Retrieve a list of Queues

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

Path parameters

Property nameTypeRequiredPIIDescription

accountSidSID<AC>

required

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

Pattern: ^AC[0-9a-fA-F]{32}$Min length: 34Max length: 34

Query parameters

Property nameTypeRequiredPIIDescription

pageSizeinteger<int64>

Optional

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

Minimum: 1Maximum: 1000

pageinteger

Optional

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

Minimum: 0

pageTokenstring

Optional

The page token. This is provided by the API.

Retrieve a list of Queues

1// Download the helper library from https://www.twilio.com/docs/node/install
2const twilio = require("twilio"); // Or, for ESM: import twilio from "twilio";
3
4// Find your Account SID at twilio.com/console
5// Provision API Keys at twilio.com/console/runtime/api-keys
6// and set the environment variables. See http://twil.io/secure
7// For local testing, you can use your Account SID and Auth token
8const accountSid = process.env.TWILIO_ACCOUNT_SID;
9const apiKey = process.env.TWILIO_API_KEY;
10const apiSecret = process.env.TWILIO_API_SECRET;
11const client = twilio(apiKey, apiSecret, { accountSid: accountSid });
12
13async function listQueue() {
14  const queues = await client.queues.list({ limit: 20 });
15
16  queues.forEach((q) => console.log(q.end));
17}
18
19listQueue();

Response

1{
2  "end": 0,
3  "first_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Queues.json?PageSize=1&Page=0",
4  "next_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Queues.json?PageSize=1&Page=1&PageToken=PAQUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
5  "page": 0,
6  "page_size": 1,
7  "previous_page_uri": null,
8  "queues": [
9    {
10      "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
11      "average_wait_time": 0,
12      "current_size": 0,
13      "date_created": "Tue, 04 Aug 2015 18:39:09 +0000",
14      "date_updated": "Tue, 04 Aug 2015 18:39:09 +0000",
15      "friendly_name": "0.361280134646222",
16      "max_size": 100,
17      "sid": "QUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
18      "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Queues/QUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json"
19    }
20  ],
21  "start": 0,
22  "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Queues.json?PageSize=1&Page=0"
23}

Update a Queue

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

Path parameters

Property nameTypeRequiredPIIDescription

accountSidSID<AC>

required

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

Pattern: ^AC[0-9a-fA-F]{32}$Min length: 34Max length: 34

sidSID<QU>

required

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

Pattern: ^QU[0-9a-fA-F]{32}$Min length: 34Max length: 34

Request body parameters

Encoding type:application/x-www-form-urlencoded

SchemaExample

Property nameTypeRequiredPIIDescriptionChild properties

friendlyNamestring

Optional

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

maxSizeinteger

Optional

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

Update a Queue

1// Download the helper library from https://www.twilio.com/docs/node/install
2const twilio = require("twilio"); // Or, for ESM: import twilio from "twilio";
3
4// Find your Account SID at twilio.com/console
5// Provision API Keys at twilio.com/console/runtime/api-keys
6// and set the environment variables. See http://twil.io/secure
7// For local testing, you can use your Account SID and Auth token
8const accountSid = process.env.TWILIO_ACCOUNT_SID;
9const apiKey = process.env.TWILIO_API_KEY;
10const apiSecret = process.env.TWILIO_API_SECRET;
11const client = twilio(apiKey, apiSecret, { accountSid: accountSid });
12
13async function updateQueue() {
14  const queue = await client
15    .queues("QUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa")
16    .update({ friendlyName: "FriendlyName" });
17
18  console.log(queue.dateUpdated);
19}
20
21updateQueue();

Response

1{
2  "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
3  "average_wait_time": 0,
4  "current_size": 0,
5  "date_created": "Tue, 04 Aug 2015 18:39:09 +0000",
6  "date_updated": "Tue, 04 Aug 2015 18:39:09 +0000",
7  "friendly_name": "FriendlyName",
8  "max_size": 100,
9  "sid": "QUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
10  "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Queues/QUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json"
11}

Delete a Queue

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

Path parameters

Property nameTypeRequiredPIIDescription

accountSidSID<AC>

required

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

Pattern: ^AC[0-9a-fA-F]{32}$Min length: 34Max length: 34

sidSID<QU>

required

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

Pattern: ^QU[0-9a-fA-F]{32}$Min length: 34Max length: 34

Delete a Queue

1// Download the helper library from https://www.twilio.com/docs/node/install
2const twilio = require("twilio"); // Or, for ESM: import twilio from "twilio";
3
4// Find your Account SID at twilio.com/console
5// Provision API Keys at twilio.com/console/runtime/api-keys
6// and set the environment variables. See http://twil.io/secure
7// For local testing, you can use your Account SID and Auth token
8const accountSid = process.env.TWILIO_ACCOUNT_SID;
9const apiKey = process.env.TWILIO_API_KEY;
10const apiSecret = process.env.TWILIO_API_SECRET;
11const client = twilio(apiKey, apiSecret, { accountSid: accountSid });
12
13async function deleteQueue() {
14  await client.queues("QUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa").remove();
15}
16
17deleteQueue();