Queue Members

Retrieve a Queue Member

Changed on

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}

Request

  • Base URL
    https://YOUR_SPACE.signalwire.com/api/laml/2010-04-01
  • URL
    https://YOUR_SPACE.signalwire.com/api/laml/2010-04-01/Accounts/{AccountSid}/Queues/{QueueSid}/Members/{CallSid}
  • Auth
    HTTP basic

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

  • 2916d5e3072eRevision changes
    • breaking

      the response's property type changed from string to no type, and format from uuid to no format for status

    • breaking

      the response's property type changed from string to no type, and format from uuid to no format for status

    • breaking

      the response's property type changed from string to no type, and format from uuid to no format for status

    • info

      added to the response property allOf list for the response status

    • info

      added to the response property allOf list for the response status

    • info

      added to the response property allOf list for the response status

  • 5344c0c93a4cRevision changes
    • info

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

    • info

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

    • info

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

    • info

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