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.
Resource properties date_enqueued
type: string<DATE TIME RFC 2822> Not PIIThe date that the member was enqueued, given in RFC 2822 format.
This member's current position in the queue.
The URI of the resource, relative to https://api.twilio.com
.
The number of seconds the member has been in the queue.
The SID of the Queue the member is in.
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.
URI parameters Path Parameter
The SID of the Queue in which to find the members to fetch.
_11 // Download the helper library from https://www.twilio.com/docs/node/install
_11 // Find your Account SID and Auth Token at twilio.com/console
_11 // and set the environment variables. See http://twil.io/secure
_11 const accountSid = process.env.TWILIO_ACCOUNT_SID;
_11 const authToken = process.env.TWILIO_AUTH_TOKEN;
_11 const client = require('twilio')(accountSid, authToken);
_11 client.queues('QUXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX')
_11 .members('CAXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX')
_11 .then(member => console.log(member.callSid));
_10 "queue_sid": "QUXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_10 "call_sid": "CAXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_10 "date_enqueued": "Tue, 07 Aug 2012 22:57:41 +0000",
_10 "uri": "/2010-04-01/Accounts/ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Queues/QUXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Members/CAXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX.json",
_11 // Download the helper library from https://www.twilio.com/docs/node/install
_11 // Find your Account SID and Auth Token at twilio.com/console
_11 // and set the environment variables. See http://twil.io/secure
_11 const accountSid = process.env.TWILIO_ACCOUNT_SID;
_11 const authToken = process.env.TWILIO_AUTH_TOKEN;
_11 const client = require('twilio')(accountSid, authToken);
_11 client.queues('QUXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX')
_11 .then(member => console.log(member.callSid));
_10 "queue_sid": "QUXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_10 "call_sid": "CAXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_10 "date_enqueued": "Tue, 07 Aug 2012 22:57:41 +0000",
_10 "uri": "/2010-04-01/Accounts/ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Queues/QUXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Members/CAXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX.json",
GET https://api.twilio.com/2010-04-01/Accounts/{AccountSid}/Queues/{QueueSid}/Members.json
URI parameters Path Parameter
The SID of the Queue in which to find the members
Query Parameter
How many resources to return in each list page. The default is 50, and the maximum is 1000.
Query Parameter
The page index. This value is simply for client state.
Query Parameter
The page token. This is provided by the API.
_11 // Download the helper library from https://www.twilio.com/docs/node/install
_11 // Find your Account SID and Auth Token at twilio.com/console
_11 // and set the environment variables. See http://twil.io/secure
_11 const accountSid = process.env.TWILIO_ACCOUNT_SID;
_11 const authToken = process.env.TWILIO_AUTH_TOKEN;
_11 const client = require('twilio')(accountSid, authToken);
_11 client.queues('QUXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX')
_11 .then(members => members.forEach(m => console.log(m.callSid)));
_20 "first_page_uri": "/2010-04-01/Accounts/ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Queues/QUXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Members.json?PageSize=50&Page=0",
_20 "next_page_uri": "/2010-04-01/Accounts/ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Queues/QUXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Members.json?PageSize=50&Page=50",
_20 "previous_page_uri": "/2010-04-01/Accounts/ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Queues/QUXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Members.json?PageSize=50&Page=0",
_20 "queue_sid": "QUXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_20 "call_sid": "CAXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_20 "date_enqueued": "Mon, 17 Dec 2018 18:36:39 +0000",
_20 "uri": "/2010-04-01/Accounts/ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Queues/QUXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Members/CAXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX.json",
_20 "uri": "/2010-04-01/Accounts/ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Queues/QUXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Members.json?PageSize=50&Page=0"
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.
URI parameters Path Parameter
The SID of the Queue in which to find the members to update.
Request body parameters Required
The absolute URL of the Queue resource.
Method
type: enum<HTTP METHOD> Not PIIHow 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:
HEAD
GET
POST
PATCH
PUT
DELETE
_11 // Download the helper library from https://www.twilio.com/docs/node/install
_11 // Find your Account SID and Auth Token at twilio.com/console
_11 // and set the environment variables. See http://twil.io/secure
_11 const accountSid = process.env.TWILIO_ACCOUNT_SID;
_11 const authToken = process.env.TWILIO_AUTH_TOKEN;
_11 const client = require('twilio')(accountSid, authToken);
_11 client.queues('QUXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX')
_11 .members('CAXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX')
_11 .update({url: 'https://example.com'})
_11 .then(member => console.log(member.callSid));
_10 "queue_sid": "QUXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_10 "call_sid": "CAXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_10 "date_enqueued": "Thu, 06 Dec 2018 18:42:47 +0000",
_10 "uri": "/2010-04-01/Accounts/ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Queues/QUXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Members/CAXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX.json",
_11 // Download the helper library from https://www.twilio.com/docs/node/install
_11 // Find your Account SID and Auth Token at twilio.com/console
_11 // and set the environment variables. See http://twil.io/secure
_11 const accountSid = process.env.TWILIO_ACCOUNT_SID;
_11 const authToken = process.env.TWILIO_AUTH_TOKEN;
_11 const client = require('twilio')(accountSid, authToken);
_11 client.queues('QUXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX')
_11 .update({url: 'https://example.com'})
_11 .then(member => console.log(member.callSid));
_10 "queue_sid": "QUXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_10 "call_sid": "CAXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_10 "date_enqueued": "Thu, 06 Dec 2018 18:42:47 +0000",
_10 "uri": "/2010-04-01/Accounts/ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Queues/QUXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Members/CAXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX.json",