listMembers

List members currently in a queue.

Path parameters

queue_idstringRequiredformat: "uuid"

Unique ID of the queue.

Response

linksobjectOptional

Pagination links.

datalist of objectsOptional

List of queue members.

Response Example

Response

1 {
2   "links": {
3     "self": "string",
4     "first": "string",
5     "next": "string",
6     "prev": "string"
7   },
8   "data": [
9     {
10       "call_id": "596e2dea-a269-4765-a0b4-01b82d11c120",
11       "project_id": "d421473b-d696-449a-a1a1-4ddd83d2d0e5",
12       "queue_id": "596e2dea-a269-4765-a0b4-01b82d11c120",
13       "position": 2,
14       "uri": "/api/relay/rest/queues/596e2dea-a269-4765-a0b4-01b82d11c120/members/596e2dea-a269-4765-a0b4-01b82d11c120",
15       "wait_time": 172975,
16       "date_enqueued": "2024-01-15T09:30:00Z"
17     }
18   ]
19 }

Example

1 import { RestClient } from "@signalwire/sdk";
2 
3 const client = new RestClient({
4   project: "your-project-id",
5   token: "your-api-token",
6   host: "your-space.signalwire.com"
7 });
8 
9 const members = await client.queues.listMembers("queue-id");
10 for (const m of members.data ?? []) {
11     console.log(m["call_id"], m["position"]);
12 }