Sign in
Queue Members

List queue members

Lists the calls currently waiting in one voice queue. Use it to monitor the queue and decide which caller to handle next; use List queues to find queues, or Compatibility List all queue members for SID-based routes.

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/api/relay/rest/queues/{queue_id}/members

Path parameters

queue_idstring uuid required

Universal Unique Identifier.

Unique ID of the queue.

Response

The request has succeeded.

Example response

{
  "data": [
    {
      "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
    }
  ]
}

Changes

No changes found, but 3 of the 137 revisions have a changelog that could not be searched — this endpoint may have changed in one of them.