Queue Members

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.

get/Accounts/{AccountSid}/Queues/{QueueSid}/Members/{CallSid}

Path parameters

AccountSidstring uuid required

Universal Unique Identifier.

The unique identifier for the account this Queue is associated with.

QueueSidstring uuid required

Universal Unique Identifier.

The unique identifier for the queue.

CallSidstring required

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.

call_sidstring uuid required

Universal Unique Identifier.

account_sidstring uuid required

Universal Unique Identifier.

queue_sidstring uuid required

Universal Unique Identifier.

date_enqueuedstring required

The date and time, in RFC 2822 format, when the member was enqueued.

positioninteger required

The position of the member in the queue (1-indexed).

wait_timeinteger required

The wait time, in seconds, since the member was enqueued.

member_typestring required

The type of the queue member.

uristring required

The URI of this resource, relative to the API base URL.

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

  • 2916d5e3072e33See the full diff
    • the account_sid response's property type/format changed from string/uuid to / for status 200

      response-property-type-changed

    • the call_sid response's property type/format changed from string/uuid to / for status 200

      response-property-type-changed

    • the queue_sid response's property type/format changed from string/uuid to / for status 200

      response-property-type-changed

    • added uuid to the account_sid response property allOf list for the response status 200

      response-property-all-of-added

    • added uuid to the call_sid response property allOf list for the response status 200

      response-property-all-of-added

    • added uuid to the queue_sid response property allOf list for the response status 200

      response-property-all-of-added

    • added 'unevaluatedProperties' constraint to the response body for the status 200

      response-body-unevaluated-properties-added

    • added 'unevaluatedProperties' constraint to the response body for the status 400

      response-body-unevaluated-properties-added

    • added 'unevaluatedProperties' constraint to the response body for the status 401

      response-body-unevaluated-properties-added

    • added 'unevaluatedProperties' constraint to the response body for the status 404

      response-body-unevaluated-properties-added

  • d5fbaaddfa3e110See the full diff
    • the wait_time response's property type/format changed from string/ to integer/int32 for status 200

      response-property-type-changed

    • for the path request parameter CallSid, the type/format was generalized from string/uuid to string/

      request-parameter-type-generalized

    • added the non-success response with the status 400

      response-non-success-status-added

    • the response property call_sid became required for the status 200

      response-property-became-required

    • the response property date_enqueued became required for the status 200

      response-property-became-required

    • the response property position became required for the status 200

      response-property-became-required

    • the response property uri became required for the status 200

      response-property-became-required

    • the response property wait_time became required for the status 200

      response-property-became-required

    • added the required property account_sid to the response with the 200 status

      response-required-property-added

    • added the required property member_type to the response with the 200 status

      response-required-property-added

    • added the required property queue_sid to the response with the 200 status

      response-required-property-added

    This revision also has 11 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 3c88f14db21e42See the full diff
    • added the new path request parameter AccountSid

      new-request-path-parameter

    • added the new path request parameter CallSid

      new-request-path-parameter

    • added the new path request parameter QueueSid

      new-request-path-parameter

    • the position response's property type/format changed from string/ to integer/int32 for status 200

      response-property-type-changed

    • added the non-success response with the status 401

      response-non-success-status-added

    • added the non-success response with the status 404

      response-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