getMember | SignalWire

Retrieve a specific member from a queue.

Path parameters

queue_idstringRequiredformat: "uuid"

Unique ID of the queue.

idstringRequiredformat: "uuid"

The unique identifier (ID) of the queue member.

Response

call_idstringRequiredformat: "uuid"

The call ID of the queue member.

project_idstringRequired

The ID of the project associated with this queue member.

queue_idstringRequired

The ID of the queue associated with this queue member.

positionintegerRequired

Queue member position in the queue.

uristringRequired

The URL of this queue member.

wait_timeintegerOptional

Wait time in seconds since the member was enqueued. If not yet enqueued, it will be null.

date_enqueueddatetimeOptional

When the queue member was last enqueued.

Response Example

Response

{
  "call_id": "596e2dea-a269-4765-a0b4-01b82d11c120",
  "project_id": "d421473b-d696-449a-a1a1-4ddd83d2d0e5",
  "queue_id": "596e2dea-a269-4765-a0b4-01b82d11c120",
  "position": 2,
  "uri": "/api/relay/rest/queues/596e2dea-a269-4765-a0b4-01b82d11c120/members/596e2dea-a269-4765-a0b4-01b82d11c120",
  "wait_time": 172975,
  "date_enqueued": "2024-01-15T09:30:00Z"
}

Example

import { RestClient } from "@signalwire/sdk";
const client = new RestClient({
  project: "your-project-id",
  token: "your-api-token",
  host: "your-space.signalwire.com"
});
const member = await client.queues.getMember("queue-id", "member-id");
console.log(member["call_id"], member["position"]);