Retrieve a Queue Member
Retrieves one waiting caller by Call SID, or the caller at the front of the queue when Front is used. Use List All Queue Members to inspect the full waiting order. The native API reads the same waiting calls by member ID, with Get next queue member in place of the Front selector.
Permissions
The API token used to authenticate must have the following scope(s) enabled to make a successful request: Voice.
Learn more about API scopes.
Path parameters
Universal Unique Identifier.
The unique identifier for the account this Queue is associated with.
Universal Unique Identifier.
The unique identifier for the queue.
The unique identifier for the call, or the special value 'Front' to reference the member at the front of the queue.
Response
The request has succeeded.
Example response
{
"date_enqueued": "Wed, 26 Sep 2018 18:00:00 +0000",
"position": 1,
"wait_time": 30,
"member_type": "laml_call",
"uri": "/api/laml/2010-04-01/Accounts/b3877c40-da60-4998-90ad-b792e98472af/Queues/b3877c40-da60-4998-90ad-b792e98472qu/Members/b3877c40-da60-4998-90ad-b792e98472ca.json"
}Changes
Changed in 4 of the 40 revisions of this API.819
- ▲
the
account_sidresponse's property type/format changed fromstring/uuidto/for status200response-property-type-changed
- ▲
the
call_sidresponse's property type/format changed fromstring/uuidto/for status200response-property-type-changed
- ▲
the
queue_sidresponse's property type/format changed fromstring/uuidto/for status200response-property-type-changed
- ○
added
uuidto theaccount_sidresponse propertyallOflist for the response status200response-property-all-of-added
- ○
added
uuidto thecall_sidresponse propertyallOflist for the response status200response-property-all-of-added
- ○
added
uuidto thequeue_sidresponse propertyallOflist for the response status200response-property-all-of-added
- ▲
- ○
added 'unevaluatedProperties' constraint to the response body for the status
200response-body-unevaluated-properties-added
- ○
added 'unevaluatedProperties' constraint to the response body for the status
400response-body-unevaluated-properties-added
- ○
added 'unevaluatedProperties' constraint to the response body for the status
401response-body-unevaluated-properties-added
- ○
added 'unevaluatedProperties' constraint to the response body for the status
404response-body-unevaluated-properties-added
- ○
- ▲
the
wait_timeresponse's property type/format changed fromstring/tointeger/int32for status200response-property-type-changed
- ○
for the
pathrequest parameterCallSid, the type/format was generalized fromstring/uuidtostring/request-parameter-type-generalized
- ○
added the non-success response with the status
400response-non-success-status-added
- ○
the response property
call_sidbecame required for the status200response-property-became-required
- ○
the response property
date_enqueuedbecame required for the status200response-property-became-required
- ○
the response property
positionbecame required for the status200response-property-became-required
- ○
the response property
uribecame required for the status200response-property-became-required
- ○
the response property
wait_timebecame required for the status200response-property-became-required
- ○
added the required property
account_sidto the response with the200statusresponse-required-property-added
- ○
added the required property
member_typeto the response with the200statusresponse-required-property-added
- ○
added the required property
queue_sidto the response with the200statusresponse-required-property-added
This revision also has 11 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
- ▲
- ▲
added the new path request parameter
AccountSidnew-request-path-parameter
- ▲
added the new path request parameter
CallSidnew-request-path-parameter
- ▲
added the new path request parameter
QueueSidnew-request-path-parameter
- ▲
the
positionresponse's property type/format changed fromstring/tointeger/int32for status200response-property-type-changed
- ○
added the non-success response with the status
401response-non-success-status-added
- ○
added the non-success response with the status
404response-non-success-status-added
This revision also has 14 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
- ▲