Queue Members

List All Queue Members

Changed on

Returns the callers currently waiting in one queue, ordered by enqueue time. Use it to inspect position and wait duration or locate a Call SID to dequeue. The SignalWire REST Queue Members API reads the same waiting calls, identifying each by a member ID rather than a Call SID.

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

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
  • 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.

Query parameters

Pageinteger

The page number to retrieve (zero-indexed).

PageSizeinteger

The number of results per page. Default is 50, maximum is 1000.

PageTokenstring

Token for cursor-based pagination. Required when navigating to pages beyond the first.

Response

The request has succeeded.

uristring required

The URI of the current page.

first_page_uristring required

The URI of the first page.

next_page_uristring nullable required

The URI of the next page. Null if there are no more pages.

previous_page_uristring nullable required

The URI of the previous page. Null if this is the first page.

pageinteger required

The current page number (zero-indexed).

page_sizeinteger required

The number of items per page.

Example response

{
  "uri": "/api/laml/2010-04-01/Accounts/b3877c40-da60-4998-90ad-b792e98472af/Queues/b3877c40-da60-4998-90ad-b792e98472qu/Members?Page=0&PageSize=50",
  "first_page_uri": "/api/laml/2010-04-01/Accounts/b3877c40-da60-4998-90ad-b792e98472af/Queues/b3877c40-da60-4998-90ad-b792e98472qu/Members",
  "next_page_uri": "/api/laml/2010-04-01/Accounts/b3877c40-da60-4998-90ad-b792e98472af/Queues/b3877c40-da60-4998-90ad-b792e98472qu/Members?Page=1&PageSize=50&PageToken=PAb3877c40-da60-4998-90ad-b792e98472me",
  "page_size": 50,
  "queue_members": [
    {
      "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

    • info

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

    • info

      added 'unevaluatedProperties' constraint to the / response property for the status