Skip to content Skip to navigation Skip to topbar

On this page

Member Resource

The Member resource is a subresource of the Queue resource and represents a single call in a call queue.

All members in a call queue can be identified by their unique CallSid, and the member at the front of the queue can be identified by the Front sid.

Member Properties

Property nameTypeRequiredDescriptionChild properties

call_sidSID<CA>

Optional

Not PII

The SID of the Call the Member resource is associated with.

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

date_enqueuedstring<date-time-rfc-2822>

Optional

Not PII

The date that the member was enqueued, given in RFC 2822 format.

positioninteger

Optional

Not PII

This member's current position in the queue.

Default: 0

uristring

Optional

Not PII

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

wait_timeinteger

Optional

Not PII

The number of seconds the member has been in the queue.

Default: 0

queue_sidSID<QU>

Optional

Not PII

The SID of the Queue the member is in.

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

Fetch a Member resource

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

You can address the member to fetch by its unique CallSid or by the Front sid to fetch the member at the front of the queue.

Path parameters

Property nameTypeRequiredPIIDescription

AccountSidSID<AC>required

Not PII

The SID of the Account that created the Member resource(s) to fetch.

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

QueueSidSID<QU>required

Not PII

The SID of the Queue in which to find the members to fetch.

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

CallSidstringrequired

Not PII

The Call SID of the resource(s) to fetch.

Fetch a Member resource

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 and Auth Token at twilio.com/console
5// and set the environment variables. See http://twil.io/secure
6const accountSid = process.env.TWILIO_ACCOUNT_SID;
7const authToken = process.env.TWILIO_AUTH_TOKEN;
8const client = twilio(accountSid, authToken);
9
10async function fetchMember() {
11  const member = await client
12    .queues("QUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa")
13    .members("CallSid")
14    .fetch();
15
16  console.log(member.callSid);
17}
18
19fetchMember();

Output

1{
2  "queue_sid": "QUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
3  "call_sid": "CallSid",
4  "date_enqueued": "Tue, 07 Aug 2012 22:57:41 +0000",
5  "position": 1,
6  "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Queues/QUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Members/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json",
7  "wait_time": 143
8}

Fetch the Member resource at the front of the 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 and Auth Token at twilio.com/console
5// and set the environment variables. See http://twil.io/secure
6const accountSid = process.env.TWILIO_ACCOUNT_SID;
7const authToken = process.env.TWILIO_AUTH_TOKEN;
8const client = twilio(accountSid, authToken);
9
10async function fetchMember() {
11  const member = await client
12    .queues("QUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa")
13    .members("Front")
14    .fetch();
15
16  console.log(member.callSid);
17}
18
19fetchMember();

Output

1{
2  "queue_sid": "QUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
3  "call_sid": "Front",
4  "date_enqueued": "Tue, 07 Aug 2012 22:57:41 +0000",
5  "position": 1,
6  "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Queues/QUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Members/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json",
7  "wait_time": 143
8}

Read multiple Member resources

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

Path parameters

Property nameTypeRequiredPIIDescription

AccountSidSID<AC>required

Not PII

The SID of the Account that created the Member resource(s) to read.

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

QueueSidSID<QU>required

Not PII

The SID of the Queue in which to find the members

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

Query parameters

Property nameTypeRequiredPIIDescription

PageSizeinteger

Optional

Not PII

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

Minimum: 1Maximum: 1000

Pageinteger

Optional

Not PII

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

Minimum: 0

PageTokenstring

Optional

Not PII

The page token. This is provided by the API.

Read multiple Member resources

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 and Auth Token at twilio.com/console
5// and set the environment variables. See http://twil.io/secure
6const accountSid = process.env.TWILIO_ACCOUNT_SID;
7const authToken = process.env.TWILIO_AUTH_TOKEN;
8const client = twilio(accountSid, authToken);
9
10async function listMember() {
11  const members = await client
12    .queues("QUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa")
13    .members.list({ limit: 20 });
14
15  members.forEach((m) => console.log(m.callSid));
16}
17
18listMember();

Output

1{
2  "end": 0,
3  "first_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Queues/QUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Members.json?PageSize=50&Page=0",
4  "next_page_uri": null,
5  "page": 0,
6  "page_size": 50,
7  "previous_page_uri": null,
8  "queue_members": [
9    {
10      "queue_sid": "QUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
11      "call_sid": "CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
12      "date_enqueued": "Mon, 17 Dec 2018 18:36:39 +0000",
13      "position": 1,
14      "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Queues/QUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Members/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json",
15      "wait_time": 124
16    }
17  ],
18  "start": 0,
19  "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Queues/QUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Members.json?PageSize=50&Page=0"
20}

Update a Member resource

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

Updating a Member resource dequeues the member to begin executing the TwiML document at that URL.

You can address the member to dequeue by its unique CallSid or by the Front sid.

If you successfully dequeue a member by its unique CallSid, it will no longer be queued so a second update action on that same member will fail.

When dequeueing a member by using the Front SID, that member will be dequeued and the next member in the queue will take its place.

Path parameters

Property nameTypeRequiredPIIDescription

AccountSidSID<AC>required

Not PII

The SID of the Account that created the Member resource(s) to update.

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

QueueSidSID<QU>required

Not PII

The SID of the Queue in which to find the members to update.

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

CallSidstringrequired

Not PII

The Call SID of the resource(s) to update.

Request body parameters

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

SchemaExample

Property nameTypeRequiredDescriptionChild properties

Urlstring<uri>required

Not PII

The absolute URL of the Queue resource.

Methodenum<http-method>

Optional

Not PII

How to pass the update request data. Can be GET or POST and the default is POST. POST sends the data as encoded form data and GET sends the data as query parameters.

Possible values:

GETPOST

Update a Member resource

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 and Auth Token at twilio.com/console
5// and set the environment variables. See http://twil.io/secure
6const accountSid = process.env.TWILIO_ACCOUNT_SID;
7const authToken = process.env.TWILIO_AUTH_TOKEN;
8const client = twilio(accountSid, authToken);
9
10async function updateMember() {
11  const member = await client
12    .queues("QUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa")
13    .members("CallSid")
14    .update({ url: "https://www.example.com" });
15
16  console.log(member.callSid);
17}
18
19updateMember();

Output

1{
2  "queue_sid": "QUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
3  "call_sid": "CallSid",
4  "date_enqueued": "Thu, 06 Dec 2018 18:42:47 +0000",
5  "position": 1,
6  "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Queues/QUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Members/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json",
7  "wait_time": 143
8}

Update the Member resource at the front of the 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 and Auth Token at twilio.com/console
5// and set the environment variables. See http://twil.io/secure
6const accountSid = process.env.TWILIO_ACCOUNT_SID;
7const authToken = process.env.TWILIO_AUTH_TOKEN;
8const client = twilio(accountSid, authToken);
9
10async function updateMember() {
11  const member = await client
12    .queues("QUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa")
13    .members("Front")
14    .update({ url: "https://www.example.com" });
15
16  console.log(member.callSid);
17}
18
19updateMember();

Output

1{
2  "queue_sid": "QUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
3  "call_sid": "Front",
4  "date_enqueued": "Thu, 06 Dec 2018 18:42:47 +0000",
5  "position": 1,
6  "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Queues/QUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Members/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json",
7  "wait_time": 143
8}