REST Client MethodsQueue Members

List

View as Markdown

Use this endpoint for the Queue Members method to read all of the queue members that are waiting in a particular queue. This will be returned as a list of members.

Path parameters

AccountSidstringRequiredformat: "uuid"
The unique identifier for the account this Queue is associated with.
QueueSidstringRequiredformat: "uuid"
The unique identifier for the queue.

Query parameters

PageintegerOptional>=0Defaults to 0
The page number to retrieve (zero-indexed).
PageSizeintegerOptional1-1000Defaults to 50
The number of results per page. Default is 50, maximum is 1000.
PageTokenstringOptional
Token for cursor-based pagination. Required when navigating to pages beyond the first.

Response

uristringRequired
The URI of the current page.
first_page_uristringRequired
The URI of the first page.
next_page_uristring or nullRequired
The URI of the next page. Null if there are no more pages.
previous_page_uristring or nullRequired
The URI of the previous page. Null if this is the first page.
pageintegerRequired
The current page number (zero-indexed).
page_sizeintegerRequired
The number of items per page.
queue_memberslist of objectsRequired
List of queue members.
Response
1{
2  "uri": "/api/laml/2010-04-01/Accounts/b3877c40-da60-4998-90ad-b792e98472af/Queues/b3877c40-da60-4998-90ad-b792e98472qu/Members?Page=0&PageSize=50",
3  "first_page_uri": "/api/laml/2010-04-01/Accounts/b3877c40-da60-4998-90ad-b792e98472af/Queues/b3877c40-da60-4998-90ad-b792e98472qu/Members",
4  "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",
5  "previous_page_uri": "string",
6  "page": 0,
7  "page_size": 50,
8  "queue_members": [
9    {
10      "call_sid": "b3877c40-da60-4998-90ad-b792e98472ca",
11      "account_sid": "b3877c40-da60-4998-90ad-b792e98472af",
12      "queue_sid": "b3877c40-da60-4998-90ad-b792e98472qu",
13      "date_enqueued": "Wed, 26 Sep 2018 18:00:00 +0000",
14      "position": 1,
15      "wait_time": 30,
16      "member_type": "laml_call",
17      "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"
18    }
19  ]
20}

Request examples

1const { RestClient } = require('@signalwire/compatibility-api')
2const client = RestClient('YourProjectID', 'YourAuthToken', { signalwireSpaceUrl: 'example.signalwire.com' })
3
4client.queues('QueueSid')
5      .members
6      .each(members => console.log(members.callSid));