Menu

Expand
Rate this page:

Thanks for rating this page!

We are always striving to improve our documentation quality, and your feedback is valuable to us. How could this documentation serve you better?

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

Names in PHP format
callSid
sid<CA> Not PII

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

dateEnqueued
date_time<rfc2822> Not PII

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

position
integer Not PII

This member's current position in the queue.

uri
uri Not PII

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

waitTime
integer Not PII

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

queueSid
sid<QU> Not PII

The SID of the Queue the member is in.

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.

Parameters
Names in None format
account_sid
Required
get sid<AC> Not PII

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

queue_sid
Required
get sid<QU> Not PII

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

call_sid
Required
get sid_like<CA> Not PII

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

Example
        
        
        
        

        Read multiple Member resources

        get
        https://api.twilio.com/2010-04-01/Accounts/{AccountSid}/Queues/{QueueSid}/Members.json
        Parameters
        Names in None format
        account_sid
        Required
        get sid<AC> Not PII

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

        queue_sid
        Required
        get sid<QU> Not PII

        The SID of the Queue in which to find the members

        Example
              
              
              
              

              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.

              Parameters
              Names in None format
              account_sid
              Required
              post sid<AC> Not PII

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

              queue_sid
              Required
              post sid<QU> Not PII

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

              call_sid
              Required
              post sid_like<CA> Not PII

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

              url
              Required
              post url Not PII

              The absolute URL of the Queue resource.

              method
              Optional
              post http_method 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.

              Example
                    
                    
                    
                    
                    Rate this page:

                    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 browsing the Twilio tag on Stack Overflow.