Skip to content Skip to navigation Skip to topbar

Twilio Docs

Programmable Voice

Getting Started with Programmable Voice

No-code quickstart C#/.NET quickstart Java quickstart Node.js quickstart PHP quickstart Python quickstart Ruby quickstart Go quickstart Android SDK quickstart iOS SDK quickstart (Objective-C and Swift)JavaScript SDK quickstarts React Native SDK quickstart

Tutorials

Make outbound phone calls Respond to incoming phone calls Modify calls in progress Record phone calls Create conference calls Gather user input via keypad Retrieve call logs Consume a real-time Media Stream using WebSockets, Python, and Flask Capture a payment during a call Capture a payment during a call (Generic Pay Connector)Build an Interactive Voice Response (IVR) Phone Tree Build an IVR for Screening and Recording Calls Build Warm Transfers with Twilio Build a Rapid Response Kit with Voice Conference and Broadcasting Track your call data Forward calls Encrypt your voice recordings Make and receive phone calls in the browser Build an Automated Survey with Twilio Programmable Voice Route calls to your SIP network with an outbound call Add programmability to your existing SIP network Record a single side of call

Make emergency calls

Overview Emergency telephone numbers

API Reference

Voice API Overview Application Resource

Call Resource

Overview Call Event Resource Stream Resource UserDefinedMessage Resource UserDefinedMessageSubscription Resource

Archived Calls SIPREC

Conference Resource

Overview Conference Participant Resource

Dialing Permissions Resources

Overview DialingPermissions Country Resource DialingPermissions BulkCountryUpdate Resource DialingPermissions HighRiskSpecialPrefix Resource DialingPermissions Settings Resource

Outgoing Caller ID Payment Resource

Queue Resource

Overview Member Resource

Recording Resource

Overview Recording Transcription

TwiML

Overview Changelog

<Connect>

Overview <Room><VirtualAgent>

<Dial>

Overview <Application><Client><Conference><Number><Queue><Sip>

<Enqueue><Gather><Hangup><Leave><Pause>

<Pay>

Overview <Prompt><Parameter>Pay Connectors Generic Pay Connector

<Play><Record><Redirect><Refer><Reject>

<Say>

Overview Text-to-Speech

<Siprec><Stream>

Media Streams

Media Streams Overview WebSocket Messages

Voice Conference

Voice Insights

Overview Voice Insights Event Streams Voice Insights REST API

Programmable Voice SIP

Overview SIP Quickstart Use SIP with Twilio Voice Inbound - Sending SIP to Twilio Outbound - Receiving SIP from Twilio SIP Registration Secure Media Emergency Calling for SIP Interfaces Inbound SIP REFER to Twilio Making SIP Calls TwiML™ Voice: <Sip>

SIP API

SIP API Overview SIP Credential Resource SIP CredentialList Resource SIP CredentialListMapping Resource SIP Domain Resource SIP Domain Registration CredentialListMapping Resource SIP IpAccessControlList Resource SIP IpAccessControlListMapping Resource SIP IpAddress Resource Emergency Calling for SIP Interfaces API

Bring Your Own Carrier (BYOC) Trunking

BYOC API

BYOC API Overview ByocTrunk Resource ConnectionPolicy Resource ConnectionPolicyTarget Resource SourceIpMapping Resource IpRecord Resource

Client-Side SDKs

Overview Network Connectivity Requirements Error Codes Voice SDK Call Message Events

Android SDK

Overview Getting Started with the Voice Android SDK Edge Locations Using Twilio Voice side by side with WebRTC - Android Changelog API Docs Voice Android SDK FAQ Best Practices

iOS SDK

Overview Getting Started with the Voice iOS SDK Edge Locations Using Twilio Voice side by side with WebRTC - iOS Changelog Migrating to iOS 13 API Docs Voice iOS SDK FAQ Best Practices

JavaScript SDK

Overview Getting Started Twilio.Call Twilio.Device Twilio.Device.audio Twilio.PreflightTest Edge Locations Changelog API Docs Best Practices Migration Guide (v2.0)Version 1.x Resources

React Native SDK

Overview Getting Started with the Voice React Native SDK Changelog API Docs

Best Practices & Troubleshooting

Answering Machine Detection FAQ & Best Practices Voice IP Migration Schedule Update Voice Media IP Migration Security FAQ Testing Voice Media IP Migration Why doesn't my invoice match what I pull from the call logs?Programmable Voice Product Behavior Changes in non-us1 Home Regions How to Share Information Between Your Applications Protect your account with Voice Dialing Geographic Permissions Troubleshooting Voice Calls Limits Failover Best Practices

SHAKEN/STIR

Trusted Calling with SHAKEN/STIR

SHAKEN/STIR Onboarding

Overview Onboarding with Twilio Console Trust Hub REST API - Direct Customers, no Subaccounts Trust Hub REST API - Direct Customers using Subaccounts Trust Hub REST API - ISVs/Resellers with Single, Top-Level Project Trust Hub REST API - ISVs/Resellers using Subaccounts

Interactive Voice Response (IVR)

CNAM

Brand Your Calls Using CNAM

Virtual Agent

Overview Dialogflow CX Onboarding Guide TwiML™ Voice: <VirtualAgent> with Dialogflow CX Connect Virtual Agent (Dialogflow CX) Studio Widget

Messaging
Voice
Serverless
Flex
Studio
All docs...

SDKs
Help

Log in
Sign up

Rate this page:

12345

On this page

Queue Properties
Create a Queue resource

Path parameters
Request body parameters
Fetch a Queue resource
Path parameters
Read multiple Queue resources
Path parameters
Query parameters
Update a Queue resource
Path parameters
Request body parameters
Delete a Queue resource
Path parameters

Queue Properties

Create a Queue resource

Path parameters

Request body parameters

Fetch a Queue resource

Path parameters

Read multiple Queue resources

Path parameters

Query parameters

Update a Queue resource

Path parameters

Request body parameters

Delete a Queue resource

Path parameters

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

Property nameTypePIIDescription

date_updatedstring<date-time-rfc-2822>

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

current_sizeinteger

The number of calls currently in the queue.

friendly_namestring

A string that you assigned to describe this resource.

uristring

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

account_sidSID<AC>

The SID of the Account that created this Queue resource.

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

average_wait_timeinteger

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

sidSID<QU>

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

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

date_createdstring<date-time-rfc-2822>

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

max_sizeinteger

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

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

Property nameTypeRequiredPIIDescription

FriendlyNamestringrequired

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

MaxSizeintegerOptional

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

C#

Java

Go

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

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

Fetch a Queue resource

Node.js

Python

C#

Java

Go

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

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

PageSizeintegerOptional

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

Minimum: 1Maximum: 1000

PageintegerOptional

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

Minimum: 0

PageTokenstringOptional

The page token. This is provided by the API.

Read multiple Queue resources

Node.js

Python

C#

Java

Go

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

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

Property nameTypeRequiredPIIDescription

FriendlyNamestringOptional

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

MaxSizeintegerOptional

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

C#

Java

Go

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

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 resource

Node.js

Python

C#

Java

Go

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();

Rate this page:

12345

Need some help?

We all do sometimes; code is hard. Get help now from our support team, or lean on the wisdom of the crowd by visiting Twilio's Stack Overflow Collective or browsing the Twilio tag on Stack Overflow.

Terms of service

Copyright © 2024 Twilio Inc.